Skip to main content
POST
/
v1
/
products
/
bulk
Bulk Upsert Products
curl --request POST \
  --url https://api.example.com/v1/products/bulk \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "product_id": "<string>",
      "product_name": "<string>",
      "product_group": "<string>",
      "manufacturer": "<string>",
      "brand": "<string>",
      "status": "<string>",
      "product_type": "<string>",
      "barcode": "<string>",
      "stock_on_hand": 123,
      "category_1": "<string>",
      "category_2": "<string>",
      "category_3": "<string>",
      "category_4": "<string>",
      "category_5": "<string>",
      "image_url": "<string>",
      "product_url": "<string>",
      "rrp": 123,
      "regular_price": 123,
      "product_created_date": "2023-12-25",
      "price_effective_date": "2023-12-25",
      "cost_effective_date": "2023-12-25",
      "size": "<string>",
      "color": "<string>",
      "uom": "<string>",
      "tax_rate": 123,
      "currency": "<string>",
      "item_id": "<string>",
      "sku": "<string>",
      "sku_name": "<string>",
      "current_price": 123,
      "unit_cost": 123
    }
  ]
}
'
{
  "results": [
    {
      "index": 123,
      "ok": true,
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

Body

application/json
items
ProductBulkItem · object[]

Response

Successful Response

results
(BulkItemSuccess · object | BulkItemError · object)[]