Reports
Reports
List all reports for an organization
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an organization.
^[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 |
List of available reports
GET /v2/tenants/{tenantUid}/organizations/{organizationUid}/reports HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
List of available reports
{
"items": [
{
"reportUid": "text",
"request": {
"fromDate": "2026-01-01",
"toDate": "2026-01-01",
"storeUids": [
"text"
],
"reportUid": "text"
},
"state": "ABORTED",
"type": "SAFT",
"createdAt": "2026-01-01T00:00:00.000Z",
"createdBy": "text",
"lastModifiedAt": "2026-01-01T00:00:00.000Z",
"lastModifiedBy": "text",
"sendNotificationTo": "text",
"notificationSentAt": "2026-01-01T00:00:00.000Z",
"progress": "text",
"filename": "text",
"filesize": 1
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Get report details
Token received from the auth service
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an organization.
^[A-Za-z0-9-_]+Reference to a report.
^[A-Za-z0-9-_]+Report details
^[A-Za-z0-9-_]+The request response depends on the what type of report it is
Available reports are:
| ENUM | Description |
|---|---|
| SAFT | SAFT reports |
| SalesPrStore | Sales per store |
| StoreWarehouseDetails | Monthly warehouse details |
| WarehouseStockDetails | Details list of all stock on the current warehouse |
| ART_FEE | Art fee report |
| ART_PROVISION | Artists' provision report |
| OPEN_ITEMS | List of outstanding receivables |
| SOLD_NOT_DELIVERED | Products sold not delivered |
GET /v2/tenants/{tenantUid}/organizations/{organizationUid}/reports/{reportUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Report details
{
"reportUid": "text",
"request": {
"fromDate": "2026-01-01",
"toDate": "2026-01-01",
"storeUids": [
"text"
],
"reportUid": "text"
},
"state": "ABORTED",
"type": "SAFT",
"createdAt": "2026-01-01T00:00:00.000Z",
"createdBy": "text",
"lastModifiedAt": "2026-01-01T00:00:00.000Z",
"lastModifiedBy": "text",
"sendNotificationTo": "text",
"notificationSentAt": "2026-01-01T00:00:00.000Z",
"progress": "text",
"filename": "text",
"filesize": 1
}Abort report generation
Required permissions: REPORT_ADMIN
Token received from the auth service
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an organization.
^[A-Za-z0-9-_]+Reference to a report.
^[A-Za-z0-9-_]+| ENUM | Description |
|---|---|
| ABORT | Abort running job |
Report details
^[A-Za-z0-9-_]+The request response depends on the what type of report it is
Available reports are:
| ENUM | Description |
|---|---|
| SAFT | SAFT reports |
| SalesPrStore | Sales per store |
| StoreWarehouseDetails | Monthly warehouse details |
| WarehouseStockDetails | Details list of all stock on the current warehouse |
| ART_FEE | Art fee report |
| ART_PROVISION | Artists' provision report |
| OPEN_ITEMS | List of outstanding receivables |
| SOLD_NOT_DELIVERED | Products sold not delivered |
POST /v2/tenants/{tenantUid}/organizations/{organizationUid}/reports/{reportUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"action": "ABORT"
}Report details
{
"reportUid": "text",
"request": {
"fromDate": "2026-01-01",
"toDate": "2026-01-01",
"storeUids": [
"text"
],
"reportUid": "text"
},
"state": "ABORTED",
"type": "SAFT",
"createdAt": "2026-01-01T00:00:00.000Z",
"createdBy": "text",
"lastModifiedAt": "2026-01-01T00:00:00.000Z",
"lastModifiedBy": "text",
"sendNotificationTo": "text",
"notificationSentAt": "2026-01-01T00:00:00.000Z",
"progress": "text",
"filename": "text",
"filesize": 1
}Delete a generated report
Deletes a generated report
Required permissions: REPORT_ADMIN
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an organization.
^[A-Za-z0-9-_]+Reference to a report.
^[A-Za-z0-9-_]+No Content
No content
Forbidden
Not Found
DELETE /v2/tenants/{tenantUid}/organizations/{organizationUid}/reports/{reportUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Download report content
Download report content
Token received from the auth service
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an organization.
^[A-Za-z0-9-_]+Reference to a report.
^[A-Za-z0-9-_]+Based on the Accept header the response will be base64 json encoded or a raw file. application/octet-stream will return a binary file application/json will return a json with the file content base64 encoded.
base64 encoded
mime type
Not Found
Conflict
GET /v2/tenants/{tenantUid}/organizations/{organizationUid}/reports/{reportUid}/download HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"content": "text",
"contentType": "text",
"filename": "text"
}Start WarehouseStockDetails report
Start report generation of WarehouseStockDetails
Required permissions: REPORT_ADMIN
Token received from the auth service
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an organization.
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+Report details
^[A-Za-z0-9-_]+The request response depends on the what type of report it is
Available reports are:
| ENUM | Description |
|---|---|
| SAFT | SAFT reports |
| SalesPrStore | Sales per store |
| StoreWarehouseDetails | Monthly warehouse details |
| WarehouseStockDetails | Details list of all stock on the current warehouse |
| ART_FEE | Art fee report |
| ART_PROVISION | Artists' provision report |
| OPEN_ITEMS | List of outstanding receivables |
| SOLD_NOT_DELIVERED | Products sold not delivered |
POST /v2/tenants/{tenantUid}/organizations/{organizationUid}/reports/warehouse-stock-details HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 116
{
"warehouseUid": "text",
"warehouseUids": [
"text"
],
"brandUids": [
"text"
],
"productGroupUids": [
"text"
],
"reportUid": "text"
}Report details
{
"reportUid": "text",
"request": {
"fromDate": "2026-01-01",
"toDate": "2026-01-01",
"storeUids": [
"text"
],
"reportUid": "text"
},
"state": "ABORTED",
"type": "SAFT",
"createdAt": "2026-01-01T00:00:00.000Z",
"createdBy": "text",
"lastModifiedAt": "2026-01-01T00:00:00.000Z",
"lastModifiedBy": "text",
"sendNotificationTo": "text",
"notificationSentAt": "2026-01-01T00:00:00.000Z",
"progress": "text",
"filename": "text",
"filesize": 1
}Start SAF-T report generation for a set period. It is also possible to only run it for a specific set of stores.
Required permissions: REPORT_ADMIN
Token received from the auth service
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an organization.
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+Report details
^[A-Za-z0-9-_]+The request response depends on the what type of report it is
Available reports are:
| ENUM | Description |
|---|---|
| SAFT | SAFT reports |
| SalesPrStore | Sales per store |
| StoreWarehouseDetails | Monthly warehouse details |
| WarehouseStockDetails | Details list of all stock on the current warehouse |
| ART_FEE | Art fee report |
| ART_PROVISION | Artists' provision report |
| OPEN_ITEMS | List of outstanding receivables |
| SOLD_NOT_DELIVERED | Products sold not delivered |
POST /v2/tenants/{tenantUid}/organizations/{organizationUid}/reports/saf-t HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87
{
"fromDate": "2026-01-01",
"toDate": "2026-01-01",
"storeUids": [
"text"
],
"reportUid": "text"
}Report details
{
"reportUid": "text",
"request": {
"fromDate": "2026-01-01",
"toDate": "2026-01-01",
"storeUids": [
"text"
],
"reportUid": "text"
},
"state": "ABORTED",
"type": "SAFT",
"createdAt": "2026-01-01T00:00:00.000Z",
"createdBy": "text",
"lastModifiedAt": "2026-01-01T00:00:00.000Z",
"lastModifiedBy": "text",
"sendNotificationTo": "text",
"notificationSentAt": "2026-01-01T00:00:00.000Z",
"progress": "text",
"filename": "text",
"filesize": 1
}Make an ad hoc Open Items report (this is not stored). Optionally filter on stores. The report is in XLSX spreadsheet format.
Required permissions: REPORT_ADMIN
Token received from the auth service
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an organization.
^[A-Za-z0-9-_]+Example response
POST /v2/tenants/{tenantUid}/organizations/{organizationUid}/reports/open-items HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"storeUids": [
"text"
]
}Example response
{
"items": [
{
"store": {
"storeUid": "text",
"name": "text",
"vatNumber": "text"
},
"customer": {
"customerUid": "text",
"displayName": "text",
"ledgerNumber": "text"
},
"orderUid": "text",
"orderNumber": "text",
"voucherNumber": "text",
"settlementUid": "text",
"settlementCode": "text",
"settledAt": "2026-01-01T00:00:00.000Z",
"amount": 1,
"dueDate": "2026-01-01",
"dueAmount": 1
}
]
}Get accounting report for a storeUid and a period. Response is a json structured data of accounting
Required permissions: REPORTING
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]*List of storeUids to include in report.
Response for Accounting report.
POST /v2/tenants/{tenantUid}/reports/accounting HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 93
{
"fromDate": "2026-01-01",
"toDate": "2026-01-01",
"organizationUid": "text",
"storeUids": [
"text"
]
}Response for Accounting report.
{
"asset": [
{
"account": "text",
"creditAmount": 1,
"date": "text",
"debetAmount": 1,
"text": "text",
"vatCode": "text"
}
],
"credit": [
{
"account": "text",
"creditAmount": 1,
"date": "text",
"debetAmount": 1,
"text": "text",
"vatCode": "text"
}
],
"debet": [
{
"account": "text",
"creditAmount": 1,
"date": "text",
"debetAmount": 1,
"text": "text",
"vatCode": "text"
}
],
"header": {
"fromDate": "text",
"storeUid": "text",
"toDate": "text"
},
"ledger": [
{
"account": "text",
"creditAmount": 1,
"date": "text",
"debetAmount": 1,
"text": "text",
"vatCode": "text"
}
],
"printDate": "text",
"tenantName": "text",
"organizationName": "text",
"storeNames": [
"text"
],
"totals": {
"totalAsset": 1,
"totalCredit": 1,
"totalCreditAndAsset": 1,
"totalDebet": 1,
"totalLedger": 1
}
}Get an accounting report for a store UID and a time period. Depending on the header you set, the response is either a json containing a base 64 encoded pdf or a direct download. The file is base64 encoded. You can set choose among the supported file types, default is PDF.
Required permissions: REPORTING
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]*List of storeUids to include in report.
Supported report formats
Based on the Accept header the response will be base64 json encoded or a raw file. application/octet-stream will return a binary file application/json will return a json with the file content base64 encoded.
base64 encoded
mime type
POST /v2/tenants/{tenantUid}/reports/accounting/download HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 114
{
"fromDate": "2026-01-01",
"toDate": "2026-01-01",
"organizationUid": "text",
"storeUids": [
"text"
],
"reportFormat": "PDF"
}Based on the Accept header the response will be base64 json encoded or a raw file. application/octet-stream will return a binary file application/json will return a json with the file content base64 encoded.
{
"content": "text",
"contentType": "text",
"filename": "text"
}Get products turnover report for a time period, optionally filtered on a list of product group and UIDs. The report generates sums of sold products and total values.
Required permissions: REPORTING
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Array of brandUids
Array of productGroup ids
Array of storeUids
if true, the excel report returns a response with order items grouped by userCode
^[A-Za-z0-9-_]*Response for Product turnover report.
POST /v2/tenants/{tenantUid}/reports/products HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 199
{
"brandUids": [
"text"
],
"fromDateTime": "2026-01-01T00:00:00.000Z",
"productGroupUids": [
"text"
],
"storeUids": [
"text"
],
"toDateTime": "2026-01-01T00:00:00.000Z",
"groupByUserCode": true,
"tenantUserUid": "text"
}Response for Product turnover report.
{
"items": [
{
"costAmount": 1,
"count": 1,
"discountAmount": 1,
"name": "text",
"revenueAmount": 1,
"revenuePercent": 1,
"storeUid": "text",
"turnoverAmount": 1,
"brandUid": "text",
"brandName": "text",
"productGroupUid": "text",
"productGroupName": "text",
"productUid": "text",
"sku": "text",
"lastSettledAt": "2026-01-01T00:00:00.000Z"
}
]
}Get turnover data grouped by store.
If tenant user UID is specified, the turnover data will only contain the numbers for that specific user.
Required permissions: 'REPORTING, SALES_ORDER, RETURN_ORDER'
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Turnover Request Body
^[A-Za-z0-9-_]+Turnover response
POST /v2/tenants/{tenantUid}/reports/turnover/stores HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 127
{
"fromDateTime": "2026-01-01T00:00:00.000Z",
"toDateTime": "2026-01-01T00:00:00.000Z",
"tenantUserUid": "text",
"storeUids": [
"text"
]
}Turnover response
{
"dates": [
{
"costAmount": 1,
"count": 1,
"date": "text",
"discountAmount": 1,
"revenueAmount": 1,
"revenuePercent": 1,
"turnoverAmount": 1
}
],
"stores": [
{
"costAmount": 1,
"count": 1,
"discountAmount": 1,
"name": "text",
"revenueAmount": 1,
"revenuePercent": 1,
"storeUid": "text",
"turnoverAmount": 1
}
],
"total": {
"costAmount": 1,
"count": 1,
"discountAmount": 1,
"revenueAmount": 1,
"revenuePercent": 1,
"turnoverAmount": 1,
"orderCount": 1
}
}Generate a report of all receipts in a given period.
Required permissions: REPORTING
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+The response will be a Excel file.
POST /v2/tenants/{tenantUid}/reports/receipts HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 102
{
"storeUids": [
"text"
],
"settledAt": {
"from": "2026-01-01T00:00:00.000Z",
"to": "2026-01-01T00:00:00.000Z"
}
}The response will be a Excel file.
binaryTurnover report for root product groups
Get turnover data for a store grouped by product-group.
If tenant user UID is specified, the turnover data will only contain the numbers for that specific user.
Required permissions: REPORTING,SALES_ORDER,RETURN_ORDER
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Turnover Request Body
^[A-Za-z0-9-_]+Turnover response for ProductGroup
POST /v2/tenants/{tenantUid}/reports/turnover/stores/{storeUid}/product-groups HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 127
{
"fromDateTime": "2026-01-01T00:00:00.000Z",
"toDateTime": "2026-01-01T00:00:00.000Z",
"tenantUserUid": "text",
"storeUids": [
"text"
]
}Turnover response for ProductGroup
{
"items": [
{
"costAmount": 1,
"count": 1,
"discountAmount": 1,
"hasChildren": true,
"productGroupUid": "text",
"revenueAmount": 1,
"revenuePercent": 1,
"text": "text",
"turnoverAmount": 1
}
],
"total": {
"costAmount": 1,
"count": 1,
"discountAmount": 1,
"revenueAmount": 1,
"revenuePercent": 1,
"turnoverAmount": 1,
"orderCount": 1
}
}Turnover report for sellers on a store
Get turnover data for all sellers in a store.
Ordered by turnover descending.
Required permissions: REPORTING,SALES_ORDER,RETURN_ORDER
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Turnover Request Body
Example response
POST /v2/tenants/{tenantUid}/reports/turnover/stores/{storeUid}/users HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 83
{
"fromDateTime": "2026-01-01T00:00:00.000Z",
"toDateTime": "2026-01-01T00:00:00.000Z"
}Example response
{
"items": [
{
"position": 1,
"costAmount": 1,
"orderCount": 1,
"discountAmount": 1,
"revenueAmount": 1,
"revenuePercent": 1,
"turnoverAmount": 1,
"vatAmount": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"tenantUserUid": "text"
}
]
}Turnover report for one product group
Get turnover data for a store and product group.
If tenant user UID is specified, the turnover data will only contain the numbers for that specific user.
Required permissions: REPORTING,SALES_ORDER,RETURN_ORDER
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a ProductGroup.
^[A-Za-z0-9-_]+Turnover Request Body
^[A-Za-z0-9-_]+Turnover response for ProductGroup
POST /v2/tenants/{tenantUid}/reports/turnover/stores/{storeUid}/product-groups/{productGroupUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 127
{
"fromDateTime": "2026-01-01T00:00:00.000Z",
"toDateTime": "2026-01-01T00:00:00.000Z",
"tenantUserUid": "text",
"storeUids": [
"text"
]
}Turnover response for ProductGroup
{
"items": [
{
"costAmount": 1,
"count": 1,
"discountAmount": 1,
"hasChildren": true,
"productGroupUid": "text",
"revenueAmount": 1,
"revenuePercent": 1,
"text": "text",
"turnoverAmount": 1
}
],
"total": {
"costAmount": 1,
"count": 1,
"discountAmount": 1,
"revenueAmount": 1,
"revenuePercent": 1,
"turnoverAmount": 1,
"orderCount": 1
}
}Turnover report for products
Get turnover data for a product group grouped by product
If tenant user UID is specified, the turnover data will only contain the numbers for that specific user.
Required permissions: REPORTING,SALES_ORDER,RETURN_ORDER
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a ProductGroup.
^[A-Za-z0-9-_]+Turnover Request Body
^[A-Za-z0-9-_]+Turnover response
POST /v2/tenants/{tenantUid}/reports/turnover/stores/{storeUid}/product-groups/{productGroupUid}/products HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 127
{
"fromDateTime": "2026-01-01T00:00:00.000Z",
"toDateTime": "2026-01-01T00:00:00.000Z",
"tenantUserUid": "text",
"storeUids": [
"text"
]
}Turnover response
{
"items": [
{
"costAmount": 1,
"count": 1,
"discountAmount": 1,
"id": "text",
"revenueAmount": 1,
"revenuePercent": 1,
"text": "text",
"turnoverAmount": 1
}
],
"total": {
"costAmount": 1,
"count": 1,
"discountAmount": 1,
"revenueAmount": 1,
"revenuePercent": 1,
"turnoverAmount": 1,
"orderCount": 1
}
}Turnover report for orders
Get turnover data for a product grouped by orders.
If tenant user UID is specified, the turnover data will only contain the numbers for that specific user.
Required permissions: REPORTING,SALES_ORDER,RETURN_ORDER
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a ProductGroup.
^[A-Za-z0-9-_]+Reference to a Product.
^[A-Za-z0-9-_]+Turnover Request Body
^[A-Za-z0-9-_]+Turnover response
POST /v2/tenants/{tenantUid}/reports/turnover/stores/{storeUid}/product-groups/{productGroupUid}/products/{productUid}/orders HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 127
{
"fromDateTime": "2026-01-01T00:00:00.000Z",
"toDateTime": "2026-01-01T00:00:00.000Z",
"tenantUserUid": "text",
"storeUids": [
"text"
]
}Turnover response
{
"items": [
{
"costAmount": 1,
"count": 1,
"discountAmount": 1,
"id": "text",
"revenueAmount": 1,
"revenuePercent": 1,
"text": "text",
"turnoverAmount": 1
}
],
"total": {
"costAmount": 1,
"count": 1,
"discountAmount": 1,
"revenueAmount": 1,
"revenuePercent": 1,
"turnoverAmount": 1,
"orderCount": 1
}
}Start Art Fee report generation for a set time period and optionally for given stores.
Required permissions: REPORTING
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an organization.
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+Report details
^[A-Za-z0-9-_]+The request response depends on the what type of report it is
Available reports are:
| ENUM | Description |
|---|---|
| SAFT | SAFT reports |
| SalesPrStore | Sales per store |
| StoreWarehouseDetails | Monthly warehouse details |
| WarehouseStockDetails | Details list of all stock on the current warehouse |
| ART_FEE | Art fee report |
| ART_PROVISION | Artists' provision report |
| OPEN_ITEMS | List of outstanding receivables |
| SOLD_NOT_DELIVERED | Products sold not delivered |
POST /v2/tenants/{tenantUid}/organizations/{organizationUid}/reports/art-fee HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87
{
"fromDate": "2026-01-01",
"toDate": "2026-01-01",
"storeUids": [
"text"
],
"reportUid": "text"
}Report details
{
"reportUid": "text",
"request": {
"fromDate": "2026-01-01",
"toDate": "2026-01-01",
"storeUids": [
"text"
],
"reportUid": "text"
},
"state": "ABORTED",
"type": "SAFT",
"createdAt": "2026-01-01T00:00:00.000Z",
"createdBy": "text",
"lastModifiedAt": "2026-01-01T00:00:00.000Z",
"lastModifiedBy": "text",
"sendNotificationTo": "text",
"notificationSentAt": "2026-01-01T00:00:00.000Z",
"progress": "text",
"filename": "text",
"filesize": 1
}The Art Provision report gives overview over each artist's sales and stock for the requested time period. Optionally filter on artist.
Artists with no sales and no stock are included.
sendEmailToSupplier = true will send email to each artist.
Required permissions: REPORTING
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+ZipFileResponse
No Content
POST /v2/tenants/{tenantUid}/stores/{storeUid}/reports/art-supplier HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 142
{
"fromDate": "2026-01-01",
"toDate": "2026-01-01",
"supplierUids": [
"text"
],
"sendEmailToSupplier": true,
"productGroupUids": [
"text"
],
"showDiff": true
}binaryList suppliers' commission sales payouts
List suppliers' payouts for commission sales in a time period. Optionally filter on commission sales that are paid/not paid.
Required permissions: REPORTING
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+GTE
LTE
filter on paid/not paid
Example response
POST /v2/tenants/{tenantUid}/stores/{storeUid}/reports/suppliers/payouts HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 132
{
"fromDate": "2026-01-01",
"toDate": "2026-01-01",
"paid": true,
"supplierUids": [
"text"
],
"productGroupUids": [
"text"
],
"scope": "STOCK_ONLY"
}Example response
{
"items": [
{
"supplier": {
"address": "text",
"city": "text",
"contactEmail": "text",
"contactName": "text",
"countryCode": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"email": "text",
"externalId": "text",
"lastModifiedAt": "2026-01-01T00:00:00.000Z",
"name": "text",
"phone": "text",
"postalCode": "text",
"supplierUid": "text",
"vatNumber": "text",
"active": true,
"bankInfo": {
"accountNumber": "text",
"bankName": "text",
"iban": "text",
"swift": "text"
},
"fixedDiscountRate": 1,
"currency": "text",
"freightPercentage": 1
},
"commissionSales": [
{
"payoutAmount": 1,
"paidAt": "2026-01-01T00:00:00.000Z",
"paid": true,
"commissionPercentage": 1,
"commissionAmount": 1,
"salesPrice": 1,
"productSku": "text",
"productName": "text",
"orderNumber": "text",
"orderSettledAt": "2026-01-01T00:00:00.000Z",
"commissionUid": "text",
"orderProductLineUid": "text",
"orderUid": "text"
}
],
"payoutsTotal": 1,
"payoutsCount": 1
}
]
}Download Products sold and not delivered excel report
Generate a report of all sold but not yet delivered products
Token received from the auth service
Reference to a tenant.
^[A-Za-z0-9-_]+SpreadSheet Response
Bad request
Unauthorized
Tenant not found
POST /v2/tenants/{tenantUid}/reports/products-sold-not-delivered HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 50
{
"organisationUids": [
"text"
],
"storeUids": [
"text"
]
}binaryList orders with order date that matches request data.
Based on the Accept header the response will be base64 json encoded or a raw file.
application/octet-stream will return a binary file
application/json will return a json with the file content base64 encoded.
Required permissions: REPORTING
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Example response
POST /v2/tenants/{tenantUid}/reports/orders HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 125
{
"orderDate": {
"from": "2026-01-01T00:00:00.000Z",
"to": "2026-01-01T00:00:00.000Z"
},
"storeUids": [
"text"
],
"orderStates": [
"OPEN"
]
}Example response
{
"items": [
{
"orderUid": "text",
"orderNumber": "text",
"orderDate": "2026-01-01T00:00:00.000Z",
"orderState": "OPEN",
"customerName": "text",
"store": {
"name": "text",
"storeUid": "text"
},
"createdBy": "text",
"orderTotal": 1
}
]
}Get a report of reason usage across orders for a specified time period.
This report provides analytics on how reasons are being used including:
- Discount reasons on order items
- Return reasons on order items
The report includes usage counts and associated monetary amounts.
Required permissions: REPORTINGAccess token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Request schema for reasons usage report
Start date and time for the report period
End date and time for the report period
^[A-Za-z0-9-_]*Reasons report response with aggregated discount and return reason data
Response schema for reasons usage report with aggregated discount and return reason data
POST /v2/tenants/{tenantUid}/reports/reasons HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 101
{
"fromDateTime": "2026-01-01T00:00:00.000Z",
"toDateTime": "2026-01-01T00:00:00.000Z",
"storeUid": "text"
}Reasons report response with aggregated discount and return reason data
{
"discountReasons": [
{
"reasonCode": "06",
"reasonDescription": "Campaign",
"totalAmount": 1493263,
"percentageOfTotal": 98.44,
"totalOccurrences": 11
},
{
"reasonCode": "3",
"reasonDescription": "Price guarantee",
"totalAmount": 17469,
"percentageOfTotal": 1.15,
"totalOccurrences": 6
}
],
"returnReasons": [
{
"reasonCode": "feil",
"reasonDescription": "Did not work",
"totalAmount": 749679,
"percentageOfTotal": 93.63,
"totalOccurrences": 250
},
{
"reasonCode": "ikkeønsket",
"reasonDescription": "Did not want it",
"totalAmount": 50965,
"percentageOfTotal": 6.37,
"totalOccurrences": 87
}
]
}Last updated