Import products

Validates imported product rows with the legacy product import schema and upserts matching products.

POST/api/imports/products

Validates imported product rows with the legacy product import schema and upserts matching products.

Request Body

application/json

Request payload for Import products.

TypeScript Definitions

Use the request body type in TypeScript.

Tabular product import rows. Each row is validated against the legacy product import Zod schema at runtime.

Example

[  {    "sku": "SKU-123",    "title": "Starter Kit",    "currency": "USD",    "price": 19990  }]

[index: integer]?any

Response Body

`application/json`

curl -X POST "https://example.com/api/imports/products" \  -H "Content-Type: application/json" \  -d '[    {      "sku": "SKU-123",      "title": "Starter Kit",      "currency": "USD",      "price": 19990    }  ]'

{  "created": 0,  "updated": 0,  "total": 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`