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

Create a pre-modifier group

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

Adds a pre-modifier group to a site. The response is the pre-modifier group, with the code to use from then on.

Needs Catalogue: writeChanges live data

Path

  • siteIdrequired

    The site, from GET /v1/sites.

    string

Headers

  • Authorizationrequired

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

    string

  • Idempotency-Key

    A value you choose, unique to what this request creates: a UUID, or your own id for it. Sending it again with the same body returns the first response and creates nothing more. Required.

    string · at most 255 characters

Body

  • namerequired

    The group's name.

    string · 1–200 characters

  • optionsrequired

    Its options, in order.

    array of objects · at least 1

    4 fields in each
    • displayNamerequired

      What the till shows.

      string · 1–100 characters

    • priceChange

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

      integer

    • pricePercent

      Or a percentage of the item's price, instead of priceChange.

      number · double

    • printName

      What the kitchen ticket says. Defaults to displayName.

      string · at most 100 characters

  • active

    False to create it retired. Defaults to true.

    boolean

Responses

201 Created

  • 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