Versions Compared

Key

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

Contents

Table of Contents

...

Overview

The rewards program rules (e.g. expiration of loyalty points, points earned for every dollar spent) are set in a document called Earning Calculation in Sanity. To access this document navigate to: Order-Level Content > Loyalty&Offers > Loyalty Configuration > Earning Calculation in Sanity.

Core Metric

This is the basis for how loyalty points are earned in the rewards program. This needs to be set to Spend. This means guests earn loyalty points based on how much they spend.

Note

Visit and Hybrid were deprecated and are not in use.

...

Points per dollar

Configure how many loyalty points are earned for every dollar spent in the app.

Info

Note this is specific to the currency you use in your market (e.g. if the currency used to set the Loyalty & Offers Program rules and configurations.is euro, configure here how many loyalty points will be earned for every euro spent in the app)

...

Minimum Spend

The minimum transaction spend (in cents) that must be satisfied for a guest to earn loyalty points.

...

Cooldown Period

The minimum time (in seconds) between purchases for loyalty points earning and burning to be applied.

Initial User Points Balance

The initial loyalty points balance that will be assigned to a guest when he first signs up to the app when the market has rewards program enabled.

...

Loyalty Points Earn Moment

This field configures allows you to configure when your users will earn loyalty points for Click & Collect and Delivery orders: this will be either when the order is paid for in the app or when the order is delivered / picked up.

...

Click and Collect

Defines when loyalty points will be earned for Click & Collect orders (Pickup, Eat In, Table Service, Drive-Thru, Curbside Pickup). This can be either:

  1. After payment: loyalty points are assigned when guest completes the payment in the app OR

  2. When order is ready: loyalty points are assigned only when guest picks up order at the restaurant.

Info

Note: we recommend always implement option 2, due to fraud risk. Please note option 2 requires development work for the Partner to let RBI know when the order has been picked up. Please read more about Partners changing orders change to DONE status here.

Delivery orders

Defines when loyalty points will be earned for Delivery orders. This can be either:

  1. After payment: loyalty points are assigned when guest completes the payment in the app OR

  2. When order is delivered: loyalty points are assigned only when order is delivered to guest.

Info

Note: we recommend always implement option 2, due to fraud risk. Please note option 2 requires development work for the Partner to let RBI know when the order has been delivered. Please read more about Partners changing orders change to DONE status here.

Loyalty Points Calculation Using

This configuration allows you to control if loyalty points earning calculation is done based on only the Subtotal of the order or if it is done on Subtotal plus any of these other add ons: tax, delivery fee, service fee, bag tax.

Info

Note: the service fee depends on the enablement and configuration of the tiered fees values. For enablement of service fees, please reach out to your Customer Success Manager.

...

Exclude from Loyalty Point Calculation

...

Note

For in-store transactions, ensure to test and align with Kiosk/POS vendor on a solution.

...

Points Expiration

Markets configure Loyalty Points Expiration rules here

...

  • Point expiration by inactivity days means Loyalty Points expire X days after the last loyalty transaction of user

    • The number of days can be set in Sanity (see screenshot below)

    • In the below scenario, Loyalty Points would expire for the user after 365 days since the user has been active in the app and completed a loyalty transaction 

...

Point Expiration By Issue Date

...

  • Days are set in Loyalty Point Duration (days) field in Sanity. In the screenshot above this is 365 days.

  • Expiration Extenstion options are Monthly, Quarterly and Bi-Anually. In the screenshot above this is Quarterly.

  • Some examples on this behavior:

    • Example 1:

      If today is Feb 14, for the following configuration:

      • Expiration Extenstion: "QUARTERLY"

      • Loyalty Points Duration (days): 120

      Steps of expected behavior:

      1. The end of the current quarter is March 31st.

      2. Add Loyalty Points Duration (days): July 29th.

      3. Points expire on July 29th

       

    • Example 2:

      If today is Feb 14, for the following configuration:

      • Expiration Extenstion: "QUARTERLY"

      • Loyalty Points Duration (days): 100

      Steps of expected behavior:

      1. The end of the current quarter is March 31st.

      2. Add Loyalty Points Duration (days): July 9th.

      3. Points expire on July 9th.

     

    • Example 3:

      • If today is Jan 10, 2023 for the following configuration:

        • Expiration Extenstion: "QUARTERLY"

        • Loyalty Points Duration (days): 365

      • Steps of expected behavior:

        • The end of the current quarter is March 31st, 2023.

        • Add Loyalty Points Duration (days): March 31, 2024.

        • Points expire on March 31, 2024.

