Store

Get all numberseries

get

/tenants/{tenantUid}/number-series

List all numberseries 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-_]+

Query parameters

numberSeriesTypestringOptional

The number series type

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}/number-series

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

200

Example response

{
  "items": [
    {
      "currentValue": 1,
      "end": 1,
      "name": "text",
      "numberSeriesUid": "text",
      "start": 1,
      "type": "PURCHASE"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Add new numberseries

post

/tenants/{tenantUid}/number-series

Add a new numberseries to 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

endintegerRequired

namestringRequired

startintegerRequired

typestring · enumRequiredPossible values:

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

Responses

200

Number series response

application/json

post

/tenants/{tenantUid}/number-series

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

{
  "end": 1,
  "name": "text",
  "start": 1,
  "type": "PURCHASE",
  "numberSeriesUid": "text"
}

200

Number series response

{
  "currentValue": 1,
  "end": 1,
  "name": "text",
  "numberSeriesUid": "text",
  "start": 1,
  "type": "PURCHASE"
}

Get a number serie

get

/tenants/{tenantUid}/number-series/{numberSeriesUid}

Get a specific numberseries 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-_]+

numberSeriesUidstringRequired

Reference to a number serie id.

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

Responses

200

Number series response

application/json

get

/tenants/{tenantUid}/number-series/{numberSeriesUid}

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

200

Number series response

{
  "currentValue": 1,
  "end": 1,
  "name": "text",
  "numberSeriesUid": "text",
  "start": 1,
  "type": "PURCHASE"
}

Update a number series record

put

/tenants/{tenantUid}/number-series/{numberSeriesUid}

Update numberseries record.

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

numberSeriesUidstringRequired

Reference to a number serie id.

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

Body

endintegerOptional

namestringRequired

startintegerOptional

Responses

200

Number series response

application/json

put

/tenants/{tenantUid}/number-series/{numberSeriesUid}

PUT /v2/tenants/{tenantUid}/number-series/{numberSeriesUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "end": 1,
  "name": "text",
  "start": 1
}

200

Number series response

{
  "currentValue": 1,
  "end": 1,
  "name": "text",
  "numberSeriesUid": "text",
  "start": 1,
  "type": "PURCHASE"
}

List stores

get

/tenants/{tenantUid}/stores

List all stores.

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Query parameters

storeExternalIdstringOptional

External reference to a store.

storeNamestringOptional

Reference to the name of a store.

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:

storeOrganizationUidstringOptional

Reference to an organization uid.

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/stores

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

200

Example response

{
  "items": [
    {
      "address": "text",
      "city": "text",
      "countryCode": "text",
      "createdAt": "2026-01-29T12:39:03.537Z",
      "defaultWarehouseUid": "text",
      "defaultReturnWarehouseUid": "text",
      "defaultDeliveryWarehouseUid": "text",
      "email": "text",
      "externalId": "text",
      "isActive": true,
      "lastModifiedAt": "2026-01-29T12:39:03.537Z",
      "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"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create a new store

post

/tenants/{tenantUid}/stores

Creates a new store.

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Body

and

Responses

200

Example response

application/json

post

/tenants/{tenantUid}/stores

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

{
  "address": "text",
  "city": "text",
  "countryCode": "text",
  "defaultReturnWarehouseUid": "text",
  "defaultWarehouseUid": "text",
  "defaultDeliveryWarehouseUid": "text",
  "email": "text",
  "externalId": "text",
  "isActive": true,
  "latitude": 1,
  "longitude": 1,
  "name": "text",
  "phone": "text",
  "postalCode": "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"
    }
  ],
  "vatNumber": "text",
  "voucherNumberSeriesUid": "text",
  "hasWorkshop": false,
  "organizationUid": "text",
  "serviceNumberSeriesUid": "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",
  "storeUid": "text"
}

200

Example response

{
  "address": "text",
  "city": "text",
  "countryCode": "text",
  "createdAt": "2026-01-29T12:39:03.537Z",
  "defaultWarehouseUid": "text",
  "defaultReturnWarehouseUid": "text",
  "defaultDeliveryWarehouseUid": "text",
  "email": "text",
  "externalId": "text",
  "isActive": true,
  "lastModifiedAt": "2026-01-29T12:39:03.537Z",
  "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"
}

Get store details

get

/tenants/{tenantUid}/stores/{storeUid}

Get details for a store.

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

tenantUidstringRequired

Reference to a tenant.

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

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/stores/{storeUid}

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

200

Example response

{
  "address": "text",
  "city": "text",
  "countryCode": "text",
  "createdAt": "2026-01-29T12:39:03.537Z",
  "defaultWarehouseUid": "text",
  "defaultReturnWarehouseUid": "text",
  "defaultDeliveryWarehouseUid": "text",
  "email": "text",
  "externalId": "text",
  "isActive": true,
  "lastModifiedAt": "2026-01-29T12:39:03.537Z",
  "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"
}

Update store details

put

/tenants/{tenantUid}/stores/{storeUid}

Update details for a store. Partial updates are allowed.

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

tenantUidstringRequired

Reference to a tenant.

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

Body

addressstringOptional

bankAccountNumberstringOptionalDeprecated

citystringOptional

countryCodestringOptional

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

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

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

emailstringOptional

externalIdstringOptional

isActivebooleanOptional

latitudenumberOptional

longitudenumberOptional

namestringOptional

phonestringOptional

postalCodestringOptional

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

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

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

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

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

receiptMessagestringOptional

emailReceiptMessagestringOptional

exchangenoteMessagestringOptional

exchangenoteValidDaysintegerOptional

Number of days an exchangenote is valid.

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

vatNumberstringOptional

VAT identification number for value added tax reporting purposes.

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

hasWorkshopbooleanOptionalDefault: false

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

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

websiteUrlstringOptional

Responses

201

Example response

application/json

put

/tenants/{tenantUid}/stores/{storeUid}

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

{
  "address": "text",
  "city": "text",
  "countryCode": "text",
  "defaultReturnWarehouseUid": "text",
  "defaultWarehouseUid": "text",
  "defaultDeliveryWarehouseUid": "text",
  "email": "text",
  "externalId": "text",
  "isActive": true,
  "latitude": 1,
  "longitude": 1,
  "name": "text",
  "phone": "text",
  "postalCode": "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"
    }
  ],
  "vatNumber": "text",
  "voucherNumberSeriesUid": "text",
  "hasWorkshop": false,
  "organizationUid": "text",
  "serviceNumberSeriesUid": "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"
}

201

Example response

{
  "address": "text",
  "city": "text",
  "countryCode": "text",
  "createdAt": "2026-01-29T12:39:03.537Z",
  "defaultWarehouseUid": "text",
  "defaultReturnWarehouseUid": "text",
  "defaultDeliveryWarehouseUid": "text",
  "email": "text",
  "externalId": "text",
  "isActive": true,
  "lastModifiedAt": "2026-01-29T12:39:03.537Z",
  "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"
}

Delete a store

delete

/tenants/{tenantUid}/stores/{storeUid}

Deletes a store.

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

tenantUidstringRequired

Reference to a tenant.

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

Responses

204

No Content

delete

/tenants/{tenantUid}/stores/{storeUid}

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

204

No Content

No content

Get Till by token information

get

/tenants/{tenantUid}/stores/{storeUid}/till

Get till information by token information

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

Responses

200

Example response

application/json

404

Not Found

get

/tenants/{tenantUid}/stores/{storeUid}/till

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

{
  "barcodePrinter": "text",
  "cashDrawer": "text",
  "createdAt": "2026-01-29T12:39:03.537Z",
  "deviceIdentifier": "text",
  "lastModifiedAt": "2026-01-29T12:39:03.537Z",
  "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"
  }
}

