Get Order Devices
post
/config/sim/v1/devices/getOrderDevices
Gets all the Order Devices configured
Request
Supported Media Types
- application/json
- multipart/form-data
A request body
Root Schema : OrderDeviceGetRequestBody
Type:
objectThe input Body model that needs to be given.
Show Source
-
include:
string
Objects included in response
-
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
-
limit:
integer
If using paging, number of results returned in this page.
-
offset:
integer
Starting resource record index. Not required if paging parameters are not supported
-
searchCriteria:
string
Search criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
A collection of Order Devices objects of the organization
Root Schema : OrderDevices
Type:
Show Source
object-
backupDeviceName(required):
object OrderDeviceTranslatedString
name of the Order Device
-
backupDeviceObjNum(required):
integer
Object number of the backup order device in the event of a communication failure or other problem.Example:
0 -
condimentSortType(required):
integer
Specify how condiments will be sorted on the selected order device. The options are:1 - No condiment sorting ??? (Condiments are listed in the order entered by the user) 2 - Sort allowed condiments ??? (Required condiments are not sorted) 3 - Sort all condiments (All condiments are sorted)Example:
1 -
customInstructions(required):
string
instructions (up to 250 characters) for the workstation's script to handle order output based on custom instructions in the script in case of using Custom Print HandlingExample:
Custom Instructions -
deviceName(required):
object OrderDeviceTranslatedString
name of the Order Device
-
deviceObjNum(required):
integer
Object number of the relevant order device record.Example:
0 -
deviceType(required):
integer
The remote device to which orders print. For a local device, orders print at the Local Order Receipt printer set for the workstation from which the order is placed. 1 ??? Remote 2 - LocalExample:
1 -
hierUnitId(required):
integer
Unique hierarchy unit valueExample:
1 -
hierUnitName(required):
object HierUnitNameTranslatedString
A string that contains translations of hierarchy unit name into multiple languages
-
hierUnitObjNum(required):
integer
Hierarchy unit object numberExample:
1 -
kdsOptions(required):
string
A string value of 0s & 1s of length 48 representing the enablement or disablement of the options associated with the Printer Order Device. Applicable if primaryDeviceType = 0Example:
000000000000000000000000000000000000000000000000 -
kdsOptionsExt(required):
object kdsOptionsExt
-
kdsSettings(required):
object kdsSettings
-
language2Name(required):
string
Name of the secondary language for the print output. Applicable only if primaryDeviceType = 0Example:
English -
language2ObjNum(required):
string
Object number of the secondary language for the print output. Applicable only if primaryDeviceType = 0Example:
English -
language3Name(required):
string
Name of the third language for the print output. Applicable only if primaryDeviceType = 0Example:
English -
language3ObjNum(required):
string
Object number of the third language for the print output. Applicable only if primaryDeviceType = 0Example:
English -
languageName(required):
string
Name of the primary language for the order device. Applicable only if primaryDeviceType = 0Example:
English -
languageObjNum(required):
integer
Object number of the primary language for the order device. Applicable only if primaryDeviceType = 0Example:
1 -
lineFeedBeforeOrder(required):
integer
The number of lines to advance before printing the order on order chits. Applicable only if primaryDeviceType = 0Example:
0 -
lineFeedsAfterOrder(required):
integer
The number of lines to advance after printing the order on order chits. Applicable only if primaryDeviceType = 0Example:
0 -
maxNumLinePerChit(required):
integer
the maximum number of lines (0-99) to print on each page of an order chit. Applicable only if primaryDeviceType = 0Example:
0 - menuItemPrinting(required): integer
-
name(required):
object OrderDeviceTranslatedString
name of the Order Device
-
objectNum(required):
integer
Object number of the Order DeviceExample:
1 -
orderDeviceRedirectName(required):
object OrderDeviceTranslatedString
name of the Order Device
-
orderDeviceRedirectObjNum(required):
integer
Object number of the order device to which orders sent to this device should be redirected. Typically, this field is set to itself.Example:
0 -
primaryDeviceType(required):
integer
The remote device to which orders print. For a local device, orders print at the Local Order Receipt printer set for the workstation from which the order is placed. 1 ??? Remote 2 - LocalExample:
0 -
primaryDistGroupName(required):
object OrderDeviceTranslatedString
name of the Order Device
-
primaryDistGroupObjNum(required):
integer
Object number of the Primary Distribution Group for the KDS. Applicable only if primaryDeviceType = 1Example:
1 -
printerOptions(required):
string
A string value of 0s & 1s of length 48 representing the enablement or disablement of the options associated with the Printer Order Device. Applicable if primaryDeviceType = 0Example:
000000000000000000000000000000000000000000000000 -
printerOptionsExt(required):
object printerOptionsExt
-
sortConsoldiationMethod(required):
integer
the sort and consolidation method for the order device 0 ??? Do Not Sort 1 ??? Seat Consolidated 2 ??? Seat No Consolidation 3 ??? Print Group Consolidated 4 ??? Print Group No Consolidation 5 ??? Seat & Print Group Consolidated 6 ??? Seat & Print Group No Consolidation 7 ??? Print Group and Seat Consolidated 8 ??? Print Group and Seat No Consolidation Applicable only if primaryDeviceType = 0Example:
0
Nested Schema : OrderDeviceTranslatedString
Type:
objectname of the Order Device
Example:
{
"en-US":"Order Device 1",
"es-MX":"Dispositivo de pedido"
}Nested Schema : HierUnitNameTranslatedString
Type:
objectA string that contains translations of hierarchy unit name into multiple languages
Example:
{
"en-US":"Property",
"de-DE":"Eigentum",
"es-MX":"Propiedad"
}Nested Schema : kdsOptionsExt
Type:
Show Source
object-
alertsExcludePrepTime:
boolean
A Boolean flag indicating to have the alert time calculation ignore the menu item prep time.Example:
false -
alwaysShowQuantity:
boolean
A Boolean flag indicating to display the quantity of every condiment ordered on a non-DOM KDS. This feature is not supported with DOM enabled.Example:
false -
bumpMarkedItems:
boolean
A Boolean flag indicating to allow bumping of marked items and orders.Example:
false -
disableDoubleTouchBump:
boolean
A Boolean flag indicating to prevent KDS users from bumping an order by double-clicking it on the display.Example:
false -
displayMenuItemCount:
boolean
A Boolean flag indicating to show the menu item count on the KDS Display if using DOMExample:
false -
displayNewOrderNotification:
boolean
A Boolean flag indicating to make new orders flash when appearing on the KDS Display if not using DOM.Example:
false -
displaySubTotal:
boolean
A Boolean flag indicating to cause the KDS to display the order subtotal if using DOM. Note that Subtotal is only displayed in certain layouts - 301, 305, 306, 309, 312, 315 , 317, 320, 401 and 402.Subtotal = Menu Item Sales Total + Discount + Tax + Auto Service Charge + Service Charge + Rounding TotalExample:
false -
dontConsolidate:
boolean
A Boolean flag indicating to print identical items separately if they are posted separately. Deselect to consolidate identical items onto one line, preceded by the quantity.Example:
false -
dontDisplayVoids:
boolean
A Boolean flag indicating select to remove voided items from the KDS Display. Deselect to show the letter V next to voided items if using DOM.Example:
false -
enableKDSConsolidation:
boolean
A Boolean flag indicating to consolidate identical items with different modifiers onto one line, preceded by the quantity on the KDS Display. This feature is not supported with DOM or a DOM KDS chit layout style.Example:
false -
expoDoneExempt:
boolean
A Boolean flag indicating to prevent an Expo Station from marking a sub-order as Done when it is marked as Done on another Expo Station.Example:
false -
matchVoidsWithOrderChits:
boolean
A Boolean flag indicating to show voided chits in front of the original order.Example:
false -
multipleCondimentsPerLine:
boolean
A Boolean flag indicating to print condiments in a continuous line on each order chit. Deselect to print each condiment on a separate line beneath the referenced menu item.Example:
false -
noExpoDoneBeforePaid:
boolean
A Boolean flag indicating to not allow the order to be expedited before the order is paid if using DOMExample:
false -
noPrepDoneBeforePaid:
boolean
A Boolean flag indicating to prevent an order from being bumped from the order device, until after the order has been paid for if using DOMExample:
false -
printCheckOnExpoDone:
boolean
A Boolean flag indicating to print a check or receipt at the Runner Chit printer when the order is bumped from the Expo.Example:
false -
printOnAllPrepDone:
boolean
A Boolean flag indicating to print a runner chit when an order is complete at all Prep Stations and before the order is bumped from the KDS Expo Display.Example:
false -
printOnExpoDone:
boolean
A Boolean flag indicating to print a runner chit when the order is marked Done at the Expo Station.Example:
false -
printOnPrepDone:
boolean
A Boolean flag indicating to print a runner chit when the order is marked Done at a Prep Station.Example:
false -
removeOriginalChitWhenItemVoided:
boolean
A Boolean flag indicating to if enabled, any item voids on the POS will immediately bump the associated item chit on the KDS. This option cannot be used with DOM, and requires Single Item Per Sub Order to be enabled. This option is required to enable Option 33 ??? Hide Void Chit When Item Voided and Option 34 ??? Show Void Chit Even if Item No Longer in Production.Example:
false -
showPrevCourseIndicator:
boolean
A Boolean flag indicating to show an icon on order chits from any course other than the first course to indicate that a previous course exists for this check. This feature only works on systems using KDS Coursing functionality with KDS Controller option Display Next Course after Previous Course Complete.Example:
false -
showVoidChitEvenIfNotInProduction:
boolean
A Boolean flag indicating if enabled, a void chit will show for an item that has been bumped from the KDS prior to being voided on the POS. This option cannot be used with DOM, and requires Single Item Per Sub Order to be enabled. This option requires Option 32 - Remove Original Chit When Item Voided.Example:
false -
singleItemPerSubOrder:
boolean
A Boolean flag indicating to show every item on an order on its own chit.Example:
false -
sortByPrintGroup:
boolean
A Boolean flag indicating to sort menu items by their print group. If a print group is not assigned, items print in order of their record number.Example:
false -
sortBySeat:
boolean
A Boolean flag indicating to sort items by seat number. Deselect to show items in the order in which they were ordered.Example:
false -
sortVoidsToTop:
boolean
A Boolean flag indicating to sort voided items to the top of the screen if not using DOM.Example:
false -
supressCheckTotal:
boolean
A Boolean flag indicating to hide the subtotal and paid amounts on chits when the Display Subtotal option is set.Example:
false -
unconsolidateItemsAfterCondimentEntry:
boolean
A Boolean flag indicating to unconsolidate multiple quantities of similar menu items if condiments are selected for each item.Example:
false -
useDeliChitFormatOnRunnerChits:
boolean
A Boolean flag indicating to print the order number using a larger and bold font on the top and bottom of runner chits.Example:
false
Nested Schema : kdsSettings
Type:
Show Source
object-
addHighlightScheme:
integer
The color configuration to use to highlight items with the quantity changed.Example:
0 -
addSortRule:
integer
The sort type to use when the quantity of an item changes.Example:
0 -
backupRunnerChitPrinterName:
object OrderDeviceTranslatedString
name of the Order Device
-
backupRunnerChitPrinterObjNum:
integer
Object number of the printer where runner chits print when orders are bumped from the KDS if Simphony cannot establish communication with the primary runner chit printerExample:
0 -
beepOnNewOrder:
integer
The sound type to emit when an order is received on the order deviceExample:
0 -
beepOnPrioritize:
integer
The sound type to emit when an order is prioritized or the order priority is increased on the order device. 0 ??? None 1 ??? PC Speaker 2 ??? WAV File 3 ??? Bump Bar SpeakerExample:
0 -
beepOnRush:
integer
0 ??? None 1 ??? PC Speaker 2 ??? WAV File 3 ??? Bump Bar SpeakerExample:
0 -
beepOnVIP:
integer
The sound type to emit when a VIP order is received.Example:
0 -
course1FirstAlertTimeInSecs:
integer
The amount of time, in seconds, for course 1 items to show the first alert.Example:
0 -
course1SecondAlertTimeInSecs:
integer
The amount of time, in seconds, for course 2 items to show the second alert.Example:
0 -
displayNewOrderNotification:
boolean
A Boolean flag indicating to make new orders flash when appearing on the KDS Display if not using DOMExample:
false -
domType:
integer
the Dynamic Order Mode type for the KDS Display.Example:
0 -
modifyHighlightScheme:
integer
The color configuration to use to highlight modified items on orders.Example:
0 -
modifySortRule:
integer
The sort type to use when existing items on an order are modified.\ 0 ??? Sort to TopExample:
0 -
newOrderNotificationTimeInSecs:
integer
The length of time, in seconds, newly added items flash on screen.Example:
0 -
othCourseFirstAlertTimeInSecs:
integer
The amount of time, in seconds, for any course except course 1 to show the first alert.Example:
0 -
othCourseSecondAlertTimeInSecs:
integer
The amount of time, in seconds, for any course except course 1 to show the second alert.Example:
0 -
primaryRunnerChitPrinterName:
object OrderDeviceTranslatedString
name of the Order Device
-
primaryRunnerChitPrinterObjNum:
integer
Object number of the printer where runner chits print when orders are bumped from the KDS.Example:
0 -
sendToPanelNum:
integer
The number of a panel (1 through 9) where orders appear on this device.Example:
0 -
voidHighlightScheme:
integer
The color configuration to use to highlight voided items.Example:
0 -
voidSortRule:
integer
The sort type to use when an item is voided.Example:
0
Nested Schema : printerOptionsExt
Type:
Show Source
object-
excludeVoids:
boolean
A Boolean flag indicating to not send voids of previous round items to the kitchen.Example:
false -
formatPrefixOnSeparateLine:
boolean
A Boolean flag indicating to print the prefix on a separate line above the condiment. Deselect to print the prefix on the same line as the condiment.Example:
false -
identiftyComboMeals:
boolean
A Boolean flag indicating to print a flag to denote menu items that are part of a combo meal.Example:
false -
intersperseDiffLanguages:
boolean
A Boolean flag indicating to print menu items in each different language before printing condiments when printing in multiple languages.Example:
false -
printBothMenuItemNames:
boolean
A Boolean flag indicating to print both names configured for a menu item. Deselect to print one name.Example:
false -
printChkInfoLinesAfterHeader:
boolean
A Boolean flag indicating to print guest check information lines after the order device header. Deselect to suppress the printing.Example:
false -
printChkInfoLinesAfterTrailer:
boolean
A Boolean flag indicating to print guest check information lines after the order device trailer. Deselect to suppress the printing.Example:
false -
printChkInfoLinesBeforeHeader:
boolean
A Boolean flag indicating to print guest check information lines before the order device header. Deselect to suppress the printing.Example:
false -
printCondimentsInRed:
boolean
A Boolean flag indicating to print condiments in red ink or in inverse. Deselect to print condiments in red/inverse or black, depending on the Print Class Red/Black option setting.Example:
false -
printDiningCourseHeader:
boolean
A Boolean flag indicating to print a dining course header and to group menu items by dining course.Example:
false -
printDopplebon:
boolean
A Boolean flag indicating to print a separate order chit for each menu item in the current service round (dopplebon style). Deselect to print one order chit for all menu items in the current service round.Example:
false -
printDopplebonSummary:
boolean
A Boolean flag indicating to print an order summary chit before printing an order's dopplebon order chits. Deselect to suppress dopplebon summary chit printing.Example:
false -
printRVCNameOnOrder:
boolean
A Boolean flag indicating to show the revenue center name with each order sent to the order device. Deselect to hide the name.Example:
false -
printSeatNumWithIndvItems:
boolean
A Boolean flag indicating to print seat numbers with each individual menu item.Example:
false -
printSecondaryItems:
boolean
A Boolean flag indicating to print secondary items being broadcast from other order devices.Example:
false -
printSecondaryItemsInRed:
boolean
A Boolean flag indicating to print secondary items in red. Deselect to print secondary items in black.Example:
false -
printSecondaryPrinterHeader:
boolean
A Boolean flag indicating to send menu items sent to this order printer as secondary items to other order printers.Example:
false -
printSingleWide:
boolean
A Boolean flag indicating to print the order using single-width characters.Example:
false -
printTransEmpNumAndName:
boolean
A Boolean flag indicating to print the employee name and number of the transaction operator. Deselect to print the employee name and number of the check operator.Example:
false -
printVoidMarkerBeforeVoid:
boolean
A Boolean flag indicating to print a VV VOID VV line, in red or inverse, in front of voided menu items. Deselect to print voided items in redExample:
false -
supressBlankLinesBetweenSecondaryItems:
boolean
A Boolean flag indicating to suppress printing extra line spacing between secondary items on order chits.Example:
false
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