Skip to main content
GET
Get a list of bookings

Path Parameters

supplierapi
string
required
Pattern: supplier|apiv1/supplier

Query Parameters

productId
integer

Only return bookings for the product with this ID.

redeemer
string

Only return bookings that partially match this redeemer name.

voucherNumber
string

Only return bookings that match this voucher number.

bookingDateAfter
string<date>

Only return bookings for activities on or after this date.

bookingDateBefore
string<date>

Only return bookings for activities before this date.

createdDateAfter
string<date>

Only return bookings which were placed on or after this date.

createdDateBefore
string<date>

Only return bookings which were placed before this date.

cancelledDateAfter
string<date>

Only return bookings which have been cancelled on or after this date.

cancelledDateBefore
string<date>

Only return bookings which have been cancelled before this date.

cancelled
boolean

Only return bookings which have/have not been cancelled.

sortBy
string

Sort the results by this field.

sortDirection
string

Sort the results in this direction.

recordsStart
integer

Position of first result to return.

recordsLength
integer

Number of results to return.

Response

Returned when successful