Get till status details by token information

get

/tenants/{tenantUid}/stores/{storeUid}/till/status

Get till status by using token information

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/stores/{storeUid}/till/status

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

200

Example response

{
  "bankdepositAmount": 1,
  "bankdepositReference": "text",
  "cashDifferenceAmount": 1,
  "cashRevenueAmount": 1,
  "cashreportUid": "text",
  "changeAmount": 1,
  "closedAt": "2026-01-29T12:39:03.537Z",
  "closedByDisplayName": "text",
  "comment": "text",
  "countedAmount": 1,
  "openAt": "2026-01-29T12:39:03.537Z",
  "openByDisplayName": "text",
  "status": "OPEN",
  "withdrawalAmount": 1,
  "cashDetailsAtOpen": [
    {
      "currencyCode": "text",
      "denomination": 1,
      "material": "COIN",
      "quantityCounted": 1,
      "amount": 1
    }
  ],
  "cashDetailsAtClose": [
    {
      "currencyCode": "text",
      "denomination": 1,
      "material": "COIN",
      "quantityCounted": 1,
      "amount": 1
    }
  ]
}

Set a new till status by token information

post

/tenants/{tenantUid}/stores/{storeUid}/till/status

Set a new till status by token information

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

Body

bankdepositAmountintegerOptional

