Table of Contents |
---|
Overview
System wide offers are the ‘base’ offers in the loyalty offers system. They are the closest match to how offers exist in the current offer system - will be referred to as ‘Cross Brand App Offers’ or ‘CBA Offers’ from here on out. All of the data and configuration for a systemwide offer is defined in sanity
Location
In the app, systemwide offers are located at /rewards/offers. Note that routing to /offers will redirect here when systemwide offers is enabled.
The configuration for systemwide offers are located in sanity under Order-Level Content > Loyalty > Incentives > Offers >Systemwide Offers.
How to Create a System Wide Offer
Most sanity fields within system wide offers are the same or similar to the fields in CBA offers. This guide will highlight anything new in system wide offers in blue.
Step 1: Navigate to Order-Level Content > Loyalty > Incentives > Offers > Systemwide Offers
...
Step 2: Click on the pencil icon to create a new systemwide offer
...
Step 3: Content Section
We’ve broken up content fields and offer mechanic fields to make it easier to create and update systemwide offers. The key distinction between the two is that ‘mechanics’ fields have a direct impact on the functionality of the offer, where content fields are purely visual.
Name
This is the name of the offer that will be displayed
5% Off Your Order
...
Description
This is the description of the offer
Take 5% off
...
Localized Image
This is the image that appears on the left of the card in the offer list view. It is also the primary image when the user is on the specific offer link.
From the previous example:
...
Notification Details
This section is for placeholder cards that will appear in the featured benefits carousel of the rewards dashboard. Unless you are building a placeholder tile for the offer, this section does not need to be configurd for SWoffers
...
UI Pattern
UI pattern determines what UI form the offer appears to the user.
NOTE: Until Quests & Promo Codes are built into Loyalty Offers, only select ‘Standard offer’
...
Short Code
This is the 4 digit code that identifies the digital offer in PMIX. For loyalty enabled restaurants, in restaurant redemption occurs by adding the offer to the users' in restaurant basket and generating a unique 6 digit loyalty basket code. For non-loyalty enabled restaurants, this short code is also what an user would show a team member in restaurant to redeem an offer.
...
Offer Price vs Market Price:
One of these fields must be filled out in order to publish, but not both
Offer price is a static price that will be the same no matter what, ie: $1 coke
Value is in cents, ie: $1 == 100
Market price means that we are taking the price of an item at a specific restaurant, and applying it to this offer. For example, a BOGO offer will take the price of the item at a specific store, not a static price
Reference the normal menu item that price should be based off of
...
Step 4: Mechanics Section
We’ve broken up content fields and offer mechanic fields to make it easier to create and update systemwide offers. The key distinction between the two is that ‘mechanics’ fields have a direct impact on the functionality of the offer, where content fields are purely visual.
Rules:
This is the section where you can define what the rule configurations should be for a user to be able to view and use the offer.
For a more detailed breakdown of each rule:
https://rbictg.atlassian.net/wiki/spaces/FEP/pages/3499851975/Incentives+Definitions+Rules
Incentives
This is where you define the benefit the user receives if they are able to redeem the offer.
If the offer should provide a menu item, link an item, combo, or picker. Note: In general when linking an incentive to an offer, that incentive should be one that is used exclusively for offers and not regular menu items.
If the offer is a discount offer, link an offer discount.
If the offer is a swap, you will need to define what swaps are eligible under this offer. Each swap needs an initial item (the item in the user’s cart) and the swapped item (the item we are offering them if they swap the item in their cart).
Note: Offer Activations are not used by Burger King or Popeyes
...
Position
Note: this will only work if you set the offer as a config offer. Systemwide offers' positioning is not determined by this toggle
Turn this on if the position should be determined by the Suggestive Sell Engine (ie Deepflame or braze)
This section is no longer relevant for systemwide offers. You do not need to make any changes here
...
Daypart
Add the dayparts that the offer should be eligible for here. This field can accomodate more than one daypart. Ensure the spelling matches the daypart in MDM.
If this field is left empty, the offer will be available in all dayparts
...
Step 5: Add Vendor Configs
These are the POS specific PLUs that apply to the specific offer. It is important to ensure that a value is configured for each POS vendor even if it’s just marking it as “empty” or “ignore”.
Step 6: Set Toggles
This toggle hides the ‘redeem in restaurant’ button on an offer
...
This toggle is used to identify config offers. This will hide the offer from appearing with regular systemwide offers and it will make the offer available in the list of config offers within offer template.
For standard systemwide offers, leave this off
For more detail on configuring config offers, see /wiki/spaces/FEP/pages/3500441682
The config only toggle has been removed from systemwide offers.
...
This test only toggle is a safeguard against an offer appearing in production with incomplete config. You should enable this toggle if you are only using the offer for testing or if the config is not ready for production.
...
Step 7: Define Redemption Type
Define what kind of offer this should be. Regular offers contained in the /rewards/offers page should be standard offers. Surprise and Delight offers should be surprise. Swap offers should be swap. Refer to the terms document for more details on surprise & delight and swap offers.
...
Step 8: Publish
Publish your offer when complete. After publishing, you should see this field populate because the loyalty engine has assigned your swoffer an ID
...
Step 9: Position
Navigate to Order-Level Content > Loyalty > Loyalty Offers UI > Offers > Systemwide Offers and add your offer. Drag it to the position you want in the list and publish.
...
Once published, you will see the sytemwide offer populate on the Offers List page (base url/rewards/offers) in the app.
Note: The URL for the systemwide offer will be constructed using the Loyalty Engine ID
Example URL:
{baseurl}/rewards/offers/{loyalty engine ID of systemwide offer}
Loyalty Offer for Users to get a free item with every order
...