RBI logo
API docs by Redocly

Burger King's Partners API v2 (2.0.0)

Download OpenAPI specification:Download

Overview

The Partners Menu API is provided for third party food ordering marketplaces integrating into Burger King's end to end fulfillment platform.

Menus

Individual Store Menu

Get full menu for an individual store

The menu response is a "flat" JSON (it doesn't have nested structures). All fields are root level properties, so you can refer to them simply by ID. The below example is a walk-through from menu to modifier.

Tenders example Type ID Name
Menu Menu menu_1 Menu
Section Section 4763b543-2d04-40a6-8b95-d55750ec554a Tenders
Picker Picker xdgrygmaqSf78Pjdh6UrTF 3Pc Tenders Meal
picker_pickerAspect PickerAspect xdgrygmaqSf78Pjdh6UrTF-76b9c2d3-536e-46bb-a060-f805a63b0063 Choose a Size
picker_pickerAspectOption PickerAspectOption xdgrygmaqSf78Pjdh6UrTF-medium Large Combo
combo Combo 00cc6fc6-5ce7-4361-aa95-9d6d726b5bbd 3Pc Tenders Medium Combo - Spicy
comboSlot ComboSlot group_item_40961 Main Item
comboSlotOption ComboSlotOption option_group_item_40961 N/A
item Item item_40961 3Pc Tenders - Spicy
modifierGroup ModifierGroup ModifierGroup_60 Sauces - 1 Included
modifier Modifier modifierMultiplier_1-00-163758 Tartar Sauce

Default entry: For each Picker & Modifier Group, each group will have a property, “defaultSelection”. DefaultSelection will have an ID for an entry that is default for that group

Group display type Description
List Group of Sections & Pickers(subsections)
Single-Entry One option that maps to options to select from (Size, Choice of Prep)
Select Group with Single Selection Option
Multi-Select Group with Multiple Selection Options
Authorizations:
bearer
path Parameters
storeId
string (StoreId) ^\d+$
Example: 42

Unique Store ID

serviceMode
string (Service Mode)
Enum: "CURBSIDE" "DELIVERY" "DRIVE_THRU" "EAT_IN" "TABLE_SERVICE" "TAKEOUT"
Example: TAKEOUT

Service mode

query Parameters
version
string
Example: version=1

Menu version ID

header Parameters
x-ui-region
string
Example: US

The Unicode Common Locale Data Repository (CLDR) region code of the country or region of the address.

For the full list of country codes, refer to the CLDR Chart.

Responses

Response Schema: application/json
required
object (Menu)

BK Menu (v2)

Response samples

Content type
application/json
{
  • "data": {
    }
}

Menu

Get full menu

The menu response is a "flat" JSON (it doesn't have nested structures). All fields are root level properties, so you can refer to them simply by ID. The below example is a walk-through from menu to modifier.

Flame Grilled Burgers Example Type ID Name
Menu Menu menu_1 Menu
Section Section section_5596 Flame Grilled Burgers
Picker Picker picker_5520 Whopper
picker_pickerAspect PickerAspect picker_5520-pickerAspect_Size Select Your Combo Size
picker_pickerAspectOption AspectOption picker_5520-pickeraspectvaluesizemedium Medium - Side and Drink Included
picker_pickerAspect_pickerAspectOption_pickerAspect PickerAspect picker_5520-pickerAspect_Size-pickeraspectvaluesizemedium-f172655b-5882-429c-a181-682ef137f044 Bacon & Cheese
picker_pickerAspectOption_pickerAspectOption2 AspectOption picker_5520-pickeraspectvaluesizemedium-baconandcheese With Bacon & Cheese
combo Combo combo_5063 Whopper with Bacon & Cheese Meal Medium
comboSlot ComboSlot combo_5063$main Main Item
item Item item_140 Whopper with Bacon & Cheese
modifierGroup ModifierGroup item_140$Modifier_845 American Cheese
modifier Modifier modifierMultiplier_1-00-200123 Regular Cheese

Default entry: For each Picker & Modifier Group, each group will have a property, “defaultSelection”. DefaultSelection will have an ID for an entry that is default for that group

Authorizations:
bearer
path Parameters
storeId
string (StoreId) ^\d+$
Example: 42

Unique Store ID

header Parameters
x-ui-region
string
Example: US

The Unicode Common Locale Data Repository (CLDR) region code of the country or region of the address.

For the full list of country codes, refer to the CLDR Chart.

Responses

Response Schema: application/json
required
object (Menu)

BK Menu (v2)

Response samples

Content type
application/json
{
  • "data": {
    }
}

Menu

required
Array of objects (ConfigOfferEntry)

Config offer entries

required
Array of objects (DayPart)

Categories of menu availability by day and time

required
Array of objects (MenuEntry)

All valid menu entries

required
object (Meta)

Metadata about the menu document

required
Array of objects (RewardEntry)

Reward entries

rootMenuEntryId
required
string

Reference to root menu entry

required
Array of objects (SystemWideOfferEntry)

Systemwide offer entries

required
Array of objects (PaperCouponEntry)

Paper coupon entries

{
  • "configOfferEntries": [
    ],
  • "dayParts": [
    ],
  • "entries": [
    ],
  • "meta": {
    },
  • "rewardEntries": [
    ],
  • "rootMenuEntryId": "string",
  • "systemWideOfferEntries": [
    ],
  • "paperCouponEntries": [
    ]
}

Error

status
number
Example: 400

HTTP status code

code
required
string
Example: "ValidationError"

Unique error code. Same as errors[0].code

message
required
string
Example: "isAvailable must be a boolean value"

Human readable error mesage. Same as errors[0].message

required
Array of objects

All errors

{
  • "status": 400,
  • "code": "ValidationError",
  • "message": "isAvailable must be a boolean value",
  • "errors": [
    ]
}