Device
Device
Register a new device for authorization.
You should already have a clientId supplied by Flow, and you will retreive a deviceIdentifier and deviceToken in the response.
Contains device name, OS, release version of OS, OS build date, like a uname -a response on linux servers
Example response
Example response
Update system information for a device.
The devicetoken is only used for to attach devices and tie it to a tenant
Contains device name, OS, release version of OS, OS build date, like a uname -a response on linux servers
No Content
No Content
No content
Device Authorization Flow - Authorize a device and attach it to a specific store
Accesstoken recevied after user login with a deviceToken
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+OK
No content
Linking failed. Ther error message will have information about what failed.
No content
Link a physical device to a device registered in Flow.
Device code from backoffice
This is a predefined app id that Flow will provide
A user code from the tenant
The password for the user
Contains device name, OS, release version of OS, OS build date, like a uname -a response on linux servers
Example response
Linking failed. Ther error message will have information about what failed.
Not found
List all users that can login to the current device.
The devicetoken is only used for to attach devices and tie it to a tenant
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
The number of items per page in a result set.
Reference to a specific page in a result set.
Example response
Linking failed. Ther error message will have information about what failed.
Get list of registered devices.
Required permission: TENANT.ADMIN
Token received from the auth service
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a store uid
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Example response
Example response
Create a new device for a tenant
Accesstoken recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]*| Enum | Description |
|---|---|
| CLIENT | Flow Retail Client |
| ASSISTANT | Flow Retail Assistant |
| UNKNOWN | No specific app |
^[A-Za-z0-9-_]*^[A-Za-z0-9-_]*Example response
Bad Request
Search Registered devices
Required permission: TENANT.ADMIN
Token received from the auth service
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
^[A-Za-z0-9-_]*| Enum | Description |
|---|---|
| CLIENT | Flow Retail Client |
| ASSISTANT | Flow Retail Assistant |
| UNKNOWN | No specific app |
Example response
Example response
Get details for a device.
Required permission: TENANT.ADMIN
Token received from the auth service
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a device
^[A-Za-z0-9-_]+Example response
Example response
Update details for a device. Partial updates are allowed.
Required permission: TENANT.ADMIN
Setting the status to "READY_TO_LINK" will unlink it for the current device and create a new deviceLinkCode and a new identifier
Token received from the auth service
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a device
^[A-Za-z0-9-_]+| Enum | Description |
|---|---|
| CLIENT | Flow Retail Client |
| ASSISTANT | Flow Retail Assistant |
| UNKNOWN | No specific app |
^[A-Za-z0-9-_]*| Enum | Description |
|---|---|
| READY_TO_LINK | The device is ready to a physical device through the link endpoint |
| ACTIVE | The device is linked and active |
| BLOCKED | The device is linked, but blocked for usage |
^[A-Za-z0-9-_]*Example response
Example response
Deletes a device.
Required permission: TENANT.ADMIN
Token received from the auth service
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a device
^[A-Za-z0-9-_]+No Content
No Content
No content
Last updated
Was this helpful?

