Otter · JSON Structure

Public Api Order Feed Structure

An order feed response

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

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

Properties

orders offsetToken

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-order-feed-structure.json",
  "name": "OrderFeed",
  "description": "An order feed response",
  "type": "object",
  "properties": {
    "orders": {
      "type": "array",
      "description": "Array of Orders",
      "items": {
        "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-order-schema.json"
      }
    },
    "offsetToken": {
      "type": "string",
      "description": "Opaque token used to fetch the following page. If not set, no more orders are available.",
      "example": "H12MAF2fFaFFFa"
    }
  },
  "required": [
    "orders"
  ]
}