Create a delivery

Dispatches a courier for an order. YUMBI creates (or reuses) the order, sends the
job to the store's delivery provider, and records the assignment that every
subsequent status update is applied to.

Pass quote_id to dispatch against a price you already quoted. Without it the
provider prices the job at dispatch time.

An order that already has a delivery in flight is not dispatched twice — the
existing delivery is returned instead, so this call is safe to retry.

Set track_delivery: true to ask the provider for live driver location pings.

Authenticate as an ordering channel. The store must be linked to your channel.

A rejected dispatch is a 422, not a 2xx. Unlike a declined quote, a rejected
dispatch means no delivery exists anywhere, so a caller that only checks the
status code must not record one. The order stays live — either re-dispatch or
fall back to the store's own driver.

order_guid, customer_phone_number, dropoff_address, dropoff_latitude
and dropoff_longitude are all mandatory; omitting any of them is a 400.

Money. Every monetary field on order is in major units (decimals) except
manifest_total_value, which is in cents. total is the gross the customer
owes, sub_total the value of the goods, and total_amount_due what is still
owed on arrival.

Payment collection. Set amount_due_collection_type when the driver has to
collect on arrival. Providers declare which collection types their drivers can
handle, and a dispatch to a provider that does not support the one you send is
refused with a 422 before any webhook is sent — no delivery is created. Omit the
field for a prepaid order; every provider can carry those.

payments and items are seeded, not authoritative. They are written only
when the order has none, because the POS push that follows shortly after owns the
full detail and rewrites both. Send them so the driver can be told what they
carry on an order dispatched before the POS push lands.

Three shapes of 422. A provider rejection carries is_successful and
provider_response; an unsupported payment method carries is_successful and
error but no provider_response, because nothing was sent to the provider; a
store with no delivery provider or no dispatch webhook configured carries error
alone.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

GUID of the YUMBI store the order is collected from.

string | null

The quote_id returned by POST /api/v1/quotes. Must be a quote your channel requested for this store; anything else reads as no quote. Omit to dispatch without one.

boolean | null

Ask the provider for live driver location updates for this delivery.

order
object
required

Monetary fields are in MAJOR UNITS (decimals) except manifest_total_value, which is in cents.

Headers
string
required

Bearer

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json