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

post

/tenants/{tenantUid}/reports/turnover/stores/{storeUid}/users

Authorizations

AuthorizationstringRequired

Access token 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

Turnover Request Body

fromDateTimestring · date-time · min: 20Required

toDateTimestring · date-time · min: 20Required

reportBasisstring · enumOptional

ENUM	Description
settled	Report on settled orders using settled_at. Includes only orders with status COMPLETE and settleState COMPLETE.
ordered	Report on orders using order_date. Includes orders with status COMPLETE or CONFIRMED.

Default: settledPossible values:

Responses

200

Example response

application/json

post/tenants/{tenantUid}/reports/turnover/stores/{storeUid}/users

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

{
  "fromDateTime": "2026-01-01T00:00:00.000Z",
  "toDateTime": "2026-01-01T00:00:00.000Z",
  "reportBasis": "settled"
}

200

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"
    }
  ]
}