{"componentChunkName":"component---src-templates-redoc-operation-js","path":"/device-details/tag/Data-definitions/schema/PrinterDeviceInfo/","result":{"data":{"contentItem":{"type":"redoc-operation","link":"/device-details/tag/Data-definitions/schema/PrinterDeviceInfo/","data":{"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"version\":\"1.0.0\",\"title\":\"Device details API\",\"description\":\"Returns information about devices for a single restaurant.\\n\",\"contact\":{\"name\":\"Enterprise Reporting\"},\"termsOfService\":\"https://pos.toasttab.com/api-terms-of-use\"},\"paths\":{\"/device-info\":{\"get\":{\"tags\":[\"Device details\"],\"operationId\":\"getDeviceInfo\",\"summary\":\"Get device details for a restaurant\",\"description\":\"Get details for the devices at a location. This includes POS terminal and handheld devices, and printers.\\n\",\"security\":[{\"oauth2\":[\"device-details.info:read\"]}],\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The identifier for the restaurant.\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\"}}],\"responses\":{\"200\":{\"description\":\"Successful operation\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Device\"}}}}},\"400\":{\"description\":\"Missing or invalid restaurant header.\"},\"401\":{\"description\":\"Unauthorized.\"},\"403\":{\"description\":\"Forbidden.\"},\"429\":{\"description\":\"Too many requests.\"},\"500\":{\"description\":\"An unexpected error occurred.\"}}}}},\"servers\":[{\"url\":\"https://toast-api-server/device-details/v1\"}],\"components\":{\"securitySchemes\":{\"oauth2\":{\"description\":\"Access to Toast APIs, specific endpoints,\\nand specific API endpoint operations is\\ncontrolled by the scopes that are associated\\nwith your API account.\\n\\nA full reference for Toast API scopes and\\ntheir capabilities can be found in the\\n[_Toast Developer Guide_](https://doc.toasttab.com/doc/devguide/apiScopes.html).\\n\",\"type\":\"oauth2\",\"flows\":{\"clientCredentials\":{\"tokenUrl\":\"https://toast-api-server/authentication/v1/authentication/login\",\"scopes\":{\"device-details.info:read\":\"Allows reading from the device details API.\"}}}}},\"schemas\":{\"Device\":{\"type\":\"object\",\"description\":\"Device details for a device. This device either uses the Toast POS app or is a printer\\nused by the Toast platform.\\n\\nDepending on the `deviceType` (either `POS` or `PRINTER`), it will include either the\\n`PosDeviceInfo` object, or the `PrinterDeviceInfo` object respectively. Only one of\\nthese two objects is used for each device.\\n\",\"required\":[\"serialNumber\",\"deviceType\"],\"properties\":{\"deviceModel\":{\"type\":\"string\",\"description\":\"The hardware model of the device. For example, TT200, TG3, TP200, and so on.\",\"example\":\"TT200\"},\"deviceModelName\":{\"type\":\"string\",\"description\":\"The model name of the device. For example, Toast Terminal, Toast Go 3, and so on.\",\"example\":\"Toast Terminal\"},\"serialNumber\":{\"type\":\"string\",\"description\":\"The serial number of the hardware device.\",\"example\":\"cb5f9ea\"},\"deviceType\":{\"type\":\"string\",\"description\":\"The type of device.\\n\\nThe values include:\\n\\n* `POS` - Devices that use the Toast POS app. The `PosDeviceInfo` object is used with this value.\\n  This value includes terminal and handheld devices, which are identified using the `posType`\\n  value in the `PosDeviceInfo` object.\\n\\n* `PRINTER` - Devices that are printers. The `PrinterDeviceInfo` object is used with this value.\\n\",\"enum\":[\"POS\",\"PRINTER\"],\"example\":\"POS\"},\"posDeviceInfo\":{\"$ref\":\"#/components/schemas/PosDeviceInfo\"},\"printerDeviceInfo\":{\"$ref\":\"#/components/schemas/PrinterDeviceInfo\"}}},\"PosDeviceInfo\":{\"type\":\"object\",\"description\":\"Device details for devices using the Toast POS app. The `deviceType` value for the\\ncontaining `Device` object must be `POS`.\\n\",\"properties\":{\"posType\":{\"type\":\"string\",\"description\":\"The POS device type, which is either terminal or handheld. This is determined by the device model.\",\"enum\":[\"TERMINAL\",\"HANDHELD\"],\"example\":\"TERMINAL\"},\"deviceName\":{\"type\":\"string\",\"description\":\"The custom name assigned to the POS device when initially setting up the Toast POS app.\"},\"deviceId\":{\"type\":\"string\",\"description\":\"The identifier assigned by the Toast platform to the hardware device.\",\"example\":\"4f49a8734eb214d0\"},\"lastSyncedAt\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time when the device was last synchronized with the Toast platform, in\\nISO-8601 format and UTC. All values in this object reflect the device state as of\\nthis timestamp.\\n\",\"example\":\"2025-04-01T12:00:00.000Z\"},\"primaryMode\":{\"type\":\"string\",\"description\":\"The primary device mode as stored on the device.\\n\\nKnown values:\\n\\n- `POS`\\n- `BAR`\\n- `PAYMENT`\\n- `ORDERS_HUB`\\n- `PENDING`\\n- `KITCHEN`\\n- `KITCHEN_2`\\n- `KITCHEN_QSR`\\n- `KIOSK`\\n- `TABLE_SIDE_KIOSK`\\n- `DELIVERY_V2`\\n\\nThis list may grow over time without a schema change; clients should treat unknown values gracefully.\\n\"},\"orderAutofireEnabled\":{\"type\":\"boolean\",\"description\":\"Identifies whether this POS device is the designated Autofire device. Autofire devices\\nautomatically approve and send online and scheduled orders to the kitchen.\\n\\nValid values:\\n\\n*`true` - This POS device is the designated Autofire device for the location.\\n*`false` - This POS device is not the designated Autofire device.\\n*`null` - The Autofire designation is not reported for this POS device.\\n\\nFor more information about Autofire devices, see [Autofiring overview](https://doc.toasttab.com/doc/platformguide/platformAutoFireDeviceOverview.html).\\n\"},\"pciCompliant\":{\"type\":\"boolean\",\"description\":\"Identifies whether the POS device meets PCI compliance requirements.\\n\\nValid values:\\n\\n*`true` - The POS device meets PCI compliance requirements.\\n*`false` - The POS device does not meet PCI compliance requirements. When this value is `false`, the `pciNonComplianceReason` value identifies the reason.\\n*`null` - PCI compliance status is not reported for this POS device.\\n\"},\"pciNonComplianceReason\":{\"type\":\"string\",\"description\":\"When the `pciCompliant` value is `false`, this value identifies the reason why a POS device is not PCI compliant.\"},\"ipAddress\":{\"type\":\"string\",\"description\":\"The IP address of the network used by the POS device.\"},\"ipType\":{\"type\":\"string\",\"description\":\"The type of IP address assigned to the POS device.\",\"enum\":[\"DHCP\",\"STATIC\",\"UNKNOWN\"]},\"macAddress\":{\"type\":\"string\",\"description\":\"The MAC address of the network interface controller used by this POS device.\"},\"networkName\":{\"type\":\"string\",\"description\":\"The service set identifier (SSID) for the Wi-Fi internet connection. This value is `null` for Ethernet connections.\"},\"networkConnectionType\":{\"type\":\"string\",\"description\":\"The type of the network interface controller used by the POS device.\\n\\n`RJ45` and `USBC` are both wired ethernet connector form factors. `MOBILE` indicates a\\ncellular (LTE) connection on handheld devices.\\n\",\"enum\":[\"WIFI\",\"ETHERNET\",\"RJ45\",\"USBC\",\"MOBILE\"]},\"deviceUptimeMillis\":{\"type\":\"integer\",\"format\":\"int64\",\"description\":\"The number of milliseconds the device has been running since its last boot.\\nThis value is captured at `lastSyncedAt` and is not real-time data.\\n\"},\"posAppVersion\":{\"type\":\"string\",\"description\":\"The version of the Toast POS app installed on the device. For example, 2.95.1.\",\"example\":\"4.3.1\"},\"firmwareVersion\":{\"type\":\"string\",\"description\":\"The firmware version of the POS device. For example, FV2.028.01.\"},\"androidOsVersion\":{\"type\":\"string\",\"description\":\"The Android OS version of the POS device. For example, 14.0.\",\"example\":\"14.0\"},\"androidOsSdkLevel\":{\"type\":\"integer\",\"description\":\"The Android API level of the POS device. For example, 34 corresponds to Android 14.\\nFor more information, see the [Android API levels reference](https://apilevels.com/).\\n\",\"example\":34},\"securityPatchVersion\":{\"type\":\"string\",\"description\":\"The date of the most recent Android OS security update applied to the POS device, in\\n`YYYY-MM-DD` format. Despite the field name, this is a date string, not a version number.\\nFor example, 2025-10-05.\\n\"}}},\"PrinterDeviceInfo\":{\"type\":\"object\",\"description\":\"Device details for printers identified by the Toast platform. The `deviceType` value for the\\ncontaining `Device` object must be `PRINTER`.\\n\",\"properties\":{\"deviceName\":{\"type\":\"string\",\"description\":\"The custom name assigned to the printer device in the Toast Web configuration.\"},\"lastSyncedAt\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time when the device was last synchronized with the Toast platform, in ISO-8601 format and UTC.\"},\"firmwareVersion\":{\"type\":\"string\",\"description\":\"The firmware version of the printer. This value is `null` if it's not reported.\"},\"ipAddress\":{\"type\":\"string\",\"description\":\"The IP address of the network used by the printer.\"},\"ipType\":{\"type\":\"string\",\"description\":\"The type of IP address assigned to the printer.\",\"enum\":[\"DHCP\",\"STATIC\",\"UNKNOWN\"]},\"macAddress\":{\"type\":\"string\",\"description\":\"The MAC address of the network interface controller used by the printer.\"},\"gatewayAddress\":{\"type\":\"string\",\"description\":\"The default gateway IP address of the network interface controller.\"},\"netmaskAddress\":{\"type\":\"string\",\"description\":\"The subnet mask used by the printer.\"},\"printerPort\":{\"type\":\"string\",\"description\":\"The transmission control protocol (TCP) port used for network printing. For example, 9100.\"}}}}}}},\"options\":{\"hideTryItPanel\":true,\"pagination\":\"item\",\"generateCodeSamples\":{\"languages\":[{\"lang\":\"curl\"},{\"lang\":\"Java\"},{\"lang\":\"Python\"}]},\"showConsole\":false,\"hideHostname\":true,\"hideDownloadButton\":true,\"sortPropsAlphabetically\":true,\"schemaDefinitionsTagName\":\"Data definitions\",\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","redocHasSecurityDefinitions":false,"redocInfoPageLink":"/device-details/overview/","redocItemId":"tag/Data-definitions/schema/PrinterDeviceInfo","redocHasInfoPage":false,"settings":{"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"Java"},{"lang":"Python"}]},"showConsole":false,"hideHostname":true,"hideDownloadButton":true,"sortPropsAlphabetically":true,"schemaDefinitionsTagName":"Data definitions","hideTryItPanel":true},"requestLogin":false,"lastModified":"2025-12-04T16:29:27.000Z"},"seo":{"title":"PrinterDeviceInfo"}}},"pageContext":{"id":"9fa3adf0-ddae-57da-b8e7-2bce903a4eectag/Data-definitions/schema/PrinterDeviceInfo/__redocly content/device-details/tag/Data-definitions/schema/PrinterDeviceInfo/","seo":{"title":"PrinterDeviceInfo","description":"<SchemaDefinition showWriteOnly={true} schemaRef=\"#/components/schemas/PrinterDeviceInfo\" />","image":"","keywords":null,"jsonLd":null,"lang":null},"pageId":"device-details.reference.page.yaml#tag/Data-definitions/schema/PrinterDeviceInfo/","pageBaseUrl":"/device-details","type":"redoc-operation","toc":{"enable":true,"maxDepth":4,"headings":null},"data":{},"catalogInfo":null,"link":"/device-details/tag/Data-definitions/schema/PrinterDeviceInfo/","sidebarName":"api-reference","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":[{"definitionId":"deviceDetails","id":"deviceDetails","title":"deviceDetails","isDefault":true,"apiId":null}],"apiVersionId":null,"isDefaultApiVersion":true}},"staticQueryHashes":["1123603147","1180902673","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3743992808","561138138"]}