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 Menus API

The Menus API from Restaurant Brands International — 3 operation(s) for menus.

Restaurant Brands International Menus 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 Menus. 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 3 operations across 3 paths, and defines 45 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.

3 operations 3 paths 45 schemas 3 GET

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 Menus API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Menus 3
GET
/stores/{storeId}/menus/{serviceMode}
Menu
getStoreMenu 4 params → 200403404
GET
/stores/{storeId}/menus
Individual Store Menu
getStoreMenu 4 params → 200403404
GET
/stores/menus
Menu
getStoreMenu 2 params → 200403404

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are DayPartSchedule (14 properties), Allergen_2 (14 properties), MenuEntry (13 properties), LoyaltyEntry (13 properties). Each schema is shown below with its type and property counts.

EntryPrice
object
Price information for a menu entry
2 properties
DayPartSchedule
object
Contains the detailed schedule for a specific daypart
14 properties 14 required
Menu_2
object
BK Menu (v2)
8 properties 8 required
Option
object
3 properties 2 required
Meta
object
Metadata about the menu document
2 properties 1 required
LoyaltyBaseEntry
object
11 properties
Currency
string
Currency code in [ISO-4217 alpha](https://en.wikipedia.org/wiki/ISO4217) format
Nutrition
object
Nutrition Details
3 properties
Error
object
Standard error format for all errors returned by the API
4 properties 3 required
Image_2
object
Image resource with optional localized alt text
2 properties
Menu
object
Store menu
7 properties 4 required
EntryOptions
object
Options configuration for a menu entry
4 properties
DayPart
object
Day parts define a window of time during which any associated menu items should be available for orders.
4 properties
ConfigOfferEntry
object
ConfigOfferEntry_2
object
Nutrition_2
object
3 properties
PaperCouponEntry
object
DayPartId
string
Unique identifier for a day part
MenuEntry
object
Represents a single menu entry
13 properties 2 required
Nutrient_2
object
12 properties
Allergen
object
Allergen (such as "Peanuts")
2 properties
Locale
string
Locale details to help render localized text. Locales are composed of the [ISO-639-1](https://en.wikipedia.org/wiki/ListofISO639-1codes) language code and the…
SystemWideOfferEntry
object
These represent System-wide Offers available for this menu.
Calories
object
Calories range
4 properties
StoreId
string
Unique Store ID
Quantity
object
Quantity constraints for a menu entry
3 properties
PriceRange
object
Default, minimum, and maximum prices.
3 properties
Image
object
2 properties
LoyaltyEntry
object
13 properties 2 required
Allergen_2
object
14 properties
Entry
object
Any entry available for selection on the store menu.
13 properties 2 required
SystemWideOfferEntry_2
object
LocalizedText
string
Text that has been translated to the correct locale for the current context
Brand
string
RewardEntry
object
These represent Reward Offers available for this menu.
ServiceMode
string
How a customer would like their order served. Note that not all service modes will be available at all restaurants.
EntryRef
object
Reference to entry and optional the price of this entry
2 properties
EntryId
string
Unique identifier for a menu entity
RewardEntry_2
object
Nutrient
object
Details for an individual nutrient
3 properties
LocalizedString
object
Translated text for different locales
2 properties
Calories_2
object
3 properties
DayPart_2
object
2 properties 2 required
QuantityConstraints
object
Quantity constraints on selection. Can apply either to items or selections with an options group. Note\: We use a minAmount of 1 with a maxAmount of 1 to indic…
3 properties
Availability
object
Availability options for delivery and pickup. A node is considered not available if the value for that service mode false. That means, a node is available if t…
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Restaurant Brands International publishes across the network.

Restaurant Brands International Loyalty API
Restaurant Brands International Orders API
Restaurant Brands International Stores API