Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Contents

Sanity Setup - Creating an Offer

The Loyalty Offer contained in the Promo Code has to be a Systemwide Loyalty Offer.

image-20240611-034727.png
  • Set up the Systemwide Loyalty Offer, refer to this doc Systemwide Offers

  • Because this Loyalty Offer is only assigned to the users having Promo Code, this Offer wouldn’t be shown in Offer list, in the Sanity setup, need to toggle the button Hide This Offer from Offers List, to hide it from Offer list.

    image-20240611-035530.png
  • Get the sanity id of the Offer

Voucherify Setup

  1. Log into Voucherify instance https://app.voucherify.io/#/app/core/welcome

    • This can be different for different markets

  2. In the left sidebar click ‘Campaign Hub - Campaigns’ and click the Create campaign in the top right to create a new campaign 

    image-20240610-034230.png

  3. Select Discount Coupons.

    image-20240610-034625.png

  4. 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 settings section. Click Next Step when done.

    image-20240610-034940.pngimage-20240610-035003.png


    See Voucherify documentation for more detail https://support.voucherify.io/article/17-how-do-i-create-my-first-campaign

  5. Set the time duration if required. Click Next Step when done.

    image-20240610-035620.png
  6. Set the discount to Rewards, and set the Free product and Units quantity. Do not need to add any validation rules. Click Next Step when done.

    image-20240610-035915.png

  7. Set up Metadata

    image-20240610-040123.png


    To add or edit the metadata. Paste keep the Key as sanityId, and paste the sanity_id from Sanity to fill the Value. This is required for the promo code to work. Click Next Step when done.

    image-20240610-041323.png

    For example, in this above case, the sanity id is 8eb47981-xxxxxx in Sanity, the Value should be set as 8eb47981-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.

  1. Confirm all of the settings are correct. Click Save when done.

    image-20240610-040800.png

  2. You will be taken to the campaign page. Click on the voucher tab to view all codes. If live, the codes should be active.

    image-20240610-040905.png

  3. 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.

    image-20240610-041039.png

  • No labels