Order Item Data Schema Specifications

Use this specification to format your order item information prior to submitting to Listrak. Submitting your data to Listrak in the right format is important for delivering successful campaigns and insights.

Please also use the following schema specifications for other data objects:

Click here for Order Item Data sample file

Attribute
(Column)
Format
Requirements and Suggestions
ATTRIBUTE (COLUMN)
ordernumber
FORMAT

Attribute Description
The orders unique identifier

Example
0531435151

Syntax
String
Max. 50 characters

Requirements and Suggestions
  • This attribute is required as a primary key and must be included for every order item.
  • When sending updates to an order item, ensure your ordernumber does not change.
  • This attribute's value must match the ordernumber provided in your Order data feed.
ATTRIBUTE (COLUMN)
alternateordernumber
FORMAT

Attribute Description
The orders alternate order number

Example
065651

Syntax
String
Max. 50 characters

Requirements and Suggestions
  • Used as an alternate order number that may derive from an Order Management System that is separate from your ecommerce order data.
  • The alternateordernumber will be used as the ordernumber in the event an ordernumber is not provided in the data file.
ATTRIBUTE (COLUMN)
sku
FORMAT

Attribute Description
The product's unique identifier

Example
9843723-red

Syntax
String
Max. 100 characters

Requirements and Suggestions
  • This attribute is required as a foreign key to the product schema and must be included for every order item.
  • Ensure that all purchasable products on your website are represented in your products data feed. Products purchased but not supplied in your products data feed will be represented by a placeholder order item generated by Listrak.
ATTRIBUTE (COLUMN)
status
FORMAT

Attribute Description
The current status of the order item

Example
Completed

Syntax
String
Integer

Supported Values
0=NotSet, 1=Misc, 2=PreOrder, 3=BackOrder, 4=Pending, 5=Hold, 6=Processing, 7=Shipped, 8=Completed, 9=Returned, 10=Canceled, 11=Unknown

Requirements and Suggestions
  • You may supply either the integer or string associated with the order item's status.
  • Use this attribute to update an order item as the status changes.
  • An up-to-date order item status is highly important for post-purchase messaging.
ATTRIBUTE (COLUMN)
quantity
FORMAT

Attribute Description
The quantity of each item ordered

Example
4

Syntax
Integer

Requirements and Suggestions
ATTRIBUTE (COLUMN)
price
FORMAT

Attribute Description
The order line's per item price

Example
15.00

Syntax
Decimal

Requirements and Suggestions
  • Ensure your price accurately reflects what is displayed on your website and that the product can be purchased at this price.
ATTRIBUTE (COLUMN)
discountedprice
FORMAT

Attribute Description
The order line's discounted per item price

Example
12.50

Syntax
Decimal

Requirements and Suggestions
  • This attribute should be less than price.
ATTRIBUTE (COLUMN)
itemdiscounttotal
FORMAT

Attribute Description
The total discount value applied to each order line

Example
10.00

Syntax
Decimal

Requirements and Suggestions
  • itemdiscounttotal = (price - discountedprice) * quantity
  • For example, a quantity of 2 items were ordered, each with a discount of $2.50, for an itemdiscounttotal of $5.00.
ATTRIBUTE (COLUMN)
itemtotal
FORMAT

Attribute Description
The total value of each order line after discounts are applied

Example
50.00

Syntax
Decimal

Requirements and Suggestions
ATTRIBUTE (COLUMN)
discounttype
FORMAT

Attribute Description
The type of the discount applied to the order item

Example
Promotion

Syntax
String

Supported Values
null, PriceOverride, PriceRule, Promotion, SeniorCitizen, Markdown, Coupon, QuantityDiscount, Rebate, CashDiscount, TradeDiscount, TradeInKind, PromptPaymentDiscount, GeneralDiscount, GiftVoucher, FlexibleDiscount, RewardProgram, ManufacturerReward, CreditCardReward

Requirements and Suggestions
  • Supply one of the supported values that best describes the nature of each item's discount.
  • Listrak CRM enables you to conduct a detailed analysis on the impact discounts have on your customers' purchasing behavior.
ATTRIBUTE (COLUMN)
discountdescription
FORMAT

Attribute Description
The description of the discount applied to the order item

Example
November Flash Sale

Syntax
String
Max. 100 characters

Requirements and Suggestions
  • This attribute can be used with or without discounttype.
ATTRIBUTE (COLUMN)
shipdate
FORMAT

Attribute Description
The order item's shipping date

Example
2018-08-26T07:43:48Z

Syntax
Datetime
ISO 8601

Requirements and Suggestions
ATTRIBUTE (COLUMN)
shippingmethod
FORMAT

Attribute Description
The order item's shipping method

Example
UPS

Syntax
String
Max. 32 characters

Requirements and Suggestions
ATTRIBUTE (COLUMN)
trackingnumber
FORMAT

Attribute Description
The order item's tracking number

Example
1Z999AA10123456784

Syntax
String
Max. 32 characters

Requirements and Suggestions
ATTRIBUTE (COLUMN)
meta1
FORMAT

Attribute Description
Supplemental order item information

Syntax
String
Max. 500 characters

Requirements and Suggestions
ATTRIBUTE (COLUMN)
meta2
FORMAT

Attribute Description
Supplemental order item information

Syntax
String
Max. 500 characters

Requirements and Suggestions
ATTRIBUTE (COLUMN)
meta3
FORMAT

Attribute Description
Supplemental order item information

Syntax
String
Max. 500 characters

Requirements and Suggestions
ATTRIBUTE (COLUMN)
meta4
FORMAT

Attribute Description
Supplemental order item information

Syntax
String
Max. 500 characters

Requirements and Suggestions
ATTRIBUTE (COLUMN)
meta5
FORMAT

Attribute Description
Supplemental order item information

Syntax
String
Max. 500 characters

Requirements and Suggestions