Store

Store

Get all numberseries

get

List all numberseries for a tenant.

Authorizations

accessTokenauthTokenintegrationToken

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

Available options:

Responses

application/json

objectoptional

get

HTTPcURLJavaScriptPython

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

Add a new numberseries to a tenant.

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

Body

endintegerrequired

namestringrequired

startintegerrequired

typestring · enumrequiredAvailable options:

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

Responses

application/json

objectoptional

post

HTTPcURLJavaScriptPython

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

Get a specific numberseries for a tenant.

Authorizations

accessTokenauthTokenintegrationToken

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

application/json

objectoptional

get

HTTPcURLJavaScriptPython

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

Update numberseries record.

Authorizations

accessTokenauthTokenintegrationToken

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

application/json

objectoptional

put

HTTPcURLJavaScriptPython

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

List all stores.

Authorizations

accessTokenauthTokenintegrationToken

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

Available options:

storeOrganizationUidstringoptional

Reference to an organization uid.

Responses

application/json

objectoptional

get

HTTPcURLJavaScriptPython

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": "2025-04-18T00:52:21.065Z",
      "defaultWarehouseUid": "text",
      "defaultReturnWarehouseUid": "text",
      "defaultDeliveryWarehouseUid": "text",
      "email": "text",
      "externalId": "text",
      "isActive": true,
      "lastModifiedAt": "2025-04-18T00:52:21.065Z",
      "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": true,
      "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

Creates a new store.

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

Body

all ofoptional

Responses

application/json

objectoptional

post

HTTPcURLJavaScriptPython

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

{
  "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": true,
  "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": "2025-04-18T00:52:21.065Z",
  "defaultWarehouseUid": "text",
  "defaultReturnWarehouseUid": "text",
  "defaultDeliveryWarehouseUid": "text",
  "email": "text",
  "externalId": "text",
  "isActive": true,
  "lastModifiedAt": "2025-04-18T00:52:21.065Z",
  "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": true,
  "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

Get details for a store.

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

storeUidstringrequired

Reference to a Store.

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

tenantUidstringrequired

Reference to a tenant.

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

Responses

application/json

objectoptional

get

HTTPcURLJavaScriptPython

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": "2025-04-18T00:52:21.065Z",
  "defaultWarehouseUid": "text",
  "defaultReturnWarehouseUid": "text",
  "defaultDeliveryWarehouseUid": "text",
  "email": "text",
  "externalId": "text",
  "isActive": true,
  "lastModifiedAt": "2025-04-18T00:52:21.065Z",
  "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": true,
  "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

Update details for a store. Partial updates are allowed.

Authorizations

accessTokenauthTokenintegrationToken

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-_]*

settingsobject[]optional

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-_]*

openingHoursobjectoptional

bankInfoobjectoptional

websiteUrlstringoptional

Responses

application/json

objectoptional

put

HTTPcURLJavaScriptPython

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: 1017

