API docs
Sous Chef Ordering API
Request access

Update an order's delivery status

POST/ordering/orders/updateOrderDeliveryStatus

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

application/json
required
  • storeCodestring

    Required. The store's code.

  • platformOrderIdstring

    Required. The platformOrderId you sent on createOrder.

  • deliveryStatusstring

    Required. Where the delivery stands. The same values order.delivery.updated reports.

    Possible values: [ASSIGNED, EN_ROUTE_TO_STORE_LOCATION, EN_ROUTE_TO_CUSTOMER, COMPLETED, CANCELED]
  • courierOrderCourier

    The courier, once one is assigned. Personal data.

Responses

200: The update as received.

Headers

  • x-mealco-tx-idstringoptional

    The correlation id for this call, returned on a response from an operation. Quote it when you report a problem so that we can trace the request. You may send your own x-mealco-tx-id on the request and it is used as the id. It is optional in the schema because a request with a malformed JSON body is rejected before an id is assigned.

  • platformOrderIdstring

    Your platformOrderId, echoed.

  • storeCodestring

    Your storeCode, echoed.

  • receivedAtstring<date-time>

    When we received the update.

  • statusstring

    What happened to the update: queued.

    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: it is the idempotency key, and it must be unique across every order you send. 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 order has reached the kitchen. An order for a store that is paused or outside its hours comes back as an order.rejected webhook. Every other order goes to the kitchen: fetchOrder returns it, and its progress arrives as order.status.updated when it becomes ready and then finished. Every write is idempotent, so retry on 500 / 503 freely.