Otter · JSON Structure

Public Api Delivery Info Structure

Information on order's delivery process.

Type: object Properties: 7
RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

DeliveryInfo is a JSON Structure definition published by Otter, describing 7 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

courier destination licensePlate makeModel lastKnownLocation dropoffInstructions note

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-delivery-info-structure.json",
  "name": "DeliveryInfo",
  "description": "Information on order's delivery process.",
  "type": "object",
  "properties": {
    "courier": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-courier-schema.json"
    },
    "destination": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-address-schema.json"
    },
    "licensePlate": {
      "type": "string",
      "nullable": true,
      "description": "License plate of a vehicle used by the courier.",
      "example": "ABC 123"
    },
    "makeModel": {
      "type": "string",
      "nullable": true,
      "description": "Make and model of a vehicle used by the courier.",
      "example": "Honda CR-V"
    },
    "lastKnownLocation": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-location-schema.json"
    },
    "dropoffInstructions": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-dropoff-instructions-schema.json"
    },
    "note": {
      "type": "string",
      "nullable": true,
      "description": "Special delivery instructions, if any.",
      "example": "Gate code 123"
    }
  }
}