Skip to main content
Skip table of contents

Commerce Product Catalog Feed Format for Emplifi Ratings & Reviews

Use the commerce product catalog format to add your list of products from one ore more regions into Emplifi. This section describes the fields that are relevant for Emplifi Ratings & Reviews. For Emplifi UGC only, see ​Commerce Product Catalog Feed Format for UGC.

Supported Data Fields

For us to accept your product list into Emplifi Ratings & Reviews, your file must adhere to these formatting requirements:

  • The feed should be a tab-delimited file.

  • The first row/line of the file must include at least the required headers.

  • For syndicating outside of Emplifi Ratings & Reviews, you must provide at least one of: MPN, UPC, or EAN.

Comma ( , ) and pipe ( | ) delimiters are supported, but not by default. If your feed must use a comma or pipe, see Using a Non-Default Delimiter.

Header

Required

Data Type

Example

Description

id

Yes

String

2001249433

A unique identifier for each product in your catalog. Usually this value can be the same as the product SKU. This is also the value you pass to the front end widget to retrieve content submitted by users for this product.

Prohibited Characters
Do not include the following characters in your SKU values: / # \ > < & = % ! . +

For more complex use cases, see Use a Variant ID or SKU.

title

Yes

String

"Floral Breeze Jumpsuit"

The name of the product.

item_url

Yes

String

https://www.example.com/products/floral-breeze-jumpsuit/EX123456.html

The URL to the product on your site. We support both relative and absolute link URLs.

image_url

Yes

String

https://www.example.com/products/floral-breeze-jumpsuit/EX123456.html

An accessible URL for the product photo. We support jpg, jpeg and png file extensions.

stock

No

Integer

50

The amount of the product in your inventory.
For products you still sell but which are out of stock, set the value to 0.

Use the active column to set whether a product is active or inactive.

active

No

Boolean

1

Determines if the product is active on your site. Boolean value (1 or 0, Y or N). Defaults to 1, which means the listing is active. Inactive products do not appear within the Emplifi platform.

category_path_json

No

JSON

