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 Class

Request

Supported Media Types
Body ()
Request body
Root Schema : MenuItemClassGetRequestBody
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 Item Classes of the organization
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 : TranslatedString_allergenClassName
Type: object
A string that contains translations of allergenClassName into multiple languages
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 : TranslatedString_DefaultMasterGroup
Type: object
A string that contains translations of DefaultMasterGroup name into multiple languages
Example:
{
    "en-US":"Master Group",
    "de-DE":"Meistergruppe",
    "es-MX":"Grupo Maestro"
}
Nested Schema : TranslatedString_dscItmZrName
Type: object
A string that contains translations of dscItmZrName into multiple languages
Example:
{
    "en-US":"Discount Itemizer",
    "de-DE":"Rabatt-Itemizer",
    "es-MX":"Itemizador de descuento"
}
Nested Schema : TranslatedString_HierUnitName
Type: object
Additional Properties Allowed
Show Source
A group of string objects representing the name of the hierarchy unit configured languages
Example:
{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}
Nested Schema : TranslatedString_kdsCourseName
Type: object
A string that contains translations of KDS Course name into multiple languages
Example:
{
    "en-US":"Course",
    "de-DE":"Kurs",
    "es-MX":"Curso"
}
Nested Schema : TranslatedString_kdsHighlightName
Type: object
A string that contains translations of Print Class name into multiple languages
Example:
{
    "en-US":"Scheme",
    "de-DE":"Planen",
    "es-MX":"Esquema"
}
Nested Schema : MenuItemClassNameTranslatedString
Type: object
A string that contains translations of MenuItemClassName into multiple languages
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 : TranslatedString_PrintClassName
Type: object
A string that contains translations of Print Class name into multiple languages
Example:
{
    "en-US":"Print Class",
    "de-DE":"Klasse drucken",
    "es-MX":"Clase de impresi??n"
}
Nested Schema : TranslatedString_refillDescriptor
Type: object
A string that contains translations of svcGroupName into multiple languages
Example:
{
    "en-US":"Refill Descriptor",
    "de-DE":"Nachf??lldeskriptor",
    "es-MX":"Descriptor de recarga"
}
Nested Schema : TranslatedString_svcGroupName
Type: object
A string that contains translations of svcGroupName into multiple languages
Example:
{
    "en-US":"Print Class",
    "de-DE":"Servicegruppe",
    "es-MX":"Clase de impresi??n"
}
Nested Schema : TranslatedString_ServiceChargeItemizer
Type: object
A string that contains translations of ServiceCharge Itemizer name into multiple languages
Example:
{
    "en-US":"Service Charge",
    "de-DE":"Servicegeb??hr",
    "es-MX":"Cargo por servicio"
}
Nested Schema : TranslatedStringTaxClassName
Type: object
A string that contains translations of TaxClassName into multiple languages
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

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