RBI logo
API docs by Redocly

Burger King's Partners API (1.0.0)

Download OpenAPI specification:Download

Overview

The Channel Partners API are provided for third party food ordering marketplaces integrating into the Restaurant Brand International (RBI) fulfillment platform.

Authentication

Webhooks

Webhook requests are signed using hex encoded HMAC signatures.

An HMAC signature is derived for validation using three components:

  • the secret shared between the service and the consumer
  • the body of the request
  • the hash function or algorithm (SHA-256)

Using these three pieces of information, compute an HMAC signature using the secret as the key and the body of the request as the message and encode the signature to a hexadecimal string for comparison.

Compare the signature generated using the above information to the signature received in the x-signature header, if the two signatures match, the request is valid.

Loyalty

Identify

Authorizations:
bearer
Request Body schema: application/json
identifier
required
string (Identifier) ^(\d{6}|\d{4})$
Example: "1234"

An OTP code (6 digit code) or a static Offer code (4 digit code)

identifierType
required
string (IdentifierType)
Enum: "OTP" "OFFER_CODE"
Example: "OTP"

Determines the type of identifier being sent

storeId
required
string (StoreId) ^\d+$
Example: "42"

Unique Store ID

serviceMode
required
string (ServiceMode)
Enum: "CURBSIDE" "DELIVERY" "DRIVE_THRU" "EAT_IN" "TABLE_SERVICE" "TAKEOUT"
Example: "TAKEOUT"

How a customer would like their order served.

Note that not all service modes will be available at all restaurants.

object (IdentifyRequestDetails)

Responses

Response Schema: application/json
required
object (IdentifyResponse)

Request samples

Content type
application/json
{
  • "identifier": "1234",
  • "identifierType": "OTP",
  • "storeId": "42",
  • "serviceMode": "TAKEOUT",
  • "details": {
    }
}

Response samples

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

Orders

Order Updated Event Webhook

Order updated events are dispatched as an order state transitions.

When these "ORDER_UPDATED" events are delivered, a request must be made to the provided callbackUrl to fetch the latest order details.

header Parameters
x-signature
string

A hex encoded HMAC signature

Request Body schema: application/json
brand
required
string (Brand)
Value: "BK"
Example: "BK"
callbackUrl
required
string <url>
Example: "https://rbictg.com/api/v1/orders/41"

URL from which the updated order contents may be retrieved

eventTime
required
string <ISO 8601 Date Time> (DateTime)
Example: "1991-02-11T20:30:19Z"

When the order update occurred

eventType
required
string
Value: "ORDER_UPDATED"

Webhook event type

region
required
string (Region)
Example: "US"

Region The Unicode Common Locale Data Repository (CLDR) region code of the country or region of the address. For example, the code for the United States is US.

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

id
required
string (OrderId)
Example: "example-unique-id"

Unique identifier for an order

Responses

Request samples

Content type
application/json
{}

Order

Retrieve an order by ID

Authorizations:
bearer
path Parameters
orderId
required
string

Unique Order 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 (Order)

Representation of an order placed by a customer

Response samples

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

Price order

Price a new order.

