Sous Chef API
Sous Chef Ordering API
Documentation

Order status updated

Webhookorder.status.updated

An order moved through its lifecycle.

Order by the transported state (data.updatedAt, data.status), never by arrival: deliveries are unordered.

Request

application/json
required
  • idstring

    Unique event id — the deduplication key.

    Deliveries are at-least-once and unordered, so you WILL receive the same event more than once. Every copy of one event carries the same id. Two legitimate transitions of the same order or store are two different events and carry two different ids.

    Key your idempotency on this field alone. timestamp is the moment the attempt was SENT and differs between copies of one event.

  • eventstring

    Always order.status.updated.

    Possible values: [order.status.updated]
  • timestampstring<date-time>

    When this delivery was SENT — not when the event happened. Order by the transported state, never by arrival.

  • organization_idstring

    Your channel's organization id — the same on every delivery to you — also carried on the delivery's X-Organization-ID header. It is your channel's organization, not the restaurant's.

    Snake case on this ONE field is a long-lived wire value shared with the Management API; every other field on this API is camelCase.

    Treat it as a sanity check, never as proof of origin. Proof of origin is the X-OneTablet-Signature header, which every delivery on this API carries; see "Verifying webhook signatures".

  • dataOrder

    The order, carrying its new status.

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.