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

Get a till menu

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

One till menu, by code, with its sections and buttons.

Needs Catalogue: read

Path

  • siteIdrequired

    The site, from GET /v1/sites.

    string

  • coderequired

    The menu's code.

    string

Headers

  • Authorizationrequired

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

    string

Responses

200 OK

  • 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