Get Combo Side Group Items
post
/config/sim/v1/menuItems/combosidegroups/getsidegroupitems
Gets a list of all the items of a combo meal group for the specified organization
Request
Supported Media Types
- application/json
- multipart/form-data
Request body
Root Schema : ComboGroupItemGetRequestBody
Type:
Show Source
object-
comboMealGroupObjNum(required):
integer
Object Number of the Combo Meal groupExample:
1 -
hierUnitId(required):
integer
Unique reference of the hierarchy unitExample:
2 -
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 returnedExample:
en-US, de-DE, es-MX -
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 Combo Side Group Items.
Root Schema : ComboGroupItemGetResponsev1
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 Combo Group Item 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 Combo Group Item objects of the organization.
Show Source
-
Array of:
object ComboGroupItemResourceObjectv1
Model for Combo Group Item Object
Nested Schema : ComboGroupItemResourceObjectv1
Type:
objectModel for Combo Group Item Object
Show Source
-
comboMealGroupObjNum:
integer
Object Number of the Combo Meal groupExample:
1 -
effectivityGroupName:
object effectivityGroupName
Effectivity Group Name
-
effectivityGroupObjNum:
integer
Object number of the effectivity groupExample:
1 -
hierUnitId:
integer
Unique reference of the hierarchy unitExample:
2 -
hierUnitName:
object hierUnitName
Hier Unit Name
-
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1 -
itemObjNum:
integer
Object number of the menu item master associated with the combo group itemExample:
1 -
options:
string
A string value of 0s & 1s of length 48 representing the enablement or disablement of the options associated with the Combo Meal Group Item. If not specified, this will represent the default options associated with the Combo MealGroup ItemExample:
000000000000000000000000000000000000000000000000 -
optionsExt:
object OptionsExt_ComboGroupItem
An object containing the descriptive options list associated with the Combo Meal Group Item
-
prices:
object Price_ComboGroupItem
Model for Combo Group Item Price Object
-
quantity:
integer
The quantity of the itemExample:
1 -
size1ItemObjNum:
integer
Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 1 function key (663).Example:
0 -
size1MenuLevelIndex:
integer
Menu Level index for using the Combo Size 1. Valid range is between 1 and 8.Example:
1 -
size2ItemObjNum:
integer
Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 2 function key (664).Example:
0 -
size2MenuLevelIndex:
integer
Menu Level index for using the Combo Size 2. Valid range is between 1 and 8.Example:
1 -
size3ItemObjNum:
integer
Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 3 function key (665).Example:
0 -
size3MenuLevelIndex:
integer
Menu Level index for using the Combo Size 3. Valid range is between 1 and 8.Example:
1 -
size4ItemObjNum:
integer
Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 4 function key (666).Example:
0 -
size4MenuLevelIndex:
integer
Menu Level index for using the Combo Size 4. Valid range is between 1 and 8.Example:
1
Nested Schema : effectivityGroupName
Type:
objectEffectivity Group Name
Example:
{
"en-US":"Enterprise",
"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 : OptionsExt_ComboGroupItem
Type:
objectAn object containing the descriptive options list associated with the Combo Meal Group Item
Show Source
-
autofill:
boolean
A flag indicating to change the side item quantity to the number of remaining items needed to complete the side requirements when ordering one of the combo meals where more than one remaining item is required.Example:
false -
defaultForOrderType1:
boolean
A flag indicating to make this item the default when Order Type 1 is active.Example:
false -
defaultForOrderType10:
boolean
A flag indicating to make this item the default when Order Type 10 is active.Example:
false -
defaultForOrderType11:
boolean
A flag indicating to make this item the default when Order Type 11 is active.Example:
false -
defaultForOrderType12:
boolean
A flag indicating to make this item the default when Order Type 12 is active.Example:
false -
defaultForOrderType13:
boolean
A flag indicating to make this item the default when Order Type 13 is active.Example:
false -
defaultForOrderType14:
boolean
A flag indicating to make this item the default when Order Type 14 is active.Example:
false -
defaultForOrderType15:
boolean
A flag indicating to make this item the default when Order Type 15 is active.Example:
false -
defaultForOrderType16:
boolean
A flag indicating to make this item the default when Order Type 16 is active.Example:
false -
defaultForOrderType17:
boolean
A flag indicating to make this item the default when Order Type 17 is active.Example:
false -
defaultForOrderType18:
boolean
A flag indicating to make this item the default when Order Type 18 is active.Example:
false -
defaultForOrderType19:
boolean
A flag indicating to make this item the default when Order Type 19 is active.Example:
false -
defaultForOrderType2:
boolean
A flag indicating to make this item the default when Order Type 2 is active.Example:
false -
defaultForOrderType20:
boolean
A flag indicating to make this item the default when Order Type 20 is active.Example:
false -
defaultForOrderType21:
boolean
A flag indicating to make this item the default when Order Type 21 is active.Example:
false -
defaultForOrderType22:
boolean
A flag indicating to make this item the default when Order Type 22 is active.Example:
false -
defaultForOrderType23:
boolean
A flag indicating to make this item the default when Order Type 23 is active.Example:
false -
defaultForOrderType24:
boolean
A flag indicating to make this item the default when Order Type 24 is active.Example:
false -
defaultForOrderType25:
boolean
A flag indicating to make this item the default when Order Type 25 is active.Example:
false -
defaultForOrderType26:
boolean
A flag indicating to make this item the default when Order Type 26 is active.Example:
false -
defaultForOrderType27:
boolean
A flag indicating to make this item the default when Order Type 27 is active.Example:
false -
defaultForOrderType28:
boolean
A flag indicating to make this item the default when Order Type 28 is active.Example:
false -
defaultForOrderType29:
boolean
A flag indicating to make this item the default when Order Type 29 is active.Example:
false -
defaultForOrderType3:
boolean
A flag indicating to make this item the default when Order Type 3 is active.Example:
false -
defaultForOrderType30:
boolean
A flag indicating to make this item the default when Order Type 30 is active.Example:
false -
defaultForOrderType31:
boolean
A flag indicating to make this item the default when Order Type 31 is active.Example:
false -
defaultForOrderType32:
boolean
A flag indicating to make this item the default when Order Type 32 is active.Example:
false -
defaultForOrderType4:
boolean
A flag indicating to make this item the default when Order Type 4 is active.Example:
false -
defaultForOrderType5:
boolean
A flag indicating to make this item the default when Order Type 5 is active.Example:
false -
defaultForOrderType6:
boolean
A flag indicating to make this item the default when Order Type 6 is active.Example:
false -
defaultForOrderType7:
boolean
A flag indicating to make this item the default when Order Type 7 is active.Example:
false -
defaultForOrderType8:
boolean
A flag indicating to make this item the default when Order Type 8 is active.Example:
false -
defaultForOrderType9:
boolean
A flag indicating to make this item the default when Order Type 9 is active.Example:
false -
defaultWhenNoOrderTypeIsSelected:
boolean
Flag indicating to make this item the default for the Combo Group without a declared Order Type.Example:
false -
sendToComboParentsOrderDevices:
boolean
A flag indicating to also send the combo side menu item to the combo meal parent menu item's Order DevicesExample:
false
Nested Schema : Price_ComboGroupItem
Type:
objectModel for Combo Group Item Price Object
Show Source
-
activeOnLevel:
integer
The main menu level on which the price is active. Setting it to 0 indicates the prices is active on all levelsExample:
0 -
effectivityGroupObjNum:
integer
Object number of the effectivity group associated with the priceExample:
1 -
prepcost:
number
The a-la carte price of the combo group side items. You can override the a-la carte price for individual combo group items by setting an a-la carte price for those items.Example:
0.89 -
price:
number
The default side item price to use for the combo group items. You can override the price for individual combo group items by setting a price for those itemsExample:
1.23 -
sequenceNum:
integer
The sequence number of the priceExample:
1