Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

Contents

Overview

This page lists test cases that we recommend operators and POS/Kiosk vendors to follow when developing an In-Restaurant integration to RBI Loyalty. All Loyalty data events, attributes and 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: Loyalty & Offers Events (Conversion)

  • 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 Loyalty Transaction Created is triggered at this time

User pre-selects a reward and inputs 6 digit Loyalty code or scans Loyalty QR code

  • User sees success modal in the app

  • User sees rewards cost temporarily removed from user balance

The event Loyalty Transaction Created is triggered at this time

User pre-selects an offer and inputs 6 digit Loyalty code or scans Loyalty QR code

  • User sees success modal in the app

  • User loyalty point balance does not change

The event Loyalty Transaction Created is triggered at this time

1.2. Validation

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 Loyalty Transaction Created is triggered at this time

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.

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:

  • Loyalty Transaction Claimed when channel = RESTAURANT

  • Loyalty Transaction Claimed In-store

  • Offer Redeemed In-store if offers are included in the order

Input 6 digit Loyalty code or scan QR code, then select offer and/or menu item in the Kiosk/POS

these events are fired:

  • Loyalty Transaction Claimed when channel = RESTAURANT

  • Loyalty Transaction Claimed In-store

  • Offer Redeemed In-store if offers are included in the order

Pre-select offer in the app and input 6 digit Loyalty code at Kiosk/POS. Then select a second offer in the Kiosk/POS.

  • Correct amount of loyalty points are added to user’s balance with 2 offers added to order.

  • Loyalty Receipt match content added in Sanity:/wiki/spaces/HELP/pages/5019500623

these events are fired:

  • Loyalty Transaction Claimed when channel = RESTAURANT

  • Loyalty Transaction Claimed In-store

  • Offer Redeemed In-store is triggered twice.

1.4. Burning loyalty points

Steps

Expected Results

Data Events

Pre-select reward in the app, scan loyalty code at Kiosk/POS and complete transaction with Offer

these events are fired:

  • Loyalty Transaction Claimed when channel = RESTAURANT

  • Loyalty Transaction Claimed In-store

  • Reward Redeemed In-store

Input 6 digit Loyalty code or scan QR code, then select a reward in the Kiosk/POS

these events are fired:

  • Loyalty Transaction Claimed when channel = RESTAURANT

  • Loyalty Transaction Claimed In-store

  • Reward Redeemed In-store if rewards are included in the order

Pre-select reward in the app and input 6 digit Loyalty code at Kiosk/POS. Then select a second reward in the Kiosk/POS.

  • Correct amount of loyalty points are removed from user’s balance with 2 rewards included in the order.

  • Loyalty Receipt match content added in Sanity:/wiki/spaces/HELP/pages/5019500623

these events are fired:

  • Loyalty Transaction Claimed when channel = RESTAURANT

  • Loyalty Transaction Claimed In-store

  • Reward Redeemed In-store is triggered twice.

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.

  • Correct amount of loyalty points are added and removed from user’s loyalty point balance.

  • Loyalty Receipt match content added in Sanity:/wiki/spaces/HELP/pages/5019500623

these events are fired:

  • Loyalty Transaction Claimed when channel = RESTAURANT

  • Loyalty Transaction Claimed In-store

  • Reward Redeemed In-store

  • Offer Redeemed In-store

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.

  • Correct amount of loyalty points are added and removed from user’s loyalty point balance.

  • Loyalty Receipt match content added in Sanity:/wiki/spaces/HELP/pages/5019500623

these events are fired:

  • Loyalty Transaction Claimed when channel = RESTAURANT

  • Loyalty Transaction Claimed In-store

  • Reward Redeemed In-store

  • Offer Redeemed In-store

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.

  • Correct amount of loyalty points are added and removed from user’s loyalty point balance.

  • Loyalty Receipt match content added in Sanity:/wiki/spaces/HELP/pages/5019500623

these events are fired:

  • Loyalty Transaction Claimed when channel = RESTAURANT

  • Loyalty Transaction Claimed In-store

  • Reward Redeemed In-store

  • Offer Redeemed In-store

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.

  • Correct amount of loyalty points are added and removed from user’s loyalty point balance.

  • Loyalty Receipt match content added in Sanity:/wiki/spaces/HELP/pages/5019500623

these events are fired:

  • Loyalty Transaction Claimed when channel = RESTAURANT

  • Loyalty Transaction Claimed In-store

  • Reward Redeemed In-store is triggered twice assuming there are 2 rewards in the order.

  • Offer Redeemed In-store is triggered twice assuming there are 2 offers in the order.

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.

  • Kiosk sessions times out and session closes.

  • Loyalty points balance of user returns to what it was before the user began the order.

this event is fired:

  • Loyalty Transaction Voided

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.

  • Error is shown to guest or operator

  • Loyalty points balance of user returns to what it was before the user began the order.

this event is fired:

  • Loyalty Transaction Voided

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.

  • 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

  • Loyalty points balance of user returns to what it was before the user began the order.

these events are fired:

  • Loyalty Transaction Voided

  • Loyalty Transaction Created

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 Claimed when channel = RESTAURANT and the event Loyalty Transaction Claimed In-store are triggered at this time

      • If Rewards are included in the purchase, the event Reward Redeemed In Store is also fired

      • If Offers are included in the purchase, the event Offer Redeemed In-store is 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 Voided and Loyalty Transaction Deleted are 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-Store event 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:

  • A URL for the Loyalty (Staging) environment. This will be used to make calls to the Loyalty Middleware endpoints. and credentials to the correct environment. URL’s should have the following format, for example for the identify endpoint: https://euc1-staging-{brand}-loyalty-middleware.rbictg.com/loyalty/identify

  • Credentials to use the environment above

  • A URL for the RBI app (Staging). This will be used to simulate guest actions such as generating OTP codes or redeeming rewards and offers.

  • A password to access the environment above

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:

  • Create a new account with your choice of email address

  • Toggle the mobile view on your browser by using responsive mode

  • Click “My Code”. The My Code page with the OTP will look something like this (BK shown in the example below):

  • No labels