API referenceCatalogImports
Preview import
Validates and previews the uploaded rows without changing catalog data. Returns mappings, row counts, missing fields, and representative skipped rows.
- Endpoint
POST /v1/imports/uploads/{uploadRef}/preview- Authorization
- Required permission: `imports:read`.
- Environments
- Production only
- Idempotency
- Not required.
Prepare import upload POST
Creates a server-bound uploadRef and short-lived PUT instructions. After uploading the file, use the same uploadRef to preview or commit it.
Commit import POST
Starts the catalog import after preview. Product files with prices must declare pricesIncludeIva; stock imports may require inventoryLocationId. Reuse the same Idempotency-Key only for the identical request.