Get Combo Side Group Item Prices
post
/config/sim/v1/menuitems/combosidegroups/getsidegroupitemprices
Gets a list of all the prices of a combo meal group item for the specified organization
Request
Supported Media Types
- application/json
- multipart/form-data
Request body
Root Schema : ComboGroupItemPriceGetRequestBody
Type:
Show Source
object-
comboMealGroupItemObjNum(required):
integer
Object number of the menu item master associated with the combo group itemExample:
1 -
comboMealGroupObjNum(required):
integer
Object Number of the Combo Meal groupExample:
1 -
hierUnitId(required):
integer
Unique reference of the hierarchy unitExample:
2 -
include:
string
Example:
locations -
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:
objectNum -
searchCriteria:
string
Search criteria to filter results based on field valueExample:
where equals(active,1)
Response
Supported Media Types
- application/json
200 Response
A collection of Combo Meal Group Item Price objects of the organization
Root Schema : ComboGroupItemPriceGetResponse
Type:
objectModel for Combo Group Item Price Object
Show Source
-
activeOnLevel(required):
integer
The main menu level on which the price is active. Setting it to 0 indicates the prices is active on all levelsExample:
0 -
comboMealGroupItemObjNum(required):
integer
Object number of the menu item master associated with the combo group itemExample:
1 -
comboMealGroupObjNum(required):
integer
Object Number of the Combo Meal groupExample:
1 -
effectivityGroupObjNum(required):
integer
Object number of the effectivity group associated with the priceExample:
1 -
hierUnitId(required):
integer
Unique reference of the hierarchy unitExample:
2 -
hierUnitName(required):
object TranslatedString_HierUnitName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the hierarchy unit configured languages
-
hierUnitObjNum(required):
integer
Object number of the hierarchy unitExample:
1 -
prepcost(required):
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(required):
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(required):
integer
The sequence number of the priceExample:
1
Nested Schema : TranslatedString_HierUnitName
Type:
objectAdditional Properties Allowed
Show Source
A 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