Otter · JSON Structure

Public Api Posorder Status Update Request Structure

The request to change an order status.

Type: object Properties: 2 Required: 2
RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

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

Properties

orderStatus orderExternalIdentifiers

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/otter/refs/heads/main/json-structure/public-api-posorder-status-update-request-structure.json",
  "name": "POSOrderStatusUpdateRequest",
  "description": "The request to change an order status.",
  "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"
  ]
}