Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.

Query Parameters

period
string

Reporting window for the chiffre d'affaires roll-up: today (default) or all.

store
string

Narrow the KPI roll-up to one store by its canonical store id; omit for the network.

Response

The aggregated sales KPIs plus the top sellers.

The aggregated sales KPIs plus the top sellers.

ticketCount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
grossSalesCents
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
basketAverageCents
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
unitsSold
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
vatTotalCents
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
topProducts
object[]
required