The price order API must be called to create a new order and to validate the cart prices and item availability with the POS. When the Price Order request returns a success reponse, a subsequent [Commit Order](#operation/ commitOrder) request should (but is not guarenteed to) succeed.

Price requests can fail for a variety of reasons. For example:

  • Restaurant - The restaurant is unavailable.
  • Menu - An item in the cart is unavailable or violates permitted constraints.
  • Loyalty - Invalid user details were provided or a discount redemption failed.
  • POS - The order failed to price or inject.

Loyalty

  • Rewards: the cart must contain a menu selection with the id of the reward and children menu selections with one of possible options. If a reward points to a combo, then the combo must also contain menu selections for its options. A reward can be reedemed muliple times by modifying the quantity of the root menuSelection. The quantity of the children menuSelection must always be 1.
  • Offers: Offers are presented in the menu in a nested structure. The first level offer will always point to a second level offer by its options. The second level offer defines the entries required in the cart by its options. If the options is of type ENTRY then the item is present in the menu as a regular item. If an option has type 'SYSTEM_WIDE_OFFER' then an entity in the offer section will be present with that id and that entity should point to regular menu items by its options. In this scenario the client is given the capability to chose which option to include in the cart.
    • Constraints
      • An order can only contain one offer. This means it isn't possible to provide two menu selections with an offer or specifiying quantity different than 1.
Authorizations:
bearer
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.

Request Body schema: application/json
externalReferenceId
string (ExternalReferenceId)

External reference ID. An example might be the external menu selection ID, customer ID or order ID.

storeId
required
string (StoreId) ^\d+$
Example: "42"

Unique Store ID

serviceMode
required
string (ServiceMode)
Enum: "CURBSIDE" "DELIVERY" "DRIVE_THRU" "EAT_IN" "TABLE_SERVICE" "TAKEOUT"
Example: "TAKEOUT"

How a customer would like their order served.

Note that not all service modes will be available at all restaurants.

required
object (Cart)

Cart representing a customer's selections from the menu

required
object (Customer)

Customer personal details

object (Charges)

Order pricing details

mpfOrderId
string (MpfOrderId)
Example: "123456789"

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 for this is to hold additional external order numbers, like receipt number or third party short order ID.

object (Address)

Standardized representation of a physical address

object (Loyalty)

User and transaction information regarding loyalty

Responses

Response Schema: application/json
required
object (Order)

Representation of an order placed by a customer

Request samples

Content type
application/json
{
  • "externalReferenceId": "string",
  • "storeId": "42",
  • "serviceMode": "TAKEOUT",
  • "cart": {
    },
  • "customer": {
    },
  • "charges": {
    },
  • "mpfOrderId": "123456789",
  • "deliveryAddress": {
    },
  • "loyalty": {
    }
}

Response samples

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

Commit order

Commit an order.

Authorizations:
bearer
path Parameters
orderId
required
string

Unique Order 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.

Request Body schema: application/json
object (Charges)

Order pricing details

mpfOrderId
string (MpfOrderId)
Example: "123456789"

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 for this is to hold additional external order numbers, like receipt number or third party short order ID.

paymentMethod
required
string (PaymentMethod)
Enum: "APPLE_PAY" "CASH" "CREDIT_CARD" "GIFTCARD" "GOOGLE_PAY" "PAYPAL" "UNPAID" "VENMO"

How the customer has paid or will pay

fireOrderInSeconds
required
integer or null (FireOrderInSeconds) [ 0 .. 100000 ]
Example: 600

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.
  • fireOrderInSeconds=null hold the order in the POS without firing, requiring an explicit Fire Order call.
readyInSeconds
integer or null (ReadyInSeconds) >= 0
Example: 600

Time in seconds when the order will be ready.

This value incorporates the order preparationTimeInSeconds plus the value of fireOrderInSeconds. When fireOrderInSeconds=0, then readyInSeconds will match the value of preparationTimeInSeconds, and when fireOrderInSeconds=null, then readyInSeconds=null as well.

Responses

Response Schema: application/json
required
object (Order)

Representation of an order placed by a customer

Request samples

Content type
application/json
{
  • "charges": {
    },
  • "mpfOrderId": "123456789",
  • "paymentMethod": "APPLE_PAY",
  • "fireOrderInSeconds": 600,
  • "readyInSeconds": 600
}

Response samples

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

Fire order

Fire a committed order to the kitchen for preparation.

In cases when an order is committed with some pre-determined lead time (e.g., 30 minutes from now), it may be necessary to "fire" or "release" the order to the kitchen immediately before the original lead time has elapsed.

Authorizations:
bearer
path Parameters
orderId
required
string

Unique Order 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 (Order)

Representation of an order placed by a customer

Response samples

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

Place order

Price and commit a new order.

The place order API prices and commits an order asynchronously. Partners receive order changes via the Order Updated webhook.

Place order can fail for the same reasons a Price and Commit calls can fail, but also:

  • Price mismatches between partner and POS.
Authorizations:
bearer
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.

Request Body schema: application/json
externalReferenceId
string (ExternalReferenceId)

External reference ID. An example might be the external menu selection ID, customer ID or order ID.

storeId
required
string (StoreId) ^\d+$
Example: "42"

Unique Store ID

serviceMode
required
string (ServiceMode)
Enum: "CURBSIDE" "DELIVERY" "DRIVE_THRU" "EAT_IN" "TABLE_SERVICE" "TAKEOUT"
Example: "TAKEOUT"

How a customer would like their order served.

Note that not all service modes will be available at all restaurants.

required
object (Cart)

Cart representing a customer's selections from the menu

required
object (Customer)

Customer personal details

object (Charges)

Order pricing details

object (Address)

Standardized representation of a physical address

paymentMethod
required
string (PaymentMethod)
Enum: "APPLE_PAY" "CASH" "CREDIT_CARD" "GIFTCARD" "GOOGLE_PAY" "PAYPAL" "UNPAID" "VENMO"

How the customer has paid or will pay

fireOrderInSeconds
required
integer or null (FireOrderInSeconds) [ 0 .. 100000 ]
Example: 600

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.
  • fireOrderInSeconds=null hold the order in the POS without firing, requiring an explicit Fire Order call.
readyInSeconds
integer or null (ReadyInSeconds) >= 0
Example: 600

Time in seconds when the order will be ready.

This value incorporates the order preparationTimeInSeconds plus the value of fireOrderInSeconds. When fireOrderInSeconds=0, then readyInSeconds will match the value of preparationTimeInSeconds, and when fireOrderInSeconds=null, then readyInSeconds=null as well.

mpfOrderId
string (MpfOrderId)
Example: "123456789"

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 for this is to hold additional external order numbers, like receipt number or third party short order ID.

Responses

Response Schema: application/json
required
object (OrderPlaced)

Representation of an order placed by a customer

Request samples

Content type
application/json
{
  • "externalReferenceId": "string",
  • "storeId": "42",
  • "serviceMode": "TAKEOUT",
  • "cart": {
    },
  • "customer": {
    },
  • "charges": {
    },
  • "deliveryAddress": {
    },
  • "paymentMethod": "APPLE_PAY",
  • "fireOrderInSeconds": 600,
  • "readyInSeconds": 600,
  • "mpfOrderId": "123456789"
}

Response samples

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

Menus

Menu Updated Event Webhook

Menu updated events are dispatched when a store's menu changes.

Menus can change for a variety of reasons. Some stores may update the availability of an item to make it unavailable for orders ("stock out"). Operators also make frequent changes to menu prices throughout the day, and at the brand-level menu entries are being added and removed continuously.

When these "MENU_UPDATED" events are delivered, a request must be made to the provided callbackUrl to fetch the latest store menu details.

header Parameters
x-signature
string

A hex encoded HMAC signature

Request Body schema: application/json
brand
required
string (Brand)
Value: "BK"
Example: "BK"
callbackUrl
required
string <url>
Example: "https://rbictg.com/api/v1/menus/41?servicemode=DELIVERY&version=1"

URL from which the updated menu contents may be retrieved

eventTime
required
string <ISO 8601 Date Time> (DateTime)
Example: "1991-02-11T20:30:19Z"

When the menu update occurred

eventType
required
string
Value: "MENU_UPDATED"

Webhook event type

region
string (Region)
Example: "US"

Region The Unicode Common Locale Data Repository (CLDR) region code of the country or region of the address. For example, the code for the United States is US.

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

serviceMode
required
string (ServiceMode)
Enum: "CURBSIDE" "DELIVERY" "DRIVE_THRU" "EAT_IN" "TABLE_SERVICE" "TAKEOUT"
Example: "TAKEOUT"

Menu service mode

storeId
required
string (StoreId) ^\d+$
Example: "42"

Unique Store ID

version
required
string

Unique ID for the menu iteration that triggered the update.

Each store menu update for a store and service mode will include a unique version ID.

Responses

Request samples

Content type
application/json
{}

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 Group menu_1 Menu
Section Group 4763b543-2d04-40a6-8b95-d55750ec554a Tenders
Picker Group xdgrygmaqSf78Pjdh6UrTF 3Pc Tenders Meal
picker_pickerAspect Group xdgrygmaqSf78Pjdh6UrTF-76b9c2d3-536e-46bb-a060-f805a63b0063 Choose a Size
picker_pickerAspectOption Group xdgrygmaqSf78Pjdh6UrTF-medium Large Combo
picker_pickerAspect_pickerAspectOption_pickerAspect Group xdgrygmaqSf78Pjdh6UrTF-76b9c2d3-536e-46bb-a060-f805a63b0063-medium-b376ee07-5ba9-464d-a3b0-e79ad3643e2a Choice of Tenders Preparation
picker_pickerAspectOption_pickerAspectOption2 Group xdgrygmaqSf78Pjdh6UrTF-medium-spicy Spicy
combo Combo 00cc6fc6-5ce7-4361-aa95-9d6d726b5bbd 3Pc Tenders Medium Combo - Spicy
comboSlot Group group_item_40961 Main Item
comboSlotOption Group option_group_item_40961 N/A
item Item item_40961 3Pc Tenders - Spicy
modifierGroup Group 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

GROUPS: The menu has four types: Combo, Item, Group and Modifier. The group type exists to wrap relevant references to walk through the menu. Only Combo, Item and Modifier will be passed to and committed to POS in Cart.

Types of Groups Description Display type
Menu Group of Sections List
Section Section is a broad container. It can contain pickers, items , combos as well as other sections List
Picker Pickers allows an step by step selection process that ultimate resolve in Combos or Item. Pickers have only one immediate child, a reference to the first aspect. Single entry
Picker Aspect Group of Picker Aspect Options Select
Picker Aspect Option Group of picker Options - References the next aspect for the picker. The picker options of the last aspect reference the final selection result (combo/item) Single entry
Combo Slot Group of Combo Slot Options Select
Combo Slot Option References Combo Slot Option Single entry
Modifier Group Group of Modifiers Multi-select
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
required
string (StoreId) ^\d+$
Example: 42

Unique Store ID

serviceMode
required
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)

