Device

Device details for a device. This device either uses the Toast POS app or is a printer used by the Toast platform.

Depending on the deviceType (either POS or PRINTER), it will include either the PosDeviceInfo object, or the PrinterDeviceInfo object respectively. Only one of these two objects is used for each device.

deviceModel
string

The hardware model of the device. For example, TT200, TG3, TP200, and so on.

deviceModelName
string

The model name of the device. For example, Toast Terminal, Toast Go 3, and so on.

deviceType
required
string

The type of device.

The values include:

  • POS - Devices that use the Toast POS app. The PosDeviceInfo object is used with this value. This value includes terminal and handheld devices, which are identified using the posType value in the PosDeviceInfo object.

  • PRINTER - Devices that are printers. The PrinterDeviceInfo object is used with this value.

Enum: "POS" "PRINTER"
object (PosDeviceInfo)

Device details for devices using the Toast POS app. The deviceType value for the containing Device object must be POS.

object (PrinterDeviceInfo)

Device details for printers identified by the Toast platform. The deviceType value for the containing Device object must be PRINTER.

serialNumber
required
string

The serial number of the hardware device.

{
  • "deviceModel": "TT200",
  • "deviceModelName": "Toast Terminal",
  • "serialNumber": "cb5f9ea",
  • "deviceType": "POS",
  • "posDeviceInfo": {
    },
  • "printerDeviceInfo": {
    }
}