Skip to main content
POST
Get a Local delivery quote for one shipment. Requires scope: orders:write

Headers

string
required
Bearer API key (Bearer <api_key>).

Body

string
required
Full pickup address (≥ 3 chars).
string
required
Full drop-off address (≥ 3 chars).
number
required
Billable weight in kg (≥ 0.1). For vehicle_type=bike, weight also selects the rate-card band.
string
bike, bus_van, or truck. When set, quotes use your business rate card. Omit for distance-only pricing.
string
Option id from Rate cards. Required for bus_van and truck. Omit for bike (band from weight).
number
Optional pickup latitude.
number
Optional pickup longitude.
number
Optional drop-off latitude.
number
Optional drop-off longitude. If all four lat/lng are set, geocode is skipped.

Response

number
Quoted price.
number
Estimated distance in km.
string
Currency code (for example NGN).
string
rate_card or distance.
string
Resolved option id (for example the bike weight band).
string
Snapshot label for the option.
string
Assignment mode (for example MOTORBIKE, BUS_VAN, TRUCK).
string
Resolved from-zone name when rate-card quoting applies.
string
Resolved to-zone name when rate-card quoting applies.
Prefer listing options RUN already configured for you, then quote with vehicle_type. See Rate-card pricing.