WebhooksOrdersLifecycle
Order Completed
Webhook payload sent when an order is completed.
Order Completed Webhook Payload
[
{
"created_at":"2021-01-01T14:01:00.000000Z",
"recorded_at":"2021-01-01T14:00:00.000000Z",
"device_id":"00112233-4455-6677-8899-AABBCCDDEEFF",
"worker_handle": "Worker-1",
"account_id":"6784e919-7168-4f61-b686-2020f547637f",
"type":"order",
"data":{
"value":"completed",
"order_handle":"DGC127092",
"route_handle":"4359cc65-90dd-4b2b-875b-26e6d2eba11d",
"distance":1834,
"duration":408,
"deviation":75,
"actual_service_time": 35,
"status":"completed",
"share_url":"https://trck.at/vr1RNLq",
"metadata":{
"storeId":"123490809808",
"customerName":"Andrew"
}
},
"version":"3.0.0"
}
]| Name | Type | Mandatory | Description |
|---|---|---|---|
| data.value | string | Yes | completed |
| data.order_handle | string | Yes | Unique handle for the Order |
| data.route_handle | string | Yes | Unique identifier of the route containing the order |
| data.status | string | Yes | Status of the order - completed |
| data.share_url | string | Yes | Contains tracking url of the order to provide real time visibility of worker on route of this order |
| data.metadata | object | No | Metadata that you have assigned to this order |
| data.distance | int | Yes | Total distance travelled to fulfill the order. In case of no location data stream from the worker's device during the shift, distance will be set to null. |
| data.duration | int | Yes | Total time in seconds since order start. Can also be null in cases when there is no data sent from the worker's device. |
| data.deviation | int | No | Deviation between order destination location and actual location where the order is completed |
| data.actual_service_time | int | No | Total time spent by worker at the destination, in case the completion happened after the arrival |