Get Menu Item Group Details
post
/config/sim/v1/menuItems/MenuItemGroups/getDetails
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
Objects included in the response.Example:
hierUnitId
-
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 the translated strings returned.Example:
en-US, es-ES, es-MX
-
limit:
integer
If using paging, number of results returned in this page.Example:
0
-
offset:
integer
Starting resource record index. Not required if paging parameters are not supported.Example:
0
-
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum:asc
-
searchCriteria:
string
Search criteria to filter results based on field value.Example:
where equals(objectNum,1)
Response
Supported Media Types
- application/json
200 Response
A Collection of Menu Item Group Details.
Root Schema : MenuItemGroupDetailGetResponsev1
Type:
Show Source
object
-
count:
integer
Current response record count.Example:
9
-
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true
-
items:
array items
Array of Menu Item Group Detail objects of the organization.
-
limit:
integer
Server page sizeExample:
10
-
offset:
integer
Starting resource record indexExample:
0
-
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
array
Array of Menu Item Group Detail objects of the organization.
Show Source
Nested Schema : MenuItemGroupDetailResponsev1
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
-
hierUnitId:
integer
Unique hierarchy unit referenceExample:
2
-
hierUnitName:
object hierUnitName
A group of string objects representing the name of the hierarchy unit configured languages
-
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1
- menuItemGroupObjNum: integer
-
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 entry. Value must lie between 1 and 32767.Example:
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
Nested Schema : hierUnitName
Type:
object
A group of string objects representing the name of the hierarchy unit configured languages
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}