Add Combo Side Groups
post
/config/sim/v1/menuItems/combosidegroups
Add the Combo Meal group object to a specified hierarchy unit of specified organization.
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string
Detail that identifies, who made the change.
Root Schema : ComboMealGroupCUDRequestBody
Type:
Show Source
object-
alternateGroups:
array alternateGroups
An array of Alternate Groups, if any, for this Combo Meal Group.
-
hierUnitId(required):
integer
Unique hierarchy unit referenceExample:
2 -
items:
array items
An array of items that are associated with the combo meal group
-
name(required):
object TranslatedString_ComboGroupName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the Combo Group in configured languages
-
objectNum(required):
integer
Combo Meal object numberExample:
1 -
options:
string
A string value of 0s & 1s of length 8 representing enabled or disabled optionsExample:
00000000
Nested Schema : alternateGroups
Type:
arrayAn array of Alternate Groups, if any, for this Combo Meal Group.
Show Source
Nested Schema : items
Type:
arrayAn array of items that are associated with the combo meal group
Show Source
-
Array of:
object ComboMealGroup_Items_CUD
Model for Combo Meal Group_Item Object
Nested Schema : TranslatedString_ComboGroupName
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the Combo Group in configured languages
Example:
{
"en-US":"Combo Group 1",
"es-MX":"Combo Grupo 1"
}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_CUD
Type:
objectModel for Combo Meal Group_Item Object
Show Source
-
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 -
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 -
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.Example:
0 -
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.Example:
0 -
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.Example:
0 -
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.Example:
0
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
Response
Supported Media Types
- application/json
200 Response
A response body for Combo Meal Group
Root Schema : ComboMealsGroupResponse
Type:
Show Source
object-
hierUnitId(required):
integer
Unique hierarchy unit valueExample:
1 -
objectNum(required):
integer
Unique reference of the Combo MealExample:
2
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