POSOrderError

Generic error object for order processing

Fortune 500FranchisingHospitalityNYSE QSRQuick Service RestaurantsRestaurants

Properties

Name Type Description
message string Human readable error message
code string Error code
View JSON Schema on GitHub

JSON Schema

channel-posorder-error-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "POSOrderError",
  "description": "Generic error object for order processing",
  "$id": "https://raw.githubusercontent.com/api-evangelist/restaurant-brands/refs/heads/main/json-schema/channel-posorder-error-schema.json",
  "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"
  ]
}