Glossary of terms

The following terms are used throughout this document:

Offer: Offers are discounted products - this may come in the form of individual item discounts, bundle discounts, dollars-off discounts, or percent-off discounts.
System-Wide Offer: System-wide offers are the ‘base’ offers in the loyalty offers system. These are available to all users who meet the required criteria for redemption and do not require any steps or processes to be assigned to a specific user. You’ll see these referenced as GLOBAL offers.
Configuration Offer: Config. offers are one-half of the required components to create a personalized offer. These are templates that only exist to provide the configuration for personalized offers. As such, they will not appear on their own on the offers page if they are not referenced by a personalized offer and the entity by itself does not represent a redeemable incentive.
Personalized Offer: Personalized offers are offers assigned specifically to a particular user. Every time a personalized offer is assigned to a user, it creates a unique offer record that can only be used for that particular user.
Rewards: Rewards are a special type of product that usually has a price of zero, and can be exchanged for points accumulated from previous purchases.
Loyalty Middleware: Public facing API for Loyalty. Consists of both a REST API and a GraphQL endpoint.
Loyalty Engine: The core Loyalty component that handles everything behind the scenes.
Loyalty Platform: Refers to both Middleware and Engine as a whole.
Sanity: RBI’s Content Management System (CMS).

Overview

To display valid offers and rewards on the kiosk UI, the client needs to retrieve data from two sources: the Loyalty Engine (Through the Loyalty Middleware) and Sanity (RBI’s CMS). The Loyalty Engine will provide incentives for which the user is "eligible," meaning they satisfy all necessary criteria (rules). Meanwhile, Sanity will offer information about active incentives, and reward categories, as well as all visual display content, such as names, images, descriptions, and more.

The client must hit both of the previously mentioned data sources and intersect the data to decide what to present. The sequence in which these queries are executed will depend on the client and its implementation. It is advised to first query Sanity for all "sorted offers" (active system-wide offers), “config offers” (possible personalized offers for any given user), and "reward categories" (active rewards), and then utilize those identifiers to request pertinent information from the Loyalty Engine.

Querying Sanity

To query Sanity you must us GraphQL, as this is a more widely known querying language. Vendors can use the provided GraphQL playground to be able to see the whole schema during development and make necessary adjustments to their queries with ease.

Using Sanity GraphQL

GraphQL URL (Playground Available):

https://czqk28jt.api.sanity.io/v1/graphql/staging_bk_de/default

Replace staging_bk_de with the {{stage}}_{{brand}}_{{country}} that you desire to query.
Sanity GraphQL can be hit via a POST request. Please reference the POST URL structure for each of the sample queries below.
Please use this playground to play with the queries below and examine the schema for fields you may wish to request.

Example offers query

The Sanity ID for the live offers document, for the most part, will be feature-loyalty-offers-ui-singleton, however, some markets have drifted from this convention.
An offer is open only if it has the ruleset RequiresAuthentication = False. If the ruleset RequiresAuthentication is not present in the offer OR if the ruleset RequiresAuthentication = True, then the offer is closed and should only show for guests that are signed into the kiosk.
Sample query:

query getSanityOffers {
  LoyaltyOffersUI(id: "feature-loyalty-offers-ui-singleton") {
    # Available for all users.
    # You can use these to lookup assets from global.
    sortedSystemwideOffers {
      _id
      loyaltyEngineId
      name {
        enRaw
      }
      rules {
        # Returns the value of the AuthenticationRequired rule
        ... on RequiresAuthentication {
          requiresAuthentication
        }
        # Add more rules as needed here (e.g. FirstOrderOnly, LoyaltyBetweenDates, etc)
      }
    }
    # These are config. offers (templates).
    # You should use these only to display content (images, names, etc).
    # You can use these to lookup assets from the actual Personalized offers.
    liveConfigOffers {
      _id
      loyaltyEngineId
      name {
        enRaw
      }
    }
  }
}

Example reward query

The _id is subject to the dataset you are using. For the most part it will be reward-list-singleton, however, some markets have drifted from this convention
Sample query:

