Brands and markets want to offer up an in-store loyalty experience where users can earn points and redeem points for in-store orders. This will require an integration between the POS and the RBI Loyalty Platform.

Desired In-store Loyalty User Flow

1. User identifies themselves as a loyalty user at the POS using identification mechanism (i.e. 6-digit short, code, QR code, etc.)

   1. The identification may include pre-selecting rewards and/or offers within the app similar to the in-store loyalty experience

2. Upon successful identification:

   1. Any pre-selected rewards and/or offers are injected into the POS order

   2. User’s information is populated within the POS terminal (i.e. name, points balance)

3. User is able to proceed with placing their order by selecting desired items/combos

4. User completes order at POS and gets their food

General API Guidelines

Region {reg} variables:

• euc1 EU Timezone Markets

• apse1 APAC Timezone Markets

• euw3 Iberia Timezone Market

Environment {env} variables:

• dev

• staging

• qa

• prod

Brand {brand} variables:

• bk

• plk

• fhs

All API requests should include the following in the header:

• x-region field. The value passed in this field should be the 2-character iso country code.

• x-api-key field. The value passed in this field will be an environment, vendor and brand specific API key.

• x-user-datetime field. The value passed in this field should be the local iso datetime string.

Overview

While the Loyalty API has been designed to be system-agnostic, there are a few instances where vendor-specific behaviour has been developed to cover market-led requirements. This section of the Loyalty API documentation covers this behaviour for each different vendor, where applicable.

Contents