Add Menu Item Classes
post
/config/sim/v1/menuItems/menuItemClasses
Adds Menu Item Classes
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string
Detail that identifies, who made the change.
CUD Request body
Root Schema : MenuItemClassCUDRequestBody
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(required):
integer
Unique hierarchy unit valueExample:
1 -
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(required):
object MenuItemClassNameTranslatedString
A string that contains translations of MenuItemClassName into multiple languages
-
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(required):
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 -
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 -
printClassName:
object TranslatedString_PrintClassName
A string that contains translations of Print Class name into multiple languages
-
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 TranslatedString_refillDescriptor
A string that contains translations of svcGroupName into multiple languages
-
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 : MenuItemClassNameTranslatedString
Type:
objectA 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 : TranslatedString_PrintClassName
Type:
objectA 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:
objectA 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 : 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
Response
Supported Media Types
- application/json
200 Response
A response body for Menu Item Class
Root Schema : MenuItemClassResponse
Type:
Show Source
object-
hierUnitId(required):
integer
Unique hierarchy unit valueExample:
1 -
objectNum(required):
integer
Unique reference of the Menu Item ClassExample:
2
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(required):
integer
Error code of the problemExample:
55223 -
status(required):
integer
HTTP status code.Example:
400 -
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(required):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html