Delivery

key	Type	Required	Description
id	string	✔️	The unique ID
number	string	✔️	The unique, user friendly delivery identifier.
createdAt	number	✔️	The seconds timestamp of the moment when the delivery was created
status	DeliveryStatus	✔️	The current status
pickupPlace	DeliveryPlace	✔️	A DeliveryPlace object representing the pick-up location
dropoffPlace	DeliveryPlace	✔️	A DeliveryPlace object representing the drop-off location
distance	number	✔️	The road distance in meters between pickup and dropoff
cashOnDeliveryAmount	number	✔️	The amount of cash collected at dropoff
weightKg	number	✔️	The total weight of the delivery in kilograms
isReturn	boolean	✔️	True if the delivery is a return for another delivery.
returnFor	string	❌	If this is a return delivery this will represent the id of the original delivery. Null if this is not a return delivery.
returnDeliveryID	string	❌	If this delivery is returned this will be the id of the return delivery. Null if the delivery is not returned.
client	object	❌	An object with the "id" and "name" fields that identifies the client requesting this delivery. Null if the delivery is not requested by a client.
agent	object	❌	An object with the "id" and "name" fields that identifies the agent assigned to this delivery. Null if the delivery does not have an assigned agent.

DeliveryStatus

UNASSIGNED	The Delivery was just created.
IN_DELIVERY_GOING_TO_PICKUP	The courier is going to pickup.
IN_DELIVERY_AT_PICKUP	The courier is at the pickup point.
IN_DELIVERY_GOING_TO_DROPOFF	The courier is going to dropoff.
IN_DELIVERY_AT_DROPOFF	The courier is at the dropoff point.
DELIVERED	The Delivery was successfully completed.
RETURNED	The Delivery was returned.
CANCELED	The Delivery was canceled.