Otter · Schema

Shipment

Shipment schema from Public API (Otter Public API).

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name Type Description
id string A UUID for the shipment.
deliveryInfo object
lineItems array A list of the shipment line items.
stateChanges array The state changes for the shipment. The final state change represents the current state of the shipment.
View JSON Schema on GitHub

JSON Schema

public-api-shipment-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Shipment",
  "description": "Shipment schema from Public API (Otter Public API).",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-shipment-schema.json",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "A UUID for the shipment.",
      "example": "18695c43-c670-4c57-a714-e0d7b215db20"
    },
    "deliveryInfo": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-shipment-delivery-info-schema.json"
    },
    "lineItems": {
      "type": "array",
      "description": "A list of the shipment line items.",
      "items": {
        "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-shipment-line-item-schema.json"
      }
    },
    "stateChanges": {
      "type": "array",
      "minItems": 1,
      "description": "The state changes for the shipment. The final state change represents the current state of the shipment.",
      "items": {
        "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-shipment-state-change-schema.json"
      }
    }
  },
  "required": [
    "id",
    "deliveryInfo",
    "lineItems",
    "stateChanges"
  ]
}