The amount that should be withdrawed from the till and deposited to night safe when the till is closed.

bankdepositReferencestringOptional

An optional reference to the bank deposit

cashAmountintegerOptional

When the till is opened this is the change amount. When the till is closed this is the counted amount

statusstring · enumRequiredPossible values:

Responses

200

Example response

application/json

post

/tenants/{tenantUid}/stores/{storeUid}/till/status

POST /v2/tenants/{tenantUid}/stores/{storeUid}/till/status HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 190

{
  "bankdepositAmount": 1,
  "bankdepositReference": "text",
  "cashAmount": 1,
  "status": "OPEN",
  "cashDetails": [
    {
      "currencyCode": "text",
      "denomination": 1,
      "material": "COIN",
      "quantityCounted": 1,
      "amount": 1
    }
  ]
}

200

Example response

{
  "bankdepositAmount": 1,
  "bankdepositReference": "text",
  "cashDifferenceAmount": 1,
  "cashRevenueAmount": 1,
  "cashreportUid": "text",
  "changeAmount": 1,
  "closedAt": "2026-01-29T12:39:03.537Z",
  "closedByDisplayName": "text",
  "comment": "text",
  "countedAmount": 1,
  "openAt": "2026-01-29T12:39:03.537Z",
  "openByDisplayName": "text",
  "status": "OPEN",
  "withdrawalAmount": 1,
  "cashDetailsAtOpen": [
    {
      "currencyCode": "text",
      "denomination": 1,
      "material": "COIN",
      "quantityCounted": 1,
      "amount": 1
    }
  ],
  "cashDetailsAtClose": [
    {
      "currencyCode": "text",
      "denomination": 1,
      "material": "COIN",
      "quantityCounted": 1,
      "amount": 1
    }
  ]
}

List tills

get

/tenants/{tenantUid}/stores/{storeUid}/tills

Lists all tills.

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

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:

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/stores/{storeUid}/tills

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

200

Example response

{
  "items": [
    {
      "barcodePrinter": "text",
      "cashDrawer": "text",
      "createdAt": "2026-01-29T12:39:03.537Z",
      "deviceIdentifier": "text",
      "lastModifiedAt": "2026-01-29T12:39:03.537Z",
      "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"
      }
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create a new till

post

/tenants/{tenantUid}/stores/{storeUid}/tills

Creates a new till. Access required: STORE ADMIN

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

tenantUidstringRequired

Reference to a tenant.

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

Body

Create a new till

barcodePrinterstringOptional

cashDrawerstringOptional

namestringRequired

paymentTerminalstring · enumOptionalPossible values:

receiptPrinterstringOptional

regularPrinterstringOptional

tillNumberintegerRequired

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

Responses

200

Example response

application/json

post

/tenants/{tenantUid}/stores/{storeUid}/tills

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

{
  "barcodePrinter": "text",
  "cashDrawer": "text",
  "name": "text",
  "paymentTerminal": "NONE",
  "receiptPrinter": "text",
  "regularPrinter": "text",
  "settings": [
    {
      "key": "STRIPE_TERMINAL_ID",
      "value": "text"
    }
  ],
  "tillNumber": 1,
  "tillUid": "text",
  "appSettings": {
    "saleStopAtDelivery": true,
    "autoLogout": 1,
    "touchMode": "UNAVAILABLE"
  }
}

200

Example response

{
  "barcodePrinter": "text",
  "cashDrawer": "text",
  "createdAt": "2026-01-29T12:39:03.537Z",
  "deviceIdentifier": "text",
  "lastModifiedAt": "2026-01-29T12:39:03.537Z",
  "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"
  }
}

Get till details

get

/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}

