Skip to content
Developers
Pilot. The API is open to a small number of organisations and may change — every change is in the changelog.

Reference · Menus

List online menus

GET/v1/sites/{siteId}/menus

A site's online menus, with their tabs and the products on each. A page at a time; retired ones only with includeInactive.

Needs Catalogue: read

Path

  • siteIdrequired

    The site, from GET /v1/sites.

    string

Query

  • limit

    How many records to return, at most.

    integer · ≥ 1 · ≤ 200 · default 50

  • cursor

    nextCursor from the previous page. Omit for the first page.

    string

  • updatedSince

    Only records changed at or after this time (RFC 3339). For a sync, pass the time your previous sync started.

    string · date-time

  • includeInactive

    Include retired records (active false). Off by default.

    boolean

Headers

  • Authorizationrequired

    An API key from Automation > Access in the Dnero portal, sent as Authorization: Bearer <key>.

    string

Responses

200 OK

  • datarequired

    The records, in a stable order.

    array of objects

    7 fields in each
    • activerequired

      False for a retired menu.

      boolean

    • coderequired

      The menu's code.

      string

    • namerequired

      The menu's name, as customers see it.

      string

    • orderrequired

      Where it sits among the site's menus, lowest first.

      integer

    • orderTypesrequired

      The order types it serves, by code: a menu serving none appears nowhere.

      array of string

    • tabsrequired

      Its tabs, in order.

      array of objects

      5 fields in each
      • coderequired

        The tab's code, within its menu.

        string

      • namerequired

        The tab's name.

        string

      • productsrequired

        The products on the tab, by code, in order.

        array of string

      • hoverImageUrl

        The picture shown under the cursor.

        string · uri

      • imageUrl

        The tab's picture.

        string · uri

    • updatedAt

      When it last changed.

      string · date-time

  • nextCursor

    Pass as cursor to get the next page. Absent on the last page.

    string