Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Steps

Expected results (Kiosk)

Expected results (RBI app)

Loyalty API usage (Kiosk)

Guest opens the Loyalty code page on the RBI app

  • N/A

  • Loyalty code page is displayed:

  • No action

Guest taps on the Kiosk screen to start a new order

  • Loyalty sign in page shows up on the Kiosk and scanner becomes active

  • N/A

  • No action

Guest scans the loyalty code or inputs 6 digit code in Kiosk

  • Kiosk authenticates the guest and shows the home page

  • Scanner remains active

  • Guest receives a successful confirmation modal

  • Call the Identify endpoint, which will return the Loyalty User ID, loyalty points balance and a transaction ID

Guest opens an reward on the RBI app, chooses to redeem in restaurant

  • No action

  • Reward is added to the guest’s pre-selection

  • A unique reward code is generated

  • No action

Guest either scans the reward’s QR code or inputs 6 digit code into Kiosk

  • Pre-selected reward(s) are shown on the Kiosk and guest has an option to customize

  • Modal is shown to guest confirming that the reward has been added to cart

  • The reward’s loyalty points cost is temporarily subtracted from the guest’s loyalty points balance at this moment

  • Reward pre-selection is cleared

  • Keep track of the current basket contents including rewards

  • Call the Identify endpoint again, which will create a new transaction ID and return selected reward(s)

  • Void the previous transaction

  • Wait for Void Confirmation

  • Call the Update endpoint with all of the Kiosk basket contents and a status of PENDING

Guest customizes rewards at will and touches confirm

Info

Note: extra customization prices are controlled by market and Kiosk vendor (e.g. price for adding 5 extra patties to the selected reward)

  • These reward(s) are incrementally added to the cart and do not replace any of the existing cart items

  • No action

  • No action

On the Kiosk UI, navigates to the rewards page

Info

Note: this step is only possible if the market has decided to allow showing rewards on the UI.

  • Rewards are displayed

  • No action

Guest adds a reward to basket

  • Guest selects and adds reward to cart

  • These reward(s) are incrementally added to the cart and do not replace any of the existing cart items

  • The reward’s loyalty points cost is temporarily subtracted from the guest’s loyalty points balance in the app

  • No modal is shown

  • Call the Update endpoint with all of the Kiosk basket contents and a status of PENDING

Guest remove a reward from basket

  • Guest removes a reward from Kiosk basket

  • The reward’s loyalty points is temporarily added back to the guest’s loyalty points balance in the app

  • No modal is shown

  • Call the Update endpoint with all of the Kiosk basket contents and a status of PENDING

Guest goes to checkout screen

  • Guest sees list of all chosen items in basket

Info

Note: If an reward can’t be redeemed because the reward rules are not met, the Kiosk displays a modal to the guest explaining why the reward can’t be added to cart

  • No action

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

Guest checks out and pays

  • Order number shows up on the screen

  • Receipt is printed

  • Guest sees updated points balance

 

  • Call the Transaction Update endpoint with a status of CLAIMED

...