⌘K
Restaurant estate
POS Devices
Restaurant
POS devices
Cloud
Retrieve the list of Point of Sale (POS) devices configured for a specific restaurant.
GET/pos_devicesList POS Devices
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| brandId | integer | Yes | Brand ID |
| restaurantId | integer | Yes | Restaurant ID |
Response
{
"status": 200,
"code": "device_found",
"data": [
{
"posDeviceId": 8063,
"deviceName": "Main Register",
"deviceId": "aff48a32d7d0396e",
"role": "independent"
}
]
}Response Properties
Every field in the example is listed below. Explicit requiredness is shown when the endpoint contract defines it.
| Property | Type | Example | Description |
|---|---|---|---|
| status | integer | 200 | HTTP status code returned by the API. |
| code | string | "device_found" | Machine-readable application code for the result. |
| data | array | […] | Endpoint-specific response payload. |
| data[] | object | {…} | Endpoint-specific response payload. |
| data[].posDeviceId | integer | 8063 | Identifier of the associated pos device. |
| data[].deviceName | string | "Main Register" | The device name value. |
| data[].deviceId | string | "aff48a32d7d0396e" | Identifier of the associated device. |
| data[].role | string | "independent" | The role value. |
Compliant Versions
Retrieve the referential of POS application versions that are compliant with fiscal regulations. Use this list to check whether the version running on a device is still supported and compliant.
GET/pos_devices/compliant_versionsList Compliant POS Versions
Retrieve the list of POS application versions considered compliant with fiscal regulations. The data field is an array of version strings.
Response
{
"status": 200,
"code": "compliant_versions",
"message": "Compliant device's versions.",
"data": [
"10.4.0",
"10.3.0",
"10.2.0",
"9.4.0"
]
}Response Properties
Every field in the example is listed below. Explicit requiredness is shown when the endpoint contract defines it.
| Property | Type | Example | Description |
|---|---|---|---|
| status | integer | 200 | HTTP status code returned by the API. |
| code | string | "compliant_versions" | Machine-readable application code for the result. |
| message | string | "Compliant device's versions." | Human-readable result message. Do not use this value for program logic. |
| data | array | […] | Endpoint-specific response payload. |
| data[] | string | "10.4.0" | Endpoint-specific response payload. |