Page tree
Skip to end of metadata
Go to start of metadata

Interaction Studio supports ingesting of products into the catalog. Products may be updated by sending updated products with the same product ID. Products may be added by sending new products with a new product ID. This means that if you include a product with an ID that is not currently in the catalog, the product will be added to the catalog by the feed. Products are configured on the Catalog and Profile Objects Setup screen where you can assign related catalog objects and define custom attributes on the product data type. Existing system fields pertaining to products include, but are not limited to:

  • Name - the name of the product
  • URL - the qualified product url on the website
  • Price - the current offer price of the item

All system fields are declared in the table below.

This Article Explains

This article details the requirements and schema of the product ETL and provides a sample file structure and download.

Sections in this Article

Requirements and Schema

  • Each product should appear only once in a single record in any given file. If your file has multiple records with the same product ID, the last valid record in the file will be loaded into Interaction Studio.
  • If a column is included in the file, all records in the file should have a value for that column (not just the records whose values have changed). Interaction Studio will overwrite existing values for any changed product records, including those that have blank values.
  • Location is a special type of catalog attribute available to products. To help denote where a product may be located, information such as geographic point (latitude and longitude), country code, city, and state can be stored as system attributes. Location fields are not required and only latitude and longitude are codependent. Any other combination of defined location fields are acceptable.


File Format

File Name Format: product-YYYY-MM-DD_HH-MM-SS.csv

Requirements and Schema

See the Sample File section below for further clarification.

Field Name

Minimum Requirements

Example Values

Max Length

Interaction Studio Data Type

idRequired. Product IDs must exactly match the product IDs provided on site and captured by Interaction Studio site mapping. Examples of unacceptable identifiers include: product name, product ID in a different format, and an inventory ID that is not used by Interaction Studio for on site tracking. These are also the parent identifiers of SKUs in the feed. IDs are only expected once per feed. When multiples of the same product IDs are encountered in the same feed, only the contents of the last row will be written to the Interaction Studio catalog.prod1237723255String
attribute:The custom attributes for the product. Column titles are the word 'attribute', followed by a colon, followed by the attribute name as configured in the Attributes section of the Catalog and Profile Objects > Product screen. Attributes are parsed as the data type they are defined as in Attributes.

attribute:fit, attribute:length

loose, long

1023any
relatedCatalogObject:

Additional relatedCatalogObjects such as brand and color may be defined and imported with matching column names. Each relatedCatalogObject name must match a catalog object type configured on the Interaction Studio Catalog and Profile objects screen. Column titles are the word 'relatedCatalogObject', followed by a colon, followed by the catalog object type name. A product can have multiple related catalog objects in separate columns and/or multiple values for the same related catalog object, separated by the pipe character. A literal pipe in one of the values is represented as two pipe characters in the feed.

Related Catalog Objects & Dimensions

For customers leveraging a product ETL configured prior to 9/7/2021 that uses "dimension:" instead of the new "relatedCatalogObject:" column header, this ETL configuration will continue to function as is. The "dimension:" column header will update the Related Catalog Object fields on the product. No changes to the ETL file are required. It is recommended that any new file leverage the updated nomenclature.

relatedCatalogObject:Color

relatedCatalogObject:Material Blue|Yellow, Leather

255String
categoriesMultiple categories may be defined using pipe delimitingHome|Bedroom|Bathroom255String
skusThe set of SKUs for this product, separated by the pipe character. A literal pipe in one of the values is represented as two pipe characters in the feed. SKUs are case-sensitive. This is typically used when all SKUs share the same product information.sku104272|sku32342|sku33388255String
System Fields



attribute:nameRepresents the name of a product and must contain at least one alphanumeric character.Slick New Kicks1023String
attribute:urlRFC-3986 Complete URLs that represent the canonical product display page for this product.https://example.com/products/prod1.html1023String
attribute:imageUrlFully-qualified URL for an image of this item.https://example.com/img/img1.png1023String
attribute:descriptionRepresents the description of the product and must contain at least one alphanumeric character.Some excellent new shoes250String
attribute:promotable

Boolean (defaults to true) - when false, the item won't be returned by the Einstein Recipes recommendation system.

Note: if no value is set, this field defaults to true.

