Restaurant Brands International · JSON Structure

Channel Order Placed Structure

Representation of an order placed by a customer

Type: object Properties: 3 Required: 2
Fortune 500FranchisingHospitalityNYSE QSRQuick Service RestaurantsRestaurants

OrderPlaced is a JSON Structure definition published by Restaurant Brands International, describing 3 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id externalReferenceId callbackUrl

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/restaurant-brands/refs/heads/main/json-structure/channel-order-placed-structure.json",
  "name": "OrderPlaced",
  "description": "Representation of an order placed by a customer",
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/components/schemas/OrderId",
      "description": "Internal order ID"
    },
    "externalReferenceId": {
      "$ref": "#/components/schemas/ExternalReferenceId",
      "description": "Partner's order ID"
    },
    "callbackUrl": {
      "type": "string",
      "description": "URL to order details.",
      "example": "https://bk-partners.rbictg.com"
    }
  },
  "required": [
    "id",
    "callbackUrl"
  ]
}