Reference · Products
Set a product's modifier groups
/v1/sites/{siteId}/products/{code}/modifier-groupsReplaces the modifier groups a product offers, in order: a flat white with Milk and Extras. The groups must exist at the site.
Path
siteIdrequiredThe site, from GET /v1/sites.
string
coderequiredThe record's code.
string
Headers
AuthorizationrequiredAn API key from Automation > Access in the Dnero portal, sent as
Authorization: Bearer <key>.string
Body
modifierGroupsrequiredThe product's modifier groups, by code, in the order the till offers them. Replaces what it has; an empty array removes them all.
array of string
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
200 OK
activerequiredFalse for a retired product, which is listed only with includeInactive.
boolean
availablerequiredFalse while it is sold out.
boolean
barcodesrequiredIts barcodes.
array of string
childrenrequiredFor a product, its modifier groups. For a modifier group, its options. Empty otherwise.
array of objects
4 fields in each
coderequiredThe child product's code.
string
defaultQtyHow many of this child come by default.
integer
maxQtyThe most of this child that may be chosen.
integer
minQtyThe fewest of this child that may be chosen.
integer
coderequiredThe product's code, the same at every site that has it.
string
namerequiredThe product's name in the portal and reports.
string
pricerequiredThe price, in the site's currency's minor units: 450 is $4.50.
integer
soldIndividuallyrequiredWhether it can be ordered on its own. False for a modifier or an ingredient.
boolean
taxCodesrequiredThe taxes it is charged with, by code.
array of string
typerequiredWhat 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"
categoryCodeThe category it is in, by code.
string
costPriceWhat it costs to buy or make, in minor units. For reporting; never what a customer pays.
integer
courseCodeThe course it goes to the kitchen with, by code.
string
descriptionThe product's description.
string
displayNameThe name customers see, when it differs from name.
string
imageUrlIts picture.
string · uri
maxChoicesFor a modifier group: the most options a customer may choose.
integer
minChoicesFor a modifier group: the fewest options a customer must choose.
integer
printNameThe name printed on kitchen dockets and receipts.
string
reportGroupCodeThe reporting group it is counted in, by code.
string
skuYour stock-keeping unit for it.
string
soldOutUntilWhen 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
updatedAtWhen the product last changed.
string · date-time