Add Menu Item Definitions
post
/config/sim/v2/menuItems/menuItemDefinitions
Add the Menu Item Definition object to a specified hierarchy unit V2.
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string
Detail that identifies, who made the change.
Request body
Root Schema : MenuItemDefinitionInsertRequestBodyV2
Type:
Show Source
object-
components:
array components
An array of components associated with the menu item
-
consumerAdvisoryDesc:
string
The consumer advisory description of the menu itemExample:
Menu Item 1 -
consumerItemDescription:
object TranslatedStringV2
A string that contains translations into multiple languages
-
consumerItemName:
object TranslatedStringV2
A string that contains translations into multiple languages
-
customMenuLevels:
array customMenuLevels
An array of custom menu levels associated with the menu item. It contains as many child attributes depending upon the custom levels configured
-
dataExtensions:
array dataExtensions
An array of data extensions for the menu item
-
defaultCondiments:
array defaultCondiments
An array of Default Condiment of a Menu Item
-
defSequenceNum(required):
integer
Indicates the definition sequence number, which is the number of the definition in the revenue center for this master record.Sequence Number should be with 1-64Example:
1 -
firstName:
object TranslatedStringV2
A string that contains translations into multiple languages
-
guestCount:
integer
Guest count for the menu item to increment the check guest count when added.Example:
1 -
hierUnitId(required):
integer
Hierarchy unit unique referenceExample:
1012 -
images:
array images
An array of images associated with the menu item
-
kdsPrepTime:
integer
The number of minutes necessary to prepare this itemExample:
10.3 -
longDescriptor:
object TranslatedStringV2
A string that contains translations into multiple languages
-
mainLevel:
string
A string value of 0s & 1s of length 8 representing main levels on which the definition is active.Example:
11001111 - menuItemClassObjNum: integer
- menuItemMasterId(required): integer
-
nluGroupObjNum:
integer
Object number of the NLU Group associated with this menu itemExample:
1 -
nluNum:
Unique NLU number for this menu item (up to 12 digits).Example:
1 -
nutrients:
array nutrients
An array of nutrients of the menu item
-
overrideAllergenClassObjNum:
integer
Object number of the Allergen Class for the menu item definition to override its menu item class settingExample:
1 -
overridePrintClassObjNum:
integer
Object number of the Print ClassExample:
1 -
prefixLevelOverride:
integer
Select to allow the condiment prefix to override the price level of the item it modifies.Example:
1 -
productionItems:
array productionItems
An array of production items associated with the menu item
-
quantity:
integer
Quantity of a Menu ItemExample:
1 -
secondName:
object TranslatedStringV2
A string that contains translations into multiple languages
-
slu1ObjNum:
integer
Object number of SLU 1 to which the Menu Item Definition belongsExample:
200 -
slu2ObjNum:
integer
Object number of SLU 2 to which the Menu Item Definition belongsExample:
201 -
slu3ObjNum:
integer
Object number of SLU 3 to which the Menu Item Definition belongsExample:
202 -
slu4ObjNum:
integer
Object number of SLU 4 to which the Menu Item Definition belongsExample:
203 -
slu5ObjNum:
integer
Object number of SLU 5 to which the Menu Item Definition belongsExample:
204 -
slu6ObjNum:
integer
Object number of SLU 6 to which the Menu Item Definition belongsExample:
205 -
slu7ObjNum:
integer
Object number of SLU 7 to which the Menu Item Definition belongsExample:
206 -
slu8ObjNum:
integer
Object number of SLU 8 to which the Menu Item Definition belongsExample:
207 -
sluSortPriority:
integer
Use this field when Page Design Layout optionExample:
0 -
subLevel:
string
A string value of 0s & 1s of length 8 representing Sub Levels on which the definition is activeExample:
11001111 -
surcharge:
integer
Surcharge for the menu itemExample:
1 -
tags:
array tags
An array of tags associated with the menu item
-
tareWeight:
integer
Weight of the empty package for an item sold by weightExample:
1.23 -
thirdName:
object TranslatedStringV2
A string that contains translations into multiple languages
Nested Schema : components
Type:
arrayAn array of components associated with the menu item
Show Source
Nested Schema : TranslatedStringV2
Type:
objectA string that contains translations into multiple languages
Example:
{
"1":"Coffee",
"2":"Kaffee",
"3":"Cafe"
}Nested Schema : customMenuLevels
Type:
arrayAn array of custom menu levels associated with the menu item. It contains as many child attributes depending upon the custom levels configured
Show Source
Nested Schema : dataExtensions
Type:
arrayAn array of data extensions for the menu item
Show Source
Nested Schema : defaultCondiments
Type:
arrayAn array of Default Condiment of a Menu Item
Show Source
Nested Schema : productionItems
Type:
arrayAn array of production items associated with the menu item
Show Source
Nested Schema : MenuItem_component
Type:
Show Source
object-
componentObjNum:
integer
Object number of the componentExample:
1
Nested Schema : MenuItem_customMenuLevel
Type:
Show Source
object-
customLevel:
string
Flag indicating if the menu item is active on Custom LevelExample:
11001111 - menuLevelObjNum: integer
Nested Schema : MenuItem_dataExtensions
Type:
Show Source
object-
columnName:
string
Name of the extention fieldExample:
extension column 1 -
value:
string
Value of the extention fieldExample:
value 1
Nested Schema : MenuItem_defaultCondiment
Type:
Show Source
object-
condimentSetObjNum:
integer
Object number of the condiment setExample:
1 - menuItemDefaultCondimentId: integer
-
options:
string
A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the default condiments of the menu item. This value is excluded by default in GET response.Example:
1000000 -
sortGroup:
integer
Sort group of the condiment setExample:
1
Nested Schema : MenuItem_image
Type:
Show Source
object-
altText:
string
The image alternative text of the menu itemExample:
pizza -
description:
string
The description text of the menu itemExample:
pizza description -
imageIndex:
integer
Image Number for referenceExample:
1 -
isCloudImage:
boolean
Flag indicating if the image is stored on the CloudExample:
true -
size:
string
The size of the imageExample:
1 -
url:
string
The URL of the image of the menu itemExample:
https://oracleObjectStore.com/images/coffee822815.jpg
Nested Schema : MenuItem_nutrient
Type:
Show Source
object- menuItemNutrientSetId: integer
-
nutrientSetObjNum:
integer
Object number of the nutrient setExample:
1
Nested Schema : MenuItem_productionItem
Type:
Show Source
object-
productionItemCount:
integer
The number of portions required to complete the menu item.Example:
1.4 -
productionItemObjNum:
integer
Object number of the production itemExample:
false
Nested Schema : MenuItem_tag
Type:
Show Source
object-
tagName:
string
The name of Tag associated with the menu itemExample:
Tag
Response
Supported Media Types
- application/json
200 Response
A response body for MenuItemDefinition added
Root Schema : MenuItemDefintionResponse
Type:
Show Source
object-
defSequenceNum(required):
integer
Indicates the definition sequence number, which is the number of the definition in the revenue center for this master record.Sequence Number should be with 1-64Example:
1 - menuItemDefinitionId(required): integer
- menuItemDefitinitionHierUnitId(required): integer
- menuItemMasterHierUnitId(required): integer
- menuItemMasterId(required): integer
- menuItemMasterObjNum(required): integer
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