Get Combo Side Groups
post
/config/sim/v1/menuItems/getcombosidegroups
Gets all the Combo Meals Groups configured for the specified organization.
Request
Supported Media Types
- application/json
- multipart/form-data
The input Body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
Objects included in the response.Example:
hierUnitId -
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 the translated strings returned.Example:
en-US, es-ES, es-MX -
limit:
integer
If using paging, number of results returned in this page.Example:
0 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supported.Example:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum:asc -
searchCriteria:
string
Search criteria to filter results based on field value.Example:
where equals(objectNum,1)
Response
Supported Media Types
- application/json
200 Response
A Collection of Combo Side Groups.
Root Schema : ComboMealGroupv1GetResponse
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 Meal Group 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 Meal Group objects of the organization.
Show Source
-
Array of:
object ComboMealGroupResourceObjectv1
Nested Schema : ComboMealGroupResourceObjectv1
Type:
Show Source
object-
alternateGroups:
array alternateGroups
An array of Alternate Groups, if any, for this Combo Meal Group.
-
hierUnitId:
integer
Unique hierarchy unit referenceExample:
2 -
hierUnitName:
object hierUnitName
Hier Unit Name.
-
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1 -
items:
array items
An array of items that are associated with the combo meal group
-
name:
object name
Name
-
objectNum:
integer
Combo Meal object numberExample:
1 -
options:
string
A string value of 0s & 1s of length 8 representing enabled or disabled optionsExample:
00000000 -
optionsExt:
object ComboMealGroup_OptionsExt
An object containing the descriptive options list associated with the Combo Meal Group.
Nested Schema : alternateGroups
Type:
arrayAn array of Alternate Groups, if any, for this Combo Meal Group.
Show Source
-
Array of:
object ComboMealGroup_AlternateGroup
Nested Schema : hierUnitName
Type:
objectHier Unit Name.
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : items
Type:
arrayAn array of items that are associated with the combo meal group
Show Source
-
Array of:
object ComboMealGroup_Items
Model for Combo Meal Group_Item Object
Nested Schema : name
Type:
objectName
Example:
{
"en-US":"Combo Group 1",
"es-MX":"Combo Grupo 1"
}Nested Schema : ComboMealGroup_OptionsExt
Type:
objectAn object containing the descriptive options list associated with the Combo Meal Group.
Show Source
-
allowDiscounts:
boolean
Flag indicating to apply discounts to items in this group.Example:
false -
substitutionGroupItemsUseThisSidesPrice:
boolean
When substituting a Combo Meal side with a menu item from another group, Set this attribute to True to set the item's price to the side's combo meal price specified in the sides Combo Group Price.Example:
false
Nested Schema : ComboMealGroup_AlternateGroup
Type:
Show Source
object-
alternateGroupObjNum:
integer
Object number of the alternate combo meal group.Example:
2 -
sequenceNum:
integer
Sequence number of the alternate combo meal group.Example:
1
Nested Schema : ComboMealGroup_Items
Type:
objectModel for Combo Meal Group_Item Object
Show Source
-
effectivityGroupName:
object effectivityGroupName
Effectivity Group Name
-
effectivityGroupObjNum:
integer
Object number of the effectivity groupExample:
1 -
itemObjNum:
integer
Object number of the Menu Item Master that contains the side items for the combo mealExample:
1 -
options:
string
A string value of 0s & 1s of length 16 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:
0000000000000000 -
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
Number of Combo Meal Group items required for the combo meal sideExample:
1 -
size1ComboGroupObjNum:
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.Example:
0 -
size2ComboGroupObjNum:
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.Example:
0 -
size3ComboGroupObjNum:
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.Example:
0 -
size4ComboGroupObjNum:
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.Example:
0
Nested Schema : effectivityGroupName
Type:
objectEffectivity Group 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 ?? la carte price of the combo group side items. You can override the ?? la carte price for individual combo group items by setting an ?? 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