OneTablet API Documentation

fetchLocationItems

POST/management/item-availability/fetchLocationItems

The item catalogue at one location — every item and modifier option this organization sells there, with OneTablet's item ids and current availability. The discovery read setItemAvailability depends on.

Scope: items whose brand this organization owns, at a location this organization owns or operates a brand out of. An unknown or foreign locationId is NotFound.

Request

application/json
required
  • locationIdstring
  • querystring

    Case-insensitive name search.

  • availableobject

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

  • pageobject

    Cursor pagination.

    • limitnumber

      Page size, 1-100. Defaults to 50 when omitted.

    • cursorstring

      Opaque cursor from the previous response. Omit for the first page.

Responses

200 — OK
  • asOfstring<date-time>
  • itemsobject[]
    • itemIdstring

      OneTablet's identifier for the item — brand-scoped, stable for that brand's catalogue across every location. What setItemAvailability addresses items by.

      ALWAYS Item.id, whether or not isModifier is set (ONE-2621) — a modifier option is an ordinary Item row, and this is the SAME id space the write path consumes (StockItem.itemId). The published schema has no second id field, so there is nowhere else for a different id to go.

    • skustring

      Stock-keeping unit. NOT unique — an alternate lookup key on setItemAvailability.

    • namestring
    • isModifierobject
    • availableobject

      Current availability at the requested location.

  • nextCursorstring

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

About Item availability

Item availability ("86-ing") — mark items available or unavailable at one or many kitchens (ONE-2621).

fetchLocationItems and setItemAvailability are ONE indivisible unit: the write is useless without the discovery read, because a partner cannot know OneTablet's item ids in advance.

NOT IMPLEMENTED ON THIS API: replay via Idempotency-Key (the published contract's parameter — vendor/published-management-api.yaml:1885-1892 — promises it, and nothing on the platform implements idempotent replay today; a retried setItemAvailability call re-applies rather than de-duplicating). ONE-2621 research and decision 3.