Loyalty - Rulesets
Contents
- 1 Overview
- 2 Shared Rules
- 2.1 Between-Dates
- 2.2 Between Times
- 2.3 Limit
- 2.4 Day-Of-Week-Band
- 2.5 First-Order-Only
- 2.6 Cart Requirements
- 2.7 Cart Requirements Exclusion
- 2.8 User Created
- 2.9 Restaurant Group Requirement
- 2.10 Service Mode Availability
- 2.11 Subtotal Minimum Spend Requirement
- 2.12 Total Minimum Spend Requirement
- 2.13 Payment Method
- 2.14 Cool Down Period
- 2.15 Transaction Count
- 2.16 User Birthday
- 3 Offers only Rules
- 3.1 Offer Limit
- 3.2 Open Offer
- 3.3 User Attribute
- 4 Rewards only Rules
- 5 Promos only Rules
Overview
This document will go through the available rules that can be configured for Offers, Rewards and Promotions. There are many types of rulesets that can be configured (for example, making a specific offer or reward only available on Mondays). These rules help markets personalize the incentive experience for their guests. In this document, references to incentive or benefit mean an Offer, Reward or Promotion.
Shared Rules
These rule types can be utilized across offers, promotions, and rewards.
Between-Dates
Incentive will not be visible in the app or apply if current date is outside of the dates specified
The start date will begin at 00:00:00 of the selected date in the user’s local time and the end date will end at 23:59:59 of that user’s local time
E.g. If you want an offer to stop showing up as of March 31st then you would configure an end date of March 30th in the offer sanity document
Note: We currently do not support the times that are entered under this ruleset. If you would like to limit the offer to specific times, use Between Times
Between Times
Incentive will not be visible in the app or apply if a user’s local time is outside of the time band defined:
Evaluation is inclusive of the times listed
Note: We currently do not support the dates that are entered under this ruleset. If you would like to limit the offer to specific dates, use Between Dates
Limit
Set the number of times the user may redeem the incentive
Can be bound by a time period, but doesn’t have to be
ie max 1x per day or max 1x total
Note when there is no defined maximum, the loyalty backend will default to a limit of 1
Day-Of-Week-Band
Incentive will not be visible in the app or apply if current calendar day is outside of the weekdays specified (M/T/W/Th/F/Sa/Su)
Enable the days that the offer should be active
Start and end of days are defined by user’s local time
Multiple selections will act like an 'or' - ie: must be a Wednesday or a Sunday
First-Order-Only
The reward will only be eligible to be redeemed on the user’s first loyalty transaction
Cart Requirements
Checks all items added to cart, and if they match the cart requirement, incentive is valid
All items within the rule are treated like an ‘OR’ ie: must purchase a coke or a sprite
Note: only items and/or combos can be used in this rule.
Cart Requirements Exclusion
Checks all items that should NOT be added to cart, and if theses requirements are fulfilled, then the incentive is valid
All items within the rule are treated like an ‘OR’ ie: must purchase a coke or a sprite
Note: only items and/or combos can be used in this rule.
User Created
User must have been created in the loyalty system within this defined time band to be eligible for the incentive
ie if user was created between March 1st and March 30th, they are eligible for this special sign up reward
Restaurant Group Requirement
User must order at a specified restaurant in order to redeem the benefit
Restaurant groups also created in Sanity, can be uploaded via CSV process
This rule can also be set up as INCLUSIVE or EXCLUSIVE
Inclusive = Only stores within the specified restaurant groups are eligible for the offer
Exclusive = Only stores within the specified restaurant group are NOT eligible for the offer
Service Mode Availability
The incentive will be available for all the service modes enabled. The incentive will still be visible but not redeemable when in other service modes
For Pickup: Eat In, Takeout, Drive Thru, Curbside
NOTE: With COVID, the team implemented feature that defaults all ‘pickup’ orders to Drive-Thru. Because of this, if you are setting an incentive to have a servicemode ruleset, you should select ALL pickup servicemodes, or NO pickup servicemodes
Subtotal Minimum Spend Requirement
If user’s purchase subtotal is over this threshold, they are eligible for the benefit. Subtotal does NOT include delivery fee, tax or any other type of service fee.
Specified in cents, not euros
ie: set
500
in Sanity == € 5.00 requirement
Total Minimum Spend Requirement
If user’s purchase total is over this threshold, they are eligible for the benefit. Total DOES include delivery fee, tax or any other type of service fee.
Specified in cents, not euros
ie: set
500
in Sanity == € 5.00 requirement
Payment Method
User must pay with a given card type in order to redeem the benefit
Note - evaluation happens at payment, so you should use this rule sparingly to avoid user frustration so close to the sale
Cool Down Period
If user has redeemed this particular incentive in the last n seconds, they are not eligible to redeem again
Transaction Count
The incentive is available to the user only if their transaction count is…
ON - on this transaction only
BETWEEN - between your x-y transactions
EVERY - on every multiple transaction
Note: This rule counts total loyalty transactions, not total transactions
User Birthday
The benefit is available to the user when:
Day - it is the day of that user’s birthday, measured in the user’s local time.
Week - it is the week of that user’s birthday, measured in the user’s local time.
Month - it is the month of that user’s birthday, measured in the user’s local time.
Note: this rule will only work for users that have saved their birthday in their accounts in the guest app
Offers only Rules
Offer Limit
This is set in Earning Calculations. Offer can exist alongside a second, third, fourth (number is set in the configuration) offer(s) in the cart.
Note: The default is one offer is allowed per order
Open Offer
When an offer is set to 'open', guests that are not signed in to an account in the app can still redeem the offer. If this ruleset is not added, then only users that are logged in to an account in the app are able to redeem the offer.
Note: This rule is not available for Reward given all users need to be signed in to redeem Rewards.
User Attribute
This ruleset allows operators to show an offer to an user, only if that user has user attributes that fulfill the rules set in Sanity. The list of user attributes that can be configured in this ruleset are:
Attribute in Sanity | Description |
---|---|
Battery level ( |
|
Was Date of Birth deleted? ( |
|
Was Phone number verified?( |
|
Opted In to Promotional Emails? ( |
|
Zip Code ( |
|
Delivery Address saved? ( |
|
Favorite Stores (favoriteStores) |
|
Favorite Offers (favoriteOffers) |
|
Rewards only Rules
Loyalty Points
Number of points to spend on the reward
This is REQUIRED on all rewards
Reward Price
This refers to the price of the Reward that will show in the app in cents. This rule should be used when Rewards that are redeemable for both loyalty points and paid money (e.g. € 3 euros) are configured.
Specified in cents, not euros
ie: set
500
in Sanity == € 5.00 requirement
Loyalty Tier Requirement
This ruleset applies to the Loyalty Tiers feature. Read more here: Loyalty Tiers | Rewards Setup
For you to show a locked reward that is only available when guests become a Tier 2 Loyalty user, then add the the ruleset Loyalty Tier Requirement
to the reward.
When you set the Tier Requirement set to Tier 2 only (e.g. Superking) and the guest is still in Tier 1, they will see the reward as Locked. If the guest becomes a Tier 2 user, then he will see the reward as unlocked. If the ruleset is not in the reward, then the reward will be available for users in both tiers.
Promos only Rules
Birthday Multiplier
Logic to check user’s birthday on every transaction.
If duration is set to month, month of current day must match birthday month
If duration is set to week, birthday must fall in the current calendar week (Sunday-Saturday)
If duration is set to day, birthday must be today
Incentive Requirement
In order to award bonus points to guests that purchase a specific offer or reward, use the incentive required ruleset.