Transaction feed layout definition

System of Record Name

sor_name

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

 N/A

Business Unit Code

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 BUSINESS_UNIT_LOOKUP; NULL values will default to enterprise. Refer to Business unit for details.

char(50)

Customer/ Buyer and Ship to Section

Source Party Profile Id

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.

This field is used in aggregate calculations.

char(320)

Source Customer Account Id

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.

char(320)

Source Loyalty Account Id

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.

char(320)

Business Name

business_name

Business Name of the customer - small Business (R & J Electrical). 

char(256)

Bill To Full Name

bill_to_full_name

Bill to customer's full name.

char(200)

Bill To Prefix Name

bill_to_prefix_name

Bill to customer's prefix name (Mrs./Mr.).

char(32)

Bill To Title

bill_to_title

Bill to customer's title (Dr.).

char(30)

Bill To First Name

bill_to_first_name

Bill to customer's first name.

This field is used in aggregate calculations.

char(60)

Bill To Middle Name

bill_to_middle_name

Bill to customer's middle name.

This field is used in aggregate calculations.

char(40)

Bill To Last Name

bill_to_last_name

Bill to customer's last name.

This field is used in aggregate calculations.

char(70)

Bill To Suffix Name

bill_to_suffix_name

Bill to customer's suffix name.

This field is used in aggregate calculations.

char(15)

Bill To Address 1

bill_to_address_1

Billing Address Line 1.

This field is used in aggregate calculations.

char(128)

Bill To Address 2

bill_to_address_2

Billing Address Line 2.

This field is used in aggregate calculations.

char(128)

Bill To Address 3

bill_to_address_3

Billing Address Line 3.

char(128)

Bill To Address 4

bill_to_address_4

Billing Address Line 4.

char(128)

Bill To City

bill_to_city

Billing City Name.

This field is used in aggregate calculations.

char(64)

Bill To State Province

bill_to_state_province

Billing State Code.

This field is used in aggregate calculations.

char(64)

Bill To Postal Code

bill_to_postal_code

Billing Postal Code.

This field is used in aggregate calculations.

char(16)

Bill To Country Code

bill_to_country_code

Billing Country ISO 2 char code (US).

This field is used in aggregate calculations.

char(2)

Bill To Home Phone Country Code

bill_to_home_phone_country_code

ISO standard 2 char code Country Code of home phone.  

char(2)

Bill To Home Phone Number

bill_to_home_phone_num

Customer's bill to home phone number including area code.

This field is used in aggregate calculations. 

char(32)

Bill To Mobile Phone Country Code

bill_to_mobile_phone_country_code

ISO standard 2 char code Country Code of mobile phone.  

char(2)

Bill To Mobile Phone Number

bill_to_mobile_phone_num

Customer's bill to cell phone number including area code.

This field is used in aggregate calculations. 

char(32)

Bill To Work Phone Country Code

bill_to_work_phone_country_code

ISO standard 2 char code Country Code of work phone.  

char(2)

Bill To Work Phone Number

bill_to_work_phone_num

Customer's bill to work phone number including area code.

This field is used in aggregate calculations. 

char(32)

Bill To Other Phone Country Code

bill_to_other_phone_country_code

ISO standard 2 char code Country Code of other phone.  

char(2)

Bill To Other Phone Number

bill_to_other_phone_num

Customer's bill to “other" phone number including area code.

This field is used in aggregate calculations. 

char(32)

Bill To Other Phone Type Code

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 PHONE_TYPE_LOOKUP. Refer to Phone type for details.

char(50)

Bill To Email Address

bill_to_email_address

Bill to customer's email address.

This field is used in aggregate calculations.

char(320)

Ship To Full Name

ship_to_full_name

Ship to customer's full name.

char(200)

Ship To Prefix Name

ship_to_prefix_name

Ship to customer's prefix name.

char(32)

Ship To Title

ship_to_title

Ship to customer's title (Dr.).

char(30)

Ship To First Name

ship_to_first_name

Ship to customer's first name.

char(60)

Ship To Middle Name

ship_to_middle_name

Ship to customer's middle name.

char(40)

Ship To Last Name

ship_to_last_name

Ship to customer's last name.

char(70)

Ship To Suffix Name

ship_to_suffix_name

Ship to customer's suffix name.

char(15)

Ship To Address 1

ship_to_address_1

Shipping Address Line 1.

char(128)

Ship To Address 2

ship_to_address_2

Shipping Address Line 2.

char(128)

Ship To Address 3

ship_to_address_3

