Otter · Schema

RequestDeliveryQuoteEvent

RequestDeliveryQuoteEvent schema from Public API (Otter Public API).

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name	Type	Description
deliveryReferenceId	string	Generated delivery reference id.
provider	string	the pre-configured fulfillment provider slug in the onboarding process.
preferredPickupDuration	integer	Preferred time for courier to arrive to pick up order. Value expressed in minutes and is relative to time delivery request is made. If not provided, or if the value is 0, please treat it as an ASAP re
pickupAddress	object	Order pickup address.
dropoffAddress	object	Order drop-off address.
destinationAddress	object	Order destination address. Deprecated in favor of dropoffAddress.
pickUpLocationId	string	An identifier for the pick up location
orderSubTotal	number	The sum of all item and modifier pricing
currencyCode	string	The 3-letter currency code (ISO 4217) to use for all monetary values.
containsAlcoholicItem	boolean	Whether or not the order contains an alcoholic item.
customerPayments	array	Processed and collectible payments from the customer.
orderExternalIdentifiers	object	ID info associated with the order in external system, which is utilized for 3pl integrations.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "RequestDeliveryQuoteEvent",
  "description": "RequestDeliveryQuoteEvent schema from Public API (Otter Public API).",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-request-delivery-quote-event-schema.json",
  "type": "object",
  "properties": {
    "deliveryReferenceId": {
      "type": "string",
      "description": "Generated delivery reference id.",
      "example": "d1a5e7c6-a79a-49bc-83bf-4169cd9c9dda"
    },
    "provider": {
      "type": "string",
      "description": "the pre-configured fulfillment provider slug in the onboarding process.",
      "example": "doordash"
    },
    "preferredPickupDuration": {
      "type": "integer",
      "description": "Preferred time for courier to arrive to pick up order. Value expressed in minutes and is relative to time delivery request is made. If not provided, or if the value is 0, please treat it as an ASAP request.",
      "format": "int32",
      "example": 0
    },
    "pickupAddress": {
      "allOf": [
        {
          "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-required-address-schema.json"
        }
      ],
      "description": "Order pickup address."
    },
    "dropoffAddress": {
      "allOf": [
        {
          "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-required-address-schema.json"
        }
      ],
      "description": "Order drop-off address."
    },
    "destinationAddress": {
      "allOf": [
        {
          "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-required-address-schema.json"
        }
      ],
      "description": "Order destination address. Deprecated in favor of dropoffAddress.",
      "deprecated": true
    },
    "pickUpLocationId": {
      "type": "string",
      "nullable": true,
      "description": "An identifier for the pick up location",
      "example": "d197bd64-a037-4b6e-aad7-06918e7e2d75"
    },
    "orderSubTotal": {
      "type": "number",
      "nullable": true,
      "description": "The sum of all item and modifier pricing",
      "example": 15
    },
    "currencyCode": {
      "type": "string",
      "nullable": true,
      "minLength": 3,
      "maxLength": 3,
      "description": "The 3-letter currency code (ISO 4217) to use for all monetary values.",
      "example": "KRW"
    },
    "containsAlcoholicItem": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether or not the order contains an alcoholic item.",
      "example": true
    },
    "customerPayments": {
      "type": "array",
      "nullable": true,
      "description": "Processed and collectible payments from the customer.",
      "items": {
        "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-customer-payment-schema.json"
      }
    },
    "orderExternalIdentifiers": {
      "nullable": true,
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-order-external-identifiers-schema.json",
      "description": "ID info associated with the order in external system, which is utilized for 3pl integrations."
    }
  }
}