Loyalty API v1 - Receipts

Owned by Lopes da Costa, Valentina
Last updated: Sept 16, 2024
2 min read

Contents

1. Overview

The Loyalty API supports printer receipt customization by providing a number of optional fields that can be used by POS or Kiosk vendors when generating their receipts. The process consists of the following steps:

  1. Franchisee configures the fields that should be used in the receipt;

  2. Loyalty API returns all configurable fields in the Transaction Update (Claimed) response;

  3. POS/Kiosk use the configurable field values when generating the receipt.

2. Receipt field configuration

Configuring the receipt fields is done in Sanity. Please refer to the configuration guide here.

3. Receipt field mapping

3.1. Field list

The following table lists all configurable fields that can be used in printed receipts. All fields are optional; if not previously configured in Sanity, these fields will not be returned by the Loyalty API.

Field Name

Type

Description / Example

Field Name

Type

Description / Example

header

String

Text to be printed to the receipt in the header of the Loyalty section (E.g., “My BK Rewards®\nYou Saved $5”)

marketing

String

Text to be printed to the receipt (E.g., “Join MY BK Rewards and start earning today! ​\nDownload BURGER KING® app or visit bk.com​\n\nAdd points to existing account, scan or visit “bk.com/rewards” to claim your points”)

pointsEarned

String

Text to be printed on the receipt (E.g., “Earned: 70”)

pointsRedeemed

String

Text to be printed on the receipt (E.g., “Redeemed: 0”)

totalPoints

String

Text to be printed on the receipt (E.g., “Balance: 100”)

identifier

String

Not currently used on receipt.

qrCode

String

Either encoded image data representing a QR Code, or a URL to be encoded by the POS into a QR Code; the QR Code to be printed on the receipt.

footer

String

Text to be printed on the receipt at the bottom of the Loyalty section (E.g., “Crown points expire 6 months after last eligible transaction. See bk.com\/terms-conditions-rewards.”)

3.2. Receipt layout

This example shows how the configurable fields can be laid out in the Loyalty block:

And for context, here’s an example of the Loyalty block in a printed receipt: