API docs
Sous Chef Management API
Request access

List items for a store

POST/management/item-availability/fetchStoreItems

The item catalogue for one storefront. This is the per-store form of fetchLocationItems, for when you hold store ids from fetchStores rather than kitchen ids.

Availability is held at the kitchen, not the storefront. This operation resolves your storeId to its parent kitchen and answers from there, narrowed to the store's own brand. Two consequences follow:

  • available is the kitchen's answer. Every other storefront of the same brand at that kitchen reports the identical value, and marking an item unavailable affects all of them. The reply echoes locationId so the sharing is visible in the data.
  • available is what Sous Chef intends, not what the delivery platform currently shows. A platform can independently mark an item unavailable on its own side, and this read does not see that. It is the item-level counterpart of the desired / observed split fetchStoreStatus makes explicit for the storefront itself.

Whether a storefront is paused is separate and does not change any available value here. Read fetchStoreStatus for that.

Scope: the store must be one your organization owns or operates a brand out of, and items are restricted to the store's own brand. A storeId 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
  • storeIdstring

    The Store.id whose catalogue you want.

  • querystring

    Case-insensitive name search.

  • availableboolean

    Filter to items currently available (or unavailable) at the store's kitchen.

  • pagePageRequest

    Cursor pagination.

Responses

200: One page of the store's items with their current availability, the kitchen the answer came from, 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.

  • locationIdstring

    The kitchen the answer came from.

    Read this before acting on the result. Availability is held per kitchen (location), never per storefront, so this operation resolves your storeId to its parent location and reports that kitchen's catalogue. Every other storefront at the same kitchen sees the identical answer. It is echoed here so the sharing is visible in the response. Pass it to setItemAvailability if you intend to change anything.

  • itemsItemAvailability[]

    The page of items tracked at the store's kitchen, narrowed to the store's own brand and sorted by name. 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.