Skip to main content
POST
Quote a merchant delivery fee that is honoured for 15 minutes

Authorizations

Authorization
string
header
required

OAuth 2.0 client-credentials flow for external machine-to-machine integrations.

Body

application/json

The pickup is a saved branch and pickup location, or an exact pickup point; a point, when given, is what the route is measured from.

merchantId
string<uuid>
required
destinationLatitude
number
required
Required range: -90 <= x <= 90
destinationLongitude
number
required
Required range: -180 <= x <= 180
branchId
string<uuid> | null
pickupLocationId
string<uuid> | null
pickupLatitude
number | null

The exact pickup point, when one was chosen; the location's own otherwise.

Required range: -90 <= x <= 90
pickupLongitude
number | null
Required range: -180 <= x <= 180

Response

Current quote

distanceMetres
integer<int64>
required
Required range: x >= 0
durationSeconds
integer<int64>
required
Required range: x >= 0
price
object
required
routeGeometry
string
required
routeGeometryFormat
string
required
quoteId
string<uuid> | null

Present only on POST /api/v2/external/quotes; null on non-binding estimates.

expiresAt
string<date-time> | null

When the quoteId stops being accepted at shipment creation.