Skip to navigation
Direct DeliveryAPI ReferenceDeliveries

Request a delivery quote

Compute availability, pickup ETA, delivery ETA, and locked delivery cost for a prospective delivery. Quote is valid for 5 minutes.

Authentication

AuthorizationBearer

Autolane Platform API key. Org-scoped with granular permissions. Deliveries endpoints additionally require an x-retailer-id header containing the site UUID from the Autolane Portal; webhooks endpoints do not.

Headers

x-retailer-idstringRequiredformat: "uuid"

Site ID (UUID) from the Autolane Portal identifying the store location

Request

This endpoint expects an object.
external_delivery_idstringRequired1-255 characters
customerobjectRequired
delivery_addressobjectRequired
ready_bydatetimeRequired
order_itemslist of maps from strings to anyRequired
pickup_instructionsstring or nullOptional<=2000 characters

Store-side instructions for the driver at pickup, such as a pickup or driver code. Shown to the driver from assignment until the order is loaded. Max 2000 characters. Integrations created before dropoff_instructions existed may be in legacy mode, where pickup_instructions is treated as the dropoff note and both fields read back the same value; when both are sent, dropoff_instructions is used unless it is null or empty. Ask Autolane to switch your account to the current behavior.

dropoff_instructionsstring or nullOptional<=2000 characters

Customer-side delivery instructions, such as a gate code or where to leave the order. Shown to the driver on the way to and at the customer. Max 2000 characters. Integrations created before dropoff_instructions existed may be in legacy mode, where pickup_instructions is treated as the dropoff note and both fields read back the same value; when both are sent, dropoff_instructions is used unless it is null or empty. Ask Autolane to switch your account to the current behavior.

Response

Quote computed (available or unavailable)

successboolean
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
422
Unprocessable Entity Error
503
Service Unavailable Error