After collecting the set of product attributes to construct your product catalog in Insider's Product Catalog Database, Insider validates the received data using default and custom product attribute definitions to unify the baseline of product data, which is sufficient to process and generate recommendations.
In this case, Insider defines default attributes that are recognized by its product feed. These can be ingested directly if they have the correct field names (such as the 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 One's InOne panel.
In this article, you will find answers to the questions below:
Default Product Attributes
The default product attributes are common attributes used in ecommerce, predefined by Insider for specific purposes. These attributes might vary based on the feed management type of your ecommerce site.
The default product attributes are not editable.
If a product attribute is not listed below but is mentioned in the Product Attribute Info section, it means those unlisted fields are still applicable but not required.
Default Attribute Set
Parameter | Object Type | Description | Character Limit | Requirement | Examples | Available Feed Management Type |
|---|---|---|---|---|---|---|
item_id | String | Unique item ID | 128 | Required | "item_id": "3110" | All |
name | String | Item name | 512 | Required | "name": "DK Pant" | All |
locale | String | Unique locale identifier | 64 | Required | "locale": "en_US" | All |
image_url | String | URL of the image. It must start with http:// or https:// | 512 | Required | "image_url": "https://posh.com | All |
url | String | URL of the product | 512 | Required | "URL": "https://posh.useinsider.com/dk-pant.html" | All |
in_stock | Number | It only takes binary values. | "0" or "1" | Required | "in_stock": 0 | Only in Stock-Revenue Based & Availability Based |
item_update_date | String | It takes date time (YYYY-MM-DD HH:MM:SS). It is used for publisher customers to filter the last two days of content. | 512 | Required | 2020-08-07 12:25:09 | Only in Published-Time Based |
item_start_date | String | It takes date time (YYYY-MM-DD HH:MM:SS). It is used for events websites to get the event start date. | 512 | Required | 2020-08-07 12:25:09 | Only in Start-End-Time Based |
item_end_date | String | It takes date time (YYYY-MM-DD HH:MM:SS). It’s used for events websites to get event end dates. | 512 | Required | 2020-08-07 12:25:09 | Only in Start-End-Time Based |
price | Number | String key and any type of value | N/A | Required → Stock Revenue Based Optional → Availability Based | "price": {"USD": 599.9} | All |
original_price | Number | String key and any type of value | N/A | Required → Stock Revenue Based Optional → Availability Based | "original_price": {"USD": 699.9} | All |
discount | Object | Discount is auto-calculated from the price and the original price as a percentage. | N/A | Optional | "discount": {"USD": 9.99} | All |
category | Array[String] | List of category names in a List of String model. | 1024 | Optional - Mandatory for algorithms that require category data | "category": ["Furniture","Sofa", "Chair"] | All |
group_code | String | The field is used to group product variants. | 512 | Optional | - | All |
sku | String | Stock-keeping unit | 512 | Optional | "sku": "123123" | All |
color | String | Color of the product | 512 | Optional | "color": "Gray" | All |
description | String | Description of the product | 1024 | Optional | "description": "Example description" | All |
brand | String | Brand of the product | 512 | Optional | "brand": "Posh Street" | All |
size | String | Size of the product | 512 | Optional | "size": "L" | All |
rating | Number | Rating of the product | 512 | Optional | "rating": "6" | All |
stock_count | Number | Stock count of the product | Min 1 , Max 10 | Optional | "stock_count": "1" | All |
product_type | String | Specifies the product type information | 512 | Optional | - | All |
gender | String | - | 512 | Optional | "gender": "male" | All |
omnibus_price | Number | - | N/A | Optional | "omnibus_price" : {"USD": 9.99} | All |
omnibus_discount | Number | - | N/A | Optional | "omnibus_discount" : {"USD": 9.99} | All |
gtin | String | Global Trade Item Number | 512 | Optional | "gtin": "911571013579" | All |
multipack | String | Specifies a multipack item | 512 | Optional | - | All |
tags | Array[String] | List of tags of the product in a List of String model. | 4096 | Optional | "tags" : ["Furniture","Sofa","Chair"] | All |
category_path | String | String version of the category | 1024 | Optional | "category_path": "["Furniture","Sofa","Chair"]" | All |
Limitations
For required parameters, inputs are invalid if they are 'undefined', 'unknown', 'null', or an empty string.
Each string field in the record can be up to 512 characters long.
The item_id field can be up to 32 characters.
The locale field can be up to 64 characters.
The description field can be up to 1024 characters.
The category field can also be up to 1024 characters.
The tags field can also be up to 4096 characters
The category_path field can also be up to 1024 characters
Custom Product Attributes
Custom product attributes refer to attributes that are not predefined as default attributes but are necessary for your business goals and data requirements. Unlike default attributes, custom attribute names are not reserved by Insider and can be defined according to your specific needs when creating them.
You should not create a new custom product attribute if there is already a default one.