Help

1 min read

Loyalty

Last Updated - Platform 25.0 - SDK 20.0

The Loyalty features enhance user engagement and retention by rewarding users for their interactions within the app. It aims to incentivize user engagement by assigning points for specific actions. Users accumulate points over time, which can be redeemed for discounts, exclusive content and other perks.

loyalty loyalty barcode 

# Loyalty Rewards
loyalty/rewards


# Loyalty Activities / Campaigns
loyalty/activities

Set up

Loyalty is part of the Account features. See Account set up for set up steps.

The backend will likely require customisation to support loyalty. To present loyalty set up the CMS account content to show the loyalty block when logged in and links to other loyalty features.

Loyalty View

The LoyaltyView has two versions; with or without (default) a barcode. To switch loyalty view to the barcode version use container injection:

Container.shared.views.loyaltyView.replace { BarcodeLoyaltyView() }

Both version of the loyalty view inherit from LoyaltyBaseView, which is a widget that manages its own state and handles navigation. It is capable of fetching loyalty data if no data is provided.

The AccountContentResponse contains loyalty data to allow the Account Content screen to present the loyalty view (the loyalty block) provided the CMS is set up.

When loyalty data needs to be fetched the loyalty view is skeletonized whilst it loads it. If the loaded loyalty data is inactive the view transitions to an empty view.

If the API returns an error the view transitions to an error view displaying the error and a retry button. Tapping retry restarts the loading process.

Club Card

The default loyalty view can open the barcode by tapping See Club Card CTA. There is no deeplink for the club card screen and loyalty data is forwarded from the loyalty view.

club card

Barcodes

The barcode comes as a regular barcode (default) and a QR code. To enable the QR code change the barcode setting:

Settings.Account.barcodeFormat = .qr

You can customise the barcode height using:

Settings.Account.barcodeCardHeight = 150

Apple Wallet

To set up a Wallet Pass:

  1. Create the Wallet identifier and certificate.
  2. Add the identifier to the AppConfig.json as the loyaltyWalletPassId key.
"loyaltyWalletPassId": "pass.com.poqstudio.demo.loyaltycard",
  1. Download and export the pass certificate as a .p12 file using Keychain Access.
  2. Send the pass to the backend developer to configure the API (most of the set up is on the backend).
  3. Add the Wallet capability to your target.

All the assets are stored on the backend and the API handles wallet pass generation.

History

  • 20.0 (v25): Initial release.