Skip to main content

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

FieldData typeRequiredDescription
lookup_codestringyes

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.

If you have a group of lookup_codes tied to a single product, add a retailer_reference_code.

Include a check digit on all UPCs to ensure we have a full UPC to correlate to what we have in our system. This helps provide the most accurate information for this product.

retailer_reference_codestringnoThe internal item code used by retailers to identify products or to group a series of lookup codes to the same product.
brand_namestringno

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_textstringnoUS retailers only. Required text compliant with California law.
departmentstringnoThe department in which the product is displayed.
item_namestringyes|no

The name of the product on the storefront. (100 character limit)

This is a static field that is only required when creating the product for the first time.
Items in Instacart’s Universal Catalog can inherit a trusted product source, such as data from CPGs.
This value is used as a method for matching PLU items to correct products and to create new products specific to a retailer.

Do not use abbreviations.

item_detailsstringnoAdditional item details or custom content.
kosherbooleannoIf the product is kosher, TRUE.
organicbooleannoIf the product is organic, TRUE.
retailer_oms_eligiblebooleannoIf the retailer uses OMS integration, TRUE.
remote_image_urlstringnoPrimary image of the product. For more information, see Image specifications.
additional_images_urlJSONnoAn array of JSON objects defining secondary image URLs. For more information, see Image specifications.
sizestringno

The numerical amount of a unit within the pack. To define the associated unit of measure, use the size_uom field.

Note: For alcoholic products and non-alcoholic beverages the size provided must be a volume measurement.

For example, for a 12 fl oz soda can, enter "12".
size_uomstringno

Unit of measure for the amount within the pack (size).
Default is ‘each’.

Note: For alcoholic products and non-alcoholic beverages the size provided must be a volume measurement.

For example, for a 12 fl oz soda can, enter "fl oz".
variantJSON objectnoThis field is a complex object to describe variations of the product. For more information, see Variant specifications.
veganbooleannoIf the product is vegan, TRUE.
vegetarianbooleannoIf 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"
}