Import price data

Imports structured price rows either into a price list or into products base prices.

POST/api/prices/import

Imports structured price rows either into a price list or into products base prices.

Request Body

application/json

Request payload for Import price data.

TypeScript Definitions

Use the request body type in TypeScript.

priceListId?|

Target price list identifier when importing into an existing list.

items*array<>

Price rows to import into the target price list.

deleteMissing?|

Whether to delete existing rows not present in the import payload.

fileName?|

Original imported file name including extension.

Response Body

`application/json`

curl -X POST "https://example.com/api/prices/import" \  -H "Content-Type: application/json" \  -d '{    "items": [      {        "sku": "SKU-123",        "amount": 0,        "currency": "USD"      }    ]  }'

{  "processed": 0}

{  "_tag": "ApiBadRequestError",  "code": "PRICE_IMPORT_DUPLICATE_SKUS",  "message": "The request payload is invalid.",  "description": "Remove duplicate SKU rows before importing the file.",  "details": null}

{  "_tag": "Unauthorized"}

{  "_tag": "ApiForbiddenError",  "message": "You do not have permission to perform this action."}

{  "_tag": "ApiNotFoundError",  "message": "The requested resource was not found."}

{  "_tag": "ApiConflictError",  "message": "A resource with this handle already exists."}

{  "_tag": "ApiUnprocessableEntityError",  "message": "The order cannot be submitted without items."}

{  "_tag": "ServiceUnavailable"}

{  "_tag": "ApiTimeoutError",  "message": "The upstream operation timed out."}

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`