Product API overview
POST /v2/data_ingestion/catalog/product/submission
Use the product API to create new and update existing products. When you create a new product, it takes 1-3 business days for the new product to be displayed in the storefront. After you update a product, it is displayed in your storefront in a few hours.
Attributes
Field | Data type | Required | Description |
---|---|---|---|
lookup_code | string | yes | The unique code that represents each of your products (such as PLU or UPC). For scannable barcodes: the code provided should be the code on the product itself. |
retailer_reference_code | string | no | The internal item code used by retailers to identify products or to group a series of lookup codes to the same product. |
brand_name | string | no | The customer-facing product brand name (100 character limit). This is a static field that is only applied when you create a product. For products shared across retailers, this brand name is provided by the brand owner. |
ca_prop65_text | string | no | US retailers only. Required text compliant with California law. |
department | string | no | The department in which the product is displayed. |
item_name | string | yes|no | The name of the product on the storefront. (100 character limit) |
item_details | string | no | Additional item details or custom content. |
kosher | boolean | no | If the product is kosher, TRUE. |
organic | boolean | no | If the product is organic, TRUE. |
retailer_oms_eligible | boolean | no | If the retailer uses OMS integration, TRUE. |
remote_image_url | string | no | Primary image of the product. For more information, see Image specifications. |
additional_images_url | JSON | no | An array of JSON objects defining secondary image URLs. For more information, see Image specifications. |
size | string | no | The numerical amount of a unit within the pack. To define the associated unit of measure, use the |
size_uom | string | no | Unit of measure for the amount within the pack (size). |
variant | JSON object | no | This field is a complex object to describe variations of the product. For more information, see Variant specifications. |
vegan | boolean | no | If the product is vegan, TRUE. |
vegetarian | boolean | no | If the product is vegetarian, TRUE. |
Example
{
"lookup_code": "1234567890",
"retailer_reference_code": "ABC",
"department": "catering",
"item_name": "Cobb Salad",
"item_details": "Chopped iceberg lettuce, crumbled bacon, black forest ham, turkey, blue cheese crumbles, chopped tomatoes, black olives and chopped egg. Served with house ranch dressing.",
"retailer_oms_eligible": true,
"remote_image_url": "https://your-website.com/url-link-to-cobb-salad-image.png"
}