Product data feed

CrossEngage's product data feed feature allows you to load all of your product data and update product attributes or stock that may be then used in marketing communication.

Introduction

To use our product feed functionality, you must upload either a JSON or XML file to the SFTP server you have defined in the System Setup area of your account. The product feed data file contains all of the products which you would like to load and use within personalised messages on CrossEngage.

Naming convention

The naming convention for the product feed file is the following:

product_feed_YYYYMMDDHHMMSS

Example:

product_feed_20180321110559.json
or
product_feed_20180321110559.xml

Data File

This data file must contain an array of objects which represent the data of the products that should be loaded into CrossEngage. Each object defines the attributes of a single product.

The only mandatory field is the skufield. The sku field refers to the stock keeping unit you have assigned to a product in your data warehouse.

If you use multiple stores, each with a separate SKU logic, you can include the business unit a particular product belongs to in its properties. Please note that the combination of business unit and SKU needs to be unique.

Available properties

Property

Type

Description

sku

string

Required. The SKU (stock keeping unit) of a product. e.g. LA222P00Q

id

string

A product's unique identifier. e.g. 1A23759926

enabled

integer

Represents whether or not a product is usable in marketing communications. If it is set to 0, the product will not be found or displayed in any marketing messaging.

title

string

A product's name. e.g. SLIM FIT - Poloshirt - navy blue

productCategory

string

Breadcrumbs style categorisation of a product. e.g. products > clothes

description

string

A product's description.

businessUnit

string

The business unit a product belongs to. e.g. DE

price

number

The price of a product without currency. e.g. 100.00

salesPrice

number

The advertised sale price of a product e.g. 80.00

discount

string

The difference between the price an sales price (if set). e.g. the value20 will result in the value -20% stored in CrossEngage.

salesPriceEffectiveDate

date range

The date range during which the sale price applies. The dates should be written in ISO8601 format separated by a /. e.g. 2018-10-19/2018-10-26

currency

string

The currency of the prices. e.g. EUR

stockQuantity

number

The number of items in stock. e.g. 102

link

string

Absolute URL to a product's page.

smallImageLink

string

Absolute URL to a product's thumbnail image.

bigImageLink

string

Absolute URL to a product's larger image.

attributes

object

An object representing additional product attributes not covered by the above set. All additional attributes must be written in camelCase format. e.g. { "colour":"White", "clothMaterial":"Plush" }

All attributes are nullable except for sku, which is mandatory. If you would like to nullify an attribute, please enter the value null or do not include the attribute at all.

Example product object:

{
"sku": "LA222P00Q",
"title": "SLIM FIT - Poloshirt - navy blue",
"description": "Poloshirt with a classic feel",
"productCategory": "Men > Shirts",
"price": "89.95",
"currency": "€",
"attributes": {
"ean": "075678164125",
"brand": "Lacoste",
"category1": "Men",
"category2": "Shirts"
}
}

Example JSON data file

[
{
"sku": "LA222P00Q",
"title": "SLIM FIT - Poloshirt - navy blue",
"description": "Poloshirt with a classic feel",
"productCategory": "Men > Shirts",
"price": "89.95",
"currency": "€",
"attributes": {
"ean": "075678164125",
"brand": "Lacoste",
"category1": "Men",
"category2": "Shirts"
}
},
{
"sku": "K4411BA03",
"title": "Pumps - Red",
"description": "For the perfect party look",
"productCategory": "Women > Shoes > High-Heels",
"price": "669.95",
"currency": "€",
"attributes": {
"ean": "079218397621",
"brand": "Louboutin",
"category1": "Women",
"category2": "Shoes",
"category2": "High-Heels"
}
}
]

Example XML data file

<?xml version="1.0" encoding="utf-8" ?>
<data>
<record>
<sku><![CDATA[LA222P00Q]]></sku>
<title><![CDATA[SLIM FIT - Poloshirt - navy blue]]></title>
<description><![CDATA[Poloshirt with a classic feel]]></description>
<productCategory><![CDATA[Men > Shirts]]></productCategory>
<price><![CDATA[89.95]]></price>
<currency><![CDATA[€]]></currency>
<attributes>
<ean><![CDATA[075678164125]]></ean>
<brand><![CDATA[Lacoste]]></brand>
<category1><![CDATA[Men]]></category1>
<category2><![CDATA[Shirts]]></category2>
</attributes>
</record>
<record>
<sku><![CDATA[K4411BA03]]></sku>
<title><![CDATA[Pumps - Red]]></title>
<description><![CDATA[For the perfect party look]]></description>
<productCategory><![CDATA[Women > Shoes > High-Heels]]></productCategory>
<price><![CDATA[669.95]]></price>
<currency><![CDATA[€]]></currency>
<attributes>
<ean><![CDATA[079218397621]]></ean>
<brand><![CDATA[Louboutin]]></brand>
<category1><![CDATA[Women]]></category1>
<category2><![CDATA[Shoes]]></category2>
<category3><![CDATA[High-Heels]]></category2>
</attributes>
</record>
</data>