Get a Quote | Zippd API | Documentation

Retrieve prices for a delivery without placing an order. Most of the details used retrieve a quote can be used to place a delivery, but placing a delivery may require more details.

This endpoint will respond with a list of price objects keyed by the vehicle name.

By Vehicles or by Items Delivered

If the vehicle types desired for quotation are known, you should provide them in the vehicles item of the request data. Without vehicles, delivery item data to be provided in the request data. Item data must be provided for every order location except for the pickup (first) location.

Retrieve prices for a delivery without placing an order. Most of the details used retrieve a quote can be used to place a delivery, but placing a delivery may require more details. This endpoint will respond with a list of price objects keyed by the vehicle name. ### By Vehicles or by Items Delivered If the vehicle types desired for quotation are known, you should provide them in the `vehicles` item of the request data. Without `vehicles`, delivery item data to be provided in the request data. Item data must be provided for every order location except for the pickup (first) location.

Authentication

AuthorizationBearer

Request

fulfilment_datedateRequired

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

vehicleslist of enumsOptional

A list of vehicle types you’d like to retrieve quotes for. This is required if items items have not been provided in the order locations.

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.

A list of vehicle types you'd like to retrieve quotes for. __This is required if `items` items have not been provided in the order locations__. 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.

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 objectsOptional

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

$	curl -X POST https://sandbox-api.deliveryapp.com/api/v1/orders-delivery/quote \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"fulfilment_date": "2022-01-11",
>	"vehicles": [
>	"Car"
>	],
>	"co_loading": true,
>	"two_man_delivery": true,
>	"order_locations": [
>	{
>	"id": 24013,
>	"time_from": "11:00:00",
>	"time_to": "11:30:00",
>	"address": {
>	"address_line_1": "123 Grovesby Road",
>	"address_line_2": "Billingham House, Flat 45",
>	"city": "Manchester",
>	"postcode": "M1 2AB",
>	"latitude": 53.477582,
>	"longitude": -2.255331
>	},
>	"requires_handballing": true
>	},
>	{
>	"id": 24013,
>	"time_from": "11:00:00",
>	"time_to": "11:30:00",
>	"address": {
>	"address_line_1": "123 Grovesby Road",
>	"address_line_2": "Billingham House, Flat 45",
>	"city": "Manchester",
>	"postcode": "M1 2AB",
>	"latitude": 53.477582,
>	"longitude": -2.255331
>	},
>	"requires_handballing": true
>	}
>	]
>	}'

1	{
2	"uuid": "string",
3	"vehicles": [
4	{
5	"[vehicle_title]": {
6	"vehicle": "Car",
7	"price": 9660,
8	"price_formatted": "£96.60",
9	"price_no_vat": 8050,
10	"price_no_vat_formatted": "£80.50"
11	}
12	}
13	],
14	"extra_trips": {
15	"price": 3000,
16	"price_formatted": "£30.00",
17	"count": 2
18	},
19	"remote": true
20	}