Get Combo Meal Side Group Prices
post
/config/sim/v1/menuItems/combomeals/getmealsidegroupprices
Gets a list of all the prices of a side in a combo meal for the specified organization
Request
Supported Media Types
- application/json
- multipart/form-data
Request body
Root Schema : ComboMealPriceGetRequestBody
Type:
Show Source
object-
comboMealObjNum(required):
integer
Object Number of the Combo MealExample:
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) -
sideNum(required):
integer
Sequence number of the sideExample:
1
Response
Supported Media Types
- application/json
200 Response
A Collection of Combomeal Side Group Prices.
Root Schema : ComboMealPriceGetResponsev1
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 Combo Meal Side Group Price 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:
arrayArray of Combo Meal Side Group Price objects of the organization.
Show Source
-
Array of:
object ComboMealPricev1
Model for Price of side of Combo Meal Object
Nested Schema : ComboMealPricev1
Type:
objectModel for Price of side of Combo Meal Object
Show Source
-
activeOnMenuLevel:
integer
The menu level (main or sub) on which the price is active. This should be a value between 0-8.Setting it to 0 indicates the prices is active on all levelsExample:
0 -
comboMealObjNum:
integer
Object Number of the Combo MealExample:
1 -
hierUnitId:
integer
Unique reference of the hierarchy unitExample:
2 -
hierUnitName:
object hierUnitName
-
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1 -
prepCost:
number
The preparation cost of the combo meal side.Example:
0.67 -
price:
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 items.Example:
1.23 -
sequenceNum:
integer
The sequence number of the priceExample:
1 -
sideNum:
integer
Sequence number of the sideExample:
1
Nested Schema : hierUnitName
Type:
objectExample:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}