Skip to main content
Skip table of contents

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

sor_name

Name of the system that is the authoritative data source for a record. 

Source Transaction Id

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.

char(200)

Line Item Number

line_item_num

(Required) Line item number identifies transaction's line number which corresponds to the actual line on the receipt where the item appears. 

integer

Source Product Id

source_product_id

(Required) Identifies a product in the transaction line, references product hierarchy.

This field is used in aggregate calculations.

char(200)

Transaction Detail Status Code

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 TRANSACTION_DETAIL_STATUS_LOOKUP. Refer to Transaction detail status for details.

This field is used in aggregate calculations.  

char(50)

Product Quantity

product_qty

Item quantity. Should be negative for 'returned' status.

This field is used in aggregate calculations.

integer

Global Net Sales Amount

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.

numeric(20,6)

Local Net Sales Amount

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. 

numeric(20,6)

Global Total Item Amount

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.

numeric(20,6)

Local Total Item Amount

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.

numeric(20,6)

Global Total Item Discount Amount

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). 

numeric(20,6)

Local Total Item Discount Amount

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). 

numeric(20,6)

Global Retail Price Amount

global_retail_price_amount

Unit price of the line's product in global currency.

numeric(20,6)

Local Retail Price Amount

local_retail_price_amount

Unit price of the line's product in local currency.

numeric(20,6)

Global Unit Cost Amount

global_unit_cost_amount

The cost of the item - amount the company paid for the item in global currency. 

numeric(20,6)

Local Unit Cost Amount

local_unit_cost_amount

The cost of the item - amount the company paid for the item in local currency. 

numeric(20,6)

Global Sale Price Amount

global_sale_price_amount

Sale price of the line's product in global currency.

numeric(20,6)

Local Sale Price Amount

local_sale_price_amount

Sale price of the line's product in local currency.

numeric(20,6)

Gift Item Indicator

gift_item_ind

Indicates if the item is a gift.

Valid values are:

  • y for yes

  • n for no

char(1)

Gift Certificate Id

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. 

char(20)

Global Item Tax Amount

global_item_tax_amount

Tax amount for the item in global currency.

numeric(20,6)

Local Item Tax Amount

local_item_tax_amount

Tax amount for the item in local currency.

numeric(20,6)

Global Additional Tax Amount

global_addtl_tax_amount

Additional tax amount in global currency.

numeric(20,6)

Local Additional Tax Amount

local_addtl_tax_amount

Additional tax amount in local currency.

numeric(20,6)

Taxable Indicator

taxable_ind

Indicates if item is taxable.

Valid values are:

  • y for yes

  • n for no

char(1)

Return Reason Code

return_reason_code

Describes the reason why an item was returned (in case of return transactions).

char(50)

Original Purchase Order Id

original_purchase_order_id

Original purchase order ID.

char(200)

Original Source Transaction Id

original_source_transaction_id

Original transaction number. 

char(200)

Original Source Location Id

original_source_location_id

Original transaction location ID.

char(128)

Original Register Number

original_register_num

Original register number.

bigint

Original Transaction Datetime

original_transaction_datetime

Original transaction datetime.

datetime

Global Original Net Sales Amount

global_original_net_sales_amount

Original net sales amount in global currency.

numeric(20,6)

Local Original Net Sales Amount

local_original_net_sales_amount

Original net sales amount in local currency.

numeric(20,6)

Global Original Total Item Amount

global_original_total_item_amount

Original total item amount in global currency.

numeric(20,6)

Local Original Total Item Amount

local_original_total_item_amount

Original total item amount in local currency.

numeric(20,6)

Global Original Item Discount Amount

global_original_item_discount_amount

Original item discount amount in global currency.

numeric(20,6)

Local Original Item Discount Amount

local_original_item_discount_amount

Original item discount amount in local currency.

numeric(20,6)

Global Original Item Tax Amount

global_original_item_tax_amount

Original item tax amount in global currency.

numeric(20,6)

Local Original Item Tax Amount

local_original_item_tax_amount

Original item tax amount in local currency.

numeric(20,6)

Global Original Additional Tax Amount

global_original_addtl_tax_amount

Original additional tax amount in global currency.

numeric(20,6)

Local Original Additional Tax Amount

local_original_addtl_tax_amount

Original additional tax amount in local currency.

numeric(20,6)

Source Record Create Datetime

source_rec_create_datetime

The datetime when the record was created at source system (YYYY-MM-DD HH:mm:ss). 

datetime

Source Record Update Datetime

source_rec_update_datetime

The datetime of the latest update of the record at source system (YYYY-MM-DD HH:mm:ss).

datetime

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.