Get Combo Meals
post
/config/sim/v2/menuItems/getComboMeals
Gets all the Combo Meals configured
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
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 -
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 Combo Meals.
Nested Schema : ComboMealsResourceObjectv2
Type:
Show Source
object-
autoComboMealAlgorithm:
integer
The Auto-Combo AlgorithmExample:
0 -
autoComboMealAlgorithmName:
string
The Auto-Combo Algorithm NameExample:
FirstDealFound -
hierUnitId:
integer
Unique hierarchy unit referenceExample:
2 -
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1 - menuItemMasterObjNum: integer
-
name:
object name
Combo Meal Name
-
objectNum:
integer
Combo Meal object numberExample:
1 -
options:
string
A string value of 0s & 1s of length 16 representing enabled or disabled optionsExample:
0000000000000000 -
optionsExt:
object ComboMeals_OptionsExt
An object containing the descriptive options list associated with the Combo Meal.
-
priority:
integer
The combo meal priority when pressing the Auto Combo function keyExample:
1 -
sides:
array sides
An array of Sides that are associated with the combo meal
Nested Schema : name
Type:
objectCombo Meal Name
Example:
{
"1":"Enterprise",
"2":"Unternehmen",
"3":"Empresa"
}Nested Schema : ComboMeals_OptionsExt
Type:
objectAn object containing the descriptive options list associated with the Combo Meal.
Show Source
-
addSidePricesToMealPrice:
boolean
Flag indicating to add the prices of the combo meal side items to the price of the meal on the workstation client and the printed guest check.Example:
false -
allowAutocomboInPreviousRound:
boolean
Flag indicating to allow this combo meal to consider previous-round items when pressing the Auto Combo function key.Example:
false -
allowResizingOfIndividualSides:
boolean
Flag indicating to allow re-sizing of one selected combo meal side item.Example:
false -
disableAutoComboRecognition:
boolean
Flag indicating to prevent this combo meal from being considered when pressing the Auto Combo function key.Example:
false -
doNotShowWithComboMealChoices:
boolean
Flag indicating to exclude this meal from the list of choices if multiple combo meals can be created from existing menu items on the check.Example:
false -
isDefinedComboMeal:
boolean
Flag indicating if the item is a pre-defined combo meal.Example:
false -
isSizedcomboMeal:
boolean
Flag indicating to allow this combo meal to use Combo Size - Size 1-4 function keys, changing the size of the items ordered.Example:
false -
keepLastItemSelectedAfterOrdering:
boolean
Flag indicating if you expect modifications to the combo meal after adding the last side, keeping the combo meal selected.Example:
false -
noBulkOrderWithQuantityOrder:
boolean
Flag indicating to prompt for each non-default side item per mealExample:
false -
noChargeForCondiments:
boolean
Flag indicating when added condiments (to the meal) are non-priced.Example:
false -
onlyPrintPricedSidesToGuestCheck:
boolean
Flag indicating to prevent the combo meal side items from printing on the guest check if they have no price, or if their price is added to the price of the meal.Example:
false
Nested Schema : sides
Type:
arrayAn array of Sides that are associated with the combo meal
Show Source
Nested Schema : ComboMeals_Sidesv2
Type:
Show Source
object-
comboGrpObjNum:
integer
Object number of the Side Item Group that contains the side items for the combo meal.Example:
1 -
defaultMenuLevelIndex:
integer
Index of the default menu level for this combo group.Example:
1 - menuLevel: string
- menuLevelExt: object ComboMeals_MenuLevelExt
-
prices:
array prices
-
sideCount:
integer
Number of Combo Meal Group items required for the combo meal side.Example:
1 -
sideNum:
integer
Sequence number of the side.Example:
1
Nested Schema : ComboMeals_MenuLevelExt
Type:
objectAn object containing the descriptive list of menu levels associated with the Combo Meal
Show Source
Nested Schema : prices
Type:
Show Source
array-
Array of:
object ComboMeals_Prices
An array of prices associated with the combo meal
Nested Schema : ComboMeals_Prices
Type:
objectAn array of prices associated with the combo meal
Show Source
-
activeOnMenuLevel:
integer
The menu level (main or sub) on which the price is active.Example:
0 -
prepCost:
number
The ?? la carte price of the combo group side items.Example:
0.89 -
price:
number
The default side item price to use for the combo group items.Example:
1.23 -
sequenceNum:
integer
The sequence number of the priceExample:
1