Skip to main content

Webhooks

order_status_updated

This event is triggered every time the status of an order changes.

Specific Data for this message

JSON FieldTypeDescription
order_uuidstringOrder UUID
order_descriptionstringYour internal friendly order ID
order_custom_fieldsarray or nullIf you passed through an array of custom fields to the order creation API (custom_fields), this will then be passed back to you here.
order_statusstringThe new status, as documented below.
account_uuidstringStore UUID
partners_unique_internal_order_idstringThe order's unique ID on your system. This can be set when creating orders.
order_account_partners_external_identifierstringThe store's unique ID on your system. This can be set when setting up a store.
order_account_business_partners_external_identifierstringThe business's unique ID on your system. This can be set when setting up a business.
published_atinteger, unix timestampThe time the event occurred
itemsarrayArray of items, please contact support to expose this field

Possible Statuses

NameDescription
in_progressThe driver has picked up the order
completedThe order has been completed
failedThe order has been failed
cancelledThe order has been cancelled
auto_closedThe order has been auto closed by our system. By default this feature is turned off and whether it is feasible to turn on depends on the integration. Please speak to your account manager.

Example payload when an order is cancelled-

{
"data": {
"order_status": "cancelled",
"order_description": "1223-486",
"account_uuid": "a9c7b6a24e67",
"published_at": 1741853709.073236,
"order_account_business_partners_external_identifier": "",
"order_account_partners_external_identifier": "",
"order_uuid": "a99fb9d86f25",
"partners_unique_internal_order_id": "0df1e1df-7e2d-4d23-a4da-997338bf377f",
"order_custom_fields": null
},
"event_name": "order_status_updated",
"environment": "production",
"created_at": "2025-03-13T08:15:09.116+00:00",
"event_uuid": "7eadbb33-cbdb-4c11-a3c7-3fd4e6ffc12e",
"metadata": {
"sent_at": "2025-03-13T08:15:09.126+00:00",
"delivery_attempt": 1
}
}

Example payload when an order is completed

{
"data": {
"order_status": "completed",
"order_description": "1538-568",
"account_uuid": "a9c7b6a24e67",
"published_at": 1741854527.282089,
"order_account_business_partners_external_identifier": "",
"order_account_partners_external_identifier": "",
"order_uuid": "a77f963c8fd6",
"partners_unique_internal_order_id": "52e6ef2b-1aff-4f05-8f9a-5aa476662d41",
"order_custom_fields": null
},
"event_name": "order_status_updated",
"environment": "production",
"created_at": "2025-03-13T02:28:47.324-06:00",
"event_uuid": "9ea080f1-8be2-44e8-ab31-f0eb3e8fcd23",
"metadata": {
"sent_at": "2025-03-13T08:28:47.357+00:00",
"delivery_attempt": 1
}
}

Example payload when an order is failed

{
"data": {
"order_status": "failed",
"order_description": "1218-677",
"account_uuid": "a9c7b6a24e67",
"published_at": 1741853625.8681452,
"order_account_business_partners_external_identifier": "",
"order_account_partners_external_identifier": "",
"order_uuid": "a89fc7b4f66f",
"partners_unique_internal_order_id": "f4b1046d-5b1b-433a-b91a-0cb1273298b5",
"order_custom_fields": null
},
"event_name": "order_status_updated",
"environment": "production",
"created_at": "2025-03-13T19:13:45.902+11:00",
"event_uuid": "a4139c21-cb4e-4fbc-bdb8-29bcb73fe598",
"metadata": {
"sent_at": "2025-03-13T08:13:45.969+00:00",
"delivery_attempt": 1
}
}