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

page
integer

1-based page number (default 1).

Required range: 0 < x <= 9007199254740991
pageSize
integer

Rows per page, 1-100 (default 20).

Required range: 0 < x <= 100
kind
enum<string>

Instrument kind to filter on: gift_card / credit_note / store_credit.

Available options:
gift_card,
credit_note,
store_credit
status
enum<string>

Instrument status to filter on, e.g. active / depleted / void.

Available options:
active,
depleted,
void
sortField
enum<string>

Field to order by: code or balanceCents.

Available options:
code,
balanceCents
sortDirection
enum<string>

Order direction for sortField (default asc).

Available options:
asc,
desc

Response

A page of instrument read models with the pagination totals.

A page of instrument read models with the pagination totals.

items
object[]
required
total
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
page
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
pageSize
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
pageCount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991