Process uploaded price list file

Downloads an uploaded file, validates price rows, and upserts price items into a price list.

POST/api/prices/lists/process-upload

Downloads an uploaded file, validates price rows, and upserts price items into a price list.

Request Body

application/json

Request payload for Process uploaded price list file.

TypeScript Definitions

Use the request body type in TypeScript.

fileId*string

Uploaded file identifier containing imported price rows.

Example"file_123"

priceListId*string

Price list identifier to update from the uploaded file.

Example"pl_123"

deleteMissing?|

Whether to delete existing price rows missing from the uploaded file.

Response Body

`application/json`

curl -X POST "https://example.com/api/prices/lists/process-upload" \  -H "Content-Type: application/json" \  -d '{    "fileId": "file_123",    "priceListId": "pl_123"  }'

{  "success": true,  "processedCount": 0,  "totalRows": 0,  "insertedCount": 0,  "updatedCount": 0,  "deletedCount": 0,  "warnings": [    "Row 8 skipped because SKU was empty."  ]}

{  "_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."}

Process uploaded price list file

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`