Redpoint Best Practices Documentation
Breadcrumbs

Transaction header feed layout definition

Overview

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.

N/A

Business Unit Code

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

This field is used in aggregate calculations.

char(50)

Customer/buyer and ship to section

Business name

Field name

Description

Field data type/length

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. Uses source_party_profile_id + business_unit_code for lookup.

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 (e.g., R & J Electrical).

char(256)

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 (defaults to 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

Business name

Field name

Description

Field data type/length

Transaction Datetime

transaction_datetime

(Required) Date 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) 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 (should be negative for "returned" status).

numeric(20,6)

Local Total Transaction Amount

local_total_transaction_amount

Total transaction amount in local currency (should be negative for “returned” status).

numeric(20,6)

Global Sub Total Transaction Amount

global_sub_total_transaction_amount

Subtotal amount of the transaction before taxes and fees in global currency (should be negative for "returned" status).

numeric(20,6)

Local Sub Total Transaction Amount

local_sub_total_transaction_amount

Subtotal amount of the transaction before taxes and fees in local currency (should be negative for "returned" status).

numeric(20,6)

Global Total Discount Amount

global_total_discount_amount

Total amount of all discounts applied for entire purchase in global currency (should be negative for "returned" status).

numeric(20,6)

Local Total Discount Amount

local_total_discount_amount

Total amount of all discounts applied for entire purchase in local currency (should be negative for "returned" status).

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 (should be negative for "returned" status).

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 (should be negative for "returned" status).

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 (should be negative for "returned" status).

numeric(20,6)

Local Total Tax Amount

local_total_tax_amount

Total tax amount applied for entire purchase in local currency (should be negative for "returned" status).

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 (should be negative for "returned" status).

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 (should be negative for "returned" status).

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)

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