query getSanityRewards {
  RewardList(id: "reward-list-singleton") {
    rewardCategories {
      _id
      label {
        en
      }
      rewards {
        ... on Reward {
          # Sanity ID of the reward
          _id
          # Loyalty Engine ID to be used in the Loyalty Engine query if needed
          loyaltyEngineId
          # Reward content to display to the user (name, image, description...)
          name {
            en
          }
          image {
            en {
              asset {
                url
              }
            }
          }
          description {
            enRaw
          }
          # Here we add the rules we want to check for the rewards
          # e.g., LoyaltyPoints (reward points cost), RewardPrice (reward money price),
          # SubtotalSpend (minimum subototal to spend for redeeming the reward)
          ruleSet {
            ... on LoyaltyPoints {
              points
            }
            ... on RewardPrice {
              price
            }
            ... on SubtotalSpend {
              minimumSpend
            }
            # Add more ruleSets as needed here (e.g. FirstOrderOnly, LoyaltyBetweenDates, etc)
            # See the screenshot below for how get the list of available ruleSet from GraphQL Playground
          }
          # Benefit of the reward, it can be either a Combo, Item, OfferDiscount
          # or Picker
          # e.g., OfferDiscount (It can be a discount for the whole cart or 
          # a discount for a specific product)
          incentives {
            ... on OfferDiscount {
              discountType
              discountValue
              discountProduct {
                ... on Item {
                  name {
                    en
                  }
                }
                ... on Combo {
                  name {
                    en
                  }
                }
              }
            }
          }
          # Reward redemption method available
          redemptionMethod
          # Here we can get the needed PLUs by looking for a specific vendor
          # e.g., Partner constant PLU
          vendorConfigs {
            partner {
              _type
              constantPlu
              pluType
            }
          }
        }
      }
    }
  }
}

To get list of ruleSet available, navigate to https://czqk28jt.apicdn.sanity.io/v1/graphql/dev_bk_aq/default, and search for “ruleSet” in the Schema explorer as seen here:

Querying the Loyalty Platform

GraphQL URL (Playground Available):

https://euc1-dev-bk-loyalty-middleware.rbictg.com/graphql

Replace euc1 with the AWS Short Region that your market belongs to. Please communicate with RBI reps to know which region your market is hosted.
Replace dev-bk with the {{stage}}-{{brand}} that you desire to query. You will need to prefix the URL with the AWS region that your market lives in. Please communicate with RBI reps to know which region your market is hosted.
- An example URL for ES (Spain) would be https://euw3-dev-bk-loyalty-middleware.rbictg.com/graphql
When querying the loyalty platform, please make sure to set the x-ui-region header to the country code you want to query, in uppercase, for example:

Please use this playground to play with the queries below and examine the schema for fields you may wish to request.
Some where filters that may be relevant to kiosks:
- ids - a collection of Engine IDs for offers/rewards. This is the loyaltyEngineId field on every sanity offer/reward document.
- omitInvalids - This controls whether invalid incentives will be returned. Only incentives that failed “fixable” rules will be returned if this is set to false. A fixable rule is one that the user can change behavior to make the rule pass, like the minSpend, the user can add more items to their cart to meet the requirement. An absolute failure like date-band will not be returned regardless of what the value of this filter is
  - This is useful for displaying error / in-line messages in the UI
- serviceMode - some incentives can only be redeemed if the service mode meets the required ruleset
- storeId - some incentives can only be redeemed at certain stores
- subtotalAmount = some incentives require a minimum spend
- cartEntries - some incentives require certain items to be in the cart, this rule uses the sanity id of each rbi product
- paymentMethod - some incentives require certain payment methods to be used

Example offers query

query getLoyaltyOffers {
  loyaltyOffersV2(loyaltyId: "<USER_LOYALTY_ID>", where: { omitInvalids: false }) {
    id
    name
    type
    sanityId
    errors {
      code
      ruleId
    }
  }
}

Example offers query response

Example rewards query

Example rewards query response

Mapping loyalty offers between Sanity and the Loyalty Engine

After retrieving all the available offers from both sources, you need to map this data to get a complete list of offers available to the user. Below there is a simple example in JavaScript demonstrating how to perform this mapping:

In this example :

sanityOffers contains the offers retrieved from Sanity, destructured into liveConfigOffers (personalized offer templates) and sortedSystemwideOffers (system-wide offers).
loyaltyEngineOffers contains the offers retrieved from the Loyalty Engine, specifically the loyaltyOffersV2 array.
allAvailableUserOffers contains all the available offers for the user.

RBI Developer Portal

Listing offers and rewards on kiosks

Glossary of terms

Overview

Querying Sanity

Using Sanity GraphQL

Example offers query

Example reward query

Querying the Loyalty Platform

Example offers query

Example offers query response

Example rewards query

Example rewards query response

Mapping loyalty offers between Sanity and the Loyalty Engine