Get details for a till.

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

tillUidstringRequired

Reference to a till.

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

tenantUidstringRequired

Reference to a tenant.

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

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}

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

200

Example response

{
  "barcodePrinter": "text",
  "cashDrawer": "text",
  "createdAt": "2026-01-29T12:39:03.537Z",
  "deviceIdentifier": "text",
  "lastModifiedAt": "2026-01-29T12:39:03.537Z",
  "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"
  }
}

Update till details

put

/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}

Updates details for a till. Access required: STORE ADMIN

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

tillUidstringRequired

Reference to a till.

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

tenantUidstringRequired

Reference to a tenant.

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

Body

Update till

barcodePrinterstringOptional

cashDrawerstringOptional

namestringOptional

paymentTerminalstring · enumOptionalPossible values:

receiptPrinterstringOptional

regularPrinterstringOptional

tillNumberintegerOptional

Responses

200

Example response

application/json

put

/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}

PUT /v2/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 287

{
  "barcodePrinter": "text",
  "cashDrawer": "text",
  "name": "text",
  "paymentTerminal": "NONE",
  "receiptPrinter": "text",
  "regularPrinter": "text",
  "settings": [
    {
      "key": "STRIPE_TERMINAL_ID",
      "value": "text"
    }
  ],
  "tillNumber": 1,
  "appSettings": {
    "saleStopAtDelivery": true,
    "autoLogout": 1,
    "touchMode": "UNAVAILABLE"
  }
}

200

Example response

{
  "barcodePrinter": "text",
  "cashDrawer": "text",
  "createdAt": "2026-01-29T12:39:03.537Z",
  "deviceIdentifier": "text",
  "lastModifiedAt": "2026-01-29T12:39:03.537Z",
  "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"
  }
}

Delete a till

delete

/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}

Deletes a till. Access required: STORE ADMIN

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

tillUidstringRequired

Reference to a till.

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

tenantUidstringRequired

Reference to a tenant.

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

Responses

204

No Content

delete

/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}

DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content

Get cashdrawer status for a till

get

/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashdrawer

Get cashdrawer status for the cashdrawer connect to the current till

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

tenantUidstringRequired

Reference to a tenant.

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

tillUidstringRequired

Reference to a till.

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

Responses

200

Example response

application/json

404

Not Found

get

/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashdrawer

GET /v2/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashdrawer HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "OPEN"
}

Open cashdrawer

post

/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashdrawer

Open the cashdrawer for the current till

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

tenantUidstringRequired

Reference to a tenant.

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

tillUidstringRequired

Reference to a till.

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

Responses

200

No content

404

Not Found

406

Cashdrawer could not be opened

post

/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashdrawer

POST /v2/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashdrawer HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List all cash control reports

get

/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashreports

Get a cash report

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

tillUidstringRequired

Reference to a till.

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

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.

sortDirectionstring · enumOptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Possible values:

sortBystringOptional

Defines which field the resource list is sorted by.

cashreportFromDatestring · dateOptional

Reference to a from-date.

cashreportToDatestring · dateOptional

Reference to a to-date.

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashreports

GET /v2/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashreports HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "bankdepositAmount": 1,
      "bankdepositReference": "text",
      "cashDifferenceAmount": 1,
      "cashRevenueAmount": 1,
      "cashreportUid": "text",
      "changeAmount": 1,
      "closedAt": "2026-01-29T12:39:03.537Z",
      "closedByDisplayName": "text",
      "comment": "text",
      "countedAmount": 1,
      "openAt": "2026-01-29T12:39:03.537Z",
      "openByDisplayName": "text",
      "status": "OPEN",
      "withdrawalAmount": 1,
      "cashDetailsAtOpen": [
        {
          "currencyCode": "text",
          "denomination": 1,
          "material": "COIN",
          "quantityCounted": 1,
          "amount": 1
        }
      ],
      "cashDetailsAtClose": [
        {
          "currencyCode": "text",
          "denomination": 1,
          "material": "COIN",
          "quantityCounted": 1,
          "amount": 1
        }
      ]
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Get a specific cash report

