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 modifier group

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

Adds a modifier group to a site: a choice such as Milk, with its options. Give it to a product with PUT /products/{code}/modifier-groups. The response is the group, as a product of type modifierGroup.

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. Unique among the site's modifier groups.

    string · 1–200 characters

  • maxChoices

    The most options a customer may choose. Defaults to 1.

    integer · ≥ 1

  • minChoices

    The fewest options a customer must choose. Defaults to 0, so the choice is optional.

    integer · ≥ 0

  • options

    Its options, by modifier code, in order. Each must be a modifier at this site.

    array of string

Responses

201 Created

  • activerequired

    False for a retired product, which is listed only with includeInactive.

    boolean

  • availablerequired

    False while it is sold out.

    boolean

  • barcodesrequired

    Its barcodes.

    array of string

  • childrenrequired

    For a product, its modifier groups. For a modifier group, its options. Empty otherwise.

    array of objects

    4 fields in each
    • coderequired

      The child product's code.

      string

    • defaultQty

      How many of this child come by default.

      integer

    • maxQty

      The most of this child that may be chosen.

      integer

    • minQty

      The fewest of this child that may be chosen.

      integer

  • coderequired

    The product's code, the same at every site that has it.

    string

  • namerequired

    The product's name in the portal and reports.

    string

  • pricerequired

    The price, in the site's currency's minor units: 450 is $4.50.

    integer

  • soldIndividuallyrequired

    Whether it can be ordered on its own. False for a modifier or an ingredient.

    boolean

  • taxCodesrequired

    The taxes it is charged with, by code.

    array of string

  • typerequired

    What it is. product is sold on its own. A modifierGroup is a choice on a product, such as Milk; its children are the options. A modifier is one option, such as Oat milk.

    string · one of "product", "modifierGroup", "modifier", "inventory", "combo"

  • categoryCode

    The category it is in, by code.

    string

  • costPrice

    What it costs to buy or make, in minor units. For reporting; never what a customer pays.

    integer

  • courseCode

    The course it goes to the kitchen with, by code.

    string

  • description

    The product's description.

    string

  • displayName

    The name customers see, when it differs from name.

    string

  • imageUrl

    Its picture.

    string · uri

  • maxChoices

    For a modifier group: the most options a customer may choose.

    integer

  • minChoices

    For a modifier group: the fewest options a customer must choose.

    integer

  • printName

    The name printed on kitchen dockets and receipts.

    string

  • reportGroupCode

    The reporting group it is counted in, by code.

    string

  • sku

    Your stock-keeping unit for it.

    string

  • soldOutUntil

    When a sold-out product comes back on its own. Absent when it is not sold out, or is sold out until someone says otherwise.

    string · date-time

  • updatedAt

    When the product last changed.

    string · date-time