How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Restaurant Brands International Orders API

The Orders API from Restaurant Brands International — 5 operation(s) for orders.

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 Order. 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 44 schemas. It is described by OpenAPI 3.2.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 operations 5 paths 44 schemas 1 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.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
getOrder 2 params → 200403404500
POST
/orders/price
Price Order
priceOrder 1 param body → 200400403500
POST
/orders/{orderId}/commit
Commit Order
commitOrder 2 params body → 200400403404500
POST
/orders/{orderId}/fire
Fire Order
fireOrder 2 params → 200403404500
POST
/orders/place
Place Order
placeOrder 1 param body → 200400403500

Schemas 44

The contract defines 44 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.

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.…
Phone
string
Phone number. Should always begin with the international country code (e.g., "+1")
Region
string
Region The Unicode [Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) region code of the country or region of the address. For example, the code…
Feedback
object
Line item feedback for a cart entry.
3 properties 1 required
Brand
string
MenuSelection
object
Menu selection in the cart
6 properties 2 required
PaymentMethod
string
How the customer has paid or will pay
PosVendor
string
The posVendor that is processing the order
OrderId
string
Unique identifier for an order
OrderError
object
Standard order error format
5 properties 3 required
Fee
object
2 properties
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…
MFTaxes
object
Representation of taxes calculated by the partner.
2 properties 2 required
PlaceOrder
object
11 properties 6 required
Cart
object
Cart representing a customer's selections from the menu
1 property 1 required
Loyalty
object
User and transaction information regarding loyalty
2 properties 2 required
OrderPlaced
object
Representation of an order placed by a customer
3 properties 2 required
Fees
array
All applicable fees for an order
Error
object
Standard error format for all errors returned by the API
4 properties 3 required
ServiceMode
string
How a customer would like their order served. Note that not all service modes will be available at all restaurants.
DateTime
string
StoreId
string
Unique Store ID
Address
object
Standardized representation of a physical address
11 properties 4 required
Charges
object
Order pricing details
5 properties
POSOrderError
object
Generic error object for order processing
2 properties 2 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…
Feedbacks
array
Feedback on cart prices and availability for cart menu selections. Cart feedback will only be provided for adjusted entries.
MenuSelectionPriced
object
Priced menu selection in the cart
3 required
Discounts
array
Any discounts which ought to be applied to the order
PriceOrder
object
9 properties 4 required
Customer
object
Customer personal details
6 properties 2 required
Currency
string
Currency code in [ISO-4217 alpha](https://en.wikipedia.org/wiki/ISO4217) format
CartPriced
object
Cart containing a customer's selections from the menu with prices
2 properties 1 required
LoyaltyTransactionId
string
The loyalty transaction id created for the identify request
Order
object
Representation of an order placed by a customer
19 properties 14 required
CommitOrder
object
5 properties 2 required
Discount
object
A discount which ought to be applied to an order
2 properties
ReadyInSeconds
integernull
Time in seconds when the order will be ready. This value incorporates the order preparationTimeInSeconds plus the value of fireOrderInSeconds. When fireOrderIn…
Payment
object
1 property
EntryId
string
Unique identifier for a menu entity
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
ExternalReferenceId
string
External reference ID. An example might be the external menu selection ID, customer ID or order ID.
LoyaltyId
string
The loyalty user id
GeoPoint
object
The coordinates (latitude and longitude) for a given address.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Restaurant Brands International publishes across the network.

Restaurant Brands International Loyalty API
Restaurant Brands International Menus API
Restaurant Brands International Stores API
Where this information came from

This is an independent, third-party profile of Restaurant Brands International Orders API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.