Transaction feed layout definition
The following table represents the feed layout definition.
Required fields are marked as (Required) in the field description column; fields not marked as required are optional.
Business name | Field name | Description | Field data type/length |
|---|---|---|---|
System of Record Name |
| (Required) Name of the system that is the authoritative data source for a record. | N/A |
Business Unit Code |
| Business Unit identifies the structure of brands within an organizational entity. It is how the brands within a company’s portfolio are related to and differentiated from one another. This field is used in aggregate calculations. Values are defined as part of on-boarding, in |
|
Customer/ Buyer and Ship to Section | |||
Source Party Profile Id |
| Unique identifier generated by legacy program systems, enrollment forms, etc. to identify the creation of a customer. Can be used to reference Party Profile ID of the profile associated with the transaction. Uses This field is used in aggregate calculations. |
|
Source Customer Account Id |
| Unique identifier generated by the source systems to identify non-Loyalty customer account associated with transaction. This field is used in aggregate calculations. |
|
Source Loyalty Account Id |
| Unique identifier generated by the source systems to identify Loyalty account associated with transaction. This field is used in aggregate calculations. |
|
Business Name |
| Business Name of the customer - small business (e.g., R & J Electrical). |
|
Bill To Full Name |
| Bill to customer's full name. |
|
Bill To Prefix Name |
| Bill to customer's prefix name (Mrs./Mr.). |
|
Bill To Title |
| Bill to customer's title (Dr.). |
|
Bill To First Name |
| Bill to customer's first name. This field is used in aggregate calculations. |
|
Bill To Middle Name |
| Bill to customer's middle name. This field is used in aggregate calculations. |
|
Bill To Last Name |
| Bill to customer's last name. This field is used in aggregate calculations. |
|
Bill To Suffix Name |
| Bill to customer's suffix name. This field is used in aggregate calculations. |
|
Bill To Address 1 |
| Billing Address Line 1. This field is used in aggregate calculations. |
|
Bill To Address 2 |
| Billing Address Line 2. This field is used in aggregate calculations. |
|
Bill To Address 3 |
| Billing Address Line 3. |
|
Bill To Address 4 |
| Billing Address Line 4. |
|
Bill To City |
| Billing City Name. This field is used in aggregate calculations. |
|
Bill To State Province |
| Billing State Code. This field is used in aggregate calculations. |
|
Bill To Postal Code |
| Billing Postal Code. This field is used in aggregate calculations. |
|
Bill To Country Code |
| ISO 3166 (alpha-2) 2-character country code of the Billing Country (defaults to This field is used in aggregate calculations. |
|
Bill To Home Phone Country Code |
| ISO 3166 (alpha-2) 2-character country code of home phone (defaults to |
|
Bill To Home Phone Number |
| Customer's bill to home phone number, including area code. This field is used in aggregate calculations. |
|
Bill To Mobile Phone Country Code |
| ISO 3166 (alpha-2) 2-character country code of mobile phone (defaults to |
|
Bill To Mobile Phone Number |
| Customer's bill to cell phone number, including area code. This field is used in aggregate calculations. |
|
Bill To Work Phone Country Code |
| ISO 3166 (alpha-2) 2-character country code of work phone (defaults to |
|
Bill To Work Phone Number |
| Customer's bill to work phone number, including area code. This field is used in aggregate calculations. |
|
Bill To Other Phone Country Code |
| ISO 3166 (alpha-2) 2-character country code of other phone (defaults to |
|
Bill To Other Phone Number |
| Customer's bill to “other" phone number, including area code. This field is used in aggregate calculations. |
|
Bill To Other Phone Type Code |
| The type of the phone, such as billing, shipping, home, work, primary, mobile, other as defined in the reference data worksheet. This field is used in aggregate calculations. Values are defined as part of on-boarding, in |
|
Bill To Email Address |
| Bill to customer's email address. This field is used in aggregate calculations. |
|
Ship To Full Name |
| Ship to customer's full name. |
|
Ship To Prefix Name |
| Ship to customer's prefix name. |
|
Ship To Title |
| Ship to customer's title (Dr.). |
|
Ship To First Name |
| Ship to customer's first name. |
|
Ship To Middle Name |
| Ship to customer's middle name. |
|
Ship To Last Name |
| Ship to customer's last name. |
|
Ship To Suffix Name |
| Ship to customer's suffix name. |
|
Ship To Address 1 |
| Shipping Address Line 1. |
|
Ship To Address 2 |
| Shipping Address Line 2. |
|
Ship To Address 3 |
| Shipping Address Line 3. |
|
Ship To Address 4 |
| Shipping Address Line 4. |
|
Ship To City |
| Shipping City Name. |
|
Ship To State Province |
| Shipping State Code. |
|
Ship To Postal Code |
| Shipping Postal Code. |
|
Ship To Country Code |
| ISO 3166 (alpha-2) 2-character country code of the ship to address (defaults to |
|
Ship To Phone Number |
| Ship to phone number including area code. |
|
Ship To Email Address |
| Ship to customer's email address. |
|
Transaction Header Section | |||
Transaction Datetime |
| (Required) Date and time when transaction occurred.
This field is used in aggregate calculations. |
|
Purchase Order Id |
| (Required for eComm Transaction) Purchase order ID generated by eCommerce system that is constant through order's life cycle (order / cancel / ship to / return, etc.). This field is used in aggregate calculations. |
|
Source Transaction Id |
| (Required) This field is the natural primary key. Either eComm Transaction ID generated by eCommerce system. May be one of the following:
This field is used in aggregate calculations. |
|
Pos Transaction Id |
| (Required for POS Transaction) Transaction number generated by POS system. |
|
Invoice Number |
| Value that uniquely identifies invoice in the fulfillment system. |
|
Source Location Id |
| (Required) Uniquely identifies a Location in the source system where transaction took place (location can be a store or website); references Location ID in Location feed layout. This field is used in aggregate calculations. |
|
Register Number |
| ID of the register used for placing an order. |
|
Transaction Type Code |
| Uniquely identifies a type of transaction, such as retail vs. web transaction. Values are defined as part of on-boarding, in |
|
Transaction Line Item Count |
| Total number of line items included in the transaction. |
|
Global Total Transaction Amount |
| Total transaction amount in global currency (should be negative for |
|
Local Total Transaction Amount |
| Total transaction amount in local currency (should be negative for |
|
Global Sub Total Transaction Amount |
| Subtotal amount of the transaction before taxes and fees in global currency (should be negative for |
|
Local Sub Total Transaction Amount |
| Subtotal amount of the transaction before taxes and fees in local currency (should be negative for |
|
Global Total Discount Amount |
| Total amount of all discounts applied for entire purchase in global currency (should be negative for |
|
Local Total Discount Amount |
| Total amount of all discounts applied for entire purchase in local currency (should be negative for |
|
Global Total Non Merchandise Amount |
| Non-merchandise amount (includes shipping and restock fee, delivery fee, any services fee) in global currency (should be negative for |
|
Local Total Non Merchandise Amount |
| Non-merchandise amount (includes shipping and restock fee, delivery fee, any services fee) in local currency (should be negative for |
|
Shipping Type Code |
| Shipping method used, such as air, ground, store pickup, expedited, etc. Values are defined as part of on-boarding, in |
|
Customer Associate Id |
| An ID of associate that helped/processed customer's transaction. |
|
Global Total Tax Amount |
| Total tax amount applied for entire purchase in global currency (should be negative for |
|
Local Total Tax Amount |
| Total tax amount applied for entire purchase in local currency (should be negative for |
|
Global Total Additional Tax Amount |
| Additional tax amount for entire purchase, like local tax in global currency (should be negative for |
|
Local Total Additional Tax Amount |
| Additional tax amount for entire purchase, like local tax in local currency (should be negative for |
|
Order Origin Name |
| Identifies original source of the transaction (purchase order) such as a particular call center, particular store (when items purchased online but from a particular B&M store location, an app, etc.). |
|
Employee Id |
| When Customer is also an Employee, contains Employee Number. |
|
Transaction Detail (Item) Section | |||
Line Item Number |
| (Must be populated in item/ detail records) This field is the natural primary key for detail record. Line-item number identifies transaction's line number, which corresponds to the actual line on the receipt where the item appears. |
|
Source Product Id |
| (Must be populated in item/ detail records) Identifies a product in the transaction line, references product hierarchy. This field is used in aggregate calculations. |
|
Transaction Detail Status Code |
| (Must be populated in item/ detail records) The status of the line item such as: sale, returned, canceled, or ordered. Aggregates have dependency on this field and if not populated, these aggregates will be set to 0. If client's system does not support both demand and sales e-commerce systems, TXN Details in 'sale' status should be captured (same as for retail TXNs). Status This field is used in aggregate calculations. Values are defined as part of on-boarding, in |
|
Product Quantity |
| Item quantity (should be negative for This field is used in aggregate calculations. |
|
Global Net Sales Amount |
| (Must be populated in item/ detail records) Net sales amount in global currency - amount for the (item x quantity) deducting taxes, markdowns, and other discounts. Final amount paid for line items. In case of items returned and canceled, this should be a negative number. This amount is used by aggregate calculations, such as LTV, first/last purchase, etc. This field is used in aggregate calculations. |
|
Local Net Sales Amount |
| Net sales amount in local currency - amount for the (item x quantity) deducting taxes, markdowns, and other discounts. Final amount paid for line items. In case of items returned and canceled, this should be a negative number. |
|
Global Total Item Amount |
| A total amount for the item in global currency (unit price x qty) before any discounts were applied (should be negative for |
|
Local Total Item Amount |
| A total amount for the item in local currency (unit price x qty) before any discounts were applied (should be negative for |
|
Global Total Item Discount Amount |
| Line-Item Total Discount Amount in global currency, for example $10 discount based on the coupon + $5 based on store sale, this will be $15. |
|
Local Total Item Discount Amount |
| Line-Item Total Discount Amount in local currency, for example $10 discount based on the coupon + $5 based on store sale equals $15. |
|
Global Retail Price Amount |
| Unit price of the line's product in global currency. |
|
Local Retail Price Amount |
| Unit price of the line's product in local currency. |
|
Global Unit Cost Amount |
| The cost of the item - amount the company paid for the item in global currency. |
|
Local Unit Cost Amount |
| The cost of the item - amount the company paid for the item in local currency. |
|
Global Sale Price Amount |
| Sale price of the line's product in global currency. |
|
Local Sale Price Amount |
| Sale price of the line's product in local currency. |
|
Gift Item Indicator |
| Indicates if the item is a gift.
|
|
Gift Certificate Id |
| Unique ID for GCs purchased - Card number for physical or virtual gift card purchase or original order card number for price adjustments and returns. |
|
Global Item Tax Amount |
| Tax amount for the item in global currency. |
|
Local Item Tax Amount |
| Tax amount for the item in local currency. |
|
Global Additional Tax Amount |
| Additional tax amount in global currency. |
|
Local Additional Tax Amount |
| Additional tax amount in local currency. |
|
Taxable Indicator |
| Indicates if item is taxable.
|
|
Return Reason Code |
| Describes the reason why an item was returned (for return transactions). |
|
Original Purchase Order Id |
| Original purchase order id. |
|
Original Source Transaction Id |
| Original transaction number. |
|
Original Source Location Id |
| Original transaction location id. | |
Original Register Number |
| Original register number. |
|
Original Transaction Datetime |
| Original transaction datetime. |
|
Global Original Net Sales Amount |
| Original net sales amount in global currency. |
|
Local Original Net Sales Amount |
| Original net sales amount in local currency. |
|
Global Original Total Item Amount |
| Original total item amount in global currency. |
|
Local Original Total Item Amount |
| Original total item amount in local currency. |
|
Global Original Item Discount Amount |
| Original item discount amount in global currency. |
|
Local Original Item Discount Amount |
| Original item discount amount in local currency. |
|
Global Original Item Tax Amount |
| Original item tax amount in global currency. |
|
Local Original Item Tax Amount |
| Original item tax amount in local currency. |
|
Global Original Additional Tax Amount |
| Original additional tax amount in global currency. |
|
Local Original Additional Tax Amount |
| Original additional tax amount in local currency. |
|