Transaction detail 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. | |
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. |
|
Line Item Number |
| (Required) Line item number identifies transaction's line number which corresponds to the actual line on the receipt where the item appears. |
|
Source Product Id |
| (Required) Identifies a product in the transaction line, references product hierarchy. This field is used in aggregate calculations. |
|
Transaction Detail Status Code |
| (Required) The status of the line item, such as: sale, returned, canceled, or ordered. Aggs have dependency on this field, and if not populated, these aggs 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 'shipped' should only be used by clients that also generate TXN Details with status 'ordered'. Values are defined as part of on-boarding, in This field is used in aggregate calculations. |
|
Product Quantity |
| Item quantity. Should be negative for 'returned' status. This field is used in aggregate calculations. |
|
Global Net Sales Amount |
| (Required) 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 aggs 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 'returned' status. |
|
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 'returned' status. |
|
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 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 will be $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. Valid values are:
|
|
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. Valid values are:
|
|
Return Reason Code |
| Describes the reason why an item was returned (in case of 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. |
|
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 ( |
|