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
- application/json
- multipart/form-data
The input Body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
If specified, limits the data returned to these fields.Example:
hierUnitId, objectNum, name -
includeAll:
string
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 -
langIds:
string
If specified, limits translated strings returnedExample:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
hierUnitId:asc -
searchCriteria:
string
If specified, returns records that match the criteria.Example:
where equals(hierUnitId, 7)
Response
Supported Media Types
- application/json
200 Response
A Collection of Menu Item Classes.
Nested Schema : MenuItemClassV2
Type:
Show Source
object-
allergenClassObjNum:
integer
Object number of the Allergen Class for the Menu Item Class.Example:
1 -
condimentEditPopup:
integer
Condiment Orderer page to automatically pop up when selecting a menu item with required condiments in the check detail.Example:
0 -
condimentGroups:
object MenuItemClass_condimentGroups
List of condiment groups that are associated with the Menu Item Class
-
condimentHandlingWithParentItemSwitching:
integer
Condiment behavior to use for Default and other Condiments when the parent item is switched in Conversational Ordering.Example:
0 -
condimentOrderPopup:
integer
Popup Condiment Orderer page to automatically pop up when adding a menu item with required condiments.Example:
1 -
condimentOrderType:
integer
Method for adding a condiment to a check. Value should be between 0-4.Example:
1 -
condimentPrefixType:
integer
Prefix Type associated with a Condiment type.Example:
1 -
countDisplay:
integer
Count that appear on the workstation and printers.Example:
1 -
countEntry:
integer
Select the operator entry method for item sales count.Example:
1 -
dataExtensions:
array dataExtensions
An array of data extensions for the menu item class
-
defaultMasterGroupObjNum:
integer
Object number of the default parent item for a condiment during conversational ordering.Example:
1 -
dscItmzrIndex:
integer
Index of the Discount Itemizer associated with this Menu Item Class.Example:
1 -
halo:
integer
High Amount Lock Out (HALO) value for items in this Menu Item Class.Example:
1 -
hierUnitId:
integer
Unique hierarchy unit valueExample:
1 -
hierUnitObjNum:
integer
Hierarchy unit object numberExample:
2 -
kdsCourseObjNum:
integer
Object number of the course to which items in this Menu Item Class belong.Example:
1 -
kdsHighlightScheme:
integer
Object number of the KDS Highlight Scheme color to display menu items on the KDS.Example:
1 -
mainLevelDefault:
boolean
Select Main Level Dflt to return the Main Level of the transaction to the default Main Level after adding an item from this Menu Item Class.Example:
false -
mainLevelPopupIndex:
integer
Main Level of the transaction to become active after adding an item from this Menu Item Class.Example:
1 -
maxRefillCount:
integer
Maximum number of Refills allowed for a Menu item.Example:
1 -
name:
object name
Menu Item Class Name
-
nextPage:
integer
Next screen or page to which the workstation user is directed.Example:
0 -
nextPanel:
integer
Panel specifies which Tab to navigate.Example:
0 -
objectNum:
integer
Object Number of the menu item Class.Example:
1 -
options:
string
A string value of 0s & 1s of length 96 representing the enablement or disablement of the options associated with the Menu Item Class.Example:
010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 -
optionsExt:
object MenuItemClass_optionsExt
An object containing the descriptive options
-
preProdChitPrintClassObjNum:
integer
Object number of the Pre Production Chit Print Class for the Menu Item Class.Example:
1 -
priceCalculation:
integer
Calculation method to use for pricing menu items in the class when entering a decimal count.Example:
0 -
printClassObjNum:
integer
Object number of the Print Class for the menu item class.Example:
1 -
printGroup:
integer
The sorting mechanism uses this value for receipt printing, check detail, and order output devices.Example:
1 -
privilegeGroup:
integer
Privilege Group number to restrict the use of items in this Menu Item Class to employees who are linked to the same Privilege GroupExample:
1 -
refillDescriptor:
object refillDescriptor
Refill Descriptor
-
slsItmzrIndex:
integer
Index of the Sales Itemizer used to sort Menu Item Classes.Example:
1 -
subLevelDefault:
boolean
Select Sub Level Dflt to return the Sub Level of the transaction to the default Sub Level after adding an item from this Menu Item Class.Example:
false -
subLevelPopupIndex:
integer
Sub Level of the transaction to become active after adding an item from this Menu Item Class.Example:
1 -
svcGroupObjNum:
integer
Object number of the Service Charge Group to apply to this Menu Item Class.Example:
1 -
svcItmzrIndex:
integer
Index of the Service Charge Itemizer associated with menus items assigned to this Menu item Class.Example:
1 -
taxClassObjNum:
integer
Tax Class object for the Menu Item classExample:
1
Nested Schema : MenuItemClass_condimentGroups
Type:
objectList of condiment groups that are associated with the Menu Item Class
Show Source
-
allowedCondimentGroups:
array allowedCondimentGroups
Array of the Condiment Groups that are allowed when adding items in this Menu Item Class.
-
memberCondimentGroups:
array memberCondimentGroups
Array of the Condiment Groups to which items in this Menu Item Class belong.
-
requiredCondimentGroups:
array requiredCondimentGroups
Array of the Condiment Groups that are required when ordering items assigned to this Menu Item Class.
Nested Schema : dataExtensions
Type:
arrayAn array of data extensions for the menu item class
Show Source
Nested Schema : name
Type:
objectMenu Item Class Name
Example:
{
"1":"Enterprise",
"2":"Unternehmen",
"3":"Empresa"
}Nested Schema : MenuItemClass_optionsExt
Type:
objectAn object containing the descriptive options
Show Source
-
addCondimentPriceToParentItem:
boolean
Flag indicating to add Condiment Price to Parent Item.Example:
false -
addToAutoSVCItmzr:
boolean
Flag indicating to add menu items in this class to the Automatic Service Charge itemizer.Example:
false -
addToGuestCount:
boolean
Flag indicating to increase the guest count when menu items in this class are ordered.Example:
false -
allowCondimentChangesPrintGroupOfParentClass:
boolean
Flag indicating to force a parent menu item that is modified by a condiment.Example:
false -
allowItemIncompleteBasedOnRole:
boolean
Flag indicating to allow the employee to add the parent menu item without the required condiments.Example:
false -
allowNonPricedMenuItems:
boolean
Flag indicating to allow menu items in this class to be non-priced.Example:
false -
applyItemDiscountsToMenuItems:
boolean
Flag indicating to allow menu items in this class to be discounted with an item discount.Example:
false -
autoFill:
boolean
Flag indicating to adjust the quantity to satisfy the required condiments when adding the condiment with a required condiment group that has Min/Max set, and more than one condiment is still needed.Example:
false -
condimentEntryRelationaltoParentItemsQuantity:
boolean
Flag indicating to show the number of condiments for each parent menu item.Example:
false -
condimentOrderDeviceProgrammingOverridesThatOfParent:
boolean
Flag indicating to allow the order devices programmed for this condiments class to override the order devices defined for the parent items.Example:
false -
consolidateMenuItemWithCondimentsOnOrderOutput:
boolean
Flag indicating to consolidate parent menu items on Order Device Output, and then to print each condiment with the seat number.Example:
false -
consolidateParentsWithMatchingCondimentsOnOrderOutput:
boolean
Flag indicating to consolidate parent menu items with identical (matching) condiments.Example:
false -
containsAlcohol:
boolean
Flag indicating for menu items in this class to be marked as containing alcohol.Example:
false -
countMenuItem:
boolean
Flag indicating to allow the menu item count to appear on the KDS or at the bottom of the requisition chit from a local or remote printer.Example:
false -
discountsApplyToPricedCondiments:
boolean
Flag indicating to apply discounts to parent items in this class and all priced condiments associated with the items.Example:
false -
doNotPrintUnPricedCondimentsOnGuestChecks:
boolean
Flag indicating to stop unpriced condiments from printing on guest checks and customer receipts.Example:
false -
doNotPutInTransactionDetail:
boolean
Flag indicating to prevent menu items in this class that have a 0.00 price, or no price record assigned, from printing, appearing, or posting.Example:
false -
enableCondimentMenuItems:
boolean
Flag indicating to designate menu items as condiments.Example:
false -
enableNegativePricedMenuItems:
boolean
Flag indicating to have menu items in this class post a negative price/sales amount.Example:
false -
enableOpenPricedMenuItems:
boolean
Flag indicating if users asked for amount each time a menu item in this class is ordered.Example:
false -
enableRefill:
boolean
Flag indicating for customers to pay once for selected menu items, while receiving multiple servings or refills.Example:
false -
forgiveInclusiveTax:
boolean
Flag indicating to forgive Inclusive Tax for this class.Example:
false -
ignoreKDSPrepTime:
boolean
Flag indicating for menu items in this class to be displayed at a KDS display as soon capacity is available, ignoring having all menu items prep complete at the same time.Example:
false -
includeInCRMOrTMSCheckDetilUpdate:
boolean
Flag indicating to indicate whether a menu item is sent to the TMS Interface with the check detail status message.Example:
false -
incrementSeatNumberWithSaleOfMenuItems:
boolean
Flag indicating to increment the seat number each time a menu item in this class is ordered.Example:
false -
isAnonymousMenuItem:
boolean
Flag indicating to allow placeholder or anonymous menu items, which can be replaced with the actual parent menu items during the ordering process.Example:
false -
isBeverageItem:
boolean
Flag indicating if all items in this Menu Item Class are beverages.Example:
false -
isRetailItem:
boolean
Flag indicating whether item is retailable or not.Example:
false - isShareableItem: boolean
-
itemMustCompleteBeforeNextItem:
boolean
Flag indicating to prevent operators from adding a second menu item before completing the first item.Example:
false -
kdsSortPriorityAboveNormal:
boolean
Flag indicating to allow menu items assigned to this class to use a higher sort priority than normal.Example:
false -
keepMainLevelWithRepeatRounds:
boolean
Flag indicating to enforce items in this class to use the same Main Menu Level that was in effect during the most recent service round when ordered using the Repeat Round key.Example:
false -
keepSubLevelWithRepeatRounds:
boolean
Flag indicating to enforce items in this class to use the same Sub Menu Level that was in effect during the most recent service round when ordered using the Repeat Round key.Example:
false -
ldsItems:
boolean
Flag indicating if all menu items in this class can be ordered using an International Liquor Dispensing System (ILDS).Example:
false -
noPlaceHolderDisplay:
boolean
Flag indicating to hide placeholder items from the check detail area.Example:
false -
onlyAllowCondimentsWithAnActivePriceRecord:
boolean
Flag indicating to prevent condiments that do not have an effective price record from being displayed in SLU's or added to a parent item from a direct access button.Example:
false -
overrideKDSCourseNumOfParentClass:
boolean
Flag indicating to allow a parent menu item modified by a condiment in this Menu Item Class to use the KDS Course of the condiment.Example:
false -
overrideParentsIgnoreKDSPrepTimeOption:
boolean
Flag indicating to override Option 83 of Parent Class.Example:
false -
parentItemsAppearOnCondimentOrderDevices:
boolean
Flag indicating to send the parent item to the order devices programmed for this class.Example:
false -
participatesInMenuItemSwitching:
boolean
Flag indicating to switch a parent menu item based a menu level change.Example:
false -
placeHolder:
boolean
Flag indicating for menu items that serve as a placeholder during Combo Meal ordering.Example:
false -
postSalesCountToKDSReports:
boolean
Flag indicating to allow the menu item count to add to the Menu Item Count totals on the KDS reports.Example:
false -
PreventMenuItemsFromBeingHeld:
boolean
Flag indicating to prevent menu items belonging to this Menu Item Class from being held.Example:
false -
printMainLevelPrefixAndSuffix:
boolean
Flag indicating to have the Main level prefix or suffix show on the check detail area and to print on order output devices, guest checks, and customer receipts.Example:
false -
printName1And2OnChecks:
boolean
Flag indicating to print the First Name and the Second Name.Example:
false -
printName2OnOrderOutput:
boolean
Flag indicating to print the Second Name on Order Device output.Example:
false -
printName3OnChecks:
boolean
Flag indicating to print the menu item definition's Third Name (if defined) on guest checks for menu items in this class.Example:
false -
printName3OnOrderOutputInsteadOfName1:
boolean
Flag indicating to print the menu item definition's Third Name (if defined) on order devices for menu items in this class.Example:
false -
printPricetoOrderchit:
boolean
Flag indicating to print the price of open-priced items on order chits.Example:
false -
printSubLevelPrefixAndSuffix:
boolean
Flag indicating to have the Sub level prefix or suffix show on the check detail area and to print on order output devices, guest checks, and customer receipts.Example:
false -
promptForSeatNumWithEachItem:
boolean
Flag indicating to prompt Enter Seat Number after adding each parent item with this Menu Item Class.Example:
false -
promptToBeginNextItemIfItemIsIncomplete:
boolean
Flag indicating to prompt to move to the next item before completing a menu item order.Example:
false -
promptToLookupMenuItemDefinitionbasedOncurrentMenuLevels:
boolean
Flag indicating to prompt the operator to look up a menu item definition based on the current menu levels when a repeatable menu item is unavailable.Example:
false -
ReferenceEntryRequired:
boolean
Flag indicating to require a reference entry for menu items assigned to this class.Example:
false -
removeItemOnSubsequentPressIfExclusiveOrderingType:
boolean
Flag indicating to remove a condiment item and revert the parent menu item to the default state.Example:
false -
rentalDeposit:
boolean
Flag indicating to make all items in this class Rental Deposits.Example:
false -
requireNumberOfCondimentsToMatchParent:
boolean
Flag indicating to require the number of required condiments to match the number of parent menu items ordered.Example:
false -
sortCondimentsByPrintGroup:
boolean
Flag indicating to sort condiment display and printing tasks according to their Print Group assignment.Example:
false -
supportEnhancedPrefixMode:
boolean
Flag indicating to turn on Enhanced Prefix Support for non-condiment menu items in this class.Example:
false -
useKDSDiningCourseNumber:
boolean
Flag indicating to use KDS/Dining Coursing with this Menu Item Class.Example:
false -
useName2OnOCBInsteadOfName1:
boolean
Flag indicating to show the menu item definition's Second Name (if defined) on an Order Confirmation Board.Example:
false -
useName2OnTouchScreens:
boolean
Flag indicating to show the Second Name, if defined, of menu items assigned to this class on workstation touchscreen keys.Example:
false -
useName3OnOCBInsteadOfName1:
boolean
Flag indicating to show the third name (if defined) on an Order Confirmation Board. If no third name is defined, the first name is used.Example:
false -
useName3OnTouchscreensInsteadOfName1:
boolean
Flag indicating to show the third name (if defined) on system generated touchscreen keys.Example:
false -
useOwnOuputLink:
boolean
Flag indicating to have condiments in this class print to their own order devices.Example:
false -
useSubLevelPricing:
boolean
Flag indicating to use Sub Level pricing for this menu item class.Example:
false -
useWithRepeatRoundKey:
boolean
Flag indicating if all menu items in this class can be reposted on guest checks using the Repeat Round key.Example:
false -
validationRequired:
boolean
Flag indicating to allow menu items in this class to be discounted with an item discount.Example:
false -
weighedItems:
boolean
Flag indicating if all menu items in this class are sold by weight.Example:
false
Nested Schema : refillDescriptor
Type:
objectRefill Descriptor
Example:
{
"1":"Enterprise",
"2":"Unternehmen",
"3":"Empresa"
}Nested Schema : allowedCondimentGroups
Type:
arrayArray of the Condiment Groups that are allowed when adding items in this Menu Item Class.
Show Source
Nested Schema : memberCondimentGroups
Type:
arrayArray of the Condiment Groups to which items in this Menu Item Class belong.
Show Source
Nested Schema : requiredCondimentGroups
Type:
arrayArray of the Condiment Groups that are required when ordering items assigned to this Menu Item Class.
Show Source
Nested Schema : MenuItemClass_allowedCondimentGroups
Type:
Show Source
object-
condimentGroupObjNum:
integer
Object number of the condiment groupExample:
1
Nested Schema : MenuItemClass_memberCondimentGroups
Type:
Show Source
object-
condimentGroupObjNum:
integer
Object number of the condiment groupExample:
2
Nested Schema : MenuItemClass_requiredCondimentGroups
Type:
Show Source
object-
condimentGroupObjNum:
integer
Object number of the condiment groupExample:
1 -
forceOptions:
array forceOptions
Force Options of the condiment group
Nested Schema : MenuItemClass_requiredCondimentGroups_forceOptions
Type:
Show Source
object-
maximum:
integer
Maximum number of items allowed in the condiment groupExample:
1 -
minimum:
integer
Minimum number of items in the condiment groupExample:
1 -
threshold1:
integer
Threshold 1 count of the condiment groupExample:
1 -
threshold2:
integer
Threshold 2 count of the condiment groupExample:
1 -
thresholdLevel1:
integer
Threshold Level 1 of the condiment groupExample:
1 -
thresholdLevel2:
integer
Threshold Level 2 of the condiment groupExample:
1
Nested Schema : MenuItemClass_dataExtensions
Type:
Show Source
object-
columnName:
string
Name of the extention fieldExample:
extension column 1 -
value:
string
Value of the extention fieldExample:
value 1