Update Menu Item Groups
post
/config/sim/v1/menuItems/updateMenuItemGroups
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string
Detail that identifies, who made the change.
A Request body for Menu Item Group
Root Schema : MenuItemGroupCUDRequestBody
Type:
Show Source
object-
detail:
array detail
An array of menu items to be included/excluded in the defined group
-
groupType:
integer
Group Type of Menu Item GroupExample:
1 -
hierUnitId(required):
integer
Unique hierarchy unit referenceExample:
2 -
name(required):
object name
A string that contains translations into multiple languages
-
objectNum(required):
integer
Menu item group object numberExample:
1 -
taxClassObjNum:
integer
Specifies the tax class override for the threshold quantityExample:
2 -
thresholdQty:
integer
Specifies the threshold quantity for applying overriden tax classExample:
2
Nested Schema : detail
Type:
arrayAn array of menu items to be included/excluded in the defined group
Show Source
Nested Schema : name
Type:
objectA string that contains translations into multiple languages
Example:
{
"en-US":"Coffee",
"de-DE":"Kaffee",
"es-MX":"Cafe"
}Nested Schema : items
Type:
Show Source
object-
endObjNum:
integer
Ending object number for the selected typeExample:
100 -
exclude:
boolean
Identifies which menu items to exclude for Group Type of 1-Discount. For Group Type 2-Tax Override, this parameter is not activeExample:
false -
overridePricePercent:
number
Indicates the amount off, percent off, or amount substitution based on the discount configuration. This is only active for Group Type 1- Discount when exclude is set to false.Example:
10.5 -
seq:
integer
Sequence number of the Menu Item Group Detail entryExample:
1 -
startObjNum:
integer
Starting object number for the selected typeExample:
1 -
type:
integer
Group type to include or exclude for the Menu Item Group Detail entry **Below is a list of accetable values for this field** | # | Type Description| |---------------|-----------------| | 0 | None | | 1 | All | | 2 | By Major Group | | 3 | By Family Group | | 4 | By Menu Item |Example:
1
Response
Supported Media Types
- application/json
200 Response
A response body for the updated Menu Item Group
Root Schema : MenuItemGroupResponse
Type:
Show Source
object-
hierUnitId(required):
integer
Unique hierarchy unit referenceExample:
2 -
objectNum(required):
integer
Menu item group object numberExample:
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