Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Restaurant Brands International Loyalty API

The Loyalty API from Restaurant Brands International — 1 operation(s) for loyalty.

Restaurant Brands International Loyalty API is one of 4 APIs that Restaurant Brands International publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Loyalty. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, authentication docs, and a JSON-LD context.

This API exposes 1 operation across 1 path, and defines 22 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://sandbox-bk-partners.rbictg.com/api/v1, https://bk-partners.rbictg.com/api/v1.

1 operations 1 paths 22 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://bk-partners.rbictg.com/api/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Restaurant Brands International Loyalty API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Loyalty 1
POST
/loyalty/identify
Identify
identify body → 200400403404500

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are Customer (6 properties), MenuSelection (6 properties), IdentifyResponse (5 properties), IdentifyRequest (5 properties). Each schema is shown below with its type and property counts.

MenuSelection
object
Menu selection in the cart
6 properties 2 required
IdentifierType
string
Determines the type of identifier being sent
Money
object
Representation of money. Money amounts are always provided in the smallest currency unit (e.g,. 100 where currency=USD represents 100 "cents" or 1 USD).
2 properties 2 required
Currency
string
Currency code in [ISO-4217 alpha](https://en.wikipedia.org/wiki/ISO4217) format
IdentifyResponse
object
5 properties 3 required
Error
object
Standard error format for all errors returned by the API
4 properties 3 required
Terminal
string
The terminal name.
IdentifyRequestDetails
object
3 properties
StoreId
string
Unique Store ID
IdentifyRequest
object
5 properties 4 required
ExternalReferenceId
string
External reference ID. An example might be the external menu selection ID, customer ID or order ID.
IdentifyLoyalty
object
User information on the Loyalty user identified
3 properties 3 required
TransactionId
string
The Partner specific order lookup id.
LoyaltyTransactionId
string
The loyalty transaction id created for the identify request
LoyaltyId
string
The loyalty user id
ServiceMode
string
How a customer would like their order served. Note that not all service modes will be available at all restaurants.
Operator
string
The cashier id submitting the transaction.
Identifier
string
An OTP code (6 digit code) or a static Offer code (4 digit code)
Customer
object
Customer personal details
6 properties 2 required
Cart
object
Cart representing a customer's selections from the menu
1 property 1 required
Phone
string
Phone number. Should always begin with the international country code (e.g., "+1")
Balance
object
The amount of a given currency the user has
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

restaurant-brands-loyalty-api-openapi.yml Raw ↑

Other APIs Restaurant Brands International publishes across the network.

Restaurant Brands International Menus API
Restaurant Brands International Orders API
Restaurant Brands International Stores API