list_vouchers

Lists vouchers. You can specify a number of parameters to filter the results, for example only so that the vouchers which can be used for a specific reservation parameters (dates/resource id) can be returned. (click for full documentation)

rental_start_time

DateTime (date part)

DateTime (time part)

If passed, the vouchers returned will be limited to those which allow the rental to start on specified date

rental_end_time

DateTime (date part)

DateTime (time part)

If passed, the vouchers returned will be limited to those which allow the rental to end on specified date

resource_id

int

If you specify resource ID only vouchers which can be used for this resource will be listed.

site_id

int

Setting site_id and not specifying any resource_id will list vouchers compatible with multiple resources. If you specified a resource_id you may leave this parameter empty. If your api key is valid for a single site, you can also leave this empty.

voucher_code_prefix

string

You can enter a voucher code or just a voucher code prefix. In such case only vouchers starting with given code will be listed.

check_reservation_time

bool

If true, then only vouchers which can be used for reservations entered at the time of making this call will be returned. Otherwise, vouchers which can be used for reservations entered at any time will be listed.

language

string

by specifying a 2-letter (ISO 639-1) language code (all capital letters e.g. EN, DE, FR, ES, IT) you can change the language of the text values returned

api_key

string*

your API key - Click here to get your key

* - required field

API Playground - list_vouchers