About the Devices object

When you retrieve device information, the details are returned in an array containing Device objects. Each Device object includes the following values:

  • serialNumber: The unique code assigned by the manufacturer to track the individual device.

  • deviceType: The type of device. The options are:

    • POS: Indicates a device that uses the Toast POS app.

    • PRINTER: Indicates a printer.

  • deviceModel: The hardware model of the device. This is determined by the device itself.

  • deviceModelName: The model name of the device. This is determined by the device itself.

  • PosDeviceInfo: The object containing information about a Toast POS app device. The object is populated when deviceType is POS. Otherwise, this object is null.

  • PrinterDeviceInfo: The object containing information about a printer. The object is populated when deviceType is PRINTER. Otherwise, this object is null.

For an example of how the Device object is structured, see Getting device information.

About the PosDeviceInfo object

When the deviceType is POS, the PosDeviceInfo object is populated in the Device object, while the PrinterDeviceInfo object is null. The PosDeviceInfo object includes the following values:

  • posType: The Toast POS app device type. This is either TERMINAL or HANDHELD.

  • deviceName: The custom name assigned to the device when initially set up.

  • deviceId: The identifier assigned by the Toast platform to the hardware device.

  • lastSyncedAt: The date and time when the Toast POS app device was last synchronized with the Toast platform, in ISO-8601 and coordinated universal time (UTC) format.

  • primaryMode: The primary mode used by the device. The values include:

    • Delivery

    • Drive-Thru

    • Kiosk

    • Kitchen Display/Expo Screen

    • Orders Hub

    • Payment Terminal

    • Pending Orders

    • Quick Order

    • Retail

    • Table Service

    • Tableside Kiosk

  • orderAutofireEnabled: Identifies whether the Toast POS app device is the designated Autofire device. For more information about Autofire devices, see Autofiring overview.

  • pciCompliant: Identifies whether the Toast POS app device meets Payment Card Industry (PCI) compliance requirements.

  • pciNonComplianceReason: If the pciCompliant value is false, this value identifies the reason why the POS device is not PCI compliant.

  • ipAddress: The internet protocol (IP) address of the network used by the POS device.

  • ipType: The type of IP address assigned to the Toast POS app device.

  • macAddress: The MAC address of the network interface controller used by the POS device.

  • networkName: The service set identifier (SSID) for the Wi-Fi internet connection. This value is null for Ethernet connections.

  • networkConnectionType: The type of network interface controller used by the Toast POS app device. RJ45 and USBC are both wired Ethernet connector form factors. MOBILE indicates a cellular connection on handheld devices. WIFI indicates a wireless internet connection.

  • deviceUptimeMillis: The number of milliseconds the device has been operating since it was last rebooted.

  • posAppVersion: The version of the Toast POS app running on the device.

  • firmwareVersion: The firmware version of the Toast POS app device.

  • androidOsVersion: The Android OS version of the Toast POS app device.

  • androidOsSdkLevel: The Android API level of the Toast POS app device.

  • securityPatchVersion: The date of the most recent Android OS security update applied to the Toast POS app device. This is in YYYY-MM-DD format.

About the PrinterDeviceInfo object

When the deviceType is PRINTER, the PrinterDeviceInfo object is populated in the Device object, while the PosDeviceInfo object is null. The PrinterDeviceInfo object includes the following values:

  • deviceName: The custom name assigned to the printer in Toast Web.

  • lastSyncedAt: The date and time when the printer was last synchronized with the Toast platform, in ISO-8601 and UTC format.

  • firmwareVersion: The firmware version of the printer.

  • ipAddress: The IP address of the network used by the printer.

  • ipType: The type of IP address assigned to the printer.

  • macAddress: The MAC address of the network interface controller used by the printer.

  • gatewayAddress: The default gateway IP address of the network interface controller.

  • netmaskAddress: The subnet mask used by the printer.

  • printerPort: The transmission control protocol (TCP) port used for network printing.