Skip to main content
POST
/
products
/
ingestions
Queues a batch of products for ingestion/upsert
curl --request POST \
  --url https://api.example.com/products/ingestions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "items": [
    {
      "external_id": "ext-123",
      "name": "Sofa X",
      "description": "3-seat sofa",
      "style": "Modern",
      "type": "Sofa",
      "sub_type": "Sleeper Sofa",
      "variants": [
        {
          "sku": "SOFA-X-001",
          "name": "Sofa X Blue",
          "item_url": "https://shop.example.com/sofa-x-blue",
          "depth": 90,
          "height": 80,
          "width": 210,
          "weight": 30000,
          "color": "Blue",
          "price": 1499.9,
          "brand": "BrandCo",
          "images": [
            {
              "url": "https://cdn.example.com/img/sofax/blue/front.jpg",
              "angle": 0
            },
            {
              "url": "https://cdn.example.com/img/sofax/blue/side.jpg"
            }
          ]
        }
      ]
    }
  ]
}'
{
  "batch_id": "<string>",
  "received_count": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
items
object[]
required

Up to 1000 items per batch. Each item is a complete product with variants.

Maximum length: 1000

Response

Batch accepted for asynchronous processing

batch_id
string
required

Batch identifier

received_count
integer
required

Number of items received

I