Restaurant Brands International Orders 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 Orders. 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
5 operations
across 5 paths,
and defines 42 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.
5 operations5 paths42 schemas1 GET4 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 Orders API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearer).
Paths & Operations 5
Across 5 paths, the API surfaces 5 operations — 1 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.
Orders 5
GET
/orders/channel/{orderId}
Order
getOrder2 params→ 200403404500
POST
/orders/price
Price Order
priceOrder1 parambody→ 200400403500
POST
/orders/{orderId}/commit
Commit Order
commitOrder2 paramsbody→ 200400403404500
POST
/orders/{orderId}/fire
Fire Order
fireOrder2 params→ 200403404500
POST
/orders/place
Place Order
placeOrder1 parambody→ 200400403500
Schemas 42
The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are Order (19 properties), Address (11 properties), PlaceOrder (11 properties), PriceOrder (9 properties). Each schema is shown below with its type and property counts.
OrderId
string
Unique identifier for an order
MenuSelection
object
Menu selection in the cart
6 properties2 required
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 properties2 required
OrderError
object
Standard order error format
5 properties3 required
OrderStatus
string
Order status, representing current state of order in its lifecycle. When transitioning the order status, the status must always advance further in the lifecycl…
Currency
string
Currency code in [ISO-4217 alpha](https://en.wikipedia.org/wiki/ISO4217) format
Error
object
Standard error format for all errors returned by the API
4 properties3 required
FireOrderInSeconds
integernull
Lead time in seconds before an injected order should be fired to the kitchen for preparation. - fireOrderInSeconds=0 fire the order immediately to the kitchen.…
Feedbacks
array
Feedback on cart prices and availability for cart menu selections. Cart feedback will only be provided for adjusted entries.
Loyalty
object
User and transaction information regarding loyalty
2 properties2 required
MpfOrderId
string
External References for the order. You can use this field to provide additional identifiers or any other string data to the order to be injected. A common use…
DateTime
string
Discounts
array
Any discounts which ought to be applied to the order
Fees
array
All applicable fees for an order
PlaceOrder
object
11 properties6 required
Feedback
object
Line item feedback for a cart entry.
3 properties1 required
StoreId
string
Unique Store ID
ExternalReferenceId
string
External reference ID. An example might be the external menu selection ID, customer ID or order ID.
MFTaxes
object
Representation of taxes calculated by the partner.
2 properties2 required
Address
object
Standardized representation of a physical address
11 properties4 required
Fee
object
2 properties
POSOrderError
object
Generic error object for order processing
2 properties2 required
Order
object
Representation of an order placed by a customer
19 properties14 required
GeoPoint
object
The coordinates (latitude and longitude) for a given address.
2 properties2 required
PriceOrder
object
9 properties4 required
Payment
object
1 property
LoyaltyTransactionId
string
The loyalty transaction id created for the identify request
MenuSelectionPriced
object
Priced menu selection in the cart
3 required
LoyaltyId
string
The loyalty user id
CartPriced
object
Cart containing a customer's selections from the menu with prices
2 properties1 required
ServiceMode
string
How a customer would like their order served. Note that not all service modes will be available at all restaurants.
PaymentMethod
string
How the customer has paid or will pay
EntryId
string
Unique identifier for a menu entity
PosVendor
string
The posVendor that is processing the order
OrderPlaced
object
Representation of an order placed by a customer
3 properties2 required
Discount
object
A discount which ought to be applied to an order
2 properties
Customer
object
Customer personal details
6 properties2 required
CommitOrder
object
5 properties2 required
Charges
object
Order pricing details
5 properties
Cart
object
Cart representing a customer's selections from the menu
1 property1 required
ReadyInSeconds
integernull
Time in seconds when the order will be ready. This value incorporates the order preparationTimeInSeconds plus the value of fireOrderInSeconds. When fireOrderIn…
Phone
string
Phone number. Should always begin with the international country code (e.g., "+1")
Specification
The full machine-readable OpenAPI contract behind this narrative.
