You are here:
View Order History on POS App
The POS app allows store associates to query the order history to list orders. Store associates may choose from several filters to narrow down the search. This screen may be accessed through a deep link. This article will go over the configuration needed to implement this feature as well as an overview of the app flow.
Order History Layout provides the flexibility to design the order history screen as per the merchant’s requirement. The layout can be configured with the default filters for search results and also have additional manual lookup filters using the deep links that are newly added in CMS as a part of this requirement.
Create Order History Layout
The order history layout can be configured with the desired filter deep links and a result view to see the order history results. This can be accessed and configured in CMS by going to .
Order History Layout Components in CMS
Below are the new CMS elements added to achieve the same.
-
Additional filter parameters to existing Order History deep link: These filters will
restrict the POS app to show the orders specific to the store ID configured in the order
history deep link. In case a Store ID parameter is set, this will be the default in the
searches and will not be editable. Otherwise, the parameter will default to the store
associate's current store and will be editable.
-
New deep links for Order History layout
- Order history search by customer
- Order history search by filters
- Order history search by receipt
- Order history search by credit Card
-
Order search results view: The results view displays the search results filtered by
criteria given using any of the above deep links. It can be seen under Cell Content on the
Layout Edit page.
Assign Order History Layout
Once the layout has been created, assign it to an app config.
- In CMS, go to .
- Edit the app config that will have the new layout displayed.
- Go to .
-
Under Order Search Layout, select the created layout.
POS Behavior
Get details of the app UI that corresponds to each of the deep links. The app presents the UI as interstitials in the Order History layout.
Order History Search by Receipt
If the merchant supports manual receipt (applicable for the Portugal region with fiscalization), the app will show the below receipt search screen.
This UI will show up if the app user is in Portugal and the fiscalization ('fiscalizationEnabled') CMS flag is on.
For other customers without the manual receipt feature, the below screen is shown for receipt-based search.
Order Search Results View
The results view displays the search results filtered by the input criteria provided in the above screens.
By default, the app will fetch the current store's orders for the day and display them. If a Store ID parameter is set to the deep link, it will show the orders for that store instead. If no orders have been placed for the day, then the app will display a message indicating so.
Order History Details
You can tap an order in the Order History to view additional details such as the order date, order status, order number, item description, applied discounts, etc.
Modify Order
If the edit order function is enabled, on the Order History Details screen, you can modify unfulfilled orders or apply appeasements. To do so, tap More Options at the bottom of the screen, then select Modify Order.
For more information on the supported functionality for editing orders and providing appeasement, refer to Supported Functionalities by Edit Order Types.
Start Return
For app builds 10.5.1 and later, you can initiate a return or exchange process for an order on the Order History Details screen. If the edit order function is disabled, tap Start Return at the bottom of the screen. If the edit order function is enabled, tap More Options at the bottom of the screen, and then select Modify Order.
If the edit order function is enabled, tap More Options at the bottom of the screen, and then select Modify Order.
Known Issues and Restrictions
- The only allowed tenders for filtering are Credit Card, Cash, and Gift Card. Orders cannot be filtered by Afterpay, Check, Finance, ACH, Miscellaneous, Apple Pay, Store Credit, Cash On Delivery, Card On Delivery, Paypal, Order Credit, Pay By Link, or Rewards.
- The allowed statuses for filtering are Canceled, Completed, Partially Refunded, Partially Exchanged, Returned, and Exchanged. They cannot be filtered by Pick, Ship, Pack, Ready, Shipped, Delivered, Damaged, Unavailable, Store Pickup, Store Fulfillment, Others, Partially shipped, Recreated, Returned Without Receipt, Failed, Fulfilled, or Pending.
- Item list in an order is sorted by the orderItemId.
