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

Info for a device

deviceIdentifierstringRequired

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

namestringRequired

get

/device

GET /v2/device HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "availablePaymentMethods": [
    {
      "allowRefund": true,
      "allowSale": true,
      "allowCashback": true,
      "allowAmount": true,
      "name": "text",
      "parameters": [
        {
          "name": "text",
          "description": "text",
          "required": true,
          "key": "text",
          "keyType": "TEXT",
          "regex": "text"
        }
      ],
      "paymentCode": "CASH",
      "storePaymentMethodUid": "text",
      "requirements": {
        "requireCustomer": true,
        "requireCustomerMobile": true,
        "requireCustomerEmail": true,
        "requireCustomerContact": true,
        "requireExclusiveUse": true
      },
      "settlementCode": "text",
      "visibility": "FEATURED",
      "position": 1,
      "description": "text"
    }
  ],
  "zeroAmountPaymentMethod": {
    "allowRefund": true,
    "allowSale": true,
    "allowCashback": true,
    "allowAmount": true,
    "name": "text",
    "parameters": [
      {
        "name": "text",
        "description": "text",
        "required": true,
        "key": "text",
        "keyType": "TEXT",
        "regex": "text"
      }
    ],
    "paymentCode": "CASH",
    "storePaymentMethodUid": "text",
    "requirements": {
      "requireCustomer": true,
      "requireCustomerMobile": true,
      "requireCustomerEmail": true,
      "requireCustomerContact": true,
      "requireExclusiveUse": true
    },
    "settlementCode": "text",
    "visibility": "FEATURED",
    "position": 1,
    "description": "text"
  },
  "availableReasons": {
    "discount": [
      {
        "code": "text",
        "description": "text"
      }
    ],
    "return": [
      {
        "code": "text",
        "description": "text"
      }
    ]
  },
  "deviceIdentifier": "text",
  "deviceUid": "text",
  "storeInfo": {
    "address": "text",
    "city": "text",
    "countryCode": "text",
    "createdAt": "2026-03-14T14:09:11.988Z",
    "defaultWarehouseUid": "text",
    "defaultReturnWarehouseUid": "text",
    "defaultDeliveryWarehouseUid": "text",
    "email": "text",
    "externalId": "text",
    "isActive": true,
    "lastModifiedAt": "2026-03-14T14:09:11.988Z",
    "latitude": 1,
    "longitude": 1,
    "name": "text",
    "postalCode": "text",
    "phone": "text",
    "purchaseNumberSeriesUid": "text",
    "internalPurchaseNumberSeriesUid": "text",
    "rmaOrderNumberSeriesUid": "text",
    "customerLedgerNumberSeriesUid": "text",
    "quicksaleCategoryUid": "text",
    "receiptMessage": "text",
    "emailReceiptMessage": "text",
    "exchangenoteMessage": "text",
    "exchangenoteValidDays": 1,
    "salesPriceUid": "text",
    "settings": [
      {
        "key": "VIPPS_MSN",
        "value": "text"
      }
    ],
    "storeUid": "text",
    "vatNumber": "text",
    "voucherNumberSeriesUid": "text",
    "serviceNumberSeriesUid": "text",
    "hasWorkShop": false,
    "organizationUid": "text",
    "availableExtensions": [
      {
        "extensionCode": "FLOWGIFTCARD",
        "name": "text"
      }
    ],
    "openingHours": {
      "monday": "text",
      "tuesday": "text",
      "wednesday": "text",
      "thursday": "text",
      "friday": "text",
      "saturday": "text",
      "sunday": "text",
      "note": "text"
    },
    "bankInfo": {
      "accountNumber": "text",
      "bankName": "text",
      "iban": "text",
      "swift": "text"
    },
    "websiteUrl": "text"
  },
  "tenantInfo": {
    "countryCode": "text",
    "createdAt": "2026-03-14T14:09:11.988Z",
    "lastModifiedAt": "2026-03-14T14:09:11.988Z",
    "name": "text",
    "pricelistUid": "text",
    "tenantUid": "text",
    "vatNumber": "text",
    "settings": {
      "allowExternalCashDrawer": false,
      "autoLogout": 1,
      "autoPrintReceipt": true,
      "numericSkuCounter": 1,
      "printCardPaymentDetails": false,
      "sendInvoicesExternally": true
    },
    "appSettings": {
      "showOutOfStockWarning": true
    },
    "extensions": [
      {
        "extensionCode": "FLOWGIFTCARD",
        "name": "text",
        "active": true
      }
    ],
    "assets": {
      "logo": {
        "url": "text",
        "assetUid": "text"
      },
      "splash": {
        "url": "text",
        "assetUid": "text"
      }
    },
    "timezone": "text",
    "languageCode": "text",
    "currency": {
      "code": "text",
      "name": "text",
      "symbol": "text",
      "symbolPosition": "text",
      "decimalSeparator": "text",
      "thousandSeparator": "text",
      "cashRounding": 1
    }
  },
  "tillInfo": {
    "barcodePrinter": "text",
    "cashDrawer": "text",
    "createdAt": "2026-03-14T14:09:11.988Z",
    "deviceIdentifier": "text",
    "lastModifiedAt": "2026-03-14T14:09:11.988Z",
    "lastOrderUid": "text",
    "lastOrderNumber": "text",
    "name": "text",
    "paymentTerminal": "NONE",
    "receiptPrinter": "text",
    "regularPrinter": "text",
    "settings": [
      {
        "key": "STRIPE_TERMINAL_ID",
        "value": "text"
      }
    ],
    "tillUid": "text",
    "tillNumber": 1,
    "appSettings": {
      "saleStopAtDelivery": true,
      "autoLogout": 1,
      "touchMode": "UNAVAILABLE"
    }
  },
  "currencyDenominations": [
    {
      "currencyCode": "text",
      "denomination": 1,
      "material": "COIN"
    }
  ],
  "name": "text",
  "settings": [
    {
      "key": "text",
      "value": "text",
      "type": "STRING",
      "allowedValues": [
        "text"
      ],
      "validationRegex": "text",
      "name": "text",
      "required": true
    }
  ],
  "printers": [
    {
      "printerUid": "text",
      "name": "text",
      "type": "LABEL"
    }
  ]
}

