Product Catalog Attribute List
- 08 May 2024
- 3 Minutes to read
Product Catalog Attribute List
- Updated on 08 May 2024
- 3 Minutes to read
Article Summary
Share feedback
Thanks for sharing your feedback!
After collecting the set of product attributes to construct your product catalog in Insider's Product Feed Database, to validate the received data, Insider uses default and custom product attribute definitions to unify the baseline of product data which will be enough to process and generate recommendations.
In this case, Insider defines default attributes that are recognized by its product feed, and they can be ingested directly if they have the correct field names (attribute's name such as color or brand) and value types (string, number, array, etc.) The custom attributes are the ones that you create on the Product Attributes page on Insider's InOne panel.
The default attributes can be mandatory or optional. To recognize a product and construct the bare minimum information on Insider's product feed database, it needs the mandatory attributes. Optional attributes are often partner-specific and the availability of those attributes depends on your business.
You can see the Product Feed default attributes based on your feed management type in the tables below:
You can also see the details regarding:
Your title goes here
If you cannot see a product attribute mentioned below tables but in the Product Attribute Information table, it means those unmentioned fields are still applicable but not required.
Your title goes here
The category field is required for Substitute, Complementary, Most Popular Items of the Category, Top Sellers of the Category, and Most Valuable Products of the Category algorithms.
Your title goes here
If you want to use an attribute as a filter, it is mandatory to send it. Otherwise, campaigns provide fallback results.
Stock-Revenue Based Feed
Stock-Revenue based feed is for you if you have products with stock and price information on your website.
- Most suitable industries: Ecommerce
- Requirement fields:
| Attribute | Required |
|---|---|
| item_id | Yes |
| locale | Yes |
| name | Yes |
| url | Yes |
| image_url | Yes |
| in_stock | Yes |
| price | Yes |
| original_price | Yes |
| discount | No |
| category | No |
Your title goes here
The category field is required for Substitute, Complementary, Most Popular Items of the Category, Top Sellers of the Category, and Most Valuable Products of the Category algorithms if you want to use it as a filter. Otherwise, campaigns provide fallback results.
Availability Based Feed
Availability Based Feed is for you if you have product stock (availability) information on your website.
- Most suitable industries: Content, Automotive, Online Travel Agency (OTA)
- Requirement fields:
| Attribute | Required |
|---|---|
| item_id | Yes |
| locale | Yes |
| name | Yes |
| url | Yes |
| image_url | Yes |
| in_stock | Yes |
| price | No |
| original_price | No |
| discount | No |
| category | No |
Published Time Based Feed
Published Time-Based Feed is for you if have products mostly in article form, and if the product’s published time is one of the important attributes to you since you care about showing updated articles in your Smart Recommender widget.
- Most suitable industries: Media & Publisher
- Requirement fields:
| Attribute | Required |
|---|---|
| item_id | Yes |
| locale | Yes |
| name | Yes |
| image_url | Yes |
| url | Yes |
| item_update_date | Yes |
| category | No |
Start-End Time-Based Feed
Start-End Time-Based Feed is for you if you have products that are available at certain times on your website. The start and end time of the product is important to recommend up-to-date products and/or events.
- Most suitable industries: Entertainment & Ticketing
- Requirement fields:
| Attribute | Required |
|---|---|
| item_id | Yes |
| locale | Yes |
| name | Yes |
| image_url | Yes |
| url | Yes |
| item_start_date | Yes |
| item_end_date | Yes |
| category | No |
Product Attribute Information
| Parameters | Object Type | Description | Example |
|---|---|---|---|
| item_id | String | Unique item id | "item_id": "3110" |
| locale | String | Unique locale identifier | "locale": "tr_TR" |
| name | String | Item name | "name": "Daria Bikram Pant" |
| url | String | Url of the product | "url":"https://posh.useinsider.com/daria-bikram-pant.html" |
| image_url | String | Must start with “http” or “https” | "image_url":"https://posh.useinsider.com /pub/media/catalog/product/cache /e4d64343b1bc593f1c5348fe05efa4a6 /w/p/wp10-gray_main.jpg" |
| category | Array[String] | Represents the product category and it consists of an array of strings. | "category": ["Electronic","Electrical appliances","Toast Machine"] |
| description | String | “description”: “Porter Unisex Shoes” | |
| price | Object | String key and any type of value. | "price": {"USD": 599.9} |
| original_price | Object | String key and any type of value. | "original_price": {"USD": 699.9} |
| discount | Object | String key and any type of value. | “discount”: { “USD” : 100.0} |
| in_stock | Number | It only takes binary values. | "in_stock": 0 |
| item_update_date | String | It takes date time (YYYY-MM-DD HH:MM:SS). You can use it if you are a publisher to filter the last 2 days of content. | 2020-08-07 12:25:09 |
| item_start_date | String | It takes date time (YYYY-MM-DD HH:MM:SS). It’s used for events websites to get the event start date. | 2020-08-07 12:25:09 |
| item_end_date | String | It takes date time (YYYY-MM-DD HH:MM:SS). It’s used for events websites to get the event start date. | 2020-08-07 12:25:09 |
| group_code | String | The field is used to group product variants. | |
| brand | String | "brand": "Posh Street" | |
| color | String | “color”: “Gray” | |
| size | Number | "size": 38 | |
| sku | String | It is the stock-keeping unit. | “sku”: “64654dsad” |
| gender | String | ||
| multipack | String | Specifies a multipack item. | |
| product_type | String | Specifies the product type information. | |
| gtin | String | It is the Global Trade Item Number. | “gtin” : “911571013579” |
| product_attributes | Object | String key and any type of value. Note: You should create the each attribute beforehand on Insider's InOne panel. | “product_attributes”: { “brand”: “Posh Street”, “subcategory”: “Bottoms”} |
Limitations
- For the required parameters, these inputs are invalid if they are 'undefined', 'unknown', 'null', or empty string.
- Each string field in the record can be as large as 512 characters.
- “item_id” field in the record can be as large as 32 characters.
- “locale” field in the record can be as large as 64 characters.
Was this article helpful?