Get Order Channel Parameters
post
/config/sim/v2/setup/getOrderChannelParameters
Gets all the Order Channel Parameters
Request
Supported Media Types
- application/json
- multipart/form-data
The input Body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
If specified, limits the data returned to these fields.Example:
hierUnitId, objectNum, name -
includeAll:
string
If this value is specified, the include parameter is ignored.
Value Description basic Forces the response to include all fields except option string details detailed Forces the response to include all fields including option string details Example:detailed -
langIds:
string
If specified, limits translated strings returnedExample:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
hierUnitId:asc -
searchCriteria:
string
If specified, returns records that match the criteria.Example:
where equals(hierUnitId, 7)
Response
Supported Media Types
- application/json
200 Response
A Collection of Order Channel Parameters.
Root Schema : schema
Type:
Show Source
object-
count:
integer
Current response record count.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Order Channel Parameter objects of the organization.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of Order Channel Parameter objects of the organization.
Show Source
Nested Schema : OrderChannelParametersv2
Type:
Show Source
object-
active:
boolean
A Boolean flag indicating the order channel is activeExample:
false -
guestCheckHeaderObjNum:
integer
Object Number of check header descriptor. It is available from Simphony version 19.8 and above.Example:
2 -
guestCheckTrailerObjNum:
integer
Object Number of check trailer descriptor. It is available from Simphony version 19.8 and above.Example:
2 -
hierUnitId:
integer
Unique hierarchy unit referenceExample:
2 -
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1 -
objectNum:
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:
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
-
receiptHeaderObjNum:
integer
Object Number of receipt header descriptor. It is available from Simphony version 19.8 and above.Example:
2 -
slaTime:
integer
Service Level Agreement Time. Allowed values are from 0-999. It is available from Simphony version 19.8 and above.Example:
10
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