Skip to main content
POST
Fulfil an order via the on-demand driver pool

Authorizations

Authorization
string
header
required

API key as a bearer token. Secret keys (sk_) allow writes; publishable keys (pk_) are read-only. live = production, test = sandbox.

Headers

Idempotency-Key
string

A unique key (UUID) that makes a write request safely retryable.

Path Parameters

orderId
string<uuid>
required

Body

application/json
tier
enum<string>
default:scheduled

On-demand delivery speed. express = dedicate a trip now (same-city only, priciest); on_the_way = a driver already heading there carries it (cheapest); scheduled = flexible window (parcel rides along a trip); driver_rate_card = a driver's own price. Pricing is flat per corridor, not per-km.

Available options:
express,
on_the_way,
scheduled,
driver_rate_card

Response

Dispatched — shipment created and offered to drivers.

order_id
string
shipment_id
string
tracking_number
string
tracking_url
string
fulfilment
string
Example:

"on_demand"

tier
enum<string>

On-demand delivery speed. express = dedicate a trip now (same-city only, priciest); on_the_way = a driver already heading there carries it (cheapest); scheduled = flexible window (parcel rides along a trip); driver_rate_card = a driver's own price. Pricing is flat per corridor, not per-km.

Available options:
express,
on_the_way,
scheduled,
driver_rate_card
fare
number
offers
integer

How many drivers were offered the delivery.