Delivery fields and multi-stop payloads

Create deliveries through the Partner API and model pickup, dropoff, and intermediate stops correctly.

A delivery can be created from a previously calculated quote or directly from a complete route.

Quote a route

Send the following to POST /partner/v1/quotes:

  • pickup and dropoff with address, latitude, and longitude.
  • A vehicle_type_id returned by GET /partner/v1/vehicle-types.
  • Optionally, up to ten stops in the order they should be visited.
  • Optional extras with extra_id, option_id, and quantity.

The response contains a quote_id, price, distance, duration, and valid_until. A quote is valid for five minutes.

Create the delivery

Send either a valid quote_id or the complete route to POST /partner/v1/deliveries. Do not send both.

A contact with name and phone is also required; email is optional. The API also accepts:

  • external_id as your own unique reference.
  • notes for operational instructions.
  • scheduled_at as an RFC 3339 timestamp.
  • test_scenario set to courier_cancelled or delivery_failed when using a test key.

Every create request requires a unique Idempotency-Key header.

Multi-stop rules

  • Do not repeat pickup or dropoff inside stops.
  • Send intermediate stops in the actual driving order.
  • A route can contain at most ten intermediate stops.
  • Always send addresses together with valid coordinates.

The API preserves the submitted order for dispatch, tracking, and ETA calculation.

Was this article helpful?

Related articles