Otter · Schema

OrderStatusEvent

OrderStatusEvent schema from Public API (Otter Public API).

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name Type Description
status string Events that represent updates on order status.
eventTime string The time when this OrderStatusUpdateEvent occurred
View JSON Schema on GitHub

JSON Schema

public-api-order-status-event-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "OrderStatusEvent",
  "description": "OrderStatusEvent schema from Public API (Otter Public API).",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-order-status-event-schema.json",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Events that represent updates on order status.",
      "enum": [
        "ORDER_ACCEPTED",
        "ORDER_HANDED_OFF",
        "ORDER_READY_TO_PICKUP",
        "ORDER_FULFILLED"
      ],
      "example": "ORDER_ACCEPTED"
    },
    "eventTime": {
      "type": "string",
      "description": "The time when this OrderStatusUpdateEvent occurred",
      "format": "date-time",
      "example": "2007-12-03T10:15:30+01:00"
    }
  }
}