Get Menu Item Masters
post
/config/sim/v1/menuItems/getMenuItemMasters
Gets all the Menu Item Masters configured and hierarchy unit
Request
Supported Media Types
- application/json
- multipart/form-data
Request body
Root Schema : MenuItemMastersGetRequestBody
Type:
Show Source
object-
hierUnitId:
integer
Unique Hierarchy unit reference. This is an optional field. Alternatively, searchCriteria can be used to get results for a particular hierUnitId.Example:
1012 -
include:
string
Example:
locations -
includeAll:
string
This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except
Ext values. If 'detailed' is specified, The response contains all the properties of the object. Example:detailed -
languages:
string
If specified, limits translated strings returned.Example:
en-US, de-DE, es-MX -
limit:
integer
Number of results returned in this page. Not required if paging parameters are not supported.Example:
10 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
2 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum -
searchCriteria:
string
Search criteria to filter results based on field value.Example:
where equals(hierUnitId,1012)
Response
Supported Media Types
- application/json
200 Response
A collection of menuItemMaster for the Hierarchy
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 : TranslatedString
Type:
objectAdditional Properties Allowed
Show Source
A string that contains translations into multiple languages
Example:
{
"en-US":"Coffee",
"de-DE":"Kaffee",
"es-MX":"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
Nested Schema : MenuItem_effectivityGroups
Type:
Show Source
object-
effectivityGroupName:
object TranslatedString
Additional Properties Allowed: additionalPropertiesA string that contains translations into multiple languages
-
effectivityGroupObjectNum:
integer
effectivity group object numberExample:
1 -
hierUnitId:
integer
hierarchy where the effectivity group is configuredExample:
14102
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(required):
integer
Error code of the problemExample:
55223 -
status(required):
integer
HTTP status code.Example:
400 -
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(required):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html
404 Response
404 Requested resource not found