Otter · Schema

OrderFeed

An order feed response

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name Type Description
orders array Array of Orders
offsetToken string Opaque token used to fetch the following page. If not set, no more orders are available.
View JSON Schema on GitHub

JSON Schema

public-api-order-feed-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "OrderFeed",
  "description": "An order feed response",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-order-feed-schema.json",
  "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"
  ]
}