Otter · Schema

ListShipmentsResponse

ListShipmentsResponse schema from Public API (Otter Public API).

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name Type Description
shipments array A list of shipments.
nextToken string Opaque token used to fetch the following page. If set, pass the value of nextToken to the next request. If not set, no more results are available.
View JSON Schema on GitHub

JSON Schema

public-api-list-shipments-response-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ListShipmentsResponse",
  "description": "ListShipmentsResponse schema from Public API (Otter Public API).",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-list-shipments-response-schema.json",
  "type": "object",
  "properties": {
    "shipments": {
      "type": "array",
      "description": "A list of shipments.",
      "maxItems": 50,
      "items": {
        "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-shipment-schema.json"
      }
    },
    "nextToken": {
      "type": "string",
      "description": "Opaque token used to fetch the following page. If set, pass the value of nextToken to the next request. If not set, no more results are available.",
      "example": "H12MAF2fFaFFFa"
    }
  }
}