Reference · Till menus
Update a till menu
/v1/sites/{siteId}/till-menus/{code}Renames a till menu, publishes it to the tills or withdraws it, changes when it is offered, or retires it. Only the fields sent change.
Path
siteIdrequiredThe site, from GET /v1/sites.
string
coderequiredThe menu's code.
string
Headers
AuthorizationrequiredAn API key from Automation > Access in the Dnero portal, sent as
Authorization: Bearer <key>.string
Body
activeFalse to retire it, true to bring it back.
boolean
availabilityReplaces when the tills offer it. Send an empty array for always.
array of objects
3 fields in each
daysrequiredThe days it applies on, monday to sunday.
array of string
endsAtUntil, as HH:MM in the site's time. Absent is to the end of the day.
string
startsAtFrom, as HH:MM in the site's time. Absent is from the start of the day.
string
nameA new name.
string · 1–200 characters
publishedSend it to the tills, or stop.
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
200 OK
activerequiredFalse for a retired till menu.
boolean
availabilityrequiredWhen the tills offer it. Empty is always.
array of objects
3 fields in each
daysrequiredThe days it applies on, monday to sunday.
array of string
endsAtUntil, as HH:MM in the site's time. Absent is to the end of the day.
string
startsAtFrom, as HH:MM in the site's time. Absent is from the start of the day.
string
coderequiredThe till menu's code.
string
namerequiredThe till menu's name, as staff see it.
string
orderrequiredWhere it sits among the site's till menus, lowest first.
integer
publishedrequiredWhether the tills receive it. An unpublished menu exists but is not in use.
boolean
sectionsrequiredIts sections, in order.
array of objects
4 fields in each
buttonsrequiredIts buttons, in order.
array of objects
4 fields in each
typerequiredWhat the button does. A folder opens its children.
string · one of "product", "modifier", "folder", "promotion", "orderType", "screen", "blank"
childrenFor a folder: the buttons inside it.
array of objects
The same fields as its parent.
nameThe button's label, when it is not the product's name.
string
productCodeFor a product or modifier button: the product, by code.
string
coderequiredThe section's code, within its menu.
string
namerequiredThe section's name.
string
colourThe section tab's colour, #RRGGBB.
string
updatedAtWhen it last changed.
string · date-time