Otter · JSON Structure

Public Api Delivery Status Update Request Structure

Update delivery status request.

Type: object Properties: 12
RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

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

Properties

deliveryStatus estimatedDeliveryTime estimatedPickupTime courier location createdAt vehicleInformation currencyCode cost providerDeliveryId dropoffInfo deliveryTrackingUrl

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-status-update-request-structure.json",
  "name": "DeliveryStatusUpdateRequest",
  "description": "Update delivery status request.",
  "type": "object",
  "properties": {
    "deliveryStatus": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-delivery-status-schema.json"
    },
    "estimatedDeliveryTime": {
      "type": "datetime",
      "nullable": true,
      "description": "The expected delivery time.",
      "example": "2007-12-03T10:15:30+01:00"
    },
    "estimatedPickupTime": {
      "type": "datetime",
      "nullable": true,
      "description": "The expected pickup time.",
      "example": "2007-12-03T10:15:30+01:00"
    },
    "courier": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-person-schema.json"
    },
    "location": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-location-schema.json"
    },
    "createdAt": {
      "type": "datetime",
      "description": "The time that the update was created.",
      "example": "2007-12-03T10:15:30+01:00"
    },
    "vehicleInformation": {
      "nullable": true,
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-vehicle-information-schema.json"
    },
    "currencyCode": {
      "type": "string",
      "nullable": true,
      "minLength": 3,
      "maxLength": 3,
      "description": "The 3-letter currency code (ISO 4217) to use for all monetary values.",
      "example": "EUR"
    },
    "cost": {
      "nullable": true,
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-delivery-cost-schema.json"
    },
    "providerDeliveryId": {
      "type": "string",
      "nullable": true,
      "description": "The provider's internal identifier for the delivery used for tracking purposes.",
      "example": "store_123"
    },
    "dropoffInfo": {
      "nullable": true,
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-dropoff-info-schema.json",
      "description": "Details on delivery dropoff."
    },
    "deliveryTrackingUrl": {
      "type": "string",
      "nullable": true,
      "description": "Delivery tracking url.",
      "example": "https://example.com/resource"
    }
  }
}