1. Configuration and Content API Guide
  2. Tasks
  3. Menu Items
  4. Menu Items

Get Menu Items

post

/config/sim/v1/menuitems/getMenuItems

Gets all the Menu Items configured

Request

Supported Media Types
Body ()
Request body
Root Schema : MenuItemsGetRequestBody
Type: object
Show Source
  • 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(active,1)
Back to Top

Response

Supported Media Types

200 Response

A collection of Menu Items in organization.
Body ()
Root Schema : MenuItemGetResponse
Type: object
Model for an Integrated Menu Item Object
Show Source
Nested Schema : definitions
Type: array
Array of definitions of the menu item master
Show Source
Nested Schema : dietaryLabels
Type: array
An array of dietary labels for menu item
Show Source
Nested Schema : TranslatedString
Type: object
Additional 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_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 : MenuItem_definitions
Type: object
Show Source
Nested Schema : components
Type: array
An array of components associated with the menu item
Show Source
Nested Schema : customMenuLevels
Type: array
An array of custom menu levels associated with the menu item. It contains as many child attributes depending upon the custom levels configured
Show Source
Nested Schema : dataExtensions
Type: array
An array of data extensions for the menu item
Show Source
Nested Schema : defaultCondiments
Type: array
An array of Default Condiment of a Menu Item
Show Source
Nested Schema : images
Type: array
An array of images associated with the menu item
Show Source
Nested Schema : MenuItem_mainLevelExt
Type: object
An object containing the descriptive options list associated with the Main level
Show Source
Nested Schema : nutrients
Type: array
An array of nutrients of the menu item
Show Source
Nested Schema : prices
Type: array
Array of prices associated with the menu item definition
Show Source
Nested Schema : productionItems
Type: array
An array of production items associated with the menu item
Show Source
Nested Schema : slu
Type: array
Array of SLU keys and names to which the Menu Item Definition belongs
Show Source
Nested Schema : MenuItem_subLevelExt
Type: object
An object containing the descriptive options list associated with the Sub Level
Show Source
Nested Schema : tags
Type: array
An array of tags associated with the menu item
Show Source
Nested Schema : MenuItem_components
Type: object
Show Source
Nested Schema : MenuItem_customMenuLevels
Type: object
Show Source
Nested Schema : MenuItem_customLevelExt
Type: object
Flag indicating if the menu item is active on Custom Level
Show Source
Nested Schema : MenuItem_dataExtensions
Type: object
Show Source
Nested Schema : MenuItem_defaultCondiments
Type: object
Show Source
Nested Schema : condimentSetName
Type: object
A group of string objects representing the name of Condiment Set in configured languages. This value is excluded by default in GET response.
Example:
{
    "en-US":"Coffee",
    "de-DE":"Kaffee",
    "es-MX":"Cafe"
}
Nested Schema : MenuItem_optionExt
Type: object
An object containing the descriptive options list associated with the default condiments of the menu item. This value is excluded by default in GET response.
Show Source
  • Flag to charge customers for the condiment count. Deselect to charge only when the item count exceeds the default count. This is set by default for an Enhanced Prefix Mode Menu Item.
    Example: false
  • Flag to show the default condiment. Set to false to prevent condiments from appearing in the check detail, sending to KDS and Order Device printers, and printing on the customer receipt/guest check, even if the print class is set to print to KDS and Order Device printers.
    Example: false
Nested Schema : MenuItem_images
Type: object
Show Source
Nested Schema : MenuItem_nutrients
Type: object
Show Source
Nested Schema : MenuItem_prices
Type: object
Show Source
Nested Schema : MenuItem_optionsExt
Type: object
An object containing the descriptive options list associated with the Menu Items Price
Show Source
Nested Schema : MenuItem_productionItems
Type: object
Show Source
Nested Schema : MenuItem_slu
Type: object
Show Source
Nested Schema : MenuItem_tags
Type: object
Show Source
Nested Schema : MenuItem_dietaryLabels
Type: object
Show Source

400 Response

400 Bad Request
Body ()
Root Schema : ErrorDetails
Type: object
Response body when the request returns an error.
Show Source

404 Response

404 Requested resource not found
Back to Top