Zippd API V1Orders

Cancel an Order

View as Markdown
This endpoint can be used to cancel any type of order

Authentication

AuthorizationBearer

Path parameters

orderIdstringRequired

Request

This endpoint expects an object.
statusenumRequired
The new status for the order.
Allowed values:
descriptionstringRequired
A reason for the change of status.

Response

OK
idstringOptionalformat: "uuid"
The ID of the order.
codestringOptional
Zippd's short ID code for the order. Unique and always starts with "DA".
typeenumOptional
The order type.
order_datedateOptional
Date on which the order was placed.
fulfilment_datedateOptional
The date on which the order will be fulfilled by the driver.
internal_refstring or nullOptional
An order reference provided by your systems.
statusenumOptional
The current status of the order.
total_itemsintegerOptional

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

is_urgentbooleanOptional
Whether or not the order has been flagged as urgent.
started_atdatetime or nullOptional

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

completed_atdatetime or nullOptional

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

canceled_atdatetime or nullOptional

Date/time when the order was cancelled.

time_change_requestsintegerOptional
Number of time change this order has received from drivers.
vehicleobjectOptional
The details of a vehicle type.
payment_cardobjectOptional
The details of a payment card used to place orders.
additional_notesstringOptional
Additional information that will be seen by the delivery driver before and during order fulfilment.
co_loadingbooleanOptional

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

two_man_deliverybooleanOptional

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

has_handballingbooleanOptional

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_goodsintegerOptional
The total cost of goods being delivered. Must be in lowest unit of currency, e.g. in pence for GBP.
cost_of_goods_formattedstringOptional

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

driverobjectOptional
Details about the driver who will be fulfilling the order.
time_zonestringOptional
The ID of the time zone in which the delivery job will take place.
locationslist of objectsOptional
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.
pricesobjectOptional

A breakdown of the costs involved with this delivery order.

NOTE: Values in this object may change over the course of a job. This may happen, for example, if the job is cancelled before it starts or a driver is required to do extra miles to fulfil the delivery.

allowed_distanceobjectOptional
An object representing a maximum allowed distance from a set point.
barcodeslist of objectsOptional

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

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

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

total_timeobject or nullOptional
The total time it took for the delivery driver to fulfil the order.
additional_timeobject or nullOptional

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

mileageobjectOptional
Information about the distance travelled by the delivery driver.

Errors

404
Not Found Error