Restaurant Brands International · JSON Structure

Channel Order Status Structure

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

Type: string Properties: 0
Fortune 500FranchisingHospitalityNYSE QSRQuick Service RestaurantsRestaurants

OrderStatus is a JSON Structure definition published by Restaurant Brands International. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

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-status-structure.json",
  "name": "OrderStatus",
  "description": "Order status, representing current state of order in its lifecycle.\n\nWhen transitioning the order status, the status must always advance further in the lifecycle. All other transitions are invalid.\n\n|Status   |Description                                                                 |\n|---------|----------------------------------------------------------------------------|\n|CREATED  |Order has been created.                                                     |\n|PRICED   |Order has been priced. The POS has provided price information for the order.|\n|COMMITTED|Order has been committed. The POS has accepted the order.                   |\n|PREPARING|Order is being prepared in the restaurant                                   |\n|PREPARED |Order has been prepared and is ready for pickup or delivery.                |\n|DONE     |Order is done. This is the final state for a successful order.              |\n|CANCELED |Order has been cancelled.                                                   |\n|ERROR    |Error with the order. Customer should be notified and refunded.             |\n",
  "type": "string",
  "enum": [
    "CREATED",
    "PRICED",
    "COMMITTED",
    "PREPARING",
    "PREPARED",
    "DONE",
    "CANCELED",
    "ERROR"
  ]
}