Otter · Schema

RequiredDeliveryInfo

Information on order's delivery process.

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name Type Description
courier object
destination object
licensePlate string License plate of a vehicle used by the courier.
makeModel string Make and model of a vehicle used by the courier.
lastKnownLocation object
dropoffInstructions object
note string Special delivery instructions, if any.
View JSON Schema on GitHub

JSON Schema

public-api-required-delivery-info-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "RequiredDeliveryInfo",
  "description": "Information on order's delivery process.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-required-delivery-info-schema.json",
  "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"
    }
  }
}