🔒 List vouchers V3

get

https://{xentralId}.xentral.biz/api/v3/vouchers

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 vouchers. Filter by code to look a single voucher up the way a webshop does - the code is what a customer enters, and remainingAmount is what is left to redeem. Vouchers whose balance is used up are part of the list; filter them out with remainingAmount if you only want the ones that can still be redeemed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

code: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

remainingAmount: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals, isNull, isNotNull

issueDate: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals, isNull, isNotNull

validFrom: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals, isNull, isNotNull

expiresAt: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals, isNull, isNotNull

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

onlyForCustomer: equals, notEquals

createdAt: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals, isNull, isNotNull

updatedAt: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals, isNull, isNotNull

filter

sort

array

Sort via id, -id, issueDate, -issueDate, expiresAt, -expiresAt, remainingAmount, -remainingAmount, createdAt, -createdAt, updatedAt and -updatedAt. Default sort is -id

sort

include

array of strings

include

Allowed:

perPage

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.

page

integer

≥ 0

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

Responses

401

Unauthorized

403

Forbidden

429Too Many Requests