Get Menu Item Definition Default Condiments
post
/config/sim/v2/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 : schema
Type:
Show Source
object
-
hierUnitId(required):
integer
Unique reference of the hierarchy unitExample:
1
-
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
-
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:
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 Definition Default Condiments.
Nested Schema : MenuItemDefinitionDefaultCondimentv2
Type:
object
Model for a Default Condiment Object
Show Source
-
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
-
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 : defaultcondiment_optionsExt
Type:
object
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.
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