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 · Modifiers

List pre-modifier groups

GET/v1/sites/{siteId}/pre-modifier-groups

A site's pre-modifier groups: words a server puts before a modifier, such as Extra or No, each with a price change. 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

    5 fields in each
    • activerequired

      False for a retired group.

      boolean

    • coderequired

      The group's code.

      string

    • namerequired

      The group's name.

      string

    • optionsrequired

      Its options, in order.

      array of objects

      5 fields in each
      • coderequired

        The option's code.

        string

      • displayNamerequired

        What the till shows.

        string

      • priceChangerequired

        Added to the item's price, in minor units. 0 is free.

        integer

      • pricePercent

        Or a percentage of the item's price: 50 is half as much again.

        number · double

      • printName

        What the kitchen ticket says, when it differs.

        string

    • updatedAt

      When it last changed.

      string · date-time

  • nextCursor

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

    string