...
| Table of Contents | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
Overview
This page lists test cases that we recommend FZ’s operators and POS/Kiosk vendors to follow when developing an In-Restaurant integration to RBI Loyalty. All Data Loyalty data events, attributes and explanations describtions are outlined here.
Test Cases for In-
...
Restaurant Loyalty
Please follow all test cases for all different POS and Kiosk vendors in the market. :
For Rewards, run all test cases with
all reward types available: item rewards, combo rewards, reward discounts, and rewards redeemable for points and euros.
For Offers, run all test cases with all
offer types available:
Systemwide, Personalized, and Discounted Offers.
For Data events, check that all events and their properties are being triggered successfully
Kiosk
Identifying user
...
Identify user with 6 digit Loyalty OTP or scanning Loyalty QR code, select menu item, Offer and/or Reward in the kiosk and check if correct amount of points is added to user balance
...
For deposits, ensure they are not counted towards loyalty points
1. Kiosk / POS
1.1. Scanning loyalty code
Steps | Expected Results | Data Events |
|---|---|---|
User inputs 6 digit Loyalty code or scans Loyalty QR code | User sees success modal in the app | The event |
User pre-selects a reward and inputs 6 digit Loyalty code or scans Loyalty QR code |
| The event |
User pre-selects an offer and inputs 6 digit Loyalty code or scans Loyalty QR code |
| The event |
1.2. Validation
Steps | Expected Results | Data Events |
|---|---|---|
User inputs 6 digit Loyalty code or scans Loyalty QR code |
Transaction Validate endpoint
...
User sees success modal in the app | The event |
User that has no other items in the basket attempts to add an Offer that has a minimum spend of $5 required |
...
. Loyalty API will return error and error message will show in the Kiosk showing that at least $5 needs to be added to check for offer to be redeemed in Kiosk. | Loyalty API will return error and error message will show in the Kiosk showing that at least $5 needs to be added to check for offer to be redeemed in Kiosk. |
*Please test all potential rule validation errors and responses described in this document
Earning loyalty points
...
Pre-select Offer in the app, login to Kiosk and complete transaction and check if correct amount of points is added to user balance
...
Identify user with 6 digit Loyalty OTP or scanning Loyalty QR code, select offer and/or Menu Item in the POS and check if correct amount of points is added to user balance
...
Adding more than 1 offer per order, completing transaction and checking if correct amount of loyalty points is added to user balance
*This test case assumes the market you are testing for allows for more than 1 Offer per order
...
Loyalty Receipt match content added in Sanity and structure specification of vendor
Full list of rules to be tested here: Loyalty API v1 - Error Responses | N / A |
1.3. Earning loyalty points
Steps | Expected Results | Data Events |
|---|---|---|
Pre-select offer in the app, scan loyalty code at Kiosk/POS and complete transaction with Offer |
| these events are fired:
|
Input 6 digit Loyalty code or scan QR code, then select offer and/or menu item in the Kiosk/POS |
| these events are fired:
|
...
|
...
If Rewards are included in the purchase, the event Reward Redeemed In Store is also fired
...
|
...
Burning loyalty points
|
Pre-select |
...
offer in the app |
...
and input 6 digit Loyalty |
...
Adding more than 1 reward per order, completing transaction and checking if correct amount of loyalty points is removed from user balance
...
code at Kiosk/POS. Then select a second offer in the Kiosk/POS. |
|
...
these events are fired:
|
...
|
...
...
If Rewards are included in the purchase, the event Reward Redeemed In Store is also fired
|
...
|
1.4. Burning loyalty points
Steps | Expected Results | Data Events |
|---|---|---|
Pre-select |
...
reward in the app, |
...
Pre-select Reward in the app, login to POS, add a menu item in the POS, complete transaction, and check if correct amount of points is added and removed from final user balance
...
Identify user with 6 digit Loyalty OTP or scanning Loyalty QR code, add offer and/or reward and/or menu item in the POS and check if correct amount of points is added and removed from final user balance
Adding more than 1 reward and more than 1 offer per order, completing transaction and checking if correct amount of loyalty points is added and removed from user balance
...
scan loyalty code at Kiosk/POS and complete transaction with Offer |
| these events are fired:
|
Input 6 digit Loyalty code or scan QR code, then select a reward in the Kiosk/POS |
|
...
these events are fired:
|
...
|
...
...
|
...
|
...
Void Transaction / Cancelling Loyalty Transaction
User pre-selects Offer and/or Reward in the app, logins to the Kiosk, BUT decides not to finish order in the Kiosk → WHEN Kiosk times out (session closes), Kiosk vendor sends VOID transaction to Loyalty API and user loyalty points returns to previous balance before transaction was started
User pre-selects Offer and/or Reward in the app, logins to the Kiosk, BUT Payment fails at checkout and/or Order fails to inject into POS, THEN Kiosk vendor sends VOID transaction to Loyalty API and user loyalty points returns to previous balance before transaction was started
User pre-selects Offer and/or Reward in the app, logins to the Kiosk, BUT the Reward and/or Offer fails to be added to Kiosk → IF user decides to re-scan Loyalty OTP code, THEN Kiosk vendor sends VOID transaction to Loyalty API and user loyalty points returns to previous balance before user begins a new transaction
Data events: the event
Loyalty Transaction Voidedis triggered at this time
POS
Identifying user
...
Identify user with 6 digit Loyalty OTP or scanning Loyalty QR code, select menu item, Offer and/or Reward in the POS and check if correct amount of points is added to user balance
...
| ||
Pre-select reward in the app and input 6 digit Loyalty code at Kiosk/POS. Then select a second reward in the Kiosk/POS. |
| these events are fired:
|
...
|
...
...
|
...
|
...
Transaction Validate endpoint
User logins with Loyalty into POS, and adds an Offer that has a minimum spend of $5 required with no other menu item selected in the POS. Loyalty API will return error and error message will show in the POS showing that at least $5 needs to be added to check for offer to be redeemed in POS.
*Please test all potential rule validation errors and responses described in this document
Earning loyalty points
...
Pre-select Offer in the app, login to POS and complete transaction and check if correct amount of points is added to user balance
...
Identify user with 6 digit Loyalty OTP or scanning Loyalty QR code, select offer and/or Menu Item in the POS and check if correct amount of points is added to user balance
...
Adding more than 1 offer per order, completing transaction and checking if correct amount of loyalty points is added to user balance
*This test case assumes the market you are testing for allows for more than 1 Offer per order
|
1.5. Earning and burning loyalty points
Steps | Expected Results | Data Events |
|---|---|---|
Pre-select reward and an offer in the app, and scan loyalty code at Kiosk/POS. Complete order with offer and reward. |
|
...
these events are fired:
|
...
|
...
...
|
...
|
...
Burning loyalty points
Pre-select |
...
reward in the app |
...
and input 6 digit Loyalty |
...
code or |
...
scan QR code |
...
. Then, add a menu item in the Kiosk/POS |
...
, and complete the transaction. |
|
...
|
...
|
...
*This test case assumes the market you are testing for allows for more than 1 Reward per order
|
...
these events are fired:
|
...
|
...
...
|
...
|
...
Earning and Burning
...
Pre-select Reward and Offer in the app, login to POS, complete transaction and check if correct amount of points is added and removed from final user balance
...
Pre-select Reward in the app, login to POS, add a menu item in the POS, complete transaction, and check if correct amount of points is added and removed from final user balance
...
Identify user with 6 digit Loyalty OTP or scanning Loyalty QR code, add offer and/or reward and/or menu item in the POS and check if correct amount of points is added and removed from final user balance
...
Adding more than 1 reward and more than 1 offer per order, completing transaction and checking if correct amount of loyalty points is added and removed from user balance
*This test case assumes the market you are testing for allows for more than 1 Reward and more than 1 Offer to be added per order
...
Loyalty Receipt match content added in Sanity and structure specification of vendor
...
Input 6 digit loyalty code or scan QR code. Then, add a menu item, an offer, and a reward in the Kiosk/POS, and complete the transaction. |
| these events are fired:
|
Input 6 digit loyalty code or scan QR code. Then, add a menu item, 2 (or more) offers, and 2 (or more) rewards in the Kiosk/POS, and complete the transaction. |
| these events are fired:
|
...
|
...
...
|
...
|
...
Void Transaction / Cancelling Loyalty Transaction
...
|
1.6. Cancelling Transaction
Steps | Expected Results | Data Events |
|---|---|---|
Pre-select offer and/or reward in the app, and scan loyalty code at Kiosk/POS. User decides not to finish order in the Kiosk. |
| this event is fired:
|
Pre-select offer and/or reward in the app, and scan loyalty code at Kiosk/POS. Payment fails at checkout and/or order fails to inject in the POS. |
| this event is fired:
|
Pre-select offer and/or reward in the app, and scan loyalty code at Kiosk/POS but the reward or offer fails to be added to the kiosk and guest decides to scan a new loyalty code.
|
...
|
...
|
...
|
...
Data events: the event Loyalty Transaction Voided is triggered at this time
| these events are fired:
|
2. Kiosk & POS
2.1. Pay@Counter Test Cases
User logins in the Kiosk with or without pre-selected items, selects Pay@Counter, and completes purchase in the counter/POS successfully
User loyalty points with new order are updated before user pays for order in the counter/POS
Once user pays for order in the counter/POS successfully, then user continues with updated loyalty point balance
Data events: the event
Loyalty Transaction Claimedwhenchannel = RESTAURANTand the eventLoyalty Transaction Claimed In-storeare triggered at this timeIf Rewards are included in the purchase, the event
Reward Redeemed In Storeis also firedIf Offers are included in the purchase, the event
Offer Redeemed In-storeis also fired
User logins in the Kiosk with or without pre-selected items, selects Pay@Counter, and NEVER completes purchase in the counter/POS successfully
User loyalty points with new order are updated before user pays for order in the counter/POS
After X amount of time where this transaction was not closed in the counter/POS, POS vendor send VOID transaction to Loyalty API and user loyalty points returns to previous balance before transaction was started
Data events: the event
Loyalty Transaction VoidedandLoyalty Transaction Deletedare triggered at this time
Test Cases for In-Store Offers
- Open RBI app
- Go to your offer list (
/rewards/offers) - Click on the Offer you would like to test in-store
- Click on the button to
Use at Restaurant - Scan the in-store Offer QR Code or input the offer code in the respective POS/Kiosk vendor
- Check correct offer shows in POS/Kiosk screen
- Complete the transaction
- Confirm your Loyalty points balance increase by the correct amount
- Confirm your offer disappears from your offer list (*UNLESS specified otherwise with Sanity rulesets)
- Confirm the
Offer Redeem In-Storeevent is fired in Amplitude for your user and redeemed offer
Instructions for Integration Partners (Kiosk and POS)
Staging environment
For the purposes of testing, you will need access to a Staging environment. Please contact RBI to get:
...
More information about the Loyalty Middleware can be found here: Loyalty API
Generating OTP codes
To generate 6-digit codes for testing and identifying user, you will need to go to the RBI app on the Staging environment and:
...