/delivery/status-updates

Delivery status event updates

Sent whenever a delivery's status changes. Match the event to your order using taskId.

{
    "taskStatusId": 1,
    "createdAt": "2023-07-20T09:56:43.331140Z",
    "taskId": 1,
    "value": "OUT_FOR_DELIVERY"
}

Status values

value is one of:

Value	Meaning
`NOT_STARTED`	Booked and accepted; nothing has happened physically yet
`OUT_FOR_COLLECTION`	A courier is on the way to collect
`COLLECTED`	The parcel is with the courier
`OUT_FOR_DELIVERY`	On the way to the delivery address
`COMPLETED`	Delivered successfully
`FAILED`	Could not be delivered
`CANCELLED`	Cancelled before completion

COMPLETED, FAILED and CANCELLED are final.

A status can repeat — for example on a second delivery attempt — and events aren't guaranteed to arrive in order. Ignore any event older than the state you already hold.

See How a delivery works for the full lifecycle.

How webhooks are delivered, retried and verified is on the Webhooks page.