Sous Chef API
Sous Chef Ordering API
Documentation

Item availability changed

Webhookitem.availability.changed

Items were 86'd or restocked at a kitchen that sells them through stores on your channel.

Delivered to the ONE url registered for your channel. Return any 2xx to acknowledge; anything else is retried with exponential backoff. Deduplicate on the envelope's id.

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 item.availability.changed.

    Possible values: [item.availability.changed]
  • 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".

  • dataItemAvailabilityChange

    The change.

About Menus

The menus of the stores on your channel. Pull a store's menu with fetchMenu; you are told when items or the store change through the item.availability.changed and store.status.changed webhooks (store.status.changed is not sent yet, coming before sandbox access).