...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
| Info |
|---|
Order-Level Content → Menu → Legacy Offers |
Overview
What are Legacy Offers?
Picker Aspects are the different criteria a Guest can choose from to result in the combo or item which they would like to order.
What is this for?
Offer are what we use for coupons and discounts. Offers typically have their own plus in their respective POS map. (Note: The diff for discount values are and handled by RBI)
...
Step-by-step
The list below includes all the required fields to create offers.
...
Add the offer you’ve just created to display it on the Website & App!
Title | Description | Notes | Example URL | Image | Used By |
|---|---|---|---|---|---|
Name | This is the main text that will be used to display the offer |
Header Super Text |
Localized Image | This is the main image that will display on for the offer |
Description | This is the text that will tell the user what the offers items are |
More Info | Anything entered here will show as the offer's disclaimer when the LaunchDarkly flag that enables custom disclaimers is set to true. If you add links to this text, you MUST set them to open in a new tab. |
How To Redeem |
Option | |||||
Short Code | |||||
Daypart | |||||
UI Pattern ( Standard Offer ) | |||||
UI Pattern ( Locked Offer Progress Bar ) | |||||
UI Pattern ( Locked Offer List ) | |||||
Locked Offers Panel | |||||
RuleSet | |||||
Incentives | |||||
For Support | |||||
Offer Price | This is the total price for this offer | ||||
Market Price | This is the market price for this offer and can be used to show how much the items are being discounted | ||||
Vender Configs | This is where the the PLU configuration is handled. Take a look at the vendor configs section of the docs for more information on this | ||||
Background Image | This is the background image that the localized image sits on top of | ||||
Depreciated | These are fields that we have used in the past. We need keep them for old versions of the sites could still be cached |
Rulesets
* = pending
Date-Band - Set the start and end date of when the coupon is redeemable. Outside of these dates, the coupon will be filtered from the UI.
...
All order-history offers must either have a date band (did the user satisfy the criteria between these dates?) or a past seconds requirement (did the user satisfy the criteria in the last week?)
Between dates are inclusive of the dates listed
past n seconds is calculated in SECONDS so you must convert if you want to calculate days, weeks
If the order of events matters, set the
sequence mattersflag to trueAll top level rules will have an accompanying checkbox on the UI
Coupon Options (What is the benefit of the coupon?) - BK & PLK
'For Two' Coupons
Option is a combo with Sicom/NCR PLUs the same as the offer PLU. Carrols should have PLU type 'ignore'. Set the main item to 'Combo item' and set the item that comes with the coupon in the comboslots. WE CANNOT REPEAT A COMBOSLOT HERE!!! You must duplicate if you want to reuse preexisting work.
...
John/Jorge to detail how to set these up
Offer setup - TH
Content Side - Sanity Fields of Importance:
Sanity ID
ID in Sanity MUST match the Offer ID that Avanade uses. It is important to us that this is a unique ID - please create the offer in Sanity first then give the ID that was generated to the Avanade team to add to the database. You can find sanity ID for an offer by clicking on the 3 dots at the top right corner of the screen, and clicking inspect.
Once created the Sanity ID can be recorded on the loyalty offers sheet [To be deprecated following engine UI development]
Name, Image Description
All localized fields, may want to limit characters to 1-2 lines to avoid overcrowding
More Info
Legal terms go here, localized
How To Redeem
Steps users must follow in order to redeem an offer in store (or through the app, for that matter). Localized
Option
This is a reference field. You should ALWAYS link to Activation Offer
Short Code
You may use this to record the internal short code associated with the offer (ie: 1201A). Note - this is not the Sanity ID and Avanade must use the GUID mentioned above in the DB
Offer Price
Set to the offer price in cents: $1.99 = 199
Vendor Config
Must set all to ignore
Rulesets
Date-Band - Set the start and end date of when the coupon is redeemable. Outside of these dates, the coupon will be filtered from the UI. This date is what we show as the expiration date on the offer card
Requires Assignment - this is a string field. Write anything in this field to make it apply (“ “ works, your name works, literally anything in this field). If this is applied, the offer is not universal and will only be shown to users who have the offer assigned to their loyalty card
Adding the offer to AppData
Once the offer has been created, go to the AppData doc on the left panel in Sanity. Under the Menu Configurations drop down, you will find ‘Sorted Offers’. You must add the offer to sorted offers in order for it to render on the UI. You can control the order offers appear by moving them higher/lower in the list
CAN vs. USA
| Note |
|---|
Canada and the US do not share a Sanity dataset. You must create any offers that apply to the different countries in the appropriate dataset. For CA, create them here: https://staging.menu.th.rbi.tools/desk/menu;offer For US, create them here: https://staging.menu.th.us.rbi.tools/desk/menu;offer |
Debugging:
The offer shows up, but get an error that ‘cannot checkout with this offer’
...