Transaction header 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 |
| Name of the system that is the authoritative data source for a record. |
|
Business Unit Code |
| Business Unit identifies the structure of brands within an organizational entity. It is the way in which the brands within a company’s portfolio are related to, and differentiated from, one another. Values are defined as part of on-boarding, in This field is used in aggregate calculations. |
|
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). |
|
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 |
| Shipping Country ISO 2 char code (defaults to US). |
|
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 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) Either eComm Transaction ID generated by eCommerce system (may be order ID or order ID + invoice or a combination of POS transaction ID + store ID and other data that makes a purchase unique within POS system). 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 'returned' status). |
|
Local Total Transaction Amount |
| Total transaction amount in local currency (should be negative for 'returned' status). |
|
Global Sub Total Transaction Amount |
| Subtotal amount of the transaction before taxes and fees in global currency (should be negative for 'returned' status). |
|
Local Sub Total Transaction Amount |
| Subtotal amount of the transaction before taxes and fees in local currency (should be negative for 'returned' status). |
|
Global Total Discount Amount |
| Total amount of all discounts applied for entire purchase in global currency (should be negative for 'returned' status). |
|
Local Total Discount Amount |
| Total amount of all discounts applied for entire purchase in local currency (should be negative for 'returned' status). |
|
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 'returned' status). |
|
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 'returned' status). |
|
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 'returned' status). |
|
Local Total Tax Amount |
| Total tax amount applied for entire purchase in local currency (should be negative for 'returned' status). |
|
Global Total Additional Tax Amount |
| Additional tax amount for entire purchase, like local tax in global currency (should be negative for 'returned' status). |
|
Local Total Additional Tax Amount |
| Additional tax amount for entire purchase, like local tax in local currency (should be negative for 'returned' status). |
|
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. |
|
Source Record Create Datetime |
| The datetime when the record was created at source system ( |
|
Source Record Update Datetime |
| The datetime of the latest update of the record at source system ( |
|