Transaction Feed Attributes Reference

Prev Next

This page describes the fields used in the Transaction Feed and how they should be populated.

All fields listed below must be included for every entry, except for StoreCode and ReturnDate.

  • If an item’s Channel is set to instore, the StoreCode field is required.

  • If an item has been returned, the original transaction record must be resent with ReturnDate included.

  • OrderId and EntryId must together uniquely identify a single row in the file.

  • The ProductId and CustomerId values must match those used in the Product Feed and Event Tracking.

Field

Description

Notes

Data Type

OrderId

Unique identifier for the order

Must not be reused. This value should match the order number sent with the order confirmation tracking.

String [a-zA-Z0-9-]

CustomerId

Unique identifier for the customer

Typically, an internal customer ID or a hashed email address. If a hash is used, document how it is generated, for example, lowercase followed by SHA-256. An opaque identifier is strongly preferred.

String [a-zA-Z0-9-]

EntryId

Identifier for the line item within the order

Must be unique within the order only. For returned items, the EntryId must match the original purchase entry.

Positive integer

ProductId

Identifier for the size- and color-specific product variant

Must match the corresponding identifier used in the Product Feed.

String [a-zA-Z0-9-]

EAN

EAN code of the purchased item

Optional if the Product Feed includes EAN values and covers the same time period. See: International Article Number (EAN).

String [0-9]

Channel

Indicates whether the item was purchased online or in a physical store

Allowed values are online or instore.

String [a-z], must be online or instore

StoreCode

Identifier of the physical store

Required only when Channel is set to instore.

String [a-zA-Z0-9-]

Price

Unit price of the item after any promotional discounts

Price should reflect the amount paid per item.

Decimal, two decimal places

Discount

Discount applied to the item

Should represent item-specific discounts, not general sale reductions.

Decimal, two decimal places

Currency

Currency in which the transaction was made

Must be a valid ISO 4217 currency code, such as USD or GBP.

String [A-Z], fixed length of 3

OrderDate

Date and time when the order was placed

UTC is strongly preferred for all timestamps. Please indicate if another time zone is used.

Date YYYY-MM-DDThh:mm:ss.sssZ

ReturnDate

Date and time when the item was returned

When populated, all other fields must match the original purchase record.

Date YYYY-MM-DDThh:mm:ss.sssZ