» Support » Entwicklerdokumentation » Item Menu API

Item Menu API

With this import, item menus or named button groups, which are used to display the different items on the POS.

If you need more information about items menus, please have a look for the user documentation.

Endpoint

The endoint definition can be found in the common information <link>.

The importconfigkey for the simple item import nnqvtxniktboxmsh

Body

The valid json looks like that:

[
{
"__id": "{{__id}}",
"__organizationalId": "{{__organizationalId}}",
"buttonGroupName": {
"i18nVariants": {
"de_DE": "{{name_de_de}}"
}
},
"buttonGroupSortingOrder": {{buttonGroupSortingOrder}},
"buttonGroupVisibility": "{{buttonGroupVisibility}}",
"mainButtonImageRelation": "",
"overallButtonType": "{{overallButtonType}}",
"overallButtonImageRelation": "",
"buttons": [
{
"buttonFunction": "{{buttons_buttonFunction}}",
"buttonValue": "item:{{buttons_buttonValue}}",
"buttonLabel": {
"i18nVariants": {
"de_DE": "{{buttons_buttonlabel_de_de}}"
}
}
}
]
}
]

Definition

Field

Type

Sample

Description

__id

"NNNNN" - string

"12345" or "ABC-123"

The internal, unique ID for the item menu.

__organizationalId

"Nli1bkf_0" or "-1"

The unique ID for the concerning organization. If there are multiple stores and the menu is only available in specific store, you need the organizationalId for the appropiate store.

buttonGroupName

"TEXT" - string

"Daily Newspapers"

The name of the menu.

buttonGroupSortingOrder

NNNN - numeric

100

The sorting sequence in which the menus are displayed. The smaller the number, the higher it is ranked

buttonGroupVisibility

"ENABLED" / "DISABLED" / "ENABLED_ONLY_AS_SUBMENU"

"ENABLED"

Specifies whether the menu should be displayed on the POS or not.

buttonFunction

"ITEM_REGISTRATION" / "SUB_MENU"

"ITEM_REGISTRATION"

Specifies whether the button associated with the menu should register an item or open a submenu.

buttonValue

"item:N|lda8miao"
"
item_menu:N|lda8mia1"

The ID of the submenu or item, associated with the menu

buttonLabel

"TEXT"

"Local Newspapers"

The button description.

Postman Collection

To have a quickstart, please download the postman ressources:

  • Postman Collection for Item Menu Import - DOWNLOAD

  • Postman Environment for Item Menu Import - DOWNLOAD