Sign in

v1

latestOpenAPI 3.1.02026-07-2296226496.3 KB
Store Catalog

Create or update products

Create new products or update existing ones in the store catalog. Products are matched by external identifier for upsert logic.

post/v1/products

Request body

Example request

{
  "products": [
    {
      "externalIdentifier": "ext_001",
      "sku": "ORG-BAN-001",
      "name": "Organic Bananas",
      "description": "Fresh organic bananas, perfect for smoothies and baking",
      "imageUrls": [
        "https://example.com/bananas1.jpg",
        "https://example.com/bananas2.jpg"
      ],
      "categories": [
        "Produce",
        "Fruits",
        "Organic"
      ],
      "weight": 0.5,
      "dimensions": {
        "depth": 10.5,
        "width": 5,
        "height": 15.2
      },
      "identifiers": [
        {
          "type": "UPC",
          "value": "123456789012"
        }
      ],
      "attributes": [
        "WEIGHTED"
      ],
      "details": {
        "weightedItemInfo": {
          "weightPerItem": 0.5,
          "weightUnit": "kg"
        },
        "sizeSpecification": {
          "value": 100,
          "description": "Large"
        },
        "packSizeSpecification": {
          "description": "Large"
        },
        "skillsRequired": [
          "gas_oven_installation"
        ],
        "dropoffServiceTimeSeconds": 600
      },
      "providerConfigs": [
        {
          "categories": [
            "Produce",
            "Fruits",
            "Organic"
          ],
          "provider": "X",
          "serviceType": "pick_and_deliver"
        }
      ]
    }
  ]
}

Response

OK

idstring required
externalIdentifierstring nullable

The external ID of the product from an external system

skustring nullable

The Stock Keeping Unit (SKU) for the product

namestring required

The name of the product

descriptionstring nullable

The description of the product

imageUrlsstring[] nullable

List of image URLs for the product

categoriesstring[] nullable

List of categories the product belongs to

weightnumber nullable

The weight of the product

attributesstring[] nullable

List of attributes for the product

Example response

[
  {
    "externalIdentifier": "ext_001",
    "sku": "11111",
    "name": "Organic Bananas",
    "description": "Fresh organic bananas, perfect for smoothies and baking",
    "imageUrls": [
      "https://example.com/bananas1.jpg",
      "https://example.com/bananas2.jpg"
    ],
    "categories": [
      "Produce",
      "Fruits",
      "Organic"
    ],
    "weight": 0.5,
    "dimensions": {
      "depth": 10.5,
      "width": 5,
      "height": 15.2
    },
    "identifiers": [
      {
        "type": "UPC",
        "value": "123456789012"
      }
    ],
    "attributes": [
      "WEIGHTED"
    ],
    "details": {
      "weightedItemInfo": {
        "weightPerItem": 0.5,
        "weightUnit": "kg"
      },
      "sizeSpecification": {
        "value": 100,
        "description": "Large"
      },
      "packSizeSpecification": {
        "description": "Large"
      }
    },
    "providerConfigs": [
      {
        "categories": [
          "Produce",
          "Fruits",
          "Organic"
        ],
        "provider": "X",
        "serviceType": "pick_and_deliver"
      }
    ]
  }
]