get

/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashreports/{cashreportUid}

Get cash control details

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

tillUidstringRequired

Reference to a till.

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

tenantUidstringRequired

Reference to a tenant.

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

cashreportUidstringRequired

Reference to a cashreport.

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

Responses

200

Example response

application/json

404

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

application/json

get

/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashreports/{cashreportUid}

GET /v2/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashreports/{cashreportUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "bankdepositAmount": 1,
  "bankdepositReference": "text",
  "cashDifferenceAmount": 1,
  "cashRevenueAmount": 1,
  "cashreportUid": "text",
  "changeAmount": 1,
  "closedAt": "2026-01-29T12:39:03.537Z",
  "closedByDisplayName": "text",
  "comment": "text",
  "countedAmount": 1,
  "openAt": "2026-01-29T12:39:03.537Z",
  "openByDisplayName": "text",
  "status": "OPEN",
  "withdrawalAmount": 1,
  "cashDetailsAtOpen": [
    {
      "currencyCode": "text",
      "denomination": 1,
      "material": "COIN",
      "quantityCounted": 1,
      "amount": 1
    }
  ],
  "cashDetailsAtClose": [
    {
      "currencyCode": "text",
      "denomination": 1,
      "material": "COIN",
      "quantityCounted": 1,
      "amount": 1
    }
  ]
}

Update cash report

put

/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashreports/{cashreportUid}

Update cash report

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

tillUidstringRequired

Reference to a till.

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

tenantUidstringRequired

Reference to a tenant.

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

cashreportUidstringRequired

Reference to a cashreport.

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

Body

commentstringOptional

Responses

200

Example response

application/json

put

/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashreports/{cashreportUid}

PUT /v2/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashreports/{cashreportUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "comment": "text"
}

200

Example response

{
  "bankdepositAmount": 1,
  "bankdepositReference": "text",
  "cashDifferenceAmount": 1,
  "cashRevenueAmount": 1,
  "cashreportUid": "text",
  "changeAmount": 1,
  "closedAt": "2026-01-29T12:39:03.537Z",
  "closedByDisplayName": "text",
  "comment": "text",
  "countedAmount": 1,
  "openAt": "2026-01-29T12:39:03.537Z",
  "openByDisplayName": "text",
  "status": "OPEN",
  "withdrawalAmount": 1,
  "cashDetailsAtOpen": [
    {
      "currencyCode": "text",
      "denomination": 1,
      "material": "COIN",
      "quantityCounted": 1,
      "amount": 1
    }
  ],
  "cashDetailsAtClose": [
    {
      "currencyCode": "text",
      "denomination": 1,
      "material": "COIN",
      "quantityCounted": 1,
      "amount": 1
    }
  ]
}

Withdraw or deposit cash at cashdrawer

post

/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashreports/{cashreportUid}/withdrawals

Withdraw or deposit cash at cashdrawer

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

tillUidstringRequired

Reference to a till.

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

tenantUidstringRequired

Reference to a tenant.

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

cashreportUidstringRequired

Reference to a cashreport.

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

Body

amountintegerRequired

commentstringRequired

Responses

200

No content

post

/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashreports/{cashreportUid}/withdrawals

POST /v2/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashreports/{cashreportUid}/withdrawals HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "amount": 1,
  "comment": "text"
}

200

No content

Register a device on for a till

post

/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/device

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

tillUidstringRequired

Reference to a till.

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

tenantUidstringRequired

Reference to a tenant.

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

Body

deviceIdentifierstringRequired

Responses

200

No content

post

/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/device

POST /v2/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/device HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "deviceIdentifier": "text"
}