Shipping Address Line 3.

char(128)

Ship To Address 4

ship_to_address_4

Shipping Address Line 4.

char(128)

Ship To City

ship_to_city

Shipping City Name.

char(64)

Ship To State Province

ship_to_state_province

Shipping State Code.

char(64)

Ship To Postal Code

ship_to_postal_code

Shipping Postal Code.

char(16)

Ship To Country Code

ship_to_country_code

Shipping Country ISO 2 char code (US).

char(2)

Ship To Phone Number

ship_to_phone_num

Ship to phone number including area code. 

char(32)

Ship To Email Address

ship_to_email_address

Ship to customer's email address.

char(320)

Transaction Header Section

Transaction Datetime

transaction_datetime

(Required) Date and time when transaction occurred.

YYYY-MM-DD HH:mm:ss

This field is used in aggregate calculations.

datetime

Purchase Order Id

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.

char(200)

Source Transaction Id

source_transaction_id

(Required) This field is the natural primary key.

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)

Pos Transaction Id

pos_transaction_id

(Required for POS Transaction) Transaction number generated by POS system.  

char(200)

Invoice Number

invoice_num

Value that uniquely identifies invoice in the fulfillment system.

char(50)

Source Location Id

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.

char(100)

Register Number

register_num

ID of the register used for placing an order.

bigint

Transaction Type Code

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_TYPE_LOOKUP. Refer to Transaction type for details.

char(50)

Transaction Line Item Count

transaction_line_item_count

Total number of line items included in the transaction.

integer

Global Total Transaction Amount

global_total_transaction_amount

Total transaction amount in global currency.

numeric(20,6)

Local Total Transaction Amount

local_total_transaction_amount

Total transaction amount in local currency.

numeric(20,6)

Global Sub Total Transaction Amount

global_sub_total_transaction_amount

Sub total amount of the transaction before taxes and fees in global currency.

numeric(20,6)

Local Sub Total Transaction Amount

local_sub_total_transaction_amount

Sub total amount of the transaction before taxes and fees in local currency.

numeric(20,6)

Global Total Discount Amount

global_total_discount_amount

Total amount of all discounts applied for entire purchase in global currency.

numeric(20,6)

Local Total Discount Amount

local_total_discount_amount

Total amount of all discounts applied for entire purchase in local currency.

numeric(20,6)

Global Total Non Merchandise Amount

global_total_non_merchandise_amount

Non merchandise amount (includes Shipping and Restock Fee, Delivery Fee, any services fee) in global currency.

numeric(20,6)

Local Total Non Merchandise Amount

local_total_non_merchandise_amount

Non merchandise amount (includes Shipping and Restock Fee, Delivery Fee, any services fee) in local currency.

numeric(20,6)

Shipping Type Code

shipping_type_code

Shipping method used such as air, ground, store pickup, expedited, etc.

Values are defined as part of on-boarding, in SHIPPING_TYPE_LOOKUP. Refer to Shipping type for details.

char(50)

Customer Associate Id

customer_associate_id

An ID of associate that helped/ processed customer's transaction.

char(100)

Global Total Tax Amount

global_total_tax_amount

Total tax amount applied for entire purchase in global currency.

numeric(20,6)

Local Total Tax Amount

local_total_tax_amount

Total tax amount applied for entire purchase in local currency.

numeric(20,6)

Global Total Additional Tax Amount

global_total_addtl_tax_amount

Additional tax amount for entire purchase, like local tax in global currency.

numeric(20,6)

Local Total Additional Tax Amount

local_total_addtl_tax_amount

Additional tax amount for entire purchase, like local tax in local currency.

numeric(20,6)

Order Origin Name

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

char(250)

Employee Id

employee_id

When Customer is also an Employee, contains Employee Number. 

char(20)

Transaction Detail (Item) Section

Line Item Number

line_item_num

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

integer

Source Product Id

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.

char(200)

Transaction Detail Status Code

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 shipped should only be used by clients that also generate TXN Details with status ordered.  

This field is used in aggregate calculations.  

Values are defined as part of on-boarding, in TRANSACTION_DETAIL_STATUS_LOOKUP. Refer to Transaction detail status for details.

char(50)

Product Quantity

product_qty

Item quantity.

This field is used in aggregate calculations.

integer

Global Net Sales Amount

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.

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.

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.

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, this 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 equals $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.

• y = yes

• n = 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.

• y = yes

• n = no 

char(1)

Return Reason Code

return_reason_code

Describes the reason why an item was returned (for 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)