Search bookings in your account

Request

GET https://api.rezdy.com/v1/bookings

Query parameters

Parameter name Value Description Additional
orderStatus string

Order status to filter results

Possible values are:

  • PROCESSING
  • NEW
  • ON_HOLD
  • PENDING_SUPPLIER
  • PENDING_CUSTOMER
  • CONFIRMED
  • CANCELLED
  • ABANDONED_CART
search string

String to search for. It will be searched in Order number, Customer name, Agent code and payment transaction codes (I.e. voucher Code).

productCode array of string, multiple occurances

Product code, to only load bookings for a specific product. Multiple values allowed: &productCode=P11111&productCode=P22222

minTourStartTime string

Only load bookings with a booked time that starts on or after this time. This is not the booking creation date, it is the booked date. ISO 8601 format, e.g. 2014-03-01T00:00:00Z

maxTourStartTime string

Only load bookings with a booked time that starts before or on this time. This is not the booking creation date, it is the booked date. ISO 8601 format, e.g. 2014-03-01T00:00:00Z

updatedSince string

Only load bookings updated after this time. ISO 8601 format, e.g. 2014-03-01T00:00:00Z. When an order is created, the dateCreated field is set to the current date and the dateUpdated field is empty. Thus using updatedSince will return results of orders that have been updated since the specified date/time, but will not include orders that have been created and not updated.

minDateCreated string

Only load bookings created on or after this date, whether they have been updated or not. ISO 8601 format, e.g. 2014-03-01T00:00:00Z

maxDateCreated string

Only load bookings created on or before this date, whether they have been updated or not. ISO 8601 format, e.g. 2014-03-01T00:00:00Z

resellerReference string

Only load bookings with specified resellerReference

limit int32

How many results are returned per request. Maximum is 100, which also a default, when not specified.

offset int32

Offset of the first result to return. Default to 0.

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

successful operation

ResponseBookingList

Explore this API

apiKey Enter your API Key to try this call
orderStatus

Order status to filter results

search

String to search for. It will be searched in Order number, Customer name, Agent code and payment transaction codes (I.e. voucher Code).

productCode

Product code, to only load bookings for a specific product. Multiple values allowed: &productCode=P11111&productCode=P22222

minTourStartTime

Only load bookings with a booked time that starts on or after this time. This is not the booking creation date, it is the booked date. ISO 8601 format, e.g. 2014-03-01T00:00:00Z

maxTourStartTime

Only load bookings with a booked time that starts before or on this time. This is not the booking creation date, it is the booked date. ISO 8601 format, e.g. 2014-03-01T00:00:00Z

updatedSince

Only load bookings updated after this time. ISO 8601 format, e.g. 2014-03-01T00:00:00Z. When an order is created, the dateCreated field is set to the current date and the dateUpdated field is empty. Thus using updatedSince will return results of orders that have been updated since the specified date/time, but will not include orders that have been created and not updated.

minDateCreated

Only load bookings created on or after this date, whether they have been updated or not. ISO 8601 format, e.g. 2014-03-01T00:00:00Z

maxDateCreated

Only load bookings created on or before this date, whether they have been updated or not. ISO 8601 format, e.g. 2014-03-01T00:00:00Z

resellerReference

Only load bookings with specified resellerReference

limit

How many results are returned per request. Maximum is 100, which also a default, when not specified.

offset

Offset of the first result to return. Default to 0.

Response Content-Type
Try it out!