TRUE1023Boolean
attribute:priceThe current offer price of this product to promote to users. Period as the decimal separator, no thousands separator.20.111023Decimal/Float
attribute:listPriceA list price or MSRP to illustrate the savings when compared with the price. Period as the decimal separator, no thousands separator.30.31023Decimal/Float
attribute:priceDescriptionDescriptive text for the price.On sale this week only1023String
attribute:marginThe profit margin of the item. Sale price - current cost of goods. Period as the decimal separator, no thousands separator.

2.45

1000.67

1023String
attribute:inventoryCount

InventoryCount: A count of product inventory. 0 count is considered out-of-stock and not promotable in product recommendations. 

Note: If this value is omitted, the field defaults to in-stock (1).

301023Integer
attribute:publishedISO 8601 Date time string for product published date.2017-04-22T10:23:37Z1023Date
attribute:expirationISO 8601 Date time string for product expiration date.2017-04-22T10:23:37Z1023Date
attribute:currencyISO 4217 formatted Currency code. 3 Uppercase letters.USD, AUD, EUR3String
attribute:ratingThe rating value associated with a product, no specific scale required, however only the value should be provided. 9/10 is invalid, while 9 is.4.51023Decimal/Float
attribute:numRatingsThe number of ratings associated with a product.51023Integer
location:latitudeRequired if latitude - The exact latitudinal value of the product. -73.9847021023Decimal/Float
location:longitudeRequired if longitude - The exact longitudinal value of the product.40.7546211023Decimal/Float
location:cityString value reflecting the name of the city/town/village/etc where the product is located.New York1023String
location:state

The state or region where the product is located. If inside the United States then it is recommended that you use a two-character postal code abbreviation (i.e. "MA" for Massachusetts).

NY2String
location:countryCodeAn ISO 3166 alpha-2 representation of the country in which the product resides.US2String
location:postalCodeA string-based representation of the postal code where the product is available.100361023String
attribute:archivedBoolean, which defaults to false when no value is set. When true, the item will not be visible in the catalog. If this column is omitted from the feed file, no changes will be made to the archived attribute.FALSE, false, TRUE, true1023Boolean

  

Sample File

Sample File Download


id

attribute:name

attribute:archived

attribute:url

attribute:imageUrl

attribute:price

attribute:listPrice

attribute:inventoryCount

attribute:description

attribute:currency

attribute:formattedPrice

relatedCatalogObject:SaleStatus

relatedCatalogObject:Gender

categories

skus

location:latitudelocation:longitudelocation:citylocation:state
prod001GlassesFALSEhttp://www.sample.com/products/product001http://www.sample.com/image/product001.jpg100.12100.121Glasses made to block blinding lightUSDNow $100.12OnSaleMenClothing|Outerwearsku1000|sku1001|sku100247.97522113.62209

prod002JacketFALSEhttp://www.sample.com/products/product002http://www.sample.com/image/product002.jpg54.63591A black leather jacketUSD
OnSaleMen|Women|UnisexClothing|Outerwear|Leather
29.0512331.20870

prod003ShirtFALSEhttp://www.sample.com/products/product003http://www.sample.com/image/product003.jpg10
1A blue polo shirtAUDNow $10
UnisexClothing|Shirtsku2000|sku2002|sku2004-14.6332114.32845

prod003ShortsFALSEhttp://www.sample.com/products/product004http://www.sample.com/image/product004.jpg33601Beige khaki shortsEURNow €33OnSaleMenClothing|Pants|Shortssku300|sku301|sku302|sku399-19.63486142.05087

prod004PantsFALSEhttp://www.sample.com/products/product005http://www.sample.com/image/product005.jpg99.981200Blue jeansUSDNow $99.98ClosingSaleMenClothing|Pantssku401|sku403|sku411

SeattleWA
prod005ShoesFALSEhttp://www.sample.com/products/product006http://www.sample.com/image/product006.jpg54.6396.850Brown leather shoesCADNow $54.63OnSaleWomenShoes|Clothing|Leathersku500

San FranciscoCA
prod006HatFALSEhttp://www.sample.com/products/product007http://www.sample.com/image/product007.jpg32.5049.99
Adjustable baseball capDKKNow 32.50Kr.OnSaleKidsClothing|Accessoriessku610|sku620|sku630


TX
prod007WatchFALSEhttp://www.sample.com/products/product008http://www.sample.com/image/product008.jpg10.5510.551Luxury watchKRWNow ₩10.55NotOnSaleWomenAccessories


Charlotte