1. Configuration and Content API Guide
  2. Tasks
  3. v1
  4. Menu Items
  5. Menu Item Master

Get Menu Item Masters

post

/config/sim/v1/menuItems/getMenuItemMasters

Gets all Menu Item Masters

Request

Supported Media Types
Body ()
Request body
Root Schema : MenuItemMastersGetRequestBody
Type: object
Show Source
  • Unique Hierarchy unit reference. This is an optional field. Alternatively, searchCriteria can be used to get results for a particular hierUnitId.
    Example: 1012
  • Example: locations
  • 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
  • If specified, limits translated strings returned.
    Example: en-US, de-DE, es-MX
  • Number of results returned in this page. Not required if paging parameters are not supported.
    Example: 10
  • Starting resource record index. Not required if paging parameters are not supported
    Example: 2
  • Sorts the response by the specified field name and sort order.
    Example: objectNum
  • Search criteria to filter results based on field value.
    Example: where equals(hierUnitId,1012)
Back to Top

Response

Supported Media Types

200 Response

A Collection of Menu Item Masters
Body ()
Root Schema : menuItemMasterGetResponseV1
Type: object
Show Source
Nested Schema : items
Type: array
Array of Menu Item Master objects.
Show Source
Nested Schema : menuItemMasterResponseV1
Type: object
Show Source
Nested Schema : dataExtensions
Type: array
An array of data extensions for the menu item
Show Source
Nested Schema : dietaryLabels
Type: array
An array of dietary labels for menu item
Show Source
Nested Schema : effectivityGroups
Type: array
An array of effectivity groups for the menu item. Excluded from the response by default. Use this field in 'include' filter or use the 'includeAll' filter to get it.
Show Source
Nested Schema : MenuItem_miMasterOptionsExt
Type: object
Show Source
  • 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 = 4
    Example: false
  • 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 = 5
    Example: false
  • 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 = 2
    Example: false
  • 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 = 3
    Example: false
Nested Schema : name
Type: object
Name
Example:
{
    "en-US":"Coffee",
    "de-DE":"Kaffee",
    "es-MX":"Cafe"
}
Nested Schema : MenuItem_dataExtensions
Type: object
Show Source
Nested Schema : MenuItemMaster_dietaryLabels
Type: object
Show Source
Nested Schema : MenuItem_effectivityGroups
Type: object
Show Source
Nested Schema : effectivityGroupName
Type: object
Effectivity Group Name
Example:
{
    "en-US":"Coffee",
    "de-DE":"Kaffee",
    "es-MX":"Cafe"
}
Back to Top