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.

Path Parameters

id
string
required

The customer id to act on, e.g. cust-1 (client Customer.id).

Minimum string length: 1

Query Parameters

page
integer
default:1

1-based page index to return. Defaults to 1.

Required range: 1 <= x <= 9007199254740991
pageSize
integer
default:20

Rows per page, 1..100. Defaults to 20.

Required range: 1 <= x <= 100
store
string

Restrict the history to one store id; omit for all stores.

Minimum string length: 1

Response

A page of the customer's priced purchase lines, newest ticket first, with the whole-history totals.

A page of the customer's priced purchase lines, newest ticket first, with the whole-history totals.

items
object[]
required

The rows on this page, in the query's sort order.

total
integer
required

Total rows matching the filter across ALL pages, not just this one.

Required range: 0 <= x <= 9007199254740991
page
integer
required

The 1-based page number served.

Required range: 0 < x <= 9007199254740991
pageSize
integer
required

Rows requested per page.

Required range: 0 < x <= 9007199254740991
pageCount
integer
required

Total number of pages; stop walking when page reaches it.

Required range: 0 <= x <= 9007199254740991