Get Menu Item Definitions
post
/config/sim/v1/menuItems/getMenuItemDefinitions
Gets all the Menu Item Definitions configured and hierarchy unit
Request
Supported Media Types
- application/json
- multipart/form-data
Request body
Root Schema : MenuItemDefinitionGetRequestBody
Type:
Show Source
object-
hierUnitId:
integer
Unique Hierarchy unit reference. This is an optional field. Alternatively, searchCriteria can be used to get results for a particular hierUnitId.Example:
1012 -
include:
string
Example:
locations -
includeAll:
string
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 -
languages:
string
If specified, limits translated strings returned.Example:
en-US, de-DE, es-MX -
limit:
integer
Number of results returned in this page. Not required if paging parameters are not supported.Example:
10 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
2 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum -
searchCriteria:
string
Search criteria to filter results based on field value.Example:
where equals(hierUnitId,1012)
Response
Supported Media Types
- application/json
200 Response
A collection of menuItemDefintions for the Hierarchy
Root Schema : MenuItemDefinitionGetResponse
Type:
Show Source
object-
components(required):
array components
An array of components associated with the menu item
-
consumerAdvisoryDesc(required):
string
The consumer advisory description of the menu itemExample:
Menu Item 1 -
consumerItemDescription(required):
object TranslatedString
Additional Properties Allowed: additionalPropertiesA string that contains translations into multiple languages
-
consumerItemName(required):
object TranslatedString
Additional Properties Allowed: additionalPropertiesA string that contains translations into multiple languages
-
customMenuLevels(required):
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(required):
array dataExtensions
An array of data extensions for the menu item
-
defaultCondiments(required):
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(required):
object TranslatedString
Additional Properties Allowed: additionalPropertiesA string that contains translations into multiple languages
-
guestCount(required):
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(required):
array images
An array of images associated with the menu item
-
kdsPrepTime(required):
integer
The number of minutes necessary to prepare this itemExample:
10.3 -
longDescriptor(required):
object TranslatedString
Additional Properties Allowed: additionalPropertiesA string that contains translations into multiple languages
-
mainLevel(required):
string
A string value of 0s & 1s of length 8 representing main levels on which the definition is active.Example:
11001111 - menuItemClassObjNum(required): integer
- menuItemDefinitionId(required): integer
- menuItemMasterId(required): integer
- menuItemMasterObjNum(required): integer
-
nluGroupObjNum(required):
integer
Object number of the NLU Group associated with this menu itemExample:
1 -
nluNum(required):
Unique NLU number for this menu item (up to 12 digits).Example:
1 -
nutrients(required):
array nutrients
An array of nutrients of the menu item
-
overrideAllergenClassObjNum(required):
integer
Object number of the Allergen Class for the menu item definition to override its menu item class settingExample:
1 -
overridePrintClassObjNum(required):
integer
Object number of the Print ClassExample:
1 -
prefixLevelOverride(required):
integer
Select to allow the condiment prefix to override the price level of the item it modifies.Example:
1 -
productionItems(required):
array productionItems
An array of production items associated with the menu item
-
quantity(required):
integer
Quantity of a Menu ItemExample:
1 -
secondName(required):
object TranslatedString
Additional Properties Allowed: additionalPropertiesA string that contains translations into multiple languages
-
slu1ObjNum(required):
integer
Object number of SLU 1 to which the Menu Item Definition belongsExample:
200 -
slu2ObjNum(required):
integer
Object number of SLU 2 to which the Menu Item Definition belongsExample:
201 -
slu3ObjNum(required):
integer
Object number of SLU 3 to which the Menu Item Definition belongsExample:
202 -
slu4ObjNum(required):
integer
Object number of SLU 4 to which the Menu Item Definition belongsExample:
203 -
slu5ObjNum(required):
integer
Object number of SLU 5 to which the Menu Item Definition belongsExample:
204 -
slu6ObjNum(required):
integer
Object number of SLU 6 to which the Menu Item Definition belongsExample:
205 -
slu7ObjNum(required):
integer
Object number of SLU 7 to which the Menu Item Definition belongsExample:
206 -
slu8ObjNum(required):
integer
Object number of SLU 8 to which the Menu Item Definition belongsExample:
207 -
sluSortPriority(required):
integer
Use this field when Page Design Layout optionExample:
0 -
subLevel(required):
string
A string value of 0s & 1s of length 8 representing Sub Levels on which the definition is activeExample:
11001111 -
surcharge(required):
integer
Surcharge for the menu itemExample:
1 -
tags(required):
array tags
An array of tags associated with the menu item
-
tareWeight(required):
integer
Weight of the empty package for an item sold by weightExample:
1.23 -
thirdName(required):
object TranslatedString
Additional Properties Allowed: additionalPropertiesA string that contains translations into multiple languages
Nested Schema : components
Type:
arrayAn array of components associated with the menu item
Show Source
Nested Schema : TranslatedString
Type:
objectAdditional Properties Allowed
Show Source
A string that contains translations into multiple languages
Example:
{
"en-US":"Coffee",
"de-DE":"Kaffee",
"es-MX":"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
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
404 Response
404 Requested resource not found