Otter · JSON Structure

Public Api Eater Order History Request Structure

Request parameters to fetch eater's order history

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

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

Properties

limit pageToken eaterId source

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-eater-order-history-request-structure.json",
  "name": "EaterOrderHistoryRequest",
  "description": "Request parameters to fetch eater's order history",
  "type": "object",
  "properties": {
    "limit": {
      "type": "double",
      "description": "Max number of orders to retrieve per page",
      "format": 10,
      "example": 1.0
    },
    "pageToken": {
      "type": "string",
      "description": "Opaque token used for paging. Query parameters must be URL encoded.",
      "example": "CgwI09+kjQYQwOvF2AM=/(urlencoded:CgwI09%2BkjQYQwOvF2AM%3D)"
    },
    "eaterId": {
      "type": "string",
      "description": "External eater's Id",
      "example": "eater-12345"
    },
    "source": {
      "type": "string",
      "description": "Order placed from which source",
      "example": "venmo"
    }
  },
  "required": [
    "limit",
    "eaterId"
  ]
}