Query vouchers

List vouchers with optional filters

Access: Auth methods: JWT bearer or API key. Requires permissions: voucher:read. Partner scope: sellingPartnerId from query.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1
Defaults to 1

Page number (1-based)

integer
1 to 2000
Defaults to 20

Items per page

string
enum

Filter by voucher status

Allowed:
string
enum

Filter by voucher source/integration

Allowed:
string
enum

Filter by voucher value type

Allowed:
string

Filter by selling partner UUID

string

Filter by reseller/third-party partner UUID

string

Filter by external POS store identifier

string

Filter by redeemed by account UUID

string

Filter by product UUID

string

Filter by start date (ISO 8601)

string

Filter by end date (ISO 8601)

Response

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