Update an order's delivery status
Tell us where a delivery stands — assigned, on the way to the store, on the way to the guest, completed or canceled — and who the courier is. The restaurant sees it on the order and you read it back as order.delivery.updated.
Statuses beyond the common ones: 404 and 422 as on createOrder.
Safe to retry: this operation changes state but is idempotent.
Request
- storeCodestring
Required. The store's
code. - platformOrderIdstring
Required. The
platformOrderIdyou sent oncreateOrder. - deliveryStatusstring
Required. Where the delivery stands. The same values
order.delivery.updatedreports.Possible values: [ASSIGNED, EN_ROUTE_TO_STORE_LOCATION, EN_ROUTE_TO_CUSTOMER, COMPLETED, CANCELED] - courierOrderCourier
The courier, once one is assigned. Personal data.
{
"storeCode": "<storeCode>",
"platformOrderId": "00000000-0000-0000-0000-000000000000",
"deliveryStatus": "ASSIGNED",
"courier": {
"name": "<name>",
"phone": "<phone>"
}
}Responses
Headers
- x-mealco-tx-idstringoptional
The correlation id for this call, echoed on every response. Quote it when reporting a problem and we can find every log line for the request. You may also send your own x-mealco-tx-id on the request and we adopt it. Not marked required because a request whose JSON body is malformed is rejected before an id exists.
- platformOrderIdstring
Your
platformOrderId, echoed. - storeCodestring
Your
storeCode, echoed. - receivedAtstring<date-time>
When we received the update.
- statusstring
What happened to the update:
queuedorcreated.Possible values: [created, queued]
About Orders
Send orders to the restaurants on your channel, move them along, and read them back.
Stores are addressed by their code from fetchStores. A code that is unknown, retired or not on your channel answers 404, indistinguishably. Orders are addressed by YOUR id, platformOrderId: together with storeCode it is the idempotency key. Sous Chef's own id for the order arrives as id on every order.* webhook and on fetchOrder.
200 on a write means we accepted the call for processing, not that the restaurant accepted the order: that arrives as an order.created or order.rejected webhook (order.created is not sent yet, coming before sandbox access). Every write is idempotent, so retry on 500 / 503 freely.