Otter · Schema

POSOrderStatusUpdateRequest

The request to change an order status.

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name	Type	Description
orderStatus	string	The requested status to transition the order to.
orderExternalIdentifiers	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "POSOrderStatusUpdateRequest",
  "description": "The request to change an order status.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-posorder-status-update-request-schema.json",
  "type": "object",
  "properties": {
    "orderStatus": {
      "type": "string",
      "description": "The requested status to transition the order to.",
      "enum": [
        "CONFIRMED",
        "CANCELED"
      ],
      "example": "CONFIRMED"
    },
    "orderExternalIdentifiers": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-order-identifier-schema.json"
    }
  },
  "required": [
    "orderExternalIdentifiers",
    "orderStatus"
  ]
}