Till
Till
Lists all tills.
Access token recevied after user login with a deviceToken
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Example response
GET /v2/tenants/{tenantUid}/stores/{storeUid}/tills HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"cashDrawer": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"lastModifiedAt": "2026-01-01T00:00:00.000Z",
"lastOrderUid": "text",
"lastOrderNumber": "text",
"name": "text",
"paymentTerminal": "NONE",
"settings": [
{
"key": "STRIPE_TERMINAL_ID",
"value": "text"
}
],
"tillUid": "text",
"tillNumber": 1,
"device": {
"deviceUid": "text",
"identifier": "text",
"name": "text"
}
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Creates a new till.
Required permissions: TILL
Access token recevied after user login with a deviceToken
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Create a new till
NOTE: This field is deprecated. Printers should be defined on the device
NOTE: This field is deprecated. Printers should be defined on the device
NOTE: This field is deprecated. Printers should be defined on the device
^[A-Za-z0-9-_]+Example response
NOTE: This field is deprecated. Printers should be defined on the device
^[A-Za-z0-9-_]+NOTE: This field is deprecated. Printers should be defined on the device
NOTE: This field is deprecated. Printers should be defined on the device
^[A-Za-z0-9-_]+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: 149
{
"cashDrawer": "text",
"name": "text",
"paymentTerminal": "NONE",
"settings": [
{
"key": "STRIPE_TERMINAL_ID",
"value": "text"
}
],
"tillNumber": 1,
"tillUid": "text"
}Example response
{
"cashDrawer": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"lastModifiedAt": "2026-01-01T00:00:00.000Z",
"lastOrderUid": "text",
"lastOrderNumber": "text",
"name": "text",
"paymentTerminal": "NONE",
"settings": [
{
"key": "STRIPE_TERMINAL_ID",
"value": "text"
}
],
"tillUid": "text",
"tillNumber": 1,
"device": {
"deviceUid": "text",
"identifier": "text",
"name": "text"
}
}Get details for a till.
Access token recevied after user login with a deviceToken
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a till.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Example response
NOTE: This field is deprecated. Printers should be defined on the device
^[A-Za-z0-9-_]+NOTE: This field is deprecated. Printers should be defined on the device
NOTE: This field is deprecated. Printers should be defined on the device
^[A-Za-z0-9-_]+GET /v2/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"cashDrawer": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"lastModifiedAt": "2026-01-01T00:00:00.000Z",
"lastOrderUid": "text",
"lastOrderNumber": "text",
"name": "text",
"paymentTerminal": "NONE",
"settings": [
{
"key": "STRIPE_TERMINAL_ID",
"value": "text"
}
],
"tillUid": "text",
"tillNumber": 1,
"device": {
"deviceUid": "text",
"identifier": "text",
"name": "text"
}
}Updates details for a till.
Required permissions: TILL
Access token recevied after user login with a deviceToken
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a till.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Update till
NOTE: This field is deprecated. Printers should be defined on the device
NOTE: This field is deprecated. Printers should be defined on the device
NOTE: This field is deprecated. Printers should be defined on the device
Example response
NOTE: This field is deprecated. Printers should be defined on the device
^[A-Za-z0-9-_]+NOTE: This field is deprecated. Printers should be defined on the device
NOTE: This field is deprecated. Printers should be defined on the device
^[A-Za-z0-9-_]+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: 132
{
"cashDrawer": "text",
"name": "text",
"paymentTerminal": "NONE",
"settings": [
{
"key": "STRIPE_TERMINAL_ID",
"value": "text"
}
],
"tillNumber": 1
}Example response
{
"cashDrawer": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"lastModifiedAt": "2026-01-01T00:00:00.000Z",
"lastOrderUid": "text",
"lastOrderNumber": "text",
"name": "text",
"paymentTerminal": "NONE",
"settings": [
{
"key": "STRIPE_TERMINAL_ID",
"value": "text"
}
],
"tillUid": "text",
"tillNumber": 1,
"device": {
"deviceUid": "text",
"identifier": "text",
"name": "text"
}
}Deletes a till.
Required permissions: TILL
Access token recevied after user login with a deviceToken
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a till.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+No Content
No content
DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No Content
No content
Get cashdrawer status for a till
Get cashdrawer status for the cashdrawer connect to the current till
Access token recevied after user login with a deviceToken
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a till.
^[A-Za-z0-9-_]+Example response
Not Found
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 the cashdrawer for the current till
Required permissions: SALES_ORDER,RETURN_ORDER
Access token recevied after user login with a deviceToken
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a till.
^[A-Za-z0-9-_]+OK
No content
Not Found
Cashdrawer could not be opened
POST /v2/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashdrawer HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Get a cash report
Access token recevied after user login with a deviceToken
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a till.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Defines which field the resource list is sorted by.
Reference to a from-date.
Reference to a to-date.
Example response
GET /v2/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashreports HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"bankdepositAmount": 1,
"bankdepositReference": "text",
"cashDifferenceAmount": 1,
"cashRevenueAmount": 1,
"cashreportUid": "text",
"changeAmount": 1,
"closedAt": "2026-01-01T00:00:00.000Z",
"closedByDisplayName": "text",
"comment": "text",
"countedAmount": 1,
"openAt": "2026-01-01T00:00:00.000Z",
"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 cash control details
Access token recevied after user login with a deviceToken
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a till.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a cashreport.
^[A-Za-z0-9-_]+Example response
Cash report for a till
The cash difference amount.
Calculation: (countedAmount + withdrawalAmount ) - (changeAmount + cashRevenueAmount)
After the till is closed the cash revenue will be calculated in this field
^[A-Za-z0-9-_]+Linking failed. Ther error message will have information about what failed.
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-01T00:00:00.000Z",
"closedByDisplayName": "text",
"comment": "text",
"countedAmount": 1,
"openAt": "2026-01-01T00:00:00.000Z",
"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
The comment field can even be updated on a cashreport with status CLOSED.
All other fields can only be set as long as status is not CLOSED.
Required permissions: TILL_OPERATION
Access token recevied after user login with a deviceToken
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a till.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a cashreport.
^[A-Za-z0-9-_]+When till is opened this is the change amount, when closed this is the counted amount.
Example response
Cash report for a till
The cash difference amount.
Calculation: (countedAmount + withdrawalAmount ) - (changeAmount + cashRevenueAmount)
After the till is closed the cash revenue will be calculated in this field
^[A-Za-z0-9-_]+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: 207
{
"comment": "text",
"bankDepositAmount": 1,
"bankDepositReference": "text",
"cashAmount": 1,
"status": "OPEN",
"cashDetails": [
{
"currencyCode": "text",
"denomination": 1,
"material": "COIN",
"quantityCounted": 1,
"amount": 1
}
]
}Example response
{
"bankdepositAmount": 1,
"bankdepositReference": "text",
"cashDifferenceAmount": 1,
"cashRevenueAmount": 1,
"cashreportUid": "text",
"changeAmount": 1,
"closedAt": "2026-01-01T00:00:00.000Z",
"closedByDisplayName": "text",
"comment": "text",
"countedAmount": 1,
"openAt": "2026-01-01T00:00:00.000Z",
"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
Withdraw or deposit cash at cashdrawer
Required permissions: TILL_OPERATION
Access token recevied after user login with a deviceToken
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a till.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a cashreport.
^[A-Za-z0-9-_]+OK
No content
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"
}OK
No content
Register a new device to a till.
Required permissions: TILL
Access token recevied after user login with a deviceToken
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a till.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+OK
No content
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"
}OK
No content
Remove a device from a till.
Required permissions: TILL
Access token recevied after user login with a deviceToken
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a till.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Example response
NOTE: This field is deprecated. Printers should be defined on the device
^[A-Za-z0-9-_]+NOTE: This field is deprecated. Printers should be defined on the device
NOTE: This field is deprecated. Printers should be defined on the device
^[A-Za-z0-9-_]+DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/device HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"cashDrawer": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"lastModifiedAt": "2026-01-01T00:00:00.000Z",
"lastOrderUid": "text",
"lastOrderNumber": "text",
"name": "text",
"paymentTerminal": "NONE",
"settings": [
{
"key": "STRIPE_TERMINAL_ID",
"value": "text"
}
],
"tillUid": "text",
"tillNumber": 1,
"device": {
"deviceUid": "text",
"identifier": "text",
"name": "text"
}
}Get till status by using token information and storeUid from url
Token received from the auth service
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a till.
^[A-Za-z0-9-_]+Example response
Cash report for a till
The cash difference amount.
Calculation: (countedAmount + withdrawalAmount ) - (changeAmount + cashRevenueAmount)
After the till is closed the cash revenue will be calculated in this field
^[A-Za-z0-9-_]+GET /v2/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/status HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"bankdepositAmount": 1,
"bankdepositReference": "text",
"cashDifferenceAmount": 1,
"cashRevenueAmount": 1,
"cashreportUid": "text",
"changeAmount": 1,
"closedAt": "2026-01-01T00:00:00.000Z",
"closedByDisplayName": "text",
"comment": "text",
"countedAmount": 1,
"openAt": "2026-01-01T00:00:00.000Z",
"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
}
]
}Last updated