1. Configuration and Content API Guide
  2. Tasks
  3. Devices
  4. Order Devices

Update Order Devices

post

/config/sim/v1/devices/updateOrderDevices

Updates an order devices record for the current organization.

Request

Supported Media Types
Header Parameters
Body ()
Order Device Object
Root Schema : OrderDevices
Type: object
Show Source
Nested Schema : OrderDeviceTranslatedString
Type: object
name of the Order Device
Example:
{
    "en-US":"Order Device 1",
    "es-SS":"Order Device"
}
Nested Schema : HierUnitNameTranslatedString
Type: object
A string that contains translations of hierarchy unit name into multiple languages
Example:
{
    "en-US":"Property",
    "de-DE":"Eigentum",
    "ar-AR":"??????????"
}
Nested Schema : kdsOptionsExt
Type: object
Show Source
  • A Boolean flag indicating to have the alert time calculation ignore the menu item prep time.
    Example: false
  • 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
  • A Boolean flag indicating to allow bumping of marked items and orders.
    Example: false
  • A Boolean flag indicating to prevent KDS users from bumping an order by double-clicking it on the display.
    Example: false
  • A Boolean flag indicating to show the menu item count on the KDS Display if using DOM
    Example: false
  • A Boolean flag indicating to make new orders flash when appearing on the KDS Display if not using DOM.
    Example: false
  • 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 Total
    Example: false
  • 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
  • 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
  • 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
  • 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
  • A Boolean flag indicating to show voided chits in front of the original order.
    Example: false
  • 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
  • A Boolean flag indicating to not allow the order to be expedited before the order is paid if using DOM
    Example: false
  • 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 DOM
    Example: false
  • 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
  • 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
  • A Boolean flag indicating to print a runner chit when the order is marked Done at the Expo Station.
    Example: false
  • A Boolean flag indicating to print a runner chit when the order is marked Done at a Prep Station.
    Example: false
  • 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
  • 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
  • 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
  • A Boolean flag indicating to show every item on an order on its own chit.
    Example: false
  • 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
  • A Boolean flag indicating to sort items by seat number. Deselect to show items in the order in which they were ordered.
    Example: false
  • A Boolean flag indicating to sort voided items to the top of the screen if not using DOM.
    Example: false
  • A Boolean flag indicating to hide the subtotal and paid amounts on chits when the Display Subtotal option is set.
    Example: false
  • A Boolean flag indicating to unconsolidate multiple quantities of similar menu items if condiments are selected for each item.
    Example: false
  • 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: object
Show Source
Nested Schema : printerOptionsExt
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

A collection of Order Devices objects of the organization
Body ()
Root Schema : OrderDevice
Type: object
Show Source

400 Response

400 Bad Request
Body ()
Root Schema : ErrorDetails
Type: object
Response body when the request returns an error.
Show Source
Back to Top