Zippd API V1Orders E Commerce

Get a Quote

View as Markdown

Authentication

AuthorizationBearer

Request

This endpoint expects an object.
vehicleslist of enumsRequired
A list of vehicle types you'd like to retrieve quotes for.
durationstringRequired
The required duration within which the order will be fulfilled.
fulfilment_datedateRequired

The date on which the order should be fulfilled. Expects date in format ‘Y-m-d’.

co_loadingbooleanOptional

Whether or not the delivery driver is allowed to load items from other deliveries on their vehicle alongside yours. Defaults to false if not provided.

two_man_deliverybooleanOptional

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.

order_locationslist of anyOptional
A list of order locations to deliver to. The first location object is always the pickup location, where the driver will go to pickup all items that are to be delivered for this order.

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.