Get Menu Item Group Details
post
/config/sim/v1/menuItems/MenuItemGroups/getDetails
Request
Supported Media Types
- application/json
- multipart/form-data
A Request body
Root Schema : MenuItemGroupDetailGetRequestBody
Type:
Show Source
object-
include:
string
Example:
overridePricePercent -
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:
seq -
searchCriteria:
string
Search criteria to filter results based on field value. Use filters for menuItemGroupObjNum and hierUnitId to get Menu Item Group Details of a particular Menu Item Group.Example:
where equals(menuItemGroupObjNum,1) and equals(hierUnitId, 2)
Response
Supported Media Types
- application/json
200 Response
A collection of menuItemGroupDetail for the Hierarchy
Root Schema : MenuItemGroupDetailResponse
Type:
Show Source
object-
endObjNum(required):
integer
Ending object number for the selected typeExample:
100 -
exclude(required):
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(required):
integer
Unique hierarchy unit referenceExample:
2 -
hierUnitName(required):
object hierUnitName
A group of string objects representing the name of the hierarchy unit configured languages
-
hierUnitObjNum(required):
integer
Object number of the hierarchy unitExample:
1 - menuItemGroupObjNum(required): integer
-
overridePricePercent(required):
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(required):
integer
Sequence number of the Menu Item Group Detail entryExample:
1 -
startObjNum(required):
integer
Starting object number for the selected typeExample:
1 -
type(required):
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:
objectA group of string objects representing the name of the hierarchy unit configured languages
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}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