Product Catalogue

The Product Catalogue stores a complete record of the products you offer, along with their properties such as price or image.

Product Properties

Property
Description
Mandatory
Example

sku

The stock keeping unit of a product (required)

id

Identifiers other than SKU which you would like to pass on to CrossEngage can be submitted through this field. This is a simple text field cannot be used as a CrossEngage product identifier

title

The product name

description

A description of the product

link

The full URL to a product page

bigImageLink

The full URL of a high resolution image of the product

smallImageLink

The full URL of a thumbnail image of the product

category

The category of a product. Can be used for a single category or for combining multiple categories in a single string, for example using breadcrumbs style: Clothes → Jeans

price

Price of a product (without currency)

salesPrice

Can be used to store the advertised sale price of a product. This is a simple numeric field, CrossEngage does not assign any internal logic to it

salesPriceEffectiveDate

Date from which the salesPrice applies. No logic is assigned to this field

discount

A human-readable description of the discount on the salesPrice (for example €20 or -20%)

currency

Currency of the numeric price values

stockQuantity

Number of items in stock

enabled

Can be used to mark products as enabled (1) or disabled (0). No internal logic is assigned to this field.

attributes

An object to store custom attributes. At the moment, only simple data types are supported (no arrays or objects). You can flatten your data before adding where necessary, e.g. instead of "categories": ["Men", "Shirts"] use "category1": "Men", "category2": "Shirts".

Example

You can upload a Product Catalogue using a JSON file. Please go to Data Management to learn more.

{
   "id": null,
   "sku": "3938-691-926",
   "title": "Puke Duke",
   "description": "Das Bier mit Zimt-Vanille-Geschmack.\nInhalt:\n- Eine Dose à 0,5 Liter.",
   "link": null,
   "bigImageLink": "https://abload.de/img/puke_dukevxke2.jpg",
   "smallImageLink": "https://abload.de/thumb/puke_dukevxke2.jpg",
   "category": "Getränke → Bier",
   "price": 1.09,
   "salesPrice": null,
   "salesPriceEffectiveDate": null,
   "discount": null,
   "currency": "€",
   "stockQuantity": 120,
   "enabled": 0,
   "attributes": {
       "brand": "Duke"}}

Last updated