Store menu

Response samples

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

Stores

Store Updated Event Webhook

Store updated events are dispatched when a store's availability or metadata has changed.

The availability of individual stores can change regularly for a variety of reasons. In some cases a store may be experiencing a temporary outage, or a more widespread outage may be affecting the Point of Sale (POS) vendor. In addition, store operators can update operating hours and service modes, and expect these changes to be reflected across all supported platforms.

When these "STORE_UPDATED" events are delivered, a request must be made to the provided callbackUrl to fetch the latest store details.

header Parameters
x-signature
string

A hex encoded HMAC signature

Request Body schema: application/json
brand
required
string (Brand)
Value: "BK"
Example: "BK"
callbackUrl
required
string <url>
Example: "https://partners-bk.rbictg.com/api/v1/stores/42"

URL from which the updated store details may be retrieved.

eventTime
required
string <ISO 8601 Date Time> (DateTime)
Example: "1991-02-11T20:30:19Z"

Store update event time.

eventType
required
string
Value: "STORE_UPDATED"

Webhook event type.

region
required
string (Region)
Example: "US"

Region The Unicode Common Locale Data Repository (CLDR) region code of the country or region of the address. For example, the code for the United States is US.

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

storeId
required
string (StoreId) ^\d+$
Example: "42"

Unique Store ID