{
  "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": true,
  "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": "2025-04-18T00:52:21.065Z",
  "defaultWarehouseUid": "text",
  "defaultReturnWarehouseUid": "text",
  "defaultDeliveryWarehouseUid": "text",
  "email": "text",
  "externalId": "text",
  "isActive": true,
  "lastModifiedAt": "2025-04-18T00:52:21.065Z",
  "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": true,
  "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

Deletes a store.

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

storeUidstringrequired

Reference to a Store.

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

tenantUidstringrequired

Reference to a tenant.

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

Responses

delete

HTTPcURLJavaScriptPython

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

Get till information by token information

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

storeUidstringrequired

Reference to a Store.

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

Responses

application/json

objectoptional

get

HTTPcURLJavaScriptPython

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": "2025-04-18T00:52:21.065Z",
  "deviceIdentifier": "text",
  "lastModifiedAt": "2025-04-18T00:52:21.065Z",
  "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

Get till status by using token information

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

storeUidstringrequired

Reference to a Store.

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

Responses

application/json

objectoptional

Cash report for a till

get

HTTPcURLJavaScriptPython

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": "2025-04-18T00:52:21.065Z",
  "closedByDisplayName": "text",
  "comment": "text",
  "countedAmount": 1,
  "openAt": "2025-04-18T00:52:21.065Z",
  "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

Set a new till status by token information

Authorizations

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 · enumrequiredAvailable options:

cashDetailsobject[]optional

Responses

application/json

objectoptional

Cash report for a till

post

HTTPcURLJavaScriptPython

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": "2025-04-18T00:52:21.065Z",
  "closedByDisplayName": "text",
  "comment": "text",
  "countedAmount": 1,
  "openAt": "2025-04-18T00:52:21.065Z",
  "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

Lists all tills.

Authorizations

accessTokenauthTokenintegrationToken

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

Available options:

Responses

application/json

objectoptional

get

HTTPcURLJavaScriptPython

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": "2025-04-18T00:52:21.065Z",
      "deviceIdentifier": "text",
      "lastModifiedAt": "2025-04-18T00:52:21.065Z",
      "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

Creates a new till. Access required: STORE ADMIN

Authorizations

accessTokenauthTokenintegrationToken

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 · enumoptionalAvailable options:

receiptPrinterstringoptional

regularPrinterstringoptional

settingsobject[]optional

Till specific settings

tillNumberintegerrequired

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

appSettingsobjectoptional

Responses

application/json

objectoptional

post

HTTPcURLJavaScriptPython

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": "2025-04-18T00:52:21.065Z",
  "deviceIdentifier": "text",
  "lastModifiedAt": "2025-04-18T00:52:21.065Z",
  "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

Get details for a till.

Authorizations

accessTokenauthTokenintegrationToken

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

application/json

objectoptional

get

HTTPcURLJavaScriptPython

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": "2025-04-18T00:52:21.065Z",
  "deviceIdentifier": "text",
  "lastModifiedAt": "2025-04-18T00:52:21.065Z",
  "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

Updates details for a till. Access required: STORE ADMIN

Authorizations

accessTokenauthTokenintegrationToken

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 · enumoptionalAvailable options:

receiptPrinterstringoptional

regularPrinterstringoptional

settingsobject[]optional

Till specific settings

tillNumberintegeroptional

appSettingsobjectoptional

Responses

application/json

objectoptional

put

HTTPcURLJavaScriptPython

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": "2025-04-18T00:52:21.065Z",
  "deviceIdentifier": "text",
  "lastModifiedAt": "2025-04-18T00:52:21.065Z",
  "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

Deletes a till. Access required: STORE ADMIN

Authorizations

accessTokenauthTokenintegrationToken

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

delete

HTTPcURLJavaScriptPython

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

Get cashdrawer status for the cashdrawer connect to the current till

Authorizations

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

application/json

objectoptional

get

HTTPcURLJavaScriptPython

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

Open the cashdrawer for the current till

Authorizations

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

post

HTTPcURLJavaScriptPython

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

Get a cash report

Authorizations

accessTokenauthTokenintegrationToken

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

Available options:

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

application/json

objectoptional

get

HTTPcURLJavaScriptPython

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": "2025-04-18T00:52:21.065Z",
      "closedByDisplayName": "text",
      "comment": "text",
      "countedAmount": 1,
      "openAt": "2025-04-18T00:52:21.065Z",
      "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

Get cash control details

Authorizations

accessTokenauthTokenintegrationToken

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

application/json

objectoptional

Cash report for a till

application/json

get

HTTPcURLJavaScriptPython

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": "2025-04-18T00:52:21.065Z",
  "closedByDisplayName": "text",
  "comment": "text",
  "countedAmount": 1,
  "openAt": "2025-04-18T00:52:21.065Z",
  "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

Update cash report

Authorizations

accessTokenauthTokenintegrationToken

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

application/json

objectoptional

Cash report for a till

put

HTTPcURLJavaScriptPython

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": "2025-04-18T00:52:21.065Z",
  "closedByDisplayName": "text",
  "comment": "text",
  "countedAmount": 1,
  "openAt": "2025-04-18T00:52:21.065Z",
  "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

Withdraw or deposit cash at cashdrawer

Authorizations

accessTokenauthTokenintegrationToken

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

post

HTTPcURLJavaScriptPython

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

OK

No Content

Register a device on for a till

post

Register a new device to a till. Access required: STORE ADMIN

Authorizations

accessTokenauthTokenintegrationToken

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

post

HTTPcURLJavaScriptPython

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

OK

No Content

Remove a device from a till

delete

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

Authorizations

accessTokenauthTokenintegrationToken

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

application/json

objectoptional

delete

HTTPcURLJavaScriptPython

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": "2025-04-18T00:52:21.065Z",
  "deviceIdentifier": "text",
  "lastModifiedAt": "2025-04-18T00:52:21.065Z",
  "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

Get till status by using token information and storeUid from url

Authorizations

authTokenintegrationToken

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

application/json

objectoptional

Cash report for a till

get

HTTPcURLJavaScriptPython

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": "2025-04-18T00:52:21.065Z",
  "closedByDisplayName": "text",
  "comment": "text",
  "countedAmount": 1,
  "openAt": "2025-04-18T00:52:21.065Z",
  "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

List all visitor records for a list of stores

Authorizations

accessTokenauthTokenintegrationToken

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

Available options:

Body

fromDateTimestring · date-timerequired

toDateTimestring · date-timerequired

storeUidsstring[]required

Responses

application/json

objectoptional

post

HTTPcURLJavaScriptPython

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": "2025-04-18T00:52:21.065Z",
  "toDateTime": "2025-04-18T00:52:21.065Z",
  "storeUids": [
    "text"
  ]
}

200

Example response

{
  "items": [
    {
      "storeVisitorUid": "text",
      "storeUid": "text",
      "dateTime": "2025-04-18T00:52:21.065Z",
      "visitorCount": 1
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}