Update Order Channel Parameters
post
/config/sim/v1/setup/updateorderchannelparameters
Updates the Order Channel Parameter. If Order Channel Parameter is not found, it creates a new Order Channel Parameter.
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string(string)
Detail that Identifies that who made the change
Order Channel Parameters Request Body for Create and Update requests.
Root Schema : OrderChannelParametersCURequestBody
Type:
Show Source
object-
active:
boolean
A Boolean flag indicating the order channel is activeExample:
false -
hierUnitId(required):
integer
Unique hierarchy unit referenceExample:
2 -
name:
object name
A string that contains translations into multiple languages
-
objectNum(required):
integer
Unique reference of the Order Channel ParameterExample:
2 -
options:
string
A string value of 0s & 1s of length 32 representing enabled or disabled optionsExample:
00000000000000000000000000000000 -
optionsExt:
object OrderChannelParameters_OptionsExt
-
orderChannelId(required):
integer
Unique reference of the Order ChannelExample:
1 -
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 Channel parameterExample:
00000000000000000000000000000000 -
orderDeviceMaskExt:
object OrderChannelParameters_orderDeviceMaskExt
Nested Schema : name
Type:
objectA string that contains translations into multiple languages
Example:
{
"en-US":"Order Channel",
"de-DE":"Bestellkanal",
"es-MX":"Canal de pedidos"
}Nested Schema : OrderChannelParameters_OptionsExt
Type:
Show Source
object-
enableRoutingOrderByOrderChannel:
boolean
A Boolean flag indicating to control order routing by Order Channel.Example:
false -
printOnCustomerReceiptAndCheck:
boolean
A Boolean flag indicating to print the Order Channel name on customer receipts and guest checks.Example:
false -
printOnOrderPrinter:
boolean
A Boolean flag indicating to print the Order Channel name on order printers.Example:
false
Nested Schema : OrderChannelParameters_orderDeviceMaskExt
Type:
Show Source
object-
mask:
boolean
A Boolean flag indicating to mask the order device for the order channel.Example:
false -
orderDeviceNum:
integer
Object number of the order device that is to be masked with the Order Channel.Example:
1
Response
Supported Media Types
- application/json
200 Response
Order channel parameters response body for Create and Update Requests
Root Schema : OrderChannelParameterCUResponse
Type:
Show Source
object-
hierUnitId(required):
integer
Unique hierarchy unit valueExample:
1 -
objectNum(required):
integer
Unique reference of the Order Channel ParameterExample:
2
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