Note: this doc is NOT finalized.
Sanity Setup - Loyalty
Set up the system Loyalty Offer refer to this doc Systemwide Offers
TODO:
some specific config in Sanity? like not show the Offer in the Offer list
Voucherify Setup
Log into Voucherify instance https://app.voucherify.io/#/app/core/welcome
This can be different for different markets
In the left sidebar click ‘Campaign Hub - Campaigns’ and click the
Create campaignin the top right to create a new campaign
Select Discount Coupons.
Determine if you want bulk codes or a standalone code. Add a name and description for the campaign. This will only be visible for voucherify users. Confirm redemption limits and the number of codes to generate. You can also define the Code format(e.g. length and pattern) in
Advanced code settingssection. Click Next Step when done.
See Voucherify documentation for more detail https://support.voucherify.io/article/17-how-do-i-create-my-first-campaignSet the time duration if required. Click Next Step when done.
Note that the time limit you set in Voucherify will control when promo codes are valid and redeemable.
See Voucherify documentation for more detail https://support.voucherify.io/article/17-how-do-i-create-my-first-campaign
Set the discount to
Rewards, and set theFree productandUnits quantity. Do not need to add any validation rules. Click Next Step when done.
Set up Metadata
To add or edit the metadata. Paste keep theKeyassanityId, and paste the sanity_id from Sanity to fill theValue. This is required for the promo code to work. Click Next Step when done.
For example, in this above case, the sanity id is
8eb47981-xxxxxxin Sanity, theValueshould be set as8eb47981-xxxxxx
The Key sanityId must be in that format, writing it as any other formats(e.g. sanityid, sanity_id) will result in Promo Code redeem failure.
For the Offer sanity id, if the online/product campaign is set up, please use the product env Sanity instance(the URL should be https://prod-{brand}-menu.{region}.rbi.tools/) to get the correct sanity id. If the sanity id from the wrong Sanity instance is set, the Kiosk vendor will NOT be able to fetch the Offer information and show it correctly in the Kiosk.
Confirm all of the settings are correct. Click Save when done.
You will be taken to the campaign page. Click on the voucher tab to view all codes. If live, the codes should be active.
To add more codes to an existing campaign, click the + in the top right corner and select ‘Add vouchers to this campaign’. Any additional codes added will correspond to the same sanity Id on the whole campaign.
