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

Get Menu Item Classes

post

/config/sim/v1/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
  • Objects included in the response.
    Example: hierUnitId
  • 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 the translated strings returned.
    Example: en-US, es-ES, es-MX
  • If using paging, number of results returned in this page.
    Example: 0
  • 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: objectNum:asc
  • Search criteria to filter results based on field value.
    Example: where equals(objectNum,1)
Back to Top

Response

Supported Media Types

200 Response

A Collection of Menu Item Classes.
Body ()
Root Schema : MenuItemClassGetResponse
Type: object
Show Source
Nested Schema : items
Type: array
Array of Menu Item Classes objects.
Show Source
Nested Schema : MenuItemClass
Type: object
Show Source
Nested Schema : allergenClassName
Type: object
Allergen Class Name
Example:
{
    "en-US":"Allergen Class",
    "de-DE":"Allergenklasse",
    "es-MX":"Clase de al??rgeno"
}
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 : defaultMasterGroupName
Type: object
Default Master Group Name
Example:
{
    "en-US":"Master Group",
    "de-DE":"Meistergruppe",
    "es-MX":"Grupo Maestro"
}
Nested Schema : dscItmZrName
Type: object
Discount Itemizer Name
Example:
{
    "en-US":"Discount Itemizer",
    "de-DE":"Rabatt-Itemizer",
    "es-MX":"Itemizador de descuento"
}
Nested Schema : hierUnitName
Type: object
Hier Unit Name
Example:
{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}
Nested Schema : kdsCourseName
Type: object
KDS Course Name
Example:
{
    "en-US":"Course",
    "de-DE":"Kurs",
    "es-MX":"Curso"
}
Nested Schema : kdsHighlightSchemeName
Type: object
KDS Highlights Scheme Name
Example:
{
    "en-US":"Scheme",
    "de-DE":"Planen",
    "es-MX":"Esquema"
}
Nested Schema : name
Type: object
Name
Example:
{
    "en-US":"Menu Item",
    "de-DE":"Men??punkt",
    "es-MX":"Opci??n del men??"
}
Nested Schema : MenuItemClass_optionsExt
Type: object
An object containing the descriptive options
Show Source
Nested Schema : preProdChitPrintClassName
Type: object
Pre Prod Chit Print Class Name
Example:
{
    "en-US":"Print Class",
    "de-DE":"Klasse drucken",
    "es-MX":"Clase de impresi??n"
}
Nested Schema : printClassName
Type: object
Print Class Name
Example:
{
    "en-US":"Print Class",
    "de-DE":"Klasse drucken",
    "es-MX":"Clase de impresi??n"
}
Nested Schema : refillDescriptor
Type: object
Refill Descriptor
Example:
{
    "en-US":"Refill Descriptor",
    "de-DE":"Nachf??lldeskriptor",
    "es-MX":"Descriptor de recarga"
}
Nested Schema : slsItmzrName
Type: object
SLS Itemizer Name
Example:
{
    "en-US":"Menu Item",
    "de-DE":"Men??punkt",
    "es-MX":"Opci??n del men??"
}
Nested Schema : svcGroupName
Type: object
SVC Group Name
Example:
{
    "en-US":"Print Class",
    "de-DE":"Servicegruppe",
    "es-MX":"Clase de impresi??n"
}
Nested Schema : svcItmzrName
Type: object
Service Charge Itemizer
Example:
{
    "en-US":"Service Charge",
    "de-DE":"Servicegeb??hr",
    "es-MX":"Cargo por servicio"
}
Nested Schema : taxClassName
Type: object
Tax Class Name
Example:
{
    "en-US":"Tax Class",
    "de-DE":"Steuerklasse",
    "es-MX":"Clasificaci??n Fiscal"
}
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