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 prices of a side in a Combo Meal of the organization
Root Schema : ComboMealPrice
Type:
objectModel for Price of side of Combo Meal Object
Show Source
-
activeOnMenuLevel(required):
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(required):
integer
Object Number of the Combo MealExample:
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 preparation cost of the combo meal side.Example:
0.67 -
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 items.Example:
1.23 -
sequenceNum(required):
integer
The sequence number of the priceExample:
1 -
sideNum(required):
integer
Sequence number of the sideExample:
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