Categories in the Catalog Feed (see Category trees (category path JSON)

A hierarchical category structure represented as JSON.

virtual_parent_code

No

String

051575

An arbitrary string used to group products. For example, if your catalog has a row for each color variant of an item, those variants can be grouped in Emplifi R&R as similar items by setting this column to the same value for all of them. To learn more, see Virtual Parent Code (VPC) and Members.

members

No

String

191677156707,12399

Used for products that represent a bundle, meaning this product has other products in the catalog it consists of. To learn more, see Virtual Parent Code (VPC) and Members.

brand

No

String

"Emplifi Style"

If your catalog consists of multiple product brands, specify the brand name of the product here.

currency

No

String

USD

The currency the product is being sold in this store.

price

No

Decimal

49.99

The current price of the product

upc

No

Integer

194276354742

A unique, 12-digit identifier for commercial products that's usually associated with a barcode printed on retail merchandise. Used mainly in North America.

ean

No

Integer

4006381333931

A unique numerical identifier for commercial products that's usually associated with a barcode printed on retail merchandise.

Used mainly outside of North America.

mpn

No

String

ABC12345

The string that uniquely identifies the product to its manufacturer. If used together with brand, this field uniquely identifies the product across the entire catalog.

regional_data

No

JSON

Regional Data in the Commerce Product Catalog

Regional Data in the Commerce Product Catalog

Example Commerce Product Catalog File for Emplifi Ratings & Reviews

The following example demonstrates how your file should be formatted so it can be uploaded to Emplifi Ratings & Reviews.

CODE 
id	title	item_url	image_url	stock	active	category_path_json	virtual_parent_code	members	brand	currency	price	upc	ean	mpn	regional_data
2001249433	Floral Breeze Jumpsuit	https://www.example.com/products/floral-breeze-jumpsuit/EX123456.html	https://www.example.com/products/floral-breeze-jumpsuit/EX123456.jpg	50	1	[{"id":"10","name":"Seasonal"},{"id":"20","name":"Summer Wears"},{"id":"30","name":"Rompers"}]	51575		"Emplifi Style"	USD	49.99	194276354742	4006381333931	ABC12345	"{""fr_CA"":{""title"":""Combinaison Brise Florale"",""item_url"": ""https://www.example.com/ca/products/combinaison-brise-florale/EX123456.html"",""image_url"": ""https://www.example.com/ca/products/combinaison-brise-florale/EX123456.jpg"",""stock"": 12,""currency"": ""CAD"",""price"": 45.00},""en_GB"":{""title"": ""Floral Breeze Jumpsuit"",""item_url"": ""https://www.example.com/uk/products/floral-breeze-jumpsuit/EX123456.html"",""image_url"": ""https://www.example.com/uk/products/floral-breeze-jumpsuit/EX123456.jpg"",""stock"": 25,""currency"": ""GBP"",""price"": 40.00}}"
2001249434	Sea Breeze Jumpsuit	https://www.example.com/products/sea-breeze-jumpsuit/EX123456.html	https://www.example.com/products/sea-breeze-jumpsuit/EX123456.jpg	50	1	[{"id":"10","name":"Seasonal"},{"id":"20","name":"Summer Wears"},{"id":"30","name":"Rompers"}]	51575		"Emplifi Style"	USD	49.99	194276344743	4006381333932	ABC12346	"{""fr_CA"":{""title"":""Combinaison Brise Marine"",""item_url"": ""https://www.example.com/ca/products/combinaison-brise-marine/EX123456.html"",""image_url"": ""https://www.example.com/ca/products/combinaison-brise-marine/EX123456.jpg"",""stock"": 12,""currency"": ""CAD"",""price"": 45.00},""en_GB"":{""title"": ""Sea Breeze Jumpsuit"",""item_url"": ""https://www.example.com/uk/products/sea-breeze-jumpsuit/EX123456.html"",""image_url"": ""https://www.example.com/uk/products/sea-breeze-jumpsuit/EX123456.jpg"",""stock"": 25,""currency"": ""GBP"",""price"": 40.00}}"
2001249435	Duo Breeze Jumpsuit Pack	https://www.example.com/products/duo-breeze-jumpsuit-pack/EX123456.html	https://www.example.com/products/duo-breeze-jumpsuit-pack/EX123456.jpg	50	1	[{"id":"10","name":"Seasonal"},{"id":"20","name":"Summer Wears"},{"id":"30","name":"Rompers"},{"id":"40", "name":"Bundles"}]	51575	2001249433, 2001249434	"Emplifi Style"	USD	89.99	194276344745	4006381333939	ABC12347	"{""fr_CA"":{""title"":""Pack de salopettes Duo Breeze"",""item_url"": ""https://www.example.com/ca/products/pack-de-salopettes-duo-breeze/EX123456.html"",""image_url"": ""https://www.example.com/ca/products/pack-de-salopettes-duo-breeze//EX123456.jpg"",""stock"": 12,""currency"": ""CAD"",""price"": 82.99},""en_GB"":{""title"": ""Duo Breeze Jumpsuit Pack"",""item_url"": ""https://www.example.com/uk/products/sea-breeze-jumpsuit/EX123456.html"",""image_url"": ""https://www.example.com/uk/products/duo-breeze-jumpsuit-pack/EX123456.jpg"",""stock"": 25,""currency"": ""GBP"",""price"": 75.99}}"

Sample File:
commerce-feed-ratings-and-reviews.tsv

Commerce Product Catalog Format for Emplifi Ratings & Reviews and Emplifi UGC

Use the commerce product catalog format to add your list of products from one ore more regions into Emplifi. This section describes the fields that are relevant for both Emplifi Ratings & Reviews and Emplifi UGC. For Emplifi UGC only, see ​Commerce Product Catalog Feed Format for UGC.

Supported Data Fields

For us to accept your product list into Emplifi UGC and Emplifi Ratings & Reviews, your file must adhere to these formatting requirements:

  • The feed should be a tab-delimited file.

  • The first row/line of the file must include at least the required headers.

  • For syndicating outside of Emplifi Ratings & Reviews, you must provide at least one of: MPN, UPC, or EAN.

Comma ( , ) and pipe ( | ) delimiters are supported, but not by default. If your feed must use a comma or pipe, see Using a Non-Default Delimiter.

Header

Required

Data Type

Example

Description

Used by

id

Yes

String

2001249433

A unique identifier for each product in your catalog. Usually this value can be the same as the product SKU. This is also the value you pass to the front end widget to retrieve content submitted by users for this product.

Prohibited Characters
Do not include the following characters in your SKU values: / # \ > < & = % ! . +

UGC

R&R

title

Yes

String

"Floral Breeze Jumpsuit"

The name of the product.

UGC

R&R

item_url

Yes

String

https://www.example.com/products/floral-breeze-jumpsuit/EX123456.html

The URL to the product on your site. We support both relative and absolute link URLs.

UGC

R&R

image_url

Yes

String

https://www.example.com/products/floral-breeze-jumpsuit/EX123456.html

An accessible URL for the product photo. We support jpg, jpeg and png file extensions.

UGC

R&R

ugc_id

No

String

10047048

Specifies a different product identifier on UGC from R&R.

UGC

additional_photos

No

JSON array of strings

["https://images.example.com/is/image/Example/EX56789_001","https://images.example.com/is/image/Example/EX56789_002"]

If you want to send more than one photo per product you can use this field. All images sent here will be available in the UI during UGC product tagging.

UGC

description

No

String

"Now you can capture retro summer vibes in this off-the-shoulder, wide-leg jumpsuit adorned with vibrant floral patterns."

Additional description about the product besides the product title that can be displayed on the Lightbox.

UGC

stock

No

Integer

50

The amount of the product in your inventory.
For products you still sell but which are out of stock, set the value to 0.

Use the active column to set whether a product is active or inactive.

UGC

R&R

active

No

Boolean

1

Determines if the product is active on your site. Boolean value (1 or 0, Y or N). Defaults to 1, which means the listing is active. Inactive products do not appear within the Emplifi platform.

UGC

R&R

tags

No

JSON array of strings

["Seasonal", "Summer Wears", "Rompers"]

A collection of tags describing the product. This could be category information or generic product attributes. If category_path_json is also included in the feed, tags and categories are evaluated against each other and flattened into unique tags.

UGC

category_path_json

No

JSON

Categories in the Catalog Feed (see Category trees (category path JSON)

A hierarchical category structure represented as JSON. Emplifi UGC automatically flattens all categories into unique tags.

UGC

R&R

virtual_parent_code

No

String

051575

An arbitrary string used to group products. For example, if your catalog has a row for each color variant of an item, those variants can be grouped in Emplifi R&R as similar items by setting this column to the same value for all of them. To learn more, see Virtual Parent Code (VPC) and Members.

R&R

members

No

String

191677156707,12399

Used for products that represent a bundle, meaning this product has other products in the catalog it consists of. To learn more, see Virtual Parent Code (VPC) and Members.

R&R

brand

No

String

"Emplifi Style"

If your catalog consists of multiple product brands, specify the brand name of the product here.

R&R

currency

No

String

USD

The currency in which the product is sold in this store.

UGC

R&R

price

No

Decimal

49.99

The current price of the product.

UGC

R&R

call_to_action

No

String

"BUY NOW"

The text that appears in the CTA button of the Lightbox.

UGC

sales_price

No

Decimal

34.99

The discounted price of the product for a specific sales date range (specified in sales_start_date) to sales_end_date fields documented below).

UGC

sales_start_date

No

Date

2024-09-01

Format can be any of the following:

  • "yyyy-MM-dd'T'HH:mm:ssZ"

  • "yyyy-MM-dd HH:mm:ss.000"

  • "yyyy-MM-dd"

UGC

sales_end_date

No (if a value is specified forsales_start_date, this field becomes required)

Date

2025-03-31

Format can be any of the following:

  • "yyyy-MM-dd'T'HH:mm:ssZ"

  • "yyyy-MM-dd HH:mm:ss.000"

  • "yyyy-MM-dd"

UGC

upc

No

Integer

0194276354742

A unique, 12-digit identifier for commercial products that's usually associated with a barcode printed on retail merchandise. Used mainly in North America.

R&R

ean

No

Integer

4006381333931

A unique numerical identifier for commercial products that's usually associated with a barcode printed on retail merchandise.

Used mainly outside of North America.

R&R

mpn

No

String

ABC12345

The string that uniquely identifies the product to its manufacturer. If used together with brand, this field uniquely identifies the product across the entire catalog.

R&R

regional_data

No

JSON

Regional Data in the Commerce Product Catalog

Regional Data in the Commerce Product Catalog

UGC

R&R

Example Commerce Product Catalog File for Emplifi Ratings & Reviews and Emplifi UGC

The following example demonstrates how your file should be formatted so it can be uploaded to both Emplifi Ratings & Reviews and Emplifi UGC.

CODE 
id	title	item_url	image_url	additional_photos	Description	stock	active	category_path_json	virtual_parent_code	members	brand	currency	price	call_to_action	sales_price	sales_start_date	sales_end_date	upc	ean	mpn	regional_data
2001249433	Floral Breeze Jumpsuit	https://www.example.com/products/floral-breeze-jumpsuit/EX123456.html	https://www.example.com/products/floral-breeze-jumpsuit/EX123456.jpg	"[""https://images.example.com/is/image/Example/EX56789_001"",""https://images.example.com/is/image/Example/EX56789_002""]"	"Now you can capture retro summer vibes in this off-the-shoulder, wide-leg jumpsuit adorned with vibrant floral patterns."	50	1	"[{""id"":""10"",""name"":""Seasonal""},{""id"":""20"",""name"":""Summer Wears""},{""id"":""30"",""name"":""Rompers""}]"	51575		Emplifi Style	USD	49.99	“BUY NOW”	34.99	2024-09-01	2025-3-31	194276354742	4006381333931	ABC12345	"{""fr_CA"":{""title"":""Combinaison Brise Florale"",""item_url"": ""https://www.example.com/ca/products/combinaison-brise-florale/EX123456.html"",""image_url"": ""https://www.example.com/ca/products/combinaison-brise-florale/EX123456.jpg"",""description"": ""Vous pouvez désormais capturer l'ambiance rétro de l'été avec cette combinaison à épaules dénudées et jambes larges, ornée de motifs floraux éclatants."",""buy_now_text"": ""Achetez maintenant"",""stock"": 12,""currency"": ""CAD"",""price"": 45.00},""en_GB"":{""title"": ""Floral Breeze Jumpsuit"",""item_url"": ""https://www.example.com/uk/products/floral-breeze-jumpsuit/EX123456.html"",""image_url"": ""https://www.example.com/uk/products/floral-breeze-jumpsuit/EX123456.jpg"",""stock"": 25,""currency"": ""GBP"",""price"": 40.00}}"
2001249434	Sea Breeze Jumpsuit	https://www.example.com/products/sea-breeze-jumpsuit/EX123456.html	https://www.example.com/products/sea-breeze-jumpsuit/EX123456.jpg	"[“https://images.example.com/is/image/Example/EX56789_003"",""https://images.example.com/is/image/Example/EX56789_004""]"	"Now you can capture retro summer vibes in this off-the-shoulder, wide-leg jumpsuit adorned with vibrant seaside patterns."	50	1	"[{""id"":""10"",""name"":""Seasonal""},{""id"":""20"",""name"":""Summer Wears""},{""id"":""30"",""name"":""Rompers""}]"	51575		Emplifi Style	USD	49.99	“BUY NOW”	34.99	2024-09-01	2025-3-31	194276344743	4006381333932	ABC12346	"{""fr_CA"":{""title"":""Combinaison Brise Marine"",""item_url"": ""https://www.example.com/ca/products/combinaison-brise-marine/EX123456.html"",""image_url"": ""https://www.example.com/ca/products/combinaison-brise-marine/EX123456.jpg"",""description"": ""Maintenant, vous pouvez capturer des vibes rétro estivales dans cette salopette à épaules dénudées et jambes larges, ornée de motifs maritimes vibrants."",""buy_now_text"": ""Achetez maintenant"",""stock"": 12,""currency"": ""CAD"",""price"": 45.00},""en_GB"":{""title"": ""Sea Breeze Jumpsuit"",""item_url"": ""https://www.example.com/uk/products/sea-breeze-jumpsuit/EX123456.html"",""image_url"": ""https://www.example.com/uk/products/sea-breeze-jumpsuit/EX123456.jpg"",""stock"": 25,""currency"": ""GBP"",""price"": 40.00}}"
2001249435	Duo Breeze Jumpsuit Pack	https://www.example.com/products/duo-breeze-jumpsuit-pack/EX123456.html	https://www.example.com/products/duo-breeze-jumpsuit-pack/EX123456.jpg	"[“https://images.example.com/is/image/Example/EX56789_005"",""https://images.example.com/is/image/Example/EX56789_006""]"	"Now you can capture retro summer vibes with these off-the-shoulder, wide-leg jumpsuits adorned with vibrant floral and seaside patterns."	50	1	"[{""id"":""10"",""name"":""Seasonal""},{""id"":""20"",""name"":""Summer Wears""},{""id"":""30"",""name"":""Rompers""},{""id"":""40"", ""name"":""Bundles""}]"	51575	2001249433, 2001249434	Emplifi Style	USD	89.99	“BUY NOW”				194276344745	4006381333939	ABC12347	"{""fr_CA"":{""title"":""Pack de salopettes Duo Breeze"",""item_url"": ""https://www.example.com/ca/products/pack-de-salopettes-duo-breeze/EX123456.html"",""image_url"": ""https://www.example.com/ca/products/pack-de-salopettes-duo-breeze//EX123456.jpg"",""description"": ""Maintenant, vous pouvez capturer des vibes rétro estivales dans cette salopette à épaules dénudées et jambes larges, ornée de motifs maritimes vibrants."",""buy_now_text"": ""Achetez maintenant"",""stock"": 12,""currency"": ""CAD"",""price"": 82.99},""en_GB"":{""title"": ""Duo Breeze Jumpsuit Pack"",""item_url"": ""https://www.example.com/uk/products/sea-breeze-jumpsuit/EX123456.html"",""image_url"": ""https://www.example.com/uk/products/duo-breeze-jumpsuit-pack/EX123456.jpg"",""stock"": 25,""currency"": ""GBP"",""price"": 75.99}}"

Sample File:
commerce-feed-ugc-ratings-and-reviews.tsv

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close