Otter · JSON Structure

Public Api Delivery Status Update Event Structure

Event that represent a status update for a delivery.

Type: object Properties: 14
RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

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

Properties

provider courier estimatedDeliveryTime estimatedPickupTime status deliveryStatus currencyCode baseFee extraFee totalFee distance updatedTime deliveryTrackingUrl dropoffInfo

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-event-structure.json",
  "name": "DeliveryStatusUpdateEvent",
  "description": "Event that represent a status update for a delivery.",
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "description": "Describes the provider of the delivery.",
      "example": "doordash"
    },
    "courier": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-courier-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"
    },
    "status": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-delivery-status-schema.json"
    },
    "deliveryStatus": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-delivery-status-schema.json"
    },
    "currencyCode": {
      "type": "string",
      "minLength": 3,
      "maxLength": 3,
      "description": "The 3-letter currency code (ISO 4217) to use for all monetary values.",
      "example": "EUR",
      "nullable": true
    },
    "baseFee": {
      "type": "double",
      "nullable": true,
      "example": 1.0
    },
    "extraFee": {
      "type": "double",
      "nullable": true,
      "example": 1.0
    },
    "totalFee": {
      "type": "double",
      "nullable": true,
      "example": 1.0
    },
    "distance": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-distance-schema.json"
    },
    "updatedTime": {
      "type": "datetime",
      "nullable": true,
      "description": "The time that the delivery status was updated.",
      "example": "2007-12-03T10:15:30+01:00"
    },
    "deliveryTrackingUrl": {
      "type": "uri",
      "nullable": true,
      "description": "The URL to track the delivery.",
      "example": "https://www.doordash.com/delivery/track/1234567890"
    },
    "dropoffInfo": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-dropoff-info-schema.json"
    }
  }
}