Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

Order-Level Content → Loyalty → Loyalty Configs → Feature Loyalty UI

Contents

Table of Contents

Overview

What is Feature Loyalty UI?

This is where the Loyalty program visuals (UI) are configured. From the Loyalty logo, to background images, icons for progress bars, tier visuals, or the Loyalty QR Code page.

The level of customization allowed is big, meaning there are several configurations you can explore.

Examples

Editing Feature Loyalty UI

Rewards Logo Inverted

No Reward Points Empty State

This empty state shows when a user logs in, has 0 loyalty points, and navigates to their loyalty account history page (/rewards/history)

image-20240326-182202.png

Not Enrolled Empty State

This empty state shows when a user logs into the Web version of the app and his account is not enrolled into loyalty. An example is when a guest logs into a loyalty market (e.g. BK CH) with the user he had already used in the past for a different loyalty market (e.g. BK DE). In this case the user will see this empty state.

image-20240326-184707.png
image-20240326-184627.png

Not Enrolled Empty State Mobile

This empty state shows when a user logs into the App and his account is not enrolled into loyalty. An example is when a guest logs into a loyalty market (e.g. BK CH) with the user he had already used in the past for a different loyalty market (e.g. BK DE). In this case the user will see this empty state.

image-20240326-185053.png

image-20240326-185155.png

No Rewards Available Empty State

This empty state shows if the guest is logged in and navigates to the Rewards list and no rewards are available. This can happen if no Rewards are available to that specific restaurant.

image-20240326-191031.png

image-20240326-190639.png

Loyalty Banner Configuration

The component will edit the Loyalty Banner, as seen below

Call to Action Buttons

Button on the Homepage - Authenticated

Info

This configuration allows you to edit the button label and button path for the Loyalty Banner Button on the Homepage when a user is authenticated (logged into the app).

Button on the Homepage - Unauthenticated

Info

This configuration allows you to edit the button label and button path for the Loyalty Banner Button on the Homepage when a user is unauthenticated (logged out of the app).

Button on Rewards page

Info

This configuration allows you to edit the button label and button path for the Loyalty Banner Button on the Rewards page when a user is authenticated (logged into the app).

Background Setting

Learn More Icon

Banner Progress Bar Icon

Opt In Modal

Opt In Modal - Error

Opt In Modal - Loading

Swap Modal Content

Short Code Confirmation Modal Content

Override Short Code Modal Content

Surprise and Delight Modal Content

Loyalty Dashboard

Loyalty

In Restaurant Redemption

The component that will edit the In Restaurant screen redemption, as seen below

Image RemovedImage Removed

Loyalty QR Code

Image RemovedImage Removed

Loyalty QR Code and Short Code

Image RemovedImage RemovedImage RemovedImage Removed

Loyalty Text

Image RemovedImage Removed

Loyalty Marketing Tile Group Widget

Image RemovedImage RemovedImage RemovedImage Removed

Loyalty Legacy Short Code

Image RemovedImage RemovedImage Removed

Loyalty Not Available at this Restaurant

Loyalty Not Available at Delivery Mode

Loyalty Not Authenticated

Featured Rewards

International Rewards Widget Type

Loyalty Tiers

Enabling the Loyalty Notifications Widget

This section will be a walkthrough on how you can enable the Widget on the Rewards Detail Page.

  1. Navigate to the Feature Loyalty UI Tab on Sanity
    Order-Level Content ➡️ Loyalty ➡️ Loyalty Configs ➡️ Feature Loyalty UI

  2. Scroll Down to the Loyalty Dashboard Section where you will see a section for Widgets

  3. This section is where you will add the Loyalty Notifications Widget. This is a Sorted Widget list, which means that the widgets will appear in the order in which they are configured.

  4. To add the Loyalty Notifications Widget, Click on Add Item and then Select Loyalty Notifications

  5. Next, you will simply complete the fields in the pop-up

    • Click on Enable Notifications Widget Radio Button

    • Enter Title of the Section - This is what the Name of the Section will be on the FE

    • And then Select the Incentives you would like to show in the section. NOTE: Only incentives with Notifications Turned On will be shown in the Drop Downs. (This is covered in the section below)

  6. Once configured, you can hit Publish and the Widget will now show on the FE.