Otter · JSON Structure

Public Api Shipment Structure

Shipment schema from Public API (Otter Public API).

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

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

Properties

id deliveryInfo lineItems stateChanges

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-shipment-structure.json",
  "name": "Shipment",
  "description": "Shipment schema from Public API (Otter Public API).",
  "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"
  ]
}