Skip to main content
Skip table of contents

Commerce Product Catalog Feed Format for UGC

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

If you use Shopify, Bigcommerce, Magento 2, or SFCC Demandware, you do not need to use the Commerce Product Catalog format. Instead, refer to the integrations instructions for your platform to ingest your product feed. To learn more, see https://developers.pixlee.com/docs/getting-started.

Supported Data Fields for Emplifi UGC

For us to accept your product list into Emplifi UGC, 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.

Comma ( , ) and pipe ( | ) delimiters are supported, but not by default. If your feed must use a comma or pipe, please notify us when submitting the file so we can adjust your settings to accept the feed. Changing the delimiter of your feed without notifying us in advance will result in your feed failing to ingest correctly.

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.

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.jpg

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

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 photo per product you can use this field. All images sent here will be available in the UI during UGC product tagging.

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.

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.

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.

currency

No

String

"USD"

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

price

No

Decimal

49.99

The current price of the product.

call_to_action

No

String

"BUY NOW"

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

sales_price

No

Decimal

29.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).

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"

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"

regional_data

No

JSON

See Regional Data

See Regional Data

Regional Data

If you have stores in multiple regions, we can ingest your products using one feed that combines your regional product data. At this time, it is not possible to ingest individual product feeds per a region.

To include region specific data in your product feed, add the regional_data column to your feed. The data in this column must be a JSON object that maps the region code to region specific product details for the product in that row.

  • The locale code should be a valid locale.

  • title, item_url, and currency are required fields.

  • stock, image_url, and price, call_to_action, and description are optional fields.

Table of supported locale codes

Country

Locale

Andorra

ca_AD

Andorra

es_AD

Australia

en_AU

Austria

de_AT

Belgium

nl_BE

Belgium

fr_BE

Bulgaria

bg_BG

Canada

en_CA

Canada

fr_CA

China

zh_CN

Czech Republic

cs_CZ

Denmark

da_DK

Finland

fi_FI

Finland

sv_FI

France

fr_FR

Germany

de_DE

Great Britain

en_GB

Greece

el_GR

Hong Kong

zh_HK

Hungary

hu_HU

India

en_IN

Indonesia

in_ID

Ireland

en_IE

Italy

it_IT

Japan

ja_JP

Latin America

es_LA

Luxembourg

fr_LU

Luxembourg

de_LU

Netherlands

nl_NL

New Zealand

en_NZ

Norway

no_NO

Poland

pl_PL

Portugal

pt_PT

Romania

ro_RO

Russia

ru_RU

Slovakia

sk_SK

South Korea

ko_KR

Spain

ca_ES

Spain

es_ES

Sweden

sv_SE

Switzerland

fr_CH

Switzerland

de_CH

Switzerland

it_CH

Taiwan

zh_TW

Thailand

th_TH

Turkey

tr_TR

Ukraine

uk_UA

United States

en_US

United States

es_US

Example:

This example is formatted for readability instead of usability. When submitting your file, the contents should be inline with other product data. See the Example Commerce Product Catalog File for additional reference.

CODE
"{
   ""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."",
      ""stock"": 12,
      ""currency"": ""CAD"",
      ""price"": 45.00,
      ""call_to_action"": ""Achetez maintenant""
   },
   ""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,
      ""call_to_action"": ""Shop Now""
   }
}"   

Example Commerce Product Catalog File for UGC Only

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

CODE
id	title	item_url	image_url	additional_photos	description	stock	active	tags	currency	price	call_to_action	sales_price	sales_start_date	sales_end_date	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	["Seasonal", "Summer Wears", "Rompers"]	"USD"	49.99	"BUY NOW"	34.99	2024-09-01	2025-03-31	"{""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."",""stock"": 12,""currency"": ""CAD"",""price"": 45.00,""buy_now_text"": ""Achetez maintenant""},""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,""buy_now_text"": ""Shop Now""}}"

Sample File:
commerce-feed-ugc.tsv

Set up Your Product Feed

When you have your product list file formatted correctly, contact us with the URL or FTP location of the file to proceed with the initial ingestion of your product catalog.

After your product feed is processed, it will continue to update regularly at a rate of approximately once per a day.

To avoid interruption of your product feed, it is important to communicate with us any changes to the file name or location.

JavaScript errors detected

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

If this problem persists, please contact our support.