API docs
Sous Chef Management API
Request access

List items at a location

POST/management/item-availability/fetchLocationItems

The item catalogue at one location: every item and modifier option your organization sells there, with Sous Chef's item ids and current availability. This is the discovery read setItemAvailability depends on.

Scope: items whose brand your organization owns, at a location your organization owns or operates a brand out of. A locationId that does not exist and one outside your organization's scope are the same 404.

Safe to retry: this operation is read-only and idempotent.

Request

application/json
required
  • locationIdstring

    The location (kitchen) whose catalogue you want: the id from StoresApi.fetchLocations. Required; absent is 400. A location that does not exist and one outside your organization's scope are the same 404.

  • querystring

    Case-insensitive name search.

  • availableboolean

    Filter to items currently available (or unavailable) at the location.

  • pagePageRequest

    Cursor pagination.

Responses

200: One page of the location's items with their current availability, and the cursor for the next page.

Headers

  • x-mealco-tx-idstringoptional

    The correlation id for this call, returned on every response that an operation produces, successful or not. 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, so that one response carries neither this header nor the txId field of the error body.

  • asOfstring<date-time>

    When this response was assembled (UTC, ISO-8601). The availability values are read live at that moment; this is the freshness claim for the whole response.

  • itemsItemAvailability[]

    The page of items tracked at the location, sorted by name, restricted to items of brands your organization owns. Empty when nothing matches.

  • nextCursorstring

    Opaque cursor for the next page. Absent means the last page.

About Item availability

Item availability: mark one item available or unavailable at one kitchen.

fetchLocationItems and setItemAvailability work as a pair: the write needs the discovery read, because Sous Chef's item ids cannot be known in advance.

There is no Idempotency-Key replay on this API: a retried setItemAvailability call re-applies the same value rather than de-duplicating.