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

The Stores API from Restaurant Brands International — 3 operation(s) for stores.

Restaurant Brands International Stores 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 Stores. 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 19 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 19 schemas 2 GET1 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 Stores 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 — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Stores 3
GET
/stores/{storeId}
Store
getStore 2 params → 200403404
POST
/stores/{storeId}/store-status-changed
Store Status Changed
storeStatusChanged 1 param body → 200400403404
GET
/stores
List Stores
getStores 3 params → 200403404

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Location (8 properties), Store (8 properties), Error (4 properties), TimeSlot (4 properties). Each schema is shown below with its type and property counts.

limit
integer
Amount of results to fetch
Reason
string
Reason for the change in store status
Store
object
Information about a store
8 properties 7 required
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…
StoreStatus
string
The current marketplace status of the store
Error
object
Standard error format for all errors returned by the API
4 properties 3 required
Location
object
Information about a store location.
8 properties
TimeSlot
object
Contains information about the store service hours for a range of 15 consecutive days, starting from the day before the request is made.
4 properties 3 required
DateTime
string
WeekdayHours
object
Human-readable view of a store's weekly operating hours. Note: This information is intended for display purposes only. If you need to perform calculations base…
1 property
StoreStatusChanged
object
4 properties 3 required
StoreId
string
Unique Store ID
Available
object
Information about store availability
2 properties 1 required
GeoPoint
object
The coordinates (latitude and longitude) for a given address.
2 properties 2 required
Timezone
string
Timezone from the IANA [tz database](https://en.wikipedia.org/wiki/Tzdatabase)
cursor
string
Pagination cursor
ServiceMode
string
How a customer would like their order served. Note that not all service modes will be available at all restaurants.
PosVendor
string
The posVendor that is processing the order
ServiceHour
object
Store operating hours by serviceMode
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

restaurant-brands-stores-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 Orders API