Responses

Request samples

Content type
application/json
{}

Store

Store (restaurant) details.

Use this endpoint get the full details of a specific store, including the Detailed Availability by service mode

Authorizations:
bearer
path Parameters
storeId
required
string

Unique ID representing a store

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 (Store)

Information about a store

Response samples

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

Store status changed

This endpoint is used to update the status of a store.

Authorizations:
bearer
path Parameters
storeId
required
string

Unique ID representing a store

Request Body schema: application/json
reason
string (Reason)
Example: "store was deactivated due to high error rate"

Reason for the change in store status

region
required
string (Region)
Example: "US"

Region The Unicode Common Locale Data Repository (CLDR) region code of the country or region of the address. For example, the code for the United States is US.

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

storeStatus
required
string (StoreStatus)
Enum: "ACTIVE" "INACTIVE"

The current marketplace status of the store

updatedAt
required
string <ISO 8601 Date Time> (DateTime)
Example: "1991-02-11T20:30:19Z"

Responses

Request samples

Content type
application/json
{
  • "reason": "store was deactivated due to high error rate",
  • "region": "US",
  • "storeStatus": "ACTIVE",
  • "updatedAt": "1991-02-11T20:30:19Z"
}

Response samples

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

List stores

Store List.

Use this endpoint get a list of stores and their info.

Pagination

Pagination is provided in a cursor-basis. For each set of results, a cursor will be returned as part of the response's meta. Providing this cursor to the next call will fetch the next page of the result set.

The max amount of restaurants to be returned is controlled by limit

Authorizations:
bearer
query Parameters
limit
integer (Limit) [ 1 .. 100 ]
Default: 20
Example: limit=10

Number of results to fetch

cursor
string (Cursor)
Example: cursor=cursor-id

Pagination cursor

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
object
required
Array of objects (Store)

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Order

id
required
string (OrderId)
Example: "example-unique-id"

Internal order ID

externalReferenceId
string (ExternalReferenceId)

External reference ID. An example might be the external menu selection ID, customer ID or order ID.

storeId
required
string (StoreId) ^\d+$
Example: "42"

Internal store ID

required
object (CartPriced)

Cart containing a customer's selections from the menu with prices

serviceMode
required
string (ServiceMode)
Enum: "CURBSIDE" "DELIVERY" "DRIVE_THRU" "EAT_IN" "TABLE_SERVICE" "TAKEOUT"
Example: "TAKEOUT"

How a customer would like their order served.

Note that not all service modes will be available at all restaurants.

required
object (Customer)

Customer personal details

required
object (Charges)

Order pricing details

Array of objects (Discounts)

Any discounts which ought to be applied to the order

