Get Menu Item Classes

post

/config/sim/v2/menuItems/getMenuItemClasses

Gets all the Menu Item Classes, it is recommended to use Menu Item Classes 2 instead of Menu Item Class.

Request

Supported Media Types
Body ()
The input Body model that needs to be given.
Root Schema : schema
Type: object
Show Source
  • If specified, limits the data returned to these fields.
    Example: hierUnitId, objectNum, name
  • If this value is specified, the include parameter is ignored.
    Value Description
    basic Forces the response to include all fields except option string details
    detailed Forces the response to include all fields including option string details
    Example: detailed
  • If specified, limits translated strings returned
    Example: 1,2,3
  • If using paging, number of results returned in this page.
    Example: 100
  • Starting resource record index. Not required if paging parameters are not supported
    Example: 0
  • Sorts the response by the specified field name and sort order.
    Example: hierUnitId:asc
  • If specified, returns records that match the criteria.
    Example: where equals(hierUnitId, 7)
Back to Top

Response

Supported Media Types

200 Response

A Collection of Menu Item Classes.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : items
Type: array
Array of Menu Item Class objects of the organization.
Show Source
Nested Schema : MenuItemClassV2
Type: object
Show Source
Nested Schema : MenuItemClass_condimentGroups
Type: object
List of condiment groups that are associated with the Menu Item Class
Show Source
Nested Schema : dataExtensions
Type: array
An array of data extensions for the menu item class
Show Source
Nested Schema : name
Type: object
Menu Item Class Name
Example:
{
    "1":"Enterprise",
    "2":"Unternehmen",
    "3":"Empresa"
}
Nested Schema : MenuItemClass_optionsExt
Type: object
An object containing the descriptive options
Show Source
Nested Schema : refillDescriptor
Type: object
Refill Descriptor
Example:
{
    "1":"Enterprise",
    "2":"Unternehmen",
    "3":"Empresa"
}
Nested Schema : allowedCondimentGroups
Type: array
Array of the Condiment Groups that are allowed when adding items in this Menu Item Class.
Show Source
Nested Schema : memberCondimentGroups
Type: array
Array of the Condiment Groups to which items in this Menu Item Class belong.
Show Source
Nested Schema : requiredCondimentGroups
Type: array
Array of the Condiment Groups that are required when ordering items assigned to this Menu Item Class.
Show Source
Nested Schema : MenuItemClass_allowedCondimentGroups
Type: object
Show Source
Nested Schema : MenuItemClass_memberCondimentGroups
Type: object
Show Source
Nested Schema : MenuItemClass_requiredCondimentGroups
Type: object
Show Source
Nested Schema : forceOptions
Type: array
Force Options of the condiment group
Show Source
Nested Schema : MenuItemClass_requiredCondimentGroups_forceOptions
Type: object
Show Source
Nested Schema : MenuItemClass_dataExtensions
Type: object
Show Source
Back to Top