Contents

...

Headers

As documented here: TBC LINK Loyalty API - Getting Started.

Body

• loyaltyId <string>: Loyalty ID in UUID format.

• promoCode <string>: string that represents the unique promo code the customer has that when inputted at a client device will unlock an offer.

• posVendor: object identifying system making the request (POS or Kiosk):

  • transactionId <string>: the POS transaction identifier.

  • storeId <integer>: uniquely identifies the store where the guest is identifying from.

  • terminal <string> (optional): identifies the POS or Kiosk terminal used in the restaurant

  • operator <string> (optional): identifies the POS operator (only applicable for orders made on a POS terminal)

  • posType <string>: identified the type of POS or Kiosk system making the request. This value must have been previously agreed between the vendor and RBI, so that the correct integration configuration is applied. In most cases, this will be set to a value of “Partner”.

  • supportingPos <string> (optional): in case the posType is “Partner”, this field should be used to identify the POS/Kiosk brand for analytical purposes.

...

{
  "loyaltyId": "4711fc2a-3a8f-414f-a9e7-44dd5231dca7", // uuid of the loyalty user
  "promoCode": "123456", // promo code identifier
  "posVendor": {
    "operator": "300", // cashier / operator id
    "posType": "Kiosk vendor name",
    "supportingPos": "POS vendor name (optional field)", // vendor to return plu for
    "storeId": "9999",
    "terminal": "0", // terminal id
  },
}

Response

...

format

Success response body

• sanityId <string>: sanity ID of the offer redeemed.

...