Request a delivery quote

Asks the store's delivery provider what it would charge to carry this order,
and how long it would take. The quote is priced by the provider and cached:
repeat calls with the same route and basket value inside the provider's
offer window return the same quote_id without re-quoting the provider.

Pass the returned quote_id to POST /api/v1/deliveries to dispatch against
this price. A quote that is not dispatched simply lapses at expiration.

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

A declined quote is a 200, not an error. A provider refusing the job — no
drivers, outside its delivery zone — is a business outcome rather than an
outage, so it comes back with is_successful: false. Do not retry it as a
transient failure; treat it as "delivery is not available for this basket".

Pickup defaults to the store's own record. YUMBI's store name, address,
coordinates and phone number win over the pickup_* fields you send, which act
as a fallback for a store missing that detail. This keeps a quote and its
dispatch describing the same pickup point, since dispatch builds its pickup block
from the same record.

Repeat calls are safe and cheap. Identical requests are serialised, so a
burst of quote calls from one checkout produces a single call to the provider
rather than one per request. manifest_total_value is in cents.

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. Must be a store linked to the calling ordering channel.

string | null

Defaults to the store's name.

string | null

Defaults to the store's composed address.

number | null

Defaults to the store's latitude.

number | null

Defaults to the store's longitude.

string | null

Defaults to the store's primary phone number.

date-time | null

When the order will be ready for collection.

date-time | null
string | null
string | null
number | null
number | null
string | null
date-time | null
date-time | null
integer | null

Total value of the goods being carried, 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