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

store
string

Narrow to one store's returns (retours / avoirs) by store id.

originalTransactionId
string

Narrow to the returns raised against one original charge transaction (vente).

page
integer

1-based page number (default 1).

Required range: 0 < x <= 9007199254740991
pageSize
integer

Rows per page, max 100 (default 20).

Required range: 0 < x <= 100

Response

A page of processed returns with the pagination totals.

A page of processed returns 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