Order Details Data Mapping

The article below provides a data mapping table for the Order History and Order Refund pages in the POS app. It documents attributes displayed on both pages, listing the fields retrieved via the GET Order SPI (ordersearchv2) for reference in the Return Workflow and Order History.

Order History Data Mapping

Subsection	Label	Data Mapping Key
Order details cell	Order Placed	order.orderDate
Order details cell	Order Status	order.orderStatusText
Order details cell	Order Number	order.displayOrderId
Customer information cell	Store Associate	order.productList.salesAssociateAttribution.storeAssociateId <br>Note: Multiple store associate attributions are joined by ", "
Customer information cell	Phone	order.customerProfile.phoneMobile <br>Note: Formatted to phone number format
Customer information cell	Address	order.customerProfile.address.addressLine1
Customer information cell	Customer	order.customerProfile.firstName order.customerProfile.lastName <br>Note: First name and last name joined by " "
Customer information cell	Email	order.customerProfile.email
Product cell	Product Name	order.productList[n].name
Product cell	Product ID	order.productList[n].productId
Product cell	Product Image	order.productList[n].imageURL
Product cell	Color	order.productList[n].color
Product cell	Size	order.productList[n].size
Product cell	Unit Price	order.productList[n].price <br>Note: Key may change depending if store price and/or sale price is present
Product cell	Quantity	order.productList[n].quantity
Product cell	Subtotal	order.productList[n].subtotal
Product cell	Status	order.productList[n].orderStatusText
Order summary cell	Subtotal	order.orderSubTotal
Order summary cell	Discount	order.transactionDiscountAmount
Order summary cell	Net Subtotal	order.taxableAmount
Order summary cell	Shipping Costs	order.shippingSubTotal
Order summary cell	Tax	order.taxSubTotal <br>Note: If multiple taxes are applied, order.taxRates is used to list taxes
Order summary cell	Tax Exemption	order.taxExemption
Order summary cell	Rounding	order.tenders[n].roundingAmount
Order summary cell	Tip	order.tipTotal
Order summary cell	Order Total	order.totalAmount
Order status cell	Order Status	order.orderStatusText
Payment method cell	Tender Type	order.tenders[n].paymentMethod
Payment method cell	Tender Amount	order.tenders[n].amountAuthorized
Notes	Notes	order.notesList

Order History

Order Refund Data Mapping


Subsection	Label	Data Mapping Key
Order details cell	Order Number	order.orderID
Order details cell	Shipped To	order.billingName
Order details cell	Payment method	order.tenders[n].paymentMethod
Order details cell	Address	order.shippingAddress
Order details cell	Order Date	order.orderDate
Return product cell	Product Name	order.productList[n].name
Return product cell	Product ID	order.productList[n].productId
Return product cell	Product Image	order.productList[n].imageURL
Return product cell	Color	order.productList[n].color
Return product cell	Size	order.productList[n].size
Return product cell	Unit price	order.productList[n].price
Return product cell	Quantity	order.productList[n].quantity
Return product cell	Subtotal	order.productList[n].subtotal
Refund summary cell	Subtotal	subTotal Note: Sum of each selected refund products
Refund summary cell	Discount	discount Note: Sum of each selected refund products
Refund summary cell	Net Subtotal	subTotal - discount Note: Sum of each selected refund products
Refund summary cell	Tax	tax Note: Sum of each selected refund products
Refund summary cell	Tax Exemption	taxExemption Note: Sum of each selected refund products
Refund summary cell	Refund Total	total Note: Sum of each selected refund products

Order Refund