Get Menu Item Definition Default Condiments
post
/config/sim/v1/menuItems/menuitemdefinition/getdefaultcondiments
Get all the default condiments for the menu item definition of a hierarchy unit of the specified organization
Request
Supported Media Types
- application/json
- multipart/form-data
Request body
Root Schema : DefaultCondimentGetRequestBody
Type:
Show Source
object-
hierUnitId(required):
integer
Unique reference of the hierarchy unitExample:
1 -
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 -
miDefSequence(required):
integer
Sequence number of the menu item definition to which the condiments are associatedExample:
1 -
miMstrObjNum(required):
integer
Object Number of the menu item master for which the condiments are associated.Example:
1 -
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 valueExample:
where equals(active,1)
Response
Supported Media Types
- application/json
200 Response
A Collection of Menu Item definition default condiments.
Root Schema : defaultcondimentGetResponsev1
Type:
Show Source
object-
count:
integer
Current response record count.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of default condiment objects of the organization.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of default condiment objects of the organization.
Show Source
-
Array of:
object defaultcondimentResponseBodyv1
Model for a Default Condiment Object
Nested Schema : defaultcondimentResponseBodyv1
Type:
objectModel for a Default Condiment Object
Show Source
-
condimentSetName:
object condimentSetName
Condiment Set Name
-
condimentSetObjNum:
integer
Object number of the Condiment Set items that are to be assigned as the default condiments when the associated Menu Item is ordered.Example:
1 -
hierUnitId:
integer
Unique reference of the hierarchy unitExample:
1 -
hierUnitName:
object hierUnitName
Hier Unit Name
-
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1 - menuItemDefaultCondimentId: integer
-
miDefSequence:
integer
Sequence number of the menu item definition to which the condiments are associatedExample:
1 -
miMstrObjNum:
integer
Object Number of the menu item master for which the condiments are associated.Example:
1 -
options:
string
A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the condiment set associated with the menu itemExample:
00000000 -
optionsExt:
object defaultcondiment_optionsExt
An object containing the descriptive options list associated with the default condiments of the menu item definition. This value is excluded by default in GET response.
-
sortGroup:
integer
Sort Group number for the Condiment Set.Example:
1
Nested Schema : condimentSetName
Type:
objectCondiment Set Name
Example:
{
"en-US":"Condiment Set Items",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : hierUnitName
Type:
objectHier Unit Name
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : defaultcondiment_optionsExt
Type:
objectAn object containing the descriptive options list associated with the default condiments of the menu item definition. This value is excluded by default in GET response.
Show Source
-
chargeForEntireSalesCount:
boolean
A Boolean flag indicating to charge for the guests for entire condiment countExample:
false -
displayWhenInDefaultState:
boolean
A Boolean flag indicating to display the condiments in default stateExample:
false