v1

latestOpenAPI 3.1.02026-07-134488210.8 KB
Products

Bulk upload products

Bulk create or update product families and their variants.

Submit up to 1,000 product families per request, each containing up to 100 variants. Products are processed asynchronously in batches. Only one bulk upload can run per store at a time.

Matching Strategy

The API uses the following priority to match incoming product families to existing records:

  1. product_family_id — Redo product family ID (direct lookup)
  2. external_id — ID from your external system
  3. SKU — Matched via variant SKUs

If no match is found, a new product family is created.

Concurrency

Only one bulk upload operation can run per store at a time. If a bulk upload is already in progress, the request will return a 409 Conflict error.

Requires the products_write scope.

post/stores/{storeId}/products/bulk-upload

Path parameters

storeIdstring required
Example:64e5a8a1af49a89df37e4ee7

Store ID

Request body

Response

Upload completed

total_countinteger required

Total number of product families in the request.

processed_countinteger required

Number of product families processed successfully.

error_countinteger required

Number of product families that failed to process.