Deprecated

Register a new device (deprecated)

post

/device

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

deviceCodestring · min: 1Required

deviceIdentifierstring · min: 1Required

expires_inintegerRequired

intervalintegerRequired

verificationUristring · min: 1Required

post

/device

POST /v2/device HTTP/1.1
Host: api.flowretail.com
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "clientId": "text",
  "name": "text",
  "systemInformation": "text"
}

200

Example response

{
  "deviceCode": "text",
  "deviceIdentifier": "text",
  "expires_in": 1,
  "interval": 1,
  "verificationUri": "text"
}

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

204

No Content

put

/device

PUT /v2/device HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "systemInformation": "text"
}

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

No content

400

Linking failed. Ther error message will have information about what failed.

application/json

post

/device/authorize

POST /v2/device/authorize HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "deviceCode": "text",
  "storeUid": "text",
  "tenantUid": "text",
  "tillUid": "text",
  "name": "text"
}

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

expiresintegerRequired

The expiry time represented as a unix timestamp.

tokenstringRequired

A JWT device token

refreshTokenstringRequired

Refresh token to be used to renew the token

400

Linking failed. Ther error message will have information about what failed.

application/json

404

Not found

post

/device/{deviceCode}/link

POST /v2/device/{deviceCode}/link HTTP/1.1
Host: api.flowretail.com
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "appId": "text",
  "userCode": "text",
  "password": "text",
  "systemInformation": "text"
}

{
  "expires": 1,
  "token": "text",
  "refreshToken": "text"
}

Request a new device token

post

/device/token

Device Authorization Flow - Request a new token

Body

Responses

200

Link successfull.

application/json

expiresintegerRequired

tokenstringRequired

token_typestringRequired

400

Example response

application/json

404

Not Found

post

/device/token

POST /v2/device/token HTTP/1.1
Host: api.flowretail.com
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "appId": "text",
  "refreshToken": "text"
}

{
  "expires": 1,
  "token": "text",
  "token_type": "text"
}

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

400

Linking failed. Ther error message will have information about what failed.

application/json

get

/device/users

GET /v2/device/users HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "accountType": "FULL",
      "displayName": "text",
      "firstname": "text",
      "lastAccessed": "2026-03-14T14:09:11.988Z",
      "lastname": "text",
      "tenantUserUid": "text",
      "userCode": "text",
      "languageCode": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

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

