Item API overview
POST /v2/data_ingestion/catalog/item/submission
Use the item API to update or set the item level attributes of a product at a specific store location. When you update an item, the change can take around two to three hours before it is displayed on the storefront.
Attributes
| Field | Type | Required | Description |
|---|---|---|---|
lookup_code | string | yes1 | 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. |
store_identifier | string | yes | The store ID where this item is located. This value is equivalent to the location_code column in the inventory file. |
retailer_reference_code | string | no1 | An internal item code used to group a series of lookup_codes to a single item. For scannable barcodes, the code provided should be the code on the product itself. |
price | number | no | The price per pound or per unit. This distinction is noted in the cost_unit field. If selling in USA, provide the price in USD. If selling in Canada, provide the price in CAD. |
cost_unit | string | no | Indicates how a product is sold: by unit or by weight unit (each, lb, g, kg). |
alcoholic | boolean | no | If the item contains alcohol, TRUE. |
available | boolean | no | If an item is available for purchase, TRUE. |
balance_on_hand | int | no | Number of items at this store. |
blackout_times | JSON | no | Use a JSON array to control when an item is unavailable. For more information, see Blackout period specification. |
is_catering | boolean | no | If an item is available as a catered item, TRUE. |
order_lead_time | int | no | Lead time, in minutes, required to support item fulfillment. |
configurable_products | JSON | no | Use a JSON array to send variant data. For more information, see Configurable products specifications. |
Before you send your files, consider using a JSON validator.
Example
{
"lookup_code": "1234567890",
"store_identifier": "1234",
"available": true,
"price": 5.99
}