PosDeviceInfo

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

androidOsSdkLevel
integer

The Android API level of the POS device. For example, 34 corresponds to Android 14. For more information, see the Android API levels reference.

androidOsVersion
string

The Android OS version of the POS device. For example, 14.0.

deviceId
string

The identifier assigned by the Toast platform to the hardware device.

deviceName
string

The custom name assigned to the POS device when initially setting up the Toast POS app.

deviceUptimeMillis
integer <int64>

The number of milliseconds the device has been running since its last boot. This value is captured at lastSyncedAt and is not real-time data.

firmwareVersion
string

The firmware version of the POS device. For example, FV2.028.01.

ipAddress
string

The IP address of the network used by the POS device.

ipType
string

The type of IP address assigned to the POS device.

Enum: "DHCP" "STATIC" "UNKNOWN"
lastSyncedAt
string <date-time>

The date and time when the device was last synchronized with the Toast platform, in ISO-8601 format and UTC. All values in this object reflect the device state as of this timestamp.

macAddress
string

The MAC address of the network interface controller used by this POS device.

networkConnectionType
string

The type of the network interface controller used by the POS device.

RJ45 and USBC are both wired ethernet connector form factors. MOBILE indicates a cellular (LTE) connection on handheld devices.

Enum: "WIFI" "ETHERNET" "RJ45" "USBC" "MOBILE"
networkName
string

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

orderAutofireEnabled
boolean

Identifies whether this POS device is the designated Autofire device. Autofire devices automatically approve and send online and scheduled orders to the kitchen.

Valid values:

*true - This POS device is the designated Autofire device for the location. *false - This POS device is not the designated Autofire device. *null - The Autofire designation is not reported for this POS device.

For more information about Autofire devices, see Autofiring overview.

pciCompliant
boolean

Identifies whether the POS device meets PCI compliance requirements.

Valid values:

*true - The POS device meets PCI compliance requirements. *false - The POS device does not meet PCI compliance requirements. When this value is false, the pciNonComplianceReason value identifies the reason. *null - PCI compliance status is not reported for this POS device.

pciNonComplianceReason
string

When the pciCompliant value is false, this value identifies the reason why a POS device is not PCI compliant.

posAppVersion
string

The version of the Toast POS app installed on the device. For example, 2.95.1.

posType
string

The POS device type, which is either terminal or handheld. This is determined by the device model.

Enum: "TERMINAL" "HANDHELD"
primaryMode
string

The primary device mode as stored on the device.

Known values:

  • POS
  • BAR
  • PAYMENT
  • ORDERS_HUB
  • PENDING
  • KITCHEN
  • KITCHEN_2
  • KITCHEN_QSR
  • KIOSK
  • TABLE_SIDE_KIOSK
  • DELIVERY_V2

This list may grow over time without a schema change; clients should treat unknown values gracefully.

securityPatchVersion
string

The date of the most recent Android OS security update applied to the POS device, in YYYY-MM-DD format. Despite the field name, this is a date string, not a version number. For example, 2025-10-05.

{
  • "posType": "TERMINAL",
  • "deviceName": "string",
  • "deviceId": "4f49a8734eb214d0",
  • "lastSyncedAt": "2025-04-01T12:00:00.000Z",
  • "primaryMode": "string",
  • "orderAutofireEnabled": true,
  • "pciCompliant": true,
  • "pciNonComplianceReason": "string",
  • "ipAddress": "string",
  • "ipType": "DHCP",
  • "macAddress": "string",
  • "networkName": "string",
  • "networkConnectionType": "WIFI",
  • "deviceUptimeMillis": 0,
  • "posAppVersion": "4.3.1",
  • "firmwareVersion": "string",
  • "androidOsVersion": "14.0",
  • "androidOsSdkLevel": 34,
  • "securityPatchVersion": "string"
}