Get Menu Item Groups
post
/config/sim/v2/menuItems/getMenuItemGroups
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 menuItemGroups.
Nested Schema : MenuItemGroupv2
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:
integer
Unique hierarchy unit referenceExample:
2 -
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1 -
name:
object name
A string that contains translations into multiple languages
-
objectNum:
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:
{
"1":"Coffee",
"2":"Kaffee",
"3":"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