API docs
Sous Chef Ordering API
Request access

Item availability changed

Webhookitem.availability.changed

Items were marked out of stock or restocked at a kitchen that sells them through stores on your channel.

Delivered to the webhook URL registered for your channel. Return any 2xx to acknowledge; anything else is retried up to four more times. Deduplicate on the envelope's id.

Request

application/json
required
  • idstring

    Unique event id: the deduplication key.

    A delivery that is not acknowledged is sent again, and deliveries are 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 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. It is your channel's organization, not the restaurant's.

    Snake case on this one field is a long-lived wire value; 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-SousChef-Signature header, which every delivery on this API carries (the same value is also sent as X-OneTablet-Signature, for backward compatibility); 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 an item or a modifier option becomes unavailable, or available again, through the item.availability.changed webhook.