Rewards - Configuration Guide
- Lopes da Costa, Valentina
- Silva, Carlos
Contents
Overview - What’s a Reward?
A reward is an item or combo that can be ordered in exchange for loyalty points. For example, you can get a free Nuggets (x6) reward by spending 150 loyalty points. Only customers that have 150 loyalty points will be eligible to redeem a Nuggets (x6) reward.
Although the majority of rewards are 0 priced, some rewards may have a price. This means that customers need to spend loyalty points and paid money to be able to use that reward.
Configuration steps
Before creating the reward in Sanity it is important you connect with your POS (Point of Sale) vendor to create, price and make the reward available with a unique PLU (Price Look-Up). Save this PLU and be ready to configure it in Sanity when creating the reward.
Always create a reward in the Staging environment in Sanity first (https://staging.menu.{brand}.{country}.rbi.tools/desk/). This will allow you to make changes and test the reward with no impact to the live app. To test that rewards are working as expected, you can use the Whitelabel App Staging environment (https://staging-{brand}-web.{country}.rbi.tools/). Rewards published in the Sanity Staging environment are only visible in the Whitelabel App Staging environment.
After testing, you can migrate the reward to higher environments (QA and Production). When you migrate rewards to the Production environment, these will become available to guests.
Sanity Migrations allow you to independently migrate content from Staging to different environments. You can therefore implement reward changes in Staging environment, test them, and afterwards push those changes to QA and Production. All this is accomplished with some clicks in the User Interface of Sanity.
Step 1: Adding Rewards
To create a new reward, click on the '+' at the top of the page:
Step 2: Content Section
We’ve broken up content fields and reward mechanic fields to make it easier to create and update rewards. The key distinction between the two is that ‘mechanics’ fields have a direct impact on the functionality of the reward, and ‘content’ fields only are purely visual and only impact the UI of a reward in the app / website.
Loyalty Engine ID
This is populated automatically. No update needed here.
Name
This is the name of the reward that will show in the platform, so must be edited according to your marketing guidelines.
Internal Name
The name that will be displayed in Sanity - it will help you quickly identify and organize your rewards.
Description
This is the description of the reward once it is clicked on.
Image
This is the image that is shown for the reward.
Best Practices Tip
Remember choosing a picture without a background will look better, remove noise, and turn the guest’s focus to the actual purchase
From the above example:
Image Description
This will be the text for the alt attribute on the image.
Background Image:
This is where you can input a background to your image if applicable (optional)
Step 3: Mechanics Section
The fields under the ‘mechanics’ dropdown control the functionality of the reward. An example of this is the rules the reward should respect when showing in the app (e.g. only redeemable once per user).
Rules:
Every reward must have the rule Loyalty Points configured. In this rule, you must specify how many loyalty points the customer will need to spend in order to redeem this reward (e.g. 400 points)
Other optional rules that can be applied to Reward: https://rbictg.atlassian.net/wiki/spaces/COG/pages/4862509059
For NCR it is not possible to create a reward with an item incentive. Please create all rewards with combos containing a marker item as explained here: https://rbictg.atlassian.net/wiki/spaces/COG/pages/3445949405/Combo#Marker-Items
Incentive
Either an item, combo, picker or discount that is the benefit of your reward. For item, combos, and pickers this is the original item or combo from the menu.
If your benefit is a discount please refer to: https://rbictg.atlassian.net/wiki/spaces/COG/pages/4707549242
Vendor Configs
A unique PLU for the reward. The PLU Type needs to be set to Constantplu and numbered value of the PLU needs to be inputted below Constant PLU.
In general, this PLU will have the price of 0. There are exceptions, if your reward can be redeemed for a price in combination with loyalty points.
Test Only
If this toggle is turned on the reward will only be available in lower environment (Dev, Staging and QA). Even if the reward is accidentally pushed to Production, it will not show up for users in the App.
Redemption Methods
The different ways the reward can be redeemed in the platform:
Restaurant Only: Reward can only be redeemable in Restaurant at Kiosk or POS
Mobile Only: Reward can only be redeemable in online ordering for both web and app
Mobile and Restaurant: Reward can be redeemable in both online and in-restaurant orders
Step 4: Publish
Publish your reward when complete. After publishing, you should see the Loyalty Engine ID field populate.
Step 5: Set the position of the reward
Navigate to Order-Level Content > Loyalty & Offers > Incentives > Rewards > Rewards List and add your reward within one of the categories. Then, inside each category drag the reward to the position you want it to show in the rewards list and click on “Publish”. For more information on the Rewards List, please read: https://rbictg.atlassian.net/wiki/spaces/COG/pages/4987486250
Once published, you will see the reward populate on the rewards list page (navigate to reward’s list: /rewards/list) in the app.
Step 6: Test the reward
Go to the Staging environment in the app (https://staging-{brand}-web.{country}.rbi.tools/rewards/list) and test:
Redeeming the reward(s) online. Check for content, pricing and success of order. Read here for more information on the online ordering flow: https://rbictg.atlassian.net/wiki/spaces/COG/pages/4962549800
Redeeming the reward(s) in restaurant. To test ordering the reward in-restaurant, connect with your POS and Kiosk vendor(s) to setup a lab environment for you to test. Read here for more information on the in restaurant ordering flow: https://rbictg.atlassian.net/wiki/spaces/COG/pages/4962975790
Step 7: Migrate to Production
After thoroughly testing your reward is working in Staging environment, follow this guide to migrate the offer from Staging environment to QA and Production environments: Menu - Content Migration.
Further reading
This document is meant to explain how to configure a reward, but does not detail all the different options that can be used for rewards. Please refer to the Rewards - Reference Guide.