Add Order Type Parameters
post
/config/sim/v1/setup/orderTypeParameters
Add the Order Type Parameter object to a specified hierarchy unit .
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string(string)
Detail that Identifies that who made the change
CUD Request Body
Root Schema : OrderTypeParameterCUDRequestBody
Type:
Show Source
object-
active:
boolean
A Boolean flag indicating the order type is activeExample:
false -
hierUnitId(required):
integer
Unique hierarchy unit referenceExample:
2 -
kdsHighlightSchemeName:
object TranslatedString
Additional Properties Allowed: additionalPropertiesA string that contains translations into multiple languages
-
kdsHighlightSchemeObjNum:
integer
Object number of the KDS Highlight Scheme to use for the order type parameterExample:
0 -
objectNum(required):
integer
Unique reference of the Order TypeExample:
1 -
options:
string
A string value of 0s & 1s of length 16 representing enabled or disabled optionsExample:
0000000000000000 -
orderDeviceMask:
string
A string value of 0s & 1s of length 32 representing the enablement or disablement of the order device mask associated with the Order Type parameterExample:
00000000000000000000000000000000 -
slaTime:
integer
Service Level Agreement TimeExample:
0 -
taxMask:
string
A string value of 0s & 1s of length 64 representing the enablement or disablement of the tax mask associated with the Order Type parameterExample:
1000000000000000000000000000000000000000000000000000000000000000 -
tipAmount1:
number
Guest Pay - Suggested Tip Amount 1. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is true.Example:
21.22 -
tipAmount2:
number
Guest Pay - Suggested Tip Amount 2. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is true.Example:
4.87 -
tipAmount3:
number
Guest Pay - Suggested Tip Amount 3. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is true.Example:
51.11 -
tipPercent1:
integer
Guest Pay - Suggested Tip Percentage 1. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is false.Example:
10 -
tipPercent2:
integer
Guest Pay - Suggested Tip Percentage 2. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is false.Example:
15 -
tipPercent3:
integer
Guest Pay - Suggested Tip Percentage 3. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is false.Example:
5
Nested Schema : TranslatedString
Type:
objectAdditional Properties Allowed
Show Source
A string that contains translations into multiple languages
Example:
{
"en-US":"Coffee",
"de-DE":"Kaffee",
"es-MX":"Cafe"
}Response
Supported Media Types
- application/json
200 Response
Response object
Root Schema : OrderTypeParameterResponse
Type:
Show Source
object-
hierUnitId(required):
integer
Unique hierarchy unit valueExample:
1 -
objectNum(required):
integer
Unique reference of the Order Type ParameterExample:
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