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 · Till menus

List till menus

GET/v1/sites/{siteId}/till-menus

A site's till menus, with their sections and buttons. 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

    8 fields in each
    • activerequired

      False for a retired till menu.

      boolean

    • availabilityrequired

      When the tills offer it. Empty is always.

      array of objects

      3 fields in each
      • daysrequired

        The days it applies on, monday to sunday.

        array of string

      • endsAt

        Until, as HH:MM in the site's time. Absent is to the end of the day.

        string

      • startsAt

        From, as HH:MM in the site's time. Absent is from the start of the day.

        string

    • coderequired

      The till menu's code.

      string

    • namerequired

      The till menu's name, as staff see it.

      string

    • orderrequired

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

      integer

    • publishedrequired

      Whether the tills receive it. An unpublished menu exists but is not in use.

      boolean

    • sectionsrequired

      Its sections, in order.

      array of objects

      4 fields in each
      • buttonsrequired

        Its buttons, in order.

        array of objects

        4 fields in each
        • typerequired

          What the button does. A folder opens its children.

          string · one of "product", "modifier", "folder", "promotion", "orderType", "screen", "blank"

        • children

          For a folder: the buttons inside it.

          array of objects

          The same fields as its parent.

        • name

          The button's label, when it is not the product's name.

          string

        • productCode

          For a product or modifier button: the product, by code.

          string

      • coderequired

        The section's code, within its menu.

        string

      • namerequired

        The section's name.

        string

      • colour

        The section tab's colour, #RRGGBB.

        string

    • updatedAt

      When it last changed.

      string · date-time

  • nextCursor

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

    string