Zippd API V1Orders Vehicle Hire

Get a Quote

View as Markdown
Retrieve prices for a vehicle hire order without placing an actual order. This endpoint will return prices for all available vehicles.

Authentication

AuthorizationBearer

Request

This endpoint expects an object.
vehicleslist of enumsRequired

A list of vehicle types you’d like to retrieve quotes for.

Use either All or * to select all vehicles. All and * may only be passed alone. Passing either in the vehicles array with other values in the array will result in a validation error.

durationenumRequired
The desired duration for this hire job. Check the documentation for more info on hire durations.
Allowed values:
fulfilment_datedateRequired

The date on which the order should be fulfilled. Expects date in format YYYY-MM-DD.

two_man_deliverybooleanOptionalDefaults to false

Whether or not the delivery driver is required to have an additional person with them to fulfil the order. Defaults to false if not provided.

Response

uuidstringformat: "uuid"
The quote ID.
vehicleslist of objects
An list of quote objects. Each object will contain a quote for every vehicle that was outlined in the request.
extra_tripsobject or null

This will be an object when the order type is delivery, null otherwise.

remoteboolean or null

This will be true if any of the locations fall in a postal code that has been flagged as remote and otherwise difficult to reach.

Errors

422
Unprocessable Entity Error