Get Order Types Parameters
post
/config/sim/v1/setup/getOrderTypeParameters
Gets all the Order Type 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
Objects included in the response.Example:
hierUnitId -
includeAll:
string
This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except
Ext values. If 'detailed' is specified, The response contains all the properties of the object. Example:detailed -
languages:
string
If specified, limits the translated strings returned.Example:
en-US, es-ES, es-MX -
limit:
integer
If using paging, number of results returned in this page.Example:
10 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supported.Example:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum:asc -
searchCriteria:
string
Search criteria to filter results based on field value.Example:
where equals(objectNum,1)
Response
Supported Media Types
- application/json
200 Response
A collection of Order Type Parameters.
Root Schema : OrderTypeParametersGetResponse
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 language 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 : OrderTypeParametersResourceObject
Type:
Show Source
object-
active:
boolean
A Boolean flag indicating the order type is activeExample:
false -
hierUnitId:
integer
Unique hierarchy unit referenceExample:
2 -
hierUnitName:
object hierUnitName
Hier Unit Name
-
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1 -
kdsHighlightSchemeName:
object kdsHighlightSchemeName
KDS Highlight Scheme Name
-
kdsHighlightSchemeObjNum:
integer
Object number of the KDS Highlight Scheme to use for the order type parameterExample:
0 -
name:
object name
Name
-
objectNum:
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 -
optionsExt:
object OrderTypeParameters_OptionsExt
-
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 -
orderDeviceMaskExt:
object OrderTypeParameters_orderDeviceMaskExt
-
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 -
taxMaskExt:
object OrderTypeParameters_taxMaskExt
-
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 : hierUnitName
Type:
objectHier Unit Name
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : kdsHighlightSchemeName
Type:
objectKDS Highlight Scheme Name
Example:
{
"en-US":"Coffee",
"de-DE":"Kaffee",
"es-MX":"Cafe"
}Nested Schema : name
Type:
objectName
Example:
{
"en-US":"Coffee",
"de-DE":"Kaffee",
"es-MX":"Cafe"
}Nested Schema : OrderTypeParameters_OptionsExt
Type:
Show Source
object-
alwaysUseKDSPrepTime:
boolean
A Boolean flag indicating to suppress Menu Item Class | Options | 83 and 84.Example:
false -
dontPostTransToTipReportTotals:
boolean
A Boolean flag indicating to prevent posting sales for this Order Type to the Gross Receipts and Charged Receipts totals on Tip Reports.Example:
false -
enableGuesTCountByMenuItemInTransService:
boolean
A Boolean flag indicating to enable transaction services to count guests like POS operations.Example:
false -
enableRoutingOrderByOrderType:
boolean
A Boolean flag indicating to control order routing by Order Type.Example:
false -
forgiveInclTax:
boolean
A Boolean flag indicating to forgive the Inclusive Tax for eligible Menu Items, Australian GST only.Example:
false -
hideCustomTipButton:
boolean
Guest Pay - disable the ability to enter custom tipsExample:
false -
hideNoTipButton:
boolean
Guest Pay - disable the "No Tip" buttonExample:
false -
kdsAllowItemPrintOnAllPrepDone:
boolean
A Boolean flag indicating to allow printing a runner chit for each item in the all prep done state.Example:
false -
performAutoComboRecognition:
boolean
A Boolean flag indicating to automatically perform Auto-Combo Recognition when a workstation operator changes the workstation to this Order Type.Example:
false -
printOnCustomerReceiptAndCheck:
boolean
A Boolean flag indicating to print the Order Type name on customer receipts and guest checks.Example:
false -
printOnOrderPrinter:
boolean
A Boolean flag indicating to print the Order Type name on order printers.Example:
false -
supressDiningCourse:
boolean
A Boolean flag indicating to ignore Dining Courses for orders using this Order Type.Example:
false -
transCancelDefault:
boolean
A Boolean flag indicating to apply this Order Type to transactions that are canceled before declaring an Order Type.Example:
false -
useAmountForTip:
boolean
Guest Pay - Use amounts instead of percentages for preconfigured tipping optionsExample:
false -
useDynamicTip:
boolean
Guest Pay - Use use dynamic tippingExample:
false
Nested Schema : OrderTypeParameters_orderDeviceMaskExt
Type:
Show Source
object-
mask:
boolean
A Boolean flag indicating to mask the order device for the order type.Example:
false -
orderDeviceNum:
integer
Object number of the order device that is to be masked with the Order Type.Example:
1
Nested Schema : OrderTypeParameters_taxMaskExt
Type:
Show Source
object-
mask:
boolean
A Boolean flag indicating to mask the tax for the order type.Example:
false -
taxObjNum:
integer
Object number of the tax that is to be masked with the Order Type.Example:
1