Skip to main content

Update Delivery Status

This event can be sent after you have assigned a driver to an order and will allow locations to see the status of your delivery driver.

API Reference

NOTE: If you have not assigned a driver yet, you will receive a 4XX error code and the order will not be updated.

{
"type": "order.update.delivery.status",
"object": {
"location_id": "location_id", // The location_id from the order event you received
"order_id": "order_id", // The order_id from the order event you received
"delivery_status": "enroute_to_pickup",
"estimated_courier_arrival_time": 1761170400000 // Optional. Unix ms, estimated courier arrival at the store
}
}

estimated_courier_arrival_time is optional. Send it while the courier is heading to the store. A value that is not a number is rejected with a 400; null is treated as if the field were omitted.