Add Menu Item Masters
post
/config/sim/v2/menuItems/menuItemMasters
Add the Menu Item Master object to a specified hierarchy unit:
Release | Description |
---|---|
23.4 | Starting with the API release 23.4, Insert Menu Item Masters is permitted only for unique object numbers within the organization |
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string
Detail that identifies, who made the change.
Request body
Root Schema : schema
Type:
Show Source
object
-
dataExtensions:
array dataExtensions
An array of data extensions for the menu item
-
dietaryLabels:
array dietaryLabels
An array of dietary labels for menu item
-
externalReference1:
string
An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32Example:
ExternalReference1
-
externalReference2:
string
An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32Example:
ExternalReference2
-
familyGroupObjectNum:
integer
Family group object numberExample:
1
-
hierUnitId(required):
integer
Unique hierarchy unit referenceExample:
2
-
majorGroupObjectNum:
integer
Major group object numberExample:
2
-
masterGroupObjectNum:
integer
Master group object numberExample:
2
-
miMasterOptions:
string
A string value of 0s & 1s of length 8 representing the enabled or disabled options, default 00000000.Example:
00000000
-
miMasterOptionsExt:
object MenuItem_miMasterOptionsExt
-
name:
object name
Name
-
name2:
object name2
Menu Item Master Name2
-
objectNum(required):
integer
Menu item master object numberExample:
1
-
reportGroupObjectNum:
integer
Report group object numberExample:
2
Nested Schema : dataExtensions
Type:
array
An array of data extensions for the menu item
Show Source
Nested Schema : MenuItem_miMasterOptionsExt
Type:
Show Source
object
-
core:
boolean
Selecting the core option designates the menu item as a core item, ensuring it is always available for sale and cannot be disabled using effectivity groups. When this option is chosen, the effectivity group selection grid is disabled, and any previously selected effectivity groups are disregarded during the sales process. miMasterOptions Option Bit = 4Example:
false
-
disabled:
boolean
Selecting the 'disabled' option deactivates the menu item for transactions and renders it unavailable for sale. Choosing this option takes precedence over other selections, such as the core menu item option and effectivity groups assigned to the master. miMasterOptions Option Bit = 5Example:
false
-
disableEditByWSEditMenuItem:
boolean
A flag indicating to prevent the menu item from appearing or being edited by OPS Function, Edit Menu Item. This prevents configuration changes to all definitions of the item. This option does not affect configuration of Menu Item Availability. miMasterOptions Option Bit = 2Example:
false
-
nonRevenue:
boolean
Select to enforce non-revenue menu items. Non-revenue menu items do not add value to the sales reports, but add value to the guest check. miMasterOptions Option Bit = 3Example:
false
Nested Schema : name
Type:
object
Name
Example:
{
"1":"Coffee",
"2":"Kaffee",
"3":"Cafe"
}
Nested Schema : name2
Type:
object
Menu Item Master Name2
Example:
{
"1":"Coffee",
"2":"Kaffee",
"3":"Cafe"
}
Nested Schema : MenuItem_dataExtensions
Type:
Show Source
object
-
columnName:
string
Name of the extention fieldExample:
extension column 1
-
value:
string
Value of the extention fieldExample:
value 1
Nested Schema : MenuItemMaster_dietaryLabels
Type:
Show Source
object
-
dietaryLabelName:
string
Name of the dietary labelExample:
Dietary Label 1
Response
Supported Media Types
- application/json
200 Response
Menu Item Master Added