Get Combo Meals
post
/config/sim/v1/menuitems/getcombomeals
Gets all the Combo Meals configured
Request
Supported Media Types
- application/json
- multipart/form-data
A request body
Root Schema : ComboMealsGetRequestBody
Type:
Show Source
object-
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 -
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 Combo Meals of the organization
Root Schema : ComboMealsResourceObject
Type:
Show Source
object-
autoComboMealAlgorithm(required):
integer
The Auto-Combo AlgorithmExample:
0 -
autoComboMealAlgorithmName(required):
object TranslatedString_autoComboMealAlgorithmName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of auto combo meal algorithm
-
hierUnitId(required):
integer
Unique hierarchy unit referenceExample:
2 -
hierUnitName(required):
object TranslatedString_HierUnitName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the hierarchy unit configured languages
-
hierUnitObjNum(required):
integer
Object number of the hierarchy unitExample:
1 - menuItemMasterName(required): object TranslatedString_MenuItemMasterName
- menuItemMasterObjNum(required): integer
-
name(required):
object TranslatedString
Additional Properties Allowed: additionalPropertiesA string that contains translations into multiple languages
-
objectNum(required):
integer
Combo Meal object numberExample:
1 -
options(required):
string
A string value of 0s & 1s of length 16 representing enabled or disabled optionsExample:
0000000000000000 -
optionsExt(required):
object ComboMeals_OptionsExt
An object containing the descriptive options list associated with the Combo Meal.
-
priority(required):
integer
The combo meal priority when pressing the Auto Combo function keyExample:
1 -
sides(required):
array sides
An array of Sides that are associated with the combo meal
Nested Schema : TranslatedString_autoComboMealAlgorithmName
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of auto combo meal algorithm
Example:
{
"en-US":"FirstDealFound",
"de-DE":"Unternehmen",
"es-MX":"Primera oferta encontrada"
}Nested Schema : TranslatedString_HierUnitName
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the hierarchy unit configured languages
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : TranslatedString_MenuItemMasterName
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the menu item master assigned to the condiment item in configured languages
Example:
{
"en-US":"Condiment Set Items",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : TranslatedString
Type:
objectAdditional Properties Allowed
Show Source
A string that contains translations into multiple languages
Example:
{
"en-US":"Coffee",
"de-DE":"Kaffee",
"es-MX":"Cafe"
}Nested Schema : ComboMeals_OptionsExt
Type:
objectAn object containing the descriptive options list associated with the Combo Meal.
Show Source
-
addSidePricesToMealPrice(required):
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(required):
boolean
Flag indicating to allow this combo meal to consider previous-round items when pressing the Auto Combo function key.Example:
false -
allowResizingOfIndividualSides(required):
boolean
Flag indicating to allow re-sizing of one selected combo meal side item.Example:
false -
disableAutoComboRecognition(required):
boolean
Flag indicating to prevent this combo meal from being considered when pressing the Auto Combo function key.Example:
false -
doNotShowWithComboMealChoices(required):
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(required):
boolean
Flag indicating if the item is a pre-defined combo meal.Example:
false -
isSizedcomboMeal(required):
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(required):
boolean
Flag indicating if you expect modifications to the combo meal after adding the last side, keeping the combo meal selected.Example:
false -
noBulkOrderWithQuantityOrder(required):
boolean
Flag indicating to prompt for each non-default side item per mealExample:
false -
noChargeForCondiments(required):
boolean
Flag indicating when added condiments (to the meal) are non-priced.Example:
false -
onlyPrintPricedSidesToGuestCheck(required):
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_Sides
Type:
Show Source
object-
comboGroupName(required):
string
name of the combo meal group
-
comboGrpObjNum(required):
integer
Object number of the Side Item Group that contains the side items for the combo meal.Example:
1 -
defaultMenuLevelIndex(required):
integer
Index of the default menu level for this combo group.Example:
1 - menuLevel(required): string
- menuLevelExt(required): object ComboMeals_MenuLevelExt
-
prices(required):
array prices
-
sideCount(required):
integer
Number of Combo Meal Group items required for the combo meal side.Example:
1 -
sideNum(required):
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
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(required):
integer
Error code of the problemExample:
55223 -
status(required):
integer
HTTP status code.Example:
400 -
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(required):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html
404 Response
404 Requested resource not found