Create a robust user experience in the POS app by viewing product details such as search results and filters.
Format
The feed formats are CSV (comma-separated), TSV (tab-separated), and pipe separated.
Feed types
- Full Feed Import - This is a complete product feed with all the products and all the columns.
- Delta Feed Import - This feed is a subset of the full product feed, and you can run it more
frequently than a full product feed import. As part of the delta feed import, you can add new
products and update information about existing products (price, promotion text, etc.).
- Upload a Product Delta (Delete feed) to delete a product from a delta feed.
Frequency
- Full Product Feed - Most customers provide a full product feed once a month.
- Delta Product Feed - The system loads deltas daily at a set frequency.
Content
| Target Field | CMS Alias | Required | Important | Data Type | Max Character Limit | Description |
|---|---|---|---|---|---|---|
| additional_image_link | AdditionalImageURL | No | Yes | String | 16,000,000 |
The pipe-separated values of additional image URLs. The recommended image size is 50 kb. Important: URLs can't contain spaces. URL encode them, replacing spaces with either a plus (+) sign or %20. |
| color | Color | No | Yes | String | 100 | The color of a product, if applicable. |
| description | Description | No | Yes | String | 16,000,000 | The product description. Use basic HTML tags (for example, <br> <li> <ul>) to format content. |
| id | ProductID | Yes | Required | String | 128 | Customize a product's unique identifier, which can include hyphens, based on the merchant's preference (for example, Style-Color-Size). |
| image_link | ImageURL | No | Yes | String | 300 |
The image URLs for a product. The recommended image size is 50 kb. Important: URLs can't contain spaces. URL encode them, replacing spaces with either a plus (+) sign or %20. |
| item_group_id | VariantGroupID | Yes | Required | Number | 256 | The identifier to group products together (for example, Variant Master i.d.). |
| link | ProductURL | No | Yes | String | 300 | The URL of the product details. |
| price | ListPrice | Yes | Required | Number | Decimal(10,2) | The list price of a product. |
| product_type | MerchantCategory | No | Yes | String | 16,000,000 | A pipe-separated list of category names that this product belongs to. |
| sale_price | SalesPrice | No | Yes | Number | Decimal(10,2) | The sale price of a product. |
| size | Size | No | Yes | Number | 128 | The size of a product, if applicable. |
| title | ProductTitle | Yes | No | String | 256 | The product title. The max field size is 256 characters. |
| AdditionalCharges | AdditionalCharges | No | No | Number | 16,000,000 | The additional charges of a product. |
| age_group | AgeGroup | No | No | String | 20 | The age group of a product. |
| agerangehigh | N/A | No | No | String | Integer | The higher end of the age range. |
| agerangelow | N/A | No | No | String | Integer | The lower end of the age range. |
| availability | Availability | No | No | String | 20 | The availability of the product. |
| AvailabilityEndTime | AvailabilityEndTime | No | No | String | TimeStamp | The availability start date of the product in ISO format (for example, YYYY-MM-DDTHH:MM:SSZ). |
| AvailabilityStartTime | AvailabilityStartTime | No | No | String | TimeStamp | The availability end date of the product in ISO format (for example, YYYY-MM-DDTHH:MM:SSZ). |
| brand | Brand | No | No | String | 128 | The brand of the product. |
| bundle | N/A | No | No | String | 45 | The bundle product. |
| CasePackID | CasePackID | No | No | Number | 128 | The case pack ID. |
| CasePackQuantity | CasePackQuantity | No | No | Number | Integer | The number of items in a case pack. |
| categoryfeaturedcolor | CategoryFeaturedColor | No | No | String | 512 | The category featured color of the products. |
| categorysortorder | CategorySortOrder | No | No | String | 1024 | The pipe-separated values for the sort position of a product within a category. |
| colorswatchurl | ColorSwatchUrl | No | No | String | 384 | The image link for color swatches. |
| condition | ProductCondition | No | No | String | 12 | The condition of the product. |
| CostPrice | CostPrice | No | No | Number | Decimal(10,2) | The cost of one case pack |
| CurrencyCode | CurrencyCode | No | No | String | 3 | The currency code of the product. |
| CustomDateTime0 - CustomDateTime1 | CustomDateTime0 - CustomDateTime1 | No | No | String | TimeStamp | A custom target field for date and time. |
| CustomDecimal0 - CustomDecimal1 | CustomDecimal0 - CustomDecimal1 | No | No | Number | Decimal(10,2) | A custom target field for decimal values. |
| CustomInt0 - CustomInt1 | CustomInt0 - CustomInt1 | No | No | Number | Integer | A custom target field for integers. |
| CustomString0 - CustomString12 | CustomString0 - CustomString12 | No | No | String | 65,535 | A custom target field for string values. |
| CustomText0 - CustomText9 | CustomText0 - CustomText9 | No | No | String | 1024 | A custom target field for text (for example, banner text, banner image URL). |
| gender | Gender | No | No | String | 20 | The gender of the product. |
| google_product_category | GoogleCategory | No | No | String | 512 | The Google product category. |
| gtin | GTIN | No | Yes | Number | 128 |
The barcode ID of a product. Required for scanning products offline. |
| internalproductid | N/A | No | No | String | 128 | The internal product ID. |
| IsOnRaffle | IsOnRaffle | No | No | Boolean | True/False | Is the product on the raffle? |
| IsOnSale | IsOnSale | No | No | Boolean |
True/False |
When the sale price of an item is lower than the listed price, the "isOnSale" is set to "True" at the product level. The promo engine primarily uses this feature, allowing promotions based on the value of "isOnSale". |
| item_sub_group_id | SubVariantGroupID | No | No | String | 256 | The product subgroup ID includes the subVariantID, which incorporates the size and color of a product. This is not to be confused with item_group_id, which includes the variantID and incorporates only the style of the product. Since the item_sub_group_id determines groupings of products based on size and color, having generic values (for example, socks, shirt, etc.) can cause inconsistent product filtering. |
| language | language | No | No | String | 2 | The language of the product. |
| manufacturer | Manufacturer | No | No | String | 128 | The manufacturer of the product. |
| manufacturerdetails | ManufacturerDetails | No | No | String | 16,000,000 | The manufacturer details of the product. |
| manufacturerlocation | ManufacturerLocation | No | No | String | 256 | The manufacturer's location of the product. |
| material | N/A | No | No | String | 512 | The material of the product. |
| MaxQuantity | MaxQuantity | No | No | Number | Integer | The max quantity of the product. |
| merchantsku | N/A | No | No | String | 256 | The merchant SKU of the product. |
| mpn | MPN | No | No | String | 128 | The manufacturer part number (MPN). |
| MultipleGTINs | MultipleGTINs | No | No | String | 16,000,000 | Additional GTINs of the product. |
| NegativeInventoryNotAllowedFor | NegativeInventoryNotAllowedFor | No | No | String | 16,000,000 | Pipe-separated fulfillment subtypes that are not allowed to have negative inventory. For example, "DEFAULT|PICKUP_LATER|BOPIS" |
| onlineinventory | OnlineInventory | No | No | Number | Integer | The current online inventory. |
| processingtime | N/A | No | No | Number | 32 | The processing time. |
| ProductClass | ProductClass | No | No | String | 48 |
The class of products. For example, GiftCard products aren't discountable. Merchandise: Regular products, which are taxable and discountable. |
| productlocation | ProductLocation | No | No | String | 3 | The product location. |
| promotion_effective_date (deprecated) | PromotionStart | No | No | String | TimeStamp | The effective date of the product promotion. |
| promotion_price (deprecated) | PromotionPrice | No | No | Number | Decimal(10,2) | The promotion price. |
| promotion_title | PromotionTitle | No | No | String | 256 | The promotion text to be displayed with the product. |
| promotionid | N/A | No | No | String | 128 | The promotion ID. |
| ReviewFormType | ReviewFormType | No | No | String | 256 | The type of review form. |
| sale_price_effective_date | SalePriceStart | No | No | String | TimeStamp | The start date of the sale price. |
| searchimageurl | SearchImageURL | No | No | String | 512 | The image URL for the product list page. The recommended image size is 20 kb. |
| SerialNumberEntryType | SerialNumberEntryType | No | No | String | The serial number entry type. | |
| SerialNumberRequired | SerialNumberRequired | No | No | Boolean | True/False | For high-value items, if a serial number is required during the sale and return. |
| shipping | N/A | No | No | String | 128 | The shipping methods. |
| shipping_weight | N/A | No | No | Number | 64 | The shipping weight. |
| sizeguideurl | SizeGuideURL | No | No | String | 256 | The image URL for the size guide. |
| timezone_id | TimeZoneID | No | No | String | 3 | The timezone ID. |
- Product Feed Known Issues and Restrictions
Understand product feeds limitations within Point of Sale CMS and how to work around them. - Troubleshooting Product Feeds
Understand and solve issues that can occur when working with Product Feeds in Retail Cloud.