Get Condiment Sets
post
/config/sim/v1/menuItems/getcondimentsets
Gets all the condiment sets
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 Condiment Sets
Root Schema : CondimentSetGetResponsev1
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 Condiment Set 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 Condiment Set objects of the organization.
Show Source
-
Array of:
object CondimentSetsv1
Model for Condiment Set Object
Nested Schema : CondimentSetsv1
Type:
objectModel for Condiment Set Object
Show Source
-
condimentItems:
array condimentItems
An array of menu items that are part of the condiment set
-
hierUnitId:
integer
Unique reference of the hierarchy unitExample:
2 -
hierUnitName:
object hierUnitName
Hier Unit Name
-
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1 -
name:
object name
name
-
objectNum:
integer
Object Number of the condiment setExample:
1
Nested Schema : condimentItems
Type:
arrayAn array of menu items that are part of the condiment set
Show Source
Nested Schema : hierUnitName
Type:
objectHier Unit Name
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : name
Type:
objectname
Example:
{
"en-US":"Coffee",
"de-DE":"Kaffee",
"es-MX":"Cafe"
}Nested Schema : CondimentSet_condimentItems
Type:
Show Source
object-
condimentItemNum:
integer
Sequence number of the condiment itemExample:
1 -
defaultCount:
integer
The number of each condiment that comes with the set.Example:
1 -
miDefSequence:
integer
The Menu Item definition sequence number of each record. This coincides with the Menu Item Definition that appears in the POS client when the condiment is triggered.Example:
0 -
miMstrName:
object miMstrName
Menu item master name
-
miMstrObjNum:
integer
Object number of the menu item master assigned to the condiment itemExample:
1 -
options:
string
A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the condiment itemExample:
00000000 -
optionsExt:
object CondimentSetItem_optionsExt
An object containing the descriptive options list associated with the condiment item
-
sortOrder:
integer
The order in which the condiments are displayed on checks, receipts, SLUs, and KDS displays. 0 - Ascending 1 - DescendingExample:
1
Nested Schema : miMstrName
Type:
objectMenu item master name
Example:
{
"en-US":"Condiment Set Items",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : CondimentSetItem_optionsExt
Type:
objectAn object containing the descriptive options list associated with the condiment item
Show Source
-
persistOnPlain:
boolean
A Boolean flag indicating to keep the selected condiment when the menu item is changed to Plain. Deselect to remove it.Example:
true