How to Set Offer / Reward Stackability Limit

...

Navigate to the Earning Calculation Tab on Sanity
Order-Level Content ➡️ Loyalty ➡️ Loyalty Configs ➡️ Earning Calculation

  1. Image Removed

Scroll Down to Offer Redemption Limits section

...

Loyalty Tiers

This configuration is optional and only applied to markets that have Loyalty Tiers enabled. This configuration allows you to control the Loyalty Tiers program rules.

Info

In order to enable the Loyalty Tiers feature, please follow this guide.

Offer Redemption Cooldown Period

The minimum time (in seconds) between purchases with an offer that must be satisfied before a second offer can be redeemed.

Note

If you require to enable this field please reach out to your CSM, as there is another internal RBI configuration that must be set for this field to work.

Offer Redemption Limits

Here you can control the limit of offers that can be ordered in a single purchase and how many of the same offer can be ordered in a single purchase.

Stackable Offer Limit

  • This is where you will configure the number of Offers a user can add to their cart per order

...

  • For example:

    • A value of 1 would mean a maximum of 1 Offer per Cart.

    • A value of 4 would mean a maximum of 4 Offers per Cart.

...

  1. Image Removed

Limit for adding the same offer

Note

This field is still In Progress and currently only applies to In-Restaurant orders. For online orders only one of the same offer can be ordered in a single order.

This represents the maximum number of times the same offer can be added in a single order.

...

How to set Maximum Transactions Limit in Sanity

...

Go to Order-Level Content > Loyalty > Loyalty Configs > Earning Calculations

  1. Image Removed

...

Under the Earning Calculations page, scroll down to the Transaction Earning Configuration section

  1. Image Removed

The Maximum Transactions Limit field is where you define what you want the Max number of transactions that would yield points to a given user.

Reward Redemption Config

Here you can control the limit of rewards that can be ordered in a single purchase.

Reward Limit per Order

  • This is where you will configure the number of Rewards a user can add to their cart per order

...

  • For example:

    • A value of 1 would mean a maximum of 1 Reward per Cart.

    • A value of 4 would mean a maximum of 4 Reward per Cart.

Transaction Earning Configuration

Here you can control how many transaction can be done per day that will count for earning of loyalty points and you can configure what is the maximum number of loyalty points that can be earned in one year. Both of these provide anti fraud configurations for the rewards program.

Maximum Transaction Limit

This field is where you define how many transaction can be done per day that will count for earning of loyalty points for a single user. If the user surpasses the number of loyalty purchases here, then he can still complete the order but he will not earn any loyalty points for these subsequent orders.

...

For example: if you input 10, then each unique guest will only be able to earn points for up to 10 transactions per day. After the 10th transaction, the guest will stop earning points for that day.

...

Once you have set the Max Transaction Limit, hit Publish

  1. Once you hit Publish, the changes will be pushed to the selected environment and the new Maximum Transactions Limit will be set.

  2. Image Removed

Maximum Earned Loyalty Points In a Year

This field defines what is the maximum number of loyalty points that can be earned in one year for a single user. If this amount is reached in a year, then users can still place orders, but they will no longer earn loyalty points with these purchases.

Info

Note: the year for this field is calculated from Jan 1 - Dec 31 calendar days.

Publish

When all you configuration are set click on the Publish button to save your changes to the app.

...