Estimate the cost and timing of a shipment.

Calculates the estimated price, pickup time, and delivery time for the given parcels using the specified shipping type.

The response also includes the asset_kind (vehicle type) that would be assigned to each delivery. This is only meaningful for express (on-demand) deliveries: it is chosen deterministically as the smallest available vehicle — in bicycle → moped → car priority order — that can fit the whole delivery by weight, volume and largest-parcel dimensions and still complete the route in time. For same_day, next_day and other cross-dock modalities the returned value does not reflect the vehicle that will actually carry the parcel and should be ignored. See the AssetKind schema for the exact per-vehicle limits used to make this choice.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
parcels
array of objects
required

List of parcels to estimate shipping for.

parcels*
string
required

Identifier of the shipping type to estimate, as returned for the pickup location by GET /v1/shipping_types/available. Opaque and environment-dependent: send it back exactly as it was returned.

date-time

Desired pickup time, formatted according to RFC 3339, section 5.6.

boolean
Defaults to false

Request a return leg: after the delivery, the rider goes back to the pickup point in the same journey. Returns must be enabled for the shipping type; asking for one on a shipping type without it fails with shipping type not enabled for return.

Responses

401

Unauthorized. Missing or invalid authentication token.

429

Too many requests. This API is rate limited per account and per endpoint. A 429 is an expected condition rather than a failed request: back off and retry it. The limits are not the same for every endpoint and can change, so handle the status instead of hard-coding a rate. See the Limits and reliability guide.

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