Zippd API V1Orders Vehicle Hire

Place an Order

View as Markdown
Place an order for a vehicle hire job on the platform.

Authentication

AuthorizationBearer

Request

This endpoint expects an object.
vehicleenumRequired
The vehicle type you require to undertake this delivery job.
durationenumRequired
Allowed values:
estimated_deliveriesintegerRequired1-65
The estimated number of deliveries the driver will be expected to make over the course of this job.
fulfilment_datedateRequired

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

payment_methodenumRequired

The method of payment that should be used to pay for this delivery job. This will be da-credit in most cases.

Allowed values:
starting_locationobjectRequired
The starting address for this job. This will likely be the address where the driver will first pick up items that are to be delivered.
internal_refstringOptional<=250 characters
An order reference provided by your systems.
additional_notesstringOptional
Additional information that will be seen by the delivery driver during order fulfilment.
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.

cost_of_goodsintegerOptionalDefaults to 0
The total cost of goods being delivered. Must be in lowest unit of currency, e.g. in pence for GBP.
time_zonestringOptional
The ID of the time zone in which the delivery job will take place. This will default to the time zone that is set on the account creating the order. As a rule, this value should be set to the time zone that the driver will be undertaking the delivery in.
allow_location_updatesbooleanOptionalDefaults to true

Make it possible to add and update locations on this delivery job after the order has been placed. Defaults to true if not provided.

Response

Created
idstringformat: "uuid"
The ID of the order.
codestring
Zippd's short ID code for the order. Unique and always starts with "DA".
typeenum
The order type.
Allowed values:
order_datedate
Date on which the order was placed.
fulfilment_datedate
The date on which the order will be fulfilled by the driver.
internal_refstring or null
An order reference provided by your systems.
statusenum
The current status of the order.
total_itemsinteger

The total number of items (or parcels) attributed to this order.

is_urgentboolean
Whether or not the order has been flagged as urgent.
started_atdatetime or null

Date/time when the delivery driver began fulfilling the order.

completed_atdatetime or null

Date/time when the delivery driver completed fulfilling the order.

canceled_atdatetime or null

Date/time when the order was cancelled.

time_change_requestsinteger
Number of time change this order has received from drivers.
vehicleobject
The details of a vehicle type.
payment_cardobject
The details of a payment card used to place orders.
additional_notesstring
Additional information that will be seen by the delivery driver before and during order fulfilment.
co_loadingboolean

Whether or not co-loading is allowed for this delivery.

two_man_deliveryboolean

Whether or not two-person delivery is required for this delivery.

has_handballingboolean

Whether or not the delivery requires the driver to assist with loading/unloading items. This is only appropriate for delivery order types. Other order types will always be false.

cost_of_goodsinteger
The total cost of goods being delivered. Must be in lowest unit of currency, e.g. in pence for GBP.
cost_of_goods_formattedstring

The total cost of goods being delivered in a human-readable format.

driverobject
Details about the driver who will be fulfilling the order.
time_zonestring
The ID of the time zone in which the delivery job will take place.
locationslist of objects
All locations relating to this order's deliveries. The first item is always the location where the driver will pickup the parcels to be delivered.
pricesobject
A breakdown of the costs involved with this delivery order.
allowed_distanceobject
An object representing a maximum allowed distance from a set point.
barcodeslist of objects

A list of barcodes (parcels) that are to be delivered on with this order.

printable_label_urlstring or null
An absolute URL to a PDF with all package labels for this order.
durationenum or null

The duration within which the order is expected to be fulfilled. This will always be null for delivery type orders.

Allowed values:
total_timeobject or null
The total time it took for the delivery driver to fulfil the order.
additional_timeobject or null

If fulfilling the order took more time than set in duration, the additional time will be outlined here.

mileageobject
Information about the distance travelled by the delivery driver.

Errors

403
Forbidden Error
422
Unprocessable Entity Error