Product catalog attributes
Overview
This table outlines the required and optional attributes for the product catalog, along with their definitions, formats, and examples. Required fields must be provided for proper ingestion, while optional fields are recommended to enhance campaign performance and improve the shopper experience.
Product catalog attributes
| Attribute | Definition | Type | Mandatory | Example |
|---|---|---|---|---|
| adult | A boolean indicating if the product is for adults only (18+). | boolean | No | false |
| brand | The brand of the product. | string | Yes | Jedi Order |
| custom_labels | An array where you can add custom labels to store additional information, such as filters. Maximum 600 characters. | array | No | [color=blue,size=large] |
| customer_rating | The customer rating of the product. | float | No | 4.5 |
| description | A short text providing more information about the product. | string | No | The favorite weapon of a Jedi Master |
| gtin | The Global Trade Item Number (GTIN), an international system for identifying products. GTINs can be 8, 12, 13, or 14 digits. | number | Yes | 012345678905 (GTIN-12) |
| image_link | The URL of the product image. This image is used in the creatives. | string | Yes | https://www.image-product-retailer.com/ |
| in_stock | A boolean indicating if the product is available. | boolean | Yes | true |
| is_bundle | A boolean indicating if the product is a bundle of other products. | boolean | No | false |
| link | The URL of the product page on your website. | string | Yes | https://www.example-retailer.com/ |
| mobile_link | The URL of the mobile-optimized product page. | string | No | https://www.m.example-retailer.com/ |
| price | The displayed price of the product. Use the same currency as your site. | float | Yes | 1999.99 |
| quantity_multipack | The number of products included in a bundle. | number | No | 1 |
| remaining_stock | The number of items currently in stock for the product. | number | No | 10 |
| retailer_parent_id | The internal ID used to group product variants under one parent product. | string | No | ABCD1234 |
| retailer_product_category | The principal category for the product. For multiple categories, use full breadcrumb paths separated by a pipe (|). The first path must be the principal category. Breadcrumbs must match your website exactly. The system ingests up to 10 levels per path. | string | Yes | Jedi women > Accessories > Swords | Star Wars > Gear > Combat |
| retailer_product_category_id | The IDs associated with the categories. Use the same separator and order as retailer_product_category. | string | Yes | 12>123>1231 | 45>456>4567 |
| retailer_product_id | The unique internal identifier for the product. Values must be unique per product. If a product lacks a unique ID, use a unique offer-level identifier (for example, an offer ID). | string | Yes | 123456789 |
| sale_price | The discounted price. If you only provide sale_price, the system displays it as the main price. If you provide both price and sale_price, the banner displays both and applies a strikethrough to the original price. | float | No | 1299.59 |
| seller | The name of the third-party seller, if applicable. | array | No | Kamino Seller |
| store_id | The internal ID for a specific store. All other fields (such as price and stock) must reflect data for this store. Provide each product-store combination as a separate row or object. | string | No | 1234 |
| thumbnail_link | The URL of the product's thumbnail image. | string | No | https://www.thumbnail-product-retailer.com/ |
| title | The name of the product. This is the main text descriptor in the creative. | string | Yes | Green lightsaber |
By default, the system considers a product as out of stock (in_stock = false) in the following cases:
- The
in_stockfield is set tofalse. - The product was in a previous feed but is missing from the latest update.