Reference · Modifiers
Create a pre-modifier group
/v1/sites/{siteId}/pre-modifier-groupsAdds a pre-modifier group to a site. The response is the pre-modifier group, with the code to use from then on.
Path
siteIdrequiredThe site, from GET /v1/sites.
string
Headers
AuthorizationrequiredAn API key from Automation > Access in the Dnero portal, sent as
Authorization: Bearer <key>.string
Idempotency-KeyA 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
namerequiredThe group's name.
string · 1–200 characters
optionsrequiredIts options, in order.
array of objects · at least 1
4 fields in each
displayNamerequiredWhat the till shows.
string · 1–100 characters
priceChangeAdded to the item's price, in minor units. 0 for free.
integer
pricePercentOr a percentage of the item's price, instead of priceChange.
number · double
printNameWhat the kitchen ticket says. Defaults to displayName.
string · at most 100 characters
activeFalse to create it retired. Defaults to true.
boolean
Responses
- bad_requestinvalid_cursoridempotency_key_required
- missing_keyinvalid_keykey_expired+1 more
- key_revokedassistant_keykey_without_access+7 more
- site_not_foundnot_found
- idempotency_key_reusedrequest_in_progress
- invalid_requestnot_a_modifier_group
- rate_limited
- server_error
- upstream_unavailable
201 Created
activerequiredFalse for a retired group.
boolean
coderequiredThe group's code.
string
namerequiredThe group's name.
string
optionsrequiredIts options, in order.
array of objects
5 fields in each
coderequiredThe option's code.
string
displayNamerequiredWhat the till shows.
string
priceChangerequiredAdded to the item's price, in minor units. 0 is free.
integer
pricePercentOr a percentage of the item's price: 50 is half as much again.
number · double
printNameWhat the kitchen ticket says, when it differs.
string
updatedAtWhen it last changed.
string · date-time