200

No content

Remove a device from a till

delete

/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/device

Remove a device from a till. Access required: STORE ADMIN

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

tillUidstringRequired

Reference to a till.

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

tenantUidstringRequired

Reference to a tenant.

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

Responses

200

Example response

application/json

delete

/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/device

DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/device HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "barcodePrinter": "text",
  "cashDrawer": "text",
  "createdAt": "2026-01-29T12:39:03.537Z",
  "deviceIdentifier": "text",
  "lastModifiedAt": "2026-01-29T12:39:03.537Z",
  "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"
  }
}

Get till status details by tillUid

get

/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/status

Get till status by using token information and storeUid from url

Authorizations

AuthorizationstringRequired

Token received from the auth service

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

tillUidstringRequired

Reference to a till.

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

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/status

GET /v2/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/status HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "bankdepositAmount": 1,
  "bankdepositReference": "text",
  "cashDifferenceAmount": 1,
  "cashRevenueAmount": 1,
  "cashreportUid": "text",
  "changeAmount": 1,
  "closedAt": "2026-01-29T12:39:03.537Z",
  "closedByDisplayName": "text",
  "comment": "text",
  "countedAmount": 1,
  "openAt": "2026-01-29T12:39:03.537Z",
  "openByDisplayName": "text",
  "status": "OPEN",
  "withdrawalAmount": 1,
  "cashDetailsAtOpen": [
    {
      "currencyCode": "text",
      "denomination": 1,
      "material": "COIN",
      "quantityCounted": 1,
      "amount": 1
    }
  ],
  "cashDetailsAtClose": [
    {
      "currencyCode": "text",
      "denomination": 1,
      "material": "COIN",
      "quantityCounted": 1,
      "amount": 1
    }
  ]
}

List all visitor records for a list of stores

post

/tenants/{tenantUid}/stores/visitors

List all visitor records for a list of stores

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Query parameters

pageSizeintegerOptional

The number of items per page in a result set.

pageNumberintegerOptional

Reference to a specific 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

fromDateTimestring · date-timeRequired

toDateTimestring · date-timeRequired

storeUidsstring[]Required

Responses

200

Example response

application/json

post

/tenants/{tenantUid}/stores/visitors

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

{
  "fromDateTime": "2026-01-29T12:39:03.537Z",
  "toDateTime": "2026-01-29T12:39:03.537Z",
  "storeUids": [
    "text"
  ]
}

200

Example response

{
  "items": [
    {
      "storeVisitorUid": "text",
      "storeUid": "text",
      "dateTime": "2026-01-29T12:39:03.537Z",
      "visitorCount": 1
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

PreviousStocktaking NextSupplier

Last updated 9 months ago

Was this helpful?

hashtagGet all numberseries

hashtagAdd new numberseries

hashtagGet a number serie

hashtagUpdate a number series record

hashtagList stores

hashtagCreate a new store

hashtagGet store details

hashtagUpdate store details

hashtagDelete a store

hashtagGet Till by token information

hashtagGet till status details by token information

hashtagSet a new till status by token information

hashtagList tills

hashtagCreate a new till

hashtagGet till details

hashtagUpdate till details

hashtagDelete a till

hashtagGet cashdrawer status for a till

hashtagOpen cashdrawer

hashtagList all cash control reports

hashtagGet a specific cash report

hashtagUpdate cash report

hashtagWithdraw or deposit cash at cashdrawer

hashtagRegister a device on for a till

hashtagRemove a device from a till

hashtagGet till status details by tillUid

hashtagList all visitor records for a list of stores

Get all numberseries

Add new numberseries

Get a number serie

Update a number series record

List stores

Create a new store

Get store details

Update store details

Delete a store

Get Till by token information

Get till status details by token information

Set a new till status by token information

List tills

Create a new till

Get till details

Update till details

Delete a till

Get cashdrawer status for a till

Open cashdrawer

List all cash control reports

Get a specific cash report

Update cash report

Withdraw or deposit cash at cashdrawer

Register a device on for a till

Remove a device from a till

Get till status details by tillUid

List all visitor records for a list of stores