Gozem Developer DocsDocs
Courier API › Quote

Create Quote

posthttps://sandbox-api.gozem.co/courier/v1/quotes

Create a delivery trip quote.

Body parameters

dropoffsarray of objectrequired

Delivery stops, at least one. Serviced in the order given unless `optimize_route` is set.

min 1 item
object
string

Contact name

string

Contact phone number

stringrequired

Dropoff location name

numberrequired

Dropoff latitude

-90 to 90
numberrequired

Dropoff longitude

-180 to 180
string

Note for the dropoff location

max 280 chars
boolean

If true, dropoffs will be reordered to optimize route

pickupobjectrequired

Where the package is collected

string

Contact name

string

Contact phone number

stringrequired

Pickup location name

numberrequired

Pickup latitude

-90 to 90
numberrequired

Pickup longitude

-180 to 180
string

Note for the pickup location

max 280 chars
string

Title of the trip

stringrequired

Unique ID or name of the selected vehicle/service type

Response 200

dataobjectrequired

The quote and its estimated fare

created_atstringrequired

Quote creation timestamp

date-time
dropoffsarray of objectrequired

Delivery stops, in the order they will be serviced

object
contact_namestring

Contact name

contact_phonestring

Contact phone number

labelstringrequired

Dropoff location name

latnumberrequired

Dropoff latitude

lonnumberrequired

Dropoff longitude

notestring

Note for the dropoff location

estimated_distancenumberrequired

Total distance (km) of the trip

estimated_durationnumberrequired

Total estimated duration (minutes)

estimated_fareobjectrequired

Fare the trip is expected to cost. Not a charge until the quote is booked.

amountnumberrequired

Total estimated fare amount

breakdownarray of objectrequired

Fare components, adding up to `amount`

object
amountnumberrequired

Component amount

labelstringrequired

Fare component label

sub_labelstring

Extra detail about the component

currency_codestringrequired

Currency code

expires_atstringrequired

When the quote stops being bookable

date-time
guidstringrequired

Unique quote identifier

pickupobjectrequired

Where the package is collected

contact_namestring

Contact name

contact_phonestring

Contact phone number

labelstringrequired

Pickup location name

latnumberrequired

Pickup latitude

lonnumberrequired

Pickup longitude

notestring

Note for the pickup location

titlestring

Title of the trip

messagestringrequired

Human-readable outcome. Defaults to `Ok`.

successbooleanrequired

Always `true` on a success response.

true

Errors

Every failure returns the same envelope. Branch on code — it is the stable contract; message is human-facing and may be reworded or localized. See the error reference for what each code means.

400401403404405409413415429500502