Versions Compared

Key

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

...

Steps

Expected results (POS)

Expected results (RBI app)

Loyalty API usage

Guest opens the Loyalty code page on the RBI app

  • N/A

  • Loyalty code page is displayed:

  • No action

Cashier is prompted to add a loyalty code

  • Cashier asked if guest is a loyalty member:

  • No action

  • No action

Guest either scans the loyalty code, or tells the 6 digit code to the cashier

  • If guest does not scan the QR code, cashier can enter the 6 digit Loyalty code:

  • Either by scanning or entering the code, POS confirms successful identification:

  • 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 requests cashier to add a an offer from POS

  • Cashier selects the offer and adds to order at POS

  • 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 v1 - Error Responses for details.

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

  • No action

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

  • A unique offer code is generated

  • No action

Guest either scans the offer’s QR code, or tells the 6 digit code to the cashier

  • Either by scanning or entering the code, POS confirms successful identification:

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

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

  • Loyalty 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 (keeping basket information)

  • Call the Identify endpoint again, which will create a new transaction ID and return selected offers

  • Update the basket with the offers returned

The cashier navigates to the offers page in the POS

  • Cashier sees all offers available for that user

  • No action

Cashier adds offer to basket

  • Added incrementally

Info

Note: If an offer can’t be redeemed because the offer rules are not met, the POS displays a modal to the cashier explaining why the offer 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 v1 - Error Responses for details.

Cashier finalizes the order and guest pays at POS

  • POS prints receipt with points earned & points balance

  • Guest sees updated points balance

 

  • After collecting the payment, 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

...