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
Get Request Body
Root Schema : OrderTypeParameterGetRequestBody
Type:
Show Source
object-
include:
string
Example:
locations -
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 translated strings returned.Example:
en-US, de-DE, es-MX -
limit:
integer
Number of results returned in this page. Not required if paging parameters are not supported.Example:
10 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
2 -
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 valueExample:
where equals(active,1)
Response
Supported Media Types
- application/json
200 Response
A collection of Order Type Parameter objects of the organization
Root Schema : OrderTypeParametersGetResponse
Type:
Show Source
object-
count(required):
integer
Current response recount count.Example:
9 -
hasMore(required):
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items(required):
array items
Array of language objects of the organization.
-
limit(required):
integer
Server page sizeExample:
10 -
offset(required):
integer
Starting resource record indexExample:
0 -
totalResults(required):
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(required):
integer
Unique hierarchy unit referenceExample:
2 -
hierUnitName:
object TranslatedString_HierUnitName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the hierarchy unit configured languages
-
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1 -
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 -
name(required):
object TranslatedString
Additional Properties Allowed: additionalPropertiesA string that contains translations into multiple languages
-
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 -
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
Nested Schema : TranslatedString_HierUnitName
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the hierarchy unit configured languages
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}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"
}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
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
404 Response
404 Requested resource not found