API Reference

Delivery object

This is an object representing your deliveries.

Deliveries

Deliveries are individual instances of dispatch from one delivery point (pickup) to another (dropoff). These are initiated by selecting one of the quotes returned from creating a delivery request.


Delivery object fields

FieldData typeDescriptionType
idstringunique id of deliveryrequired
delivery_request_idstringreference to unique id of related delivery requestrequired
dropoff_etadate timeestimated time that dropoff will occurrequired
feeintegercost of deliveryrequired
currencystringcurrency of feerequired
statusenumtracks the status of the deliveryrequired
completedbooleanindicates if the delivery has been completed or notrequired