Gozem Developer DocsDocs
Back to siteGo to consoleConsoleGet beta accessGet access
Courier API › Vehicle

Get Available Vehicles

gethttps://sandbox-api.gozem.co/courier/v1/vehicles

Fetch available vehicle and their operating zones.

Query parameters

string

Exact vehicle identifier, as returned in `data[].guid`.

1–64 chars
string

Exact vehicle name, case-insensitive.

1–64 chars
string

Substring of a covered city name, case-insensitive.

1–64 chars
string

ISO 3166-1 alpha-2 code (case-insensitive) or a substring of the country name.

1–64 chars
number

Latitude of a point to test against coverage polygons. Requires `lon`.

-90 to 90
number

Longitude of a point to test against coverage polygons. Requires `lat`.

-180 to 180

Response 200

dataarray of objectrequired

Vehicles available for booking

object
city_coveragearray of objectrequired

Cities where the vehicle can be booked

object
city_namestringrequired

City name

country_codestring

ISO 3166-1 alpha-2 country code

country_namestringrequired

Country name

geo_polygonobject

Area of the city the vehicle serves. Omitted when the stored boundary is not GeoJSON.

coordinatesarray of array of array of numberrequired

Linear rings; the first is the outer boundary, any others are holes

typestringrequired

GeoJSON geometry type. Always `Polygon`.

Polygon
descriptionstringrequired

Load capacity and typical use of the vehicle

guidstringrequired

Unique vehicle identifier

namestringrequired

Vehicle name, accepted as the `vehicle` field when quoting or booking

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