object (Payment)
posVendor
required
string (PosVendor)
Enum: "BRINK" "CARROLS" "NCR" "QDI" "SICOM"

The posVendor that is processing the order

status
required
string (OrderStatus)
Enum: "CREATED" "PRICED" "COMMITTED" "PREPARING" "PREPARED" "DONE" "CANCELED" "ERROR"

Order status, representing current state of order in its lifecycle.

When transitioning the order status, the status must always advance further in the lifecycle. All other transitions are invalid.

Status Description
CREATED Order has been created.
PRICED Order has been priced. The POS has provided price information for the order.
COMMITTED Order has been committed. The POS has accepted the order.
PREPARING Order is being prepared in the restaurant
PREPARED Order has been prepared and is ready for pickup or delivery.
DONE Order is done. This is the final state for a successful order.
CANCELED Order has been cancelled.
ERROR Error with the order. Customer should be notified and refunded.
object (Address)

Where the order will be delivered (only delivery orders)

loyaltyPointsEarned
integer >= 0
Example: 15

Amount of Loyalty Points earned on this order

Array of objects (Order Error)

Any errors which occurred during order processing

createdAt
required
string <ISO 8601 Date Time> (DateTime)
Example: "1991-02-11T20:30:19Z"

When the order was first created

updatedAt
required
string <ISO 8601 Date Time> (DateTime)
Example: "1991-02-11T20:30:19Z"

When the order was last updated

fireOrderInSeconds
required
integer or null (FireOrderInSeconds) [ 0 .. 100000 ]
Example: 600

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.
  • fireOrderInSeconds=null hold the order in the POS without firing, requiring an explicit Fire Order call.
preparationTimeInSeconds
required
integer >= 0
Example: 300

Estimated time it takes to prepare an order

readyInSeconds
required
integer or null (ReadyInSeconds) >= 0
Example: 600

Time in seconds when the order will be ready.

This value incorporates the order preparationTimeInSeconds plus the value of fireOrderInSeconds. When fireOrderInSeconds=0, then readyInSeconds will match the value of preparationTimeInSeconds, and when fireOrderInSeconds=null, then readyInSeconds=null as well.

{
  • "id": "example-unique-id",
  • "externalReferenceId": "string",
  • "storeId": "42",
  • "cart": {
    },
  • "serviceMode": "TAKEOUT",
  • "customer": {
    },
  • "charges": {
    },
  • "discounts": [
    ],
  • "payment": {
    },
  • "posVendor": "BRINK",
  • "status": "CREATED",
  • "deliveryAddress": {
    },
  • "loyaltyPointsEarned": 15,
  • "errors": [
    ],
  • "createdAt": "1991-02-11T20:30:19Z",
  • "updatedAt": "1991-02-11T20:30:19Z",
  • "fireOrderInSeconds": 600,
  • "preparationTimeInSeconds": 300,
  • "readyInSeconds": 600
}

Menu

required
object

Metadata about the menu document

required
Array of objects (Menu availability)

Categories of menu availability by day and time

rootMenuEntryId
required
string (EntryId)
Example: "entry-id"

Reference to root menu entry

required
Array of objects (Entry)

All valid menu entries

Array of objects (SystemWideOfferEntry)

All System-Wide Offer Entries

Array of objects (RewardEntry)

All Reward Entries

Array of objects (ConfigOfferEntry)

All Config Offer Entries

{
  • "meta": {
    },
  • "dayParts": [
    ],
  • "rootMenuEntryId": "entry-id",
  • "entries": [
    ],
  • "systemWideOfferEntries": [
    ],
  • "rewardEntries": [
    ],
  • "configOfferEntries": [
    ]
}

Store

required
object (Available)

True if the store is available for ordering.

franchiseGroupName
string
Example: "Acme Group"

Store franchise group name.

required
object (Location)

Information about a store location.

name
required
string
Example: "Example test lab"

Store name

posVendor
required
string (PosVendor)
Enum: "BRINK" "CARROLS" "NCR" "QDI" "SICOM"

The posVendor that is processing the order

required
Array of objects (ServiceHour)

Store operating hours by serviceMode

storeId
required
string (StoreId) ^\d+$
Example: "42"

Unique Store ID

timezone
required
string (Timezone)
Example: "America/New_York"

Timezone from the IANA tz database

{
  • "availability": {
    },
  • "franchiseGroupName": "Acme Group",
  • "location": {
    },
  • "name": "Example test lab",
  • "posVendor": "BRINK",
  • "serviceHour": [
    ],
  • "storeId": "42",
  • "timezone": "America/New_York"
}

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": [
    ]
}