Update Condiment Sets
post
/config/sim/v2/menuItems/updateCondimentSets
Updates the Condiment Set. If Condiment Set is not found , it creates a new condiment set .
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string
Detail that identifies, who made the change.
Request body
Root Schema : CondimentSetCUDRequestBodyv2
Type:
objectCUD Request Body for Condiment Set Object
Show Source
-
condimentItems:
array condimentItems
An array of menu items that are part of the condiment set
-
hierUnitId(required):
integer
Unique reference of the hierarchy unitExample:
2 -
name(required):
object name
Condiment Set Name
-
objectNum(required):
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
-
Array of:
object CondimentSet_condimentItemsCUD
Nested Schema : name
Type:
objectCondiment Set Name
Example:
{
"1":"Enterprise",
"2":"Unternehmen",
"3":"Empresa"
}Nested Schema : CondimentSet_condimentItemsCUD
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 -
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 -
sortOrder:
integer
The order in which the condiments are displayed on checks, receipts, SLUs, and KDS displays. 0 ??? Ascending 1 ??? DescendingExample:
1
Response
Supported Media Types
- application/json
200 Response
Condiment Set Response
Root Schema : CondimentSetResponse
Type:
Show Source
object-
hierUnitId(required):
integer
Unique reference of the hierarchy unitExample:
2 -
objectNum(required):
integer
Object Number of the condiment setExample:
1
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