Add Condiment Sets
post
/config/sim/v1/menuItems/condimentsets
Add the condiment set object to a specified hierarchy unit of specified organization.
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string
Detail that identifies, who made the change.
-
Simphony-OrgShortName: string
The ShortName of the organization
Request body
Root Schema : CondimentSet
Type:
object
Model for Condiment Set Object
Show Source
-
condimentItems(optional):
array condimentItems
An array of menu items that are part of the condiment set
-
hierUnitId:
integer
Unique reference of the hierarchy unitExample:
2
-
hierUnitName(optional):
object TranslatedString_HierUnitName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the hierarchy unit configured languages
-
hierUnitObjNum(optional):
integer
Object number of the hierarchy unitExample:
1
-
name:
object TranslatedString
Additional Properties Allowed: additionalPropertiesA string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`
-
objectNum:
integer
Object Number of the condiment setExample:
1
Nested Schema : condimentItems
Type:
array
An array of menu items that are part of the condiment set
Show Source
Nested Schema : TranslatedString_HierUnitName
Type:
object
Additional Properties Allowed
Show Source
A group of string objects representing the name of the hierarchy unit configured languages
Example:
{
"en-US":"Enterprise",
"es-SS":"Empresa",
"lt=LT":"??mon??"
}
Nested Schema : TranslatedString
Type:
object
Additional Properties Allowed
Show Source
A string that contains translations into multiple languages
**Example**
`{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`
Example:
{
"en-US":"Coffee",
"de-DE":"Kaffee",
"ar-AR":"????????"
}
Nested Schema : CondimentSet_condimentItems
Type:
Show Source
object
-
condimentItemNum(optional):
integer
Sequence number of the condiment itemExample:
1
-
defaultCount(optional):
integer
The number of each condiment that comes with the set.Example:
1
-
miDefSequence(optional):
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(optional):
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(optional):
integer
Object number of the menu item master assigned to the condiment itemExample:
1
-
options(optional):
string
A string value of 0???s & 1???s representing the enablement or disablement of the options associated with the condiment itemExample:
000000
-
optionsExt(optional):
object CondimentSetItem_optionsExt
An object containing the descriptive options list associated with the condiment item
-
sortOrder(optional):
integer
The order in which the condiments are displayed on checks, receipts, SLUs, and KDS displays. 0 ??? Ascending 1 ??? DescendingExample:
1
Nested Schema : TranslatedString_MenuItemMasterName
Type:
object
Additional 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",
"es-SS":"Empresa",
"lt=LT":"??mon??"
}
Nested Schema : CondimentSetItem_optionsExt
Type:
object
An object containing the descriptive options list associated with the condiment item
Show Source
-
persistOnPlain(optional):
boolean
A Boolean flag indicating to keep the selected condiment when the menu item is changed to Plain. Deselect to remove it.Example:
true
Response
Supported Media Types
- application/json
200 Response
Condiment Set Response
Root Schema : CondimentSetResponse
Type:
Show Source
object
-
hierUnitId:
integer
Unique reference of the hierarchy unitExample:
2
-
objectNum:
integer
Object Number of the condiment setExample:
1
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
object
Response body when the request returns an error.
Show Source
-
detail(optional):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid
-
errorDetails(optional):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist
-
o:errorCode(optional):
integer
Error code of the problemExample:
55223
-
status(optional):
integer
HTTP status code.Example:
400
-
title(optional):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR
-
type(optional):
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