Booking List Request

The booking list api call main purpose is to look for and retrieve a list of bookings that were done by the client. This operation is used by some clients to allow a search of bookings for their customers.  

When performing the booking list the response will not include all the information that usually is returned in a booking detail response api call but a summary of it. Nevertheless you can always do a booking detail to obtain all information including vouchers. 

Specifications

Live URL: https://api.hotelbeds.com/activity-api/3.0/bookings/{{lang }}?start={{starting_date}}&end={{end_date}}&includedCancelled={{cancelled}&filterType={{filter_type}}

Test URL: https://api.test.hotelbeds.com/activity-api/3.0/bookings/{{lang }}?start={{starting_date}}&end={{end_date}}&includedCancelled={{cancelled}&filterType={{filter_type}}

Method: GET 

Request

The booking list api call is a GET operation. 

The following is the operation spec: 

PARAMETERS

NODE/ATTRIBUTE

TYPE

MANDATORY

DESCRIPTION

language

String

Yes

Language code of the request.

filterType

String

Yes

Filter type. Possible values are:

  • CHECKIN: Default value, bookings with check-in date (or between a range of dates – date from to date to).
  • CREATION: Used to search bookings with a creation date or between dates.
  • CANCELLATION: Used to search bookings by cancellation date between a range of dates

start

String

Yes

Date from. 

end

String

Yes

Date to. 

holder String No Is the relevant holder for the booking. If informed it will search all of those bookings that are linked to the holder. 

includedCancelled

boolean

Yes

True if the cancelled bookings should be included in the search results.

itemsPerPage

Integer

No

Number of items per page.

Default value: 10

page

Integer

No

Number of page.

Default value: 1

To review the response information for the booking list please click here

Docs Navigation