Channel Posorder Error Structure

Generic error object for order processing

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

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

Properties

message code

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-posorder-error-structure.json",
  "name": "POSOrderError",
  "description": "Generic error object for order processing",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Human readable error message",
      "example": "TERMINAL UPDATE IN PROGRESS"
    },
    "code": {
      "type": "string",
      "description": "Error code",
      "example": "STORE",
      "enum": [
        "MENU",
        "STORE",
        "TIMEOUT",
        "UNKNOWN"
      ]
    }
  },
  "required": [
    "message",
    "code"
  ]
}