GET /v2/tenants/{tenantUid}/devices HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "createdAt": "2026-03-14T14:09:11.988Z",
      "createdBy": "text",
      "deviceUid": "text",
      "identifier": "text",
      "lastModifiedAt": "2026-03-14T14:09:11.988Z",
      "lastModifiedBy": "text",
      "lastActivityAt": "2026-03-14T14:09:11.988Z",
      "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",
      "settings": [
        {
          "key": "text",
          "value": "text",
          "type": "STRING",
          "allowedValues": [
            "text"
          ],
          "validationRegex": "text",
          "name": "text",
          "required": true
        }
      ],
      "printers": [
        {
          "printerUid": "text",
          "name": "text",
          "type": "LABEL"
        }
      ]
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

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

201

Example response

application/json

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-03-14T14:09:11.988Z",
  "createdBy": "text",
  "deviceUid": "text",
  "identifier": "text",
  "lastModifiedAt": "2026-03-14T14:09:11.988Z",
  "lastModifiedBy": "text",
  "lastActivityAt": "2026-03-14T14:09:11.988Z",
  "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",
  "settings": [
    {
      "key": "text",
      "value": "text",
      "type": "STRING",
      "allowedValues": [
        "text"
      ],
      "validationRegex": "text",
      "name": "text",
      "required": true
    }
  ],
  "printers": [
    {
      "printerUid": "text",
      "name": "text",
      "type": "LABEL"
    }
  ]
}

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

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

{
  "name": "text",
  "deviceIdentifier": "text",
  "query": "text",
  "appCode": "CLIENT",
  "statuses": [
    "ACTIVE"
  ]
}

200

Example response

{
  "items": [
    {
      "createdAt": "2026-03-14T14:09:11.988Z",
      "createdBy": "text",
      "deviceUid": "text",
      "identifier": "text",
      "lastModifiedAt": "2026-03-14T14:09:11.988Z",
      "lastModifiedBy": "text",
      "lastActivityAt": "2026-03-14T14:09:11.988Z",
      "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",
      "settings": [
        {
          "key": "text",
          "value": "text",
          "type": "STRING",
          "allowedValues": [
            "text"
          ],
          "validationRegex": "text",
          "name": "text",
          "required": true
        }
      ],
      "printers": [
        {
          "printerUid": "text",
          "name": "text",
          "type": "LABEL"
        }
      ]
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

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

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

lastModifiedBystringOptional

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:

get

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

GET /v2/tenants/{tenantUid}/devices/{deviceUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "createdAt": "2026-03-14T14:09:11.988Z",
  "createdBy": "text",
  "deviceUid": "text",
  "identifier": "text",
  "lastModifiedAt": "2026-03-14T14:09:11.988Z",
  "lastModifiedBy": "text",
  "lastActivityAt": "2026-03-14T14:09:11.988Z",
  "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",
  "settings": [
    {
      "key": "text",
      "value": "text",
      "type": "STRING",
      "allowedValues": [
        "text"
      ],
      "validationRegex": "text",
      "name": "text",
      "required": true
    }
  ],
  "printers": [
    {
      "printerUid": "text",
      "name": "text",
      "type": "LABEL"
    }
  ]
}

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

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

lastModifiedBystringOptional

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:

put

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

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

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

200

Example response

{
  "createdAt": "2026-03-14T14:09:11.988Z",
  "createdBy": "text",
  "deviceUid": "text",
  "identifier": "text",
  "lastModifiedAt": "2026-03-14T14:09:11.988Z",
  "lastModifiedBy": "text",
  "lastActivityAt": "2026-03-14T14:09:11.988Z",
  "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",
  "settings": [
    {
      "key": "text",
      "value": "text",
      "type": "STRING",
      "allowedValues": [
        "text"
      ],
      "validationRegex": "text",
      "name": "text",
      "required": true
    }
  ],
  "printers": [
    {
      "printerUid": "text",
      "name": "text",
      "type": "LABEL"
    }
  ]
}

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

204

No Content

delete

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

DELETE /v2/tenants/{tenantUid}/devices/{deviceUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content

PreviousCustomerGroup NextExtensions

Last updated 11 months ago

Was this helpful?

hashtagGet device information

hashtagRegister a new device (deprecated)

hashtagUpdate systemInformation for a device

hashtagAccept Device (deprecated)

hashtagLink a physical device

hashtagRequest a new device token

hashtagList device users

hashtagList registered devices

hashtagCreate a new device

hashtagSearch registered devices

hashtagGet device details

hashtagUpdate device details

hashtagDelete a device

Get device information

Register a new device (deprecated)

Update systemInformation for a device

Accept Device (deprecated)

Link a physical device

Request a new device token

List device users

List registered devices

Create a new device

Search registered devices

Get device details

Update device details

Delete a device