Get Condiment Set Items
post
/config/sim/v1/menuItems/condimentsets/getItems
Gets all the condiment items for a condiment set for the specified organization
Request
Supported Media Types
- application/json
- multipart/form-data
Request body
Root Schema : CondimentSetItemsGetRequestBody
Type:
Show Source
object-
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 -
objectNum(required):
integer
Unique reference of the condiment setExample:
1 -
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 Condiment items for a Condiment Set for the specified organization
Root Schema : CondimentSetItemGetResponse
Type:
objectModel for Condiment Set Item Object
Show Source
-
condimentItemNum(required):
integer
Sequence number of the condiment itemExample:
1 -
defaultCount(required):
integer
The number of each condiment that comes with the set.Example:
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 -
miDefSequence(required):
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(required):
object TranslatedString_MenuItemMasterName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the menu item master assigned to the condiment item in configured languages
-
miMstrObjNum(required):
integer
Object number of the menu item master assigned to the condiment itemExample:
1 -
objectNum(required):
integer
Object Number of the condiment setExample:
1 -
options(required):
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(required):
object CondimentSetItem_optionsExt
An object containing the descriptive options list associated with the condiment item
-
sortOrder(required):
integer
The order in which the condiments are displayed on checks, receipts, SLUs, and KDS displays. 0 indicates Ascending and 1 indicates Descending.Example:
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"
}Nested Schema : TranslatedString_MenuItemMasterName
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the menu item master assigned to the condiment item in configured languages
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
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