Heads up, our devs are blazing ahead—docs are catching up, so some features might not be fully documented yet.

Device

Device

Get device information

get
/device

Fetch device info for current device given in token

Authorizations
AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Responses
200

Example response

application/json
get
/device
200

Example response

Deprecated

Register a new device (deprecated)

post
/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.

Body
clientIdstringRequired
namestring | nullableOptional
systemInformationstring | nullableOptional

Contains device name, OS, release version of OS, OS build date, like a uname -a response on linux servers

Responses
200

Example response

application/json
post
/device
200

Example response

Update systemInformation for a device

put
/device

Update system information for a device.

Authorizations
AuthorizationstringRequired

The devicetoken is only used for to attach devices and tie it to a tenant

Body
systemInformationstringRequired

Contains device name, OS, release version of OS, OS build date, like a uname -a response on linux servers

Responses
put
/device
204

No Content

No content

Deprecated

Accept Device (deprecated)

post
/device/authorize

Device Authorization Flow - Authorize a device and attach it to a specific store

Authorizations
AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Body
deviceCodestringRequired
storeUidstringRequiredPattern: ^[A-Za-z0-9-_]+
tenantUidstringRequiredPattern: ^[A-Za-z0-9-_]+
tillUidstringOptionalPattern: ^[A-Za-z0-9-_]+
namestringOptional
Responses
200

OK

No content

post
/device/authorize

No content

Link a physical device

post
/device/{deviceCode}/link

Link a physical device to a device registered in Flow.

Path parameters
deviceCodestringRequired

Device code from backoffice

Body
appIdstringRequired

This is a predefined app id that Flow will provide

userCodestringRequired

A user code from the tenant

passwordstringRequired

The password for the user

systemInformationstringOptional

Contains device name, OS, release version of OS, OS build date, like a uname -a response on linux servers

Responses
200

Example response

application/json
post
/device/{deviceCode}/link

Request a new device token

post
/device/token

Device Authorization Flow - Request a new token

Body
or
Responses
200

Link successfull.

application/json
post
/device/token

List device users

get
/device/users

List all users that can login to the current device.

Authorizations
AuthorizationstringRequired

The devicetoken is only used for to attach devices and tie it to a tenant

Query parameters
sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional
ENUM Description
ASC Sort in ascending order
DESC Sort in descending order
Possible values:
pageSizeintegerOptional

The number of items per page in a result set.

pageNumberintegerOptional

Reference to a specific page in a result set.

Responses
200

Example response

application/json
get
/device/users

List registered devices

get
/tenants/{tenantUid}/devices

Get list of registered devices.

Required permission: TENANT.ADMIN

Authorizations
AuthorizationstringRequired

Token received from the auth service

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Query parameters
deviceStoreUidstringOptional

Reference to a store uid

Pattern: ^[A-Za-z0-9-_]+
pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional
ENUM Description
ASC Sort in ascending order
DESC Sort in descending order
Possible values:
Responses
200

Example response

application/json
get
/tenants/{tenantUid}/devices
200

Example response

Create a new device

post
/tenants/{tenantUid}/devices

Create a new device for a tenant

Authorizations
AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
deviceUidstringOptionalPattern: ^[A-Za-z0-9-_]*
namestringRequired
appCodestring · enumRequired
Enum Description
CLIENT Flow Retail Client
ASSISTANT Flow Retail Assistant
UNKNOWN No specific app
Possible values:
storeUidstringOptionalPattern: ^[A-Za-z0-9-_]*
tillUidstringOptionalPattern: ^[A-Za-z0-9-_]*
printerUidsstring[]Optional
Responses
post
/tenants/{tenantUid}/devices

Search registered devices

post
/tenants/{tenantUid}/devices/search

Search Registered devices

Required permission: TENANT.ADMIN

Authorizations
AuthorizationstringRequired

Token received from the auth service

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Query parameters
pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional
ENUM Description
ASC Sort in ascending order
DESC Sort in descending order
Possible values:
Body
namestringOptional
deviceIdentifierstringOptionalPattern: ^[A-Za-z0-9-_]*
querystringOptional
appCodestring · enumOptional
Enum Description
CLIENT Flow Retail Client
ASSISTANT Flow Retail Assistant
UNKNOWN No specific app
Possible values:
Responses
200

Example response

application/json
post
/tenants/{tenantUid}/devices/search
200

Example response

Get device details

get
/tenants/{tenantUid}/devices/{deviceUid}

Get details for a device.

Required permission: TENANT.ADMIN

Authorizations
AuthorizationstringRequired

Token received from the auth service

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
deviceUidstringRequired

Reference to a device

Pattern: ^[A-Za-z0-9-_]+
Responses
200

Example response

application/json
get
/tenants/{tenantUid}/devices/{deviceUid}
200

Example response

Update device details

put
/tenants/{tenantUid}/devices/{deviceUid}

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

Authorizations
AuthorizationstringRequired

Token received from the auth service

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
deviceUidstringRequired

Reference to a device

Pattern: ^[A-Za-z0-9-_]+
Body
namestringOptional
appCodestring · enumOptional
Enum Description
CLIENT Flow Retail Client
ASSISTANT Flow Retail Assistant
UNKNOWN No specific app
Possible values:
storeUidstringOptionalPattern: ^[A-Za-z0-9-_]*
statusstring · enumOptional
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
Possible values:
tillUidstringOptionalPattern: ^[A-Za-z0-9-_]*
printerUidsstring[]Optional
Responses
200

Example response

application/json
put
/tenants/{tenantUid}/devices/{deviceUid}
200

Example response

Delete a device

delete
/tenants/{tenantUid}/devices/{deviceUid}

Deletes a device.

Required permission: TENANT.ADMIN

Authorizations
AuthorizationstringRequired

Token received from the auth service

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
deviceUidstringRequired

Reference to a device

Pattern: ^[A-Za-z0-9-_]+
Responses
delete
/tenants/{tenantUid}/devices/{deviceUid}
204

No Content

No content

Last updated

Was this helpful?