Sales data feed specifications

Sitecore Discover predefines sales data attributes to facilitate your sales data feed. When you prepare a sales data feed file, you must map your own sales attributes to the appropriate Discover sales attributes.

Note

After you have prepared your sales data feed file, please contact Sitecore Support to configure the initial feed run.

The following table lists and describes required and optional attributes to include in your sales data feed:

Attribute

Type

Description

Example

order_id

string

Required.

Unique number or ID associated with an order. Is the same across all lines associated with an order.

1234FGH89G

order_date

string

Required.

Date and time when the order was placed.

Format ISO 8601 standard:

  • YYYY-MM-DD

  • YYYY-MM-DDThh:mm:ss

  • YYYY-MM-DDThh:mm:ssZ

2019-04-01

2019-04-01T19:47:25

2019-04-01T19:47:25Z

product_group

string

Required.

A unique string that identifies a group of SKUs. If a product is same as SKU, then it can be the same value as the SKU value.

For example, all the size variations of a given shirt size and color might fall into this category. When not specified, all products sharing a particular URL are grouped together.

234sbd

sku

string

Required.

A unique string used to identify a particular product, usually SKU.

sku1234

price

float

Required.

Catalog price when order was made. Double precision floating point number.

27.99

sale_price

float

Required.

Sale price at the time order was made. If there is no discount from the catalog price, this must be the same as the price attribute. Double precision floating point number.

21.97

quantity

integer

Required.

The number of items purchased.

1

order_total

float

Required.

Total order amount. This is the value that is used to track revenue in your system. It must be the same value for all lines associated with an order. Double precision floating point number.

25.5

user_id

string

Optional.

Unique ID associated with the user or customer who made the purchase. Typically, this is the ID assigned to the customer in your CRM system.

This is the same user ID used in events (user.id) for analytics, that is: order:confirm, user:login and user:info events.

c-00001

user_eid

string

Optional.

A hash (md5 or SHA256) of user email address, or other ID used by the email service provider.

Used for personalizing recommendations in promotional email campaigns.

a9601f3839e5d5da764c1861a5e1daf6

user_email

string

Optional.

User or customer email address.

[email protected]

billing_zipcode

string

Optional.

Zip code of billing address.

90404

billing_region

string

Optional.

State or region used for billing. For USA billing address, this is the state name or abbreviation.

California/CA

billing_country

string

Optional.

Country in the billing address.

USA

In-store sales attributes

The following attributes are used for in-store:

Attribute

Type

Description

Example

store_id

string

Optional.

ID of the store where order was placed. Presence of this attribute value means the transaction happened in store.

store001

store_zipcode

string

Optional.

Zip code of store.

90404

store_region

string

Optional.

Region where store is located.

For example in the USA, this is the state name/abbreviation.

California/CA

store_country

string

Optional.

A 3-letter country code. Default: USA

usa

Do you have some feedback for us?

If you have suggestions for improving this article,