Summarise sales into dashboard KPIs

Error

A valid request URL is required to generate request examples

{
  "ticketCount": 2,
  "grossSalesCents": 7200,
  "basketAverageCents": 3600,
  "unitsSold": 4,
  "vatTotalCents": 1200,
  "topProducts": [
    {
      "skuId": "sku-espresso-1kg",
      "unitsSold": 4,
      "grossCents": 7200
    }
  ]
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123,
    "fieldErrors": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

GET

sales

summary

Error

A valid request URL is required to generate request examples

{
  "ticketCount": 2,
  "grossSalesCents": 7200,
  "basketAverageCents": 3600,
  "unitsSold": 4,
  "vatTotalCents": 1200,
  "topProducts": [
    {
      "skuId": "sku-espresso-1kg",
      "unitsSold": 4,
      "grossCents": 7200
    }
  ]
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123,
    "fieldErrors": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

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

store

string

Response

The aggregated sales KPIs plus the top sellers.

ticketCount

integer

required