Opti-X - Prepare your Data Ecommerce Inventory

💡Note that these fields need to map accordingly with the real time events . For more information [click here]

Summary

OptiX data is designed to support three hierarchical levels, in order: product, variant and sku.

Clients may not have variant or sku level information, therefore see explanation to fill this out.

Use the RAW_DATA field to supply additional data which does not fit the schema. These fields are used to filter and output additional fields in the placement responses.

The 'Explanation' and Opti-X Impact' columns describes the implications of missing data.

Fields	Mandatory	Type	Example	Explanation	Opti-X Impact
SKU_ID	No	String	RippedJeans1934256-Blue-W28H30	Unique ID representing the lowest level of a product. If not applicable, set this to value of VARIANT_ID.	Used in recommendation logic, clients may want to configure showing items at a SKU level.
VARIANT_ID	No	String	RippedJeans1934256-Blue	Unique ID representing the variant of a product. If not applicable, set this to value of PRODUCT_ID.	Used in recommendation logic, clients may want to configure showing items at a Variant level. Placement Recommendation response output.
PRODUCT_ID	Yes	String	RippedJeans1934256	Unique ID representing the product.	Foundational to base personalised recommendations with. Placement Recommendation response output.
ITEM_NAME	Yes	String	Ripped Jeans	Name of the product.	Placement Recommendation response output. E-commerce Rules (Filtering recommendations within a placement)
ITEM_DESCRIPTION	No	String	100% Soft Denim Fabric!	Description of the item	Placement Recommendation response output.
SKU_NAME	No	String	Blue Ripped Jeans, W28 H30	Name of the SKU	Placement Recommendation response output.
VARIANT_NAME	No	String	Blue Ripped Jeans	Name of the variant	Placement Recommendation response output.
CATEGORYID	Yes	String	050102	Unique ID representing the category of the product.	Placement Recommendation response output.
CATEGORY	Yes	String	Jeans	Name of the category.	Placement Recommendation response output. E-commerce Rules (Filtering recommendations within a placement)
DEPARTMENTID	Yes	String	05	Unique ID representing the department.	Placement Recommendation response output.
DEPARTMENT	Yes	String	Clothing	Unique ID representing the department name, highest level of category	Placement Recommendation response output. E-commerce Rules (Filtering recommendations within a placement)
CATEGORY_LIST	Yes	String	Clothing > Trousers > Jeans	Order of category name where the highest is the department and lowest is the category. Please use '>' delimiter.	Placement Recommndation Ecomm Rules logic to identify categories of parent categories.
CATEGORY_KEY_LIST	Yes	String	05 > 0501 > 050102	Order of category key where the highest is the department and lowest is the category. Please use '>' delimiter.	Placement Recommndation Ecomm Rules logic to identify categories of parent categories.
BRAND	Yes	String	Example Brand	Brand	Placement Recommendation response output. E-commerce Rules (Filtering recommendations within a placement)
CURRENCY	No, if only one currency.	String	USD	Currency	Currency of prices.
PRICE	No (Recommended, see impact)	Number	40	Standard price before sale	E-commerce Rules (Filtering recommendations within a placement). Price related smart-campaign use-cases
SIZE	No	String	W28 H30	Size. Not always applicable.	Placement Recommendation response output. E-commerce Rules (Filtering recommendations within a placement)
COLOUR	No	String	Blue	Colour. Not always applicable.	Placement Recommendation response output. E-commerce Rules (Filtering recommendations within a placement)
STOCK	No (Recommended, see impact)	Number	826	Current Stock	E-commerce Rules (Filtering recommendations within a placement). Stock related use-cases.
RELEASE_DATE	No (Recommended, see impact)	String	2024-10-15	When the product was released/shown on the e-commerce site.	Required for Model/Methods and smart campaign use cases related to the release date, e.g. showing new items.
LAST_UPDATED	No	String	2024-10-16 08:02:30	When this item was last updated.	Sanity checking internal mapping and tracking changes.
FEATURES	No	String	Jeans, Ripped, Blue, Baggy	Features of the item.	Placement Recommendation response output. It may be relevant for training new models/methods.
DISPLAY_STATUS	No	Boolean	TRUE	Whether the item is displayed. Default set to TRUE if customer is not providing data.	E-commerce Rules (Filtering recommendations within a placement)
DISCONTINUE_DATE	No	String	2024-10-20	Date of discontinued item.	Sanity checking internal mapping and tracking changes.
ISDISCONTINUED	No	Boolean	FALSE	Whether the item is discontinued. Default set to FALSE if customer is not providing data.	E-commerce Rules (Filtering recommendations within a placement)
ISAVAILABLE	No	Boolean	TRUE	Hard Boolean representing if the item should still be displayed in recommendations. Default set to TRUE if customer is not providing data.	If the item in inventory is always expected to return in recommendations.
RAW_DATA	No	List of dictionaries/json	In the format of: [ {'attribute_key': Value1, 'attribute_value': Value2, 'level': product\|variant\|sku, 'type': text\|numeric\|boolean} ] Example: [{'attribute_key': is_sale, 'attribute_value': TRUE, 'level': sku, 'type':boolean}, {'attribute_key': type, 'attribute_value': store_only, 'level': product, 'type':text}]	List of JSON containing additional data. Value1 e.g. is_mini Value2 e.g. 1 level e.g. either product\|variant\|sku type: text\|numeric\|boolean	Extra data used to prefilter and output in a Placement Recommendation Response.
PRODUCT_URL	No (Recommended, see impact)	String	https://www.example.com/products/afjoi239	Useful for Image Based Models	Response field of recommend, smart search and smart campaigns.
PRODUCT_IMAGE	No (Recommended, see impact)	String	https://www.example.com/products/afjoi239.png	E-commerce Rules (Filtering recommendations within a placement) Recommended for Smart Banner use-cases	Response field of recommend, smart search and smart campaigns.
VIDEO_URL	No	String	https://www.example.com/products/afjoi239.mov	Can be useful in other use-cases. Possibly smart banner addition.
RATING	No	Number	3	Numeric value, no range specified.	Determined by the client.