Upload a CSV or XLSX (and optionally a ZIP of images) for preview
Nothing lands until the import is committed.
/v1/clients/{clientId}/importsNothing lands until the import is committed. The file is validated in full in the background; poll the import until its status is ready, review the rows, then commit. Rows match existing products by SKU. Download the template for the column list.
Authorization
bearerAuth A tenant API key (sk_{env}_{id}_{secret}), a wallet user token, or an IdP access token. Which principal the credential resolves to decides the scopes it carries; see the authentication guide.
In: header
Path Parameters
uuidRequest Body
multipart/form-data
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/v1/clients/497f6eca-6276-4993-bfeb-53cbbbba6f08/imports" \ -F file="null"{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643", "status": "validating", "file_name": "string", "has_images": true, "row_count": 0, "create_count": 0, "update_count": 0, "error_count": 0, "applied_count": 0, "error": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "committed_at": "2019-08-24T14:15:22Z"}The shop's imports, newest first
The shop's bulk imports, newest first, each with its status and its create, update, error and applied counts.
One import and its counts
One import with its current status and counts — poll this after starting or committing an import, both of which finish in the background.