Steps | Expected results (POS) | Expected results (RBI app) | Loyalty API usage (POS) |
---|
Guest opens an offer on the RBI app | | | |
Guest taps “Use at restaurant” | | | | Guest taps on the Kiosk screen to start a new order | |
N/A Cashier is prompted whether the Guest has loyalty, and confirms | Image Added | | |
Guest either scans the offer’s QR offer code, or inputs tells the 6 digit code into Kiosk Info |
---|
Note: if a user pre-selects more offers in the app, all pre-selected offers will show in the Kiosk screen after scanning with an option for the user to customize each offer | User to the cashier | Image RemovedLoyalty points balance is not updated, since the guest is scanning an offer Offer Either by scanning or entering the code, POS confirms successful identification (since the offer code also identifies the Loyalty user): Image Added | Image Added | Call the Identify endpoint, which will return the Loyalty User ID, a list of offer(s) pre-selected, loyalty points balance and a transaction ID The Loyalty API will know this store does not have Loyalty enabled
|
Guest customizes offers at will and adds to basket | Info |
---|
Note: If an offer can’t be redeemed because the offer rules are not met, the Kiosk displays a modal to the guest explaining why the offer can’t be added to cart |
| | Call the Transaction Validate endpoint to verify that the current basket selection is valid Note that the call above may return errors. Please refer to Loyalty API - Error List for details. The Validate call will return an error if any Rewards are added to cart
| Guest opens a second offer on the RBI app, chooses to redeem in restaurant Info |
---|
Note: the flow is exactly the same if the guest pre-selects multiple offers. |
| | Image Added | |
Guest either scans the offer’s QR code, or inputs tells the 6 digit code into Kiosk Info |
---|
Note: if a user pre-selects more offers in the app, all pre-selected offers will show in the Kiosk screen after scanning with an option for the user to customize each offer | Image Removedto the cashier | Image Added | Image RemovedImage AddedLoyalty points balance is not updated, since the guest is scanning an offer Offer pre-selection is cleared
| Keep track of the current basket contents including offers Void the previous transaction Call the Identify endpoint again, which will create a new transaction ID and selected offers Update the basket with the offers returned
|
Guest customizes offers at will and adds Cashier adds offer to basket | Image Removed Info |
---|
Note: If an offer a reward can’t be redeemed because the offer rules are not met, the Kiosk POS displays a modal to the guest cashier explaining why the offer reward can’t be added to cart |
| | Call the Transaction Validate endpoint to verify that the current basket selection is valid Note that the call above may return errors. Please refer to Loyalty API v1 - Error ListResponses for details.
|
Cashier checks out and pays | | | Call the Transaction Update endpoint with a status of CLAIMED to complete the order After this call it is not possible to modify the loyalty transaction anymore Once this transaction is CLAIMED no Loyalty points are updated in the user’s balance
|