🔒 List voucher redemptions V3

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: voucher:read.

Paginated list of the redemptions of a voucher on sales orders and invoices, including the ones made at the point of sale. The remaining balance of the voucher is its value minus these redemptions.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
filter
array of objects

The filter parameter is used to filter the results of the given endpoint.

Supported filter operators by key:

id: equals, notEquals, in, notIn, isNull, isNotNull

redeemedOn.type: equals, notEquals, in, notIn

redeemedOn.id: equals, notEquals, in, notIn, isNull, isNotNull

filter
sort
array

Sort via id and -id. Default sort is id

sort
Allowed:
integer
≥ 0

Number of items per page. Default: 15, Max: 100. A larger value is reduced to the maximum; omitting it or sending 0 selects the default.

integer
≥ 0

Page number. Omitting it or sending 0 selects the first page.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

403

Forbidden

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json