Create a new device

Create a new device for a tenant

Required permissions: DEVICE

post

/tenants/{tenantUid}/devices

Authorizations

AuthorizationstringRequired

Access token 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

201

Example response

application/json

createdAtstring · date-timeRequired

createdBystringRequired

deviceUidstringRequiredPattern: ^[A-Za-z0-9-_]+

identifierstringRequired

A unique client identifier. This will be set when the client is linked.

lastModifiedAtstring · date-timeRequired

lastModifiedBystringRequired

lastActivityAtstring · date-time · nullableRequired

The timestamp indicating the most recent date and time when the device registered any activity.

lastTenantUserUidstringRequired

The tenantUserUid who interacted with this device most recently

namestringRequired

systemInformationstringRequired

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

statusstring · enumRequired

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:

deviceLinkCodestringRequired

The code that should be used to link the device to an app

lastOrderUidstringRequiredPattern: ^[A-Za-z0-9-_]*

appCodestring · enumRequired

Enum	Description
CLIENT	Flow Retail Client
ASSISTANT	Flow Retail Assistant
UNKNOWN	No specific app

Possible values:

appVersionstringRequired

400

Bad Request

post/tenants/{tenantUid}/devices

POST /v2/tenants/{tenantUid}/devices HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "deviceUid": "text",
  "name": "text",
  "appCode": "CLIENT",
  "storeUid": "text",
  "tillUid": "text",
  "settings": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "printerUids": [
    "text"
  ]
}

{
  "createdAt": "2026-01-01T00:00:00.000Z",
  "createdBy": "text",
  "deviceUid": "text",
  "identifier": "text",
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "lastModifiedBy": "text",
  "lastActivityAt": "2026-01-01T00:00:00.000Z",
  "lastTenantUserUid": "text",
  "name": "text",
  "systemInformation": "text",
  "status": "ACTIVE",
  "store": {
    "name": "text",
    "storeUid": "text",
    "organizationUid": "text"
  },
  "deviceLinkCode": "text",
  "lastOrderUid": "text",
  "till": {
    "tillUid": "text",
    "name": "text",
    "tillNumber": 1
  },
  "appCode": "CLIENT",
  "appVersion": "text",
  "settings": [
    {
      "key": "text",
      "value": "text",
      "type": "STRING",
      "allowedValues": [
        "text"
      ],
      "validationRegex": "text",
      "name": "text",
      "required": true
    }
  ],
  "printers": [
    {
      "printerUid": "text",
      "name": "text",
      "type": "LABEL",
      "availablePrintActions": [
        "RECEIPT"
      ]
    }
  ]
}