Booking List

The booking list response displays a list of bookings based on the search criteria.

The most important information returned for each booking in the list is:

  • Booking reference
  • Booking holder
  • Booking paxes
  • Hotel, rooms and boards confirmed
  • Booking rates

ENDPOINTGET https://api.test.hotelbeds.com/hotel-api/1.0/bookings

Request parameters

Paramenter

Type

Mandatory

Description

start

Date

Y

Date from when the method will start checking bookings

The format must be YYYY-MM-DD

end

Date

Y

Date to when the method will finish checking bookings

The format must be YYYY-MM-DD

status

String

N

The parameter is used to get all bookings, including or excluding cancelled bookings.
Values:

 

  • ALL: displays all bookings.
  • CONFIRMED: displays only confirmed bookings.
  • CANCELLED:  displays only cancelled bookings.

 

filterType

String

N

The parameter is used to identify if the bookings list is by check-in date or by booking creation date. Values:

  • CHECKIN: for check-in date.
  • CREATION: for creation date.

from

Int

Y

Number "from" of bookings to be returned

to

Int

Y

Number "to" of bookings to be returned

clientReference String N Parameter to filter the result by the client reference included in the booking.
country String N Parameter to filter the results by the country of the hotel. Can include multiple values separated by ",".
destination String N Parameter to filter the results by the destination of the hotel. Can include multiple values separated by ",".
hotel String N Parameter to filter the results by the hotels reserved in the bookings. Can include multiple values separated by ",".

Request example

https://api.test.hotelbeds.com/hotel-api/1.0/bookings?start=2015-09-10&end=2015-09-15&filterType=CREATION&status=CONFIRMED&from=1&to=25 

Response parameters

Node/Attribute

Type

Description

bookingListRS

Element

Top Element

bookingListRS/auditData

Element

Relevant internal information

bookingListRS/auditData/@processTime

Float

Server process time in milliseconds

bookingListRS/auditData/@timestamp

Date

Date/time when the request has been processed

bookingListRS/auditData/@requestHost String IP address of the system host

bookingListRS/auditData/@serverId

String

Server code or ID (for internal use)

bookingListRS/auditData/@environment

String

Environment where the request has been sent and processed

bookingListRS/auditData/@release String Release version identifier
bookingListRS/auditData/@token String Token identifier of the operation

bookingListRS/bookings

Array of booking elements

List of bookings

bookingListRS/bookings/@total

Int

Total number of bookings

bookingListRS/bookings/booking/@reference

String

Booking reference

Format: XX-XXXXXX

bookingListRS/bookings/booking/@creationDate

Date

Booking creation date

Format: YYYY-MM-DD

bookingListRS/bookings/booking/@totalAmount

Float

Total amount of the booking

bookingListRS/bookings/booking/@currency

String

Currency of the amount to be paid

bookingListRS/bookings/booking/@status

String

Booking status:

  • CONFIRMED
  • CANCELLED

bookingListRS/bookings/booking/holder

Element

Holder information element

bookingListRS/bookings/booking/holder/@name

String

Holder name

bookingListRS/bookings/booking/holder/@surname

String

Holder surname

bookingListRS/bookings/booking/hotel

Element

Element that contains information about the hotel and associated rates

bookingListRS/bookings/booking/hotel/@name

String

Hotel name

bookingListRS/bookings/booking/hotel/@code

Int

Hotebeds internal hotel code

bookingListRS/bookings/booking/hotel/@category

String

Hotel category

bookingListRS/bookings/booking/hotel/@destination

String

Destination code for hotel location

bookingListRS/bookings/booking/hotel/@zone

Int

Zone code for hotel location

bookingListRS/bookings/booking/hotel/@currency

String

Client currency 

bookingListRS/bookings/booking/hotel/rooms

Array of room elements

List of rooms available for a particular hotel

bookingListRS/bookings/booking/hotel/rooms/room/

Element

Element that contains information about the room and associated rates

bookingListRS/bookings/booking/hotel/rooms/room/@code

Int

Internal room code

bookingListRS/bookings/booking/hotel/rooms/room/rates

Array of rate elements

List of rates for a particular hotel

bookingListRS/bookings/booking/hotel/rooms/room/rates/rate

Element

Rate information for a room type and board

bookingListRS/bookings/booking/hotel/rooms/room/rates/rate/@checkIn

Date

Check-in date

Format: YYYY-MM-DD

bookingListRS/bookings/booking/hotel/rooms/room/rates/rate/@checkOut

Date

Check-out date

Format: YYYY-MM-DD

bookingListRS/bookings/booking/hotel/rooms/room/rates/rate/@rateClass

String

Internal rate class type (NOR, NRF, SPE, OFE, PAQ ...)

bookingListRS/bookings/booking/hotel/rooms/room/rates/rate/@rateType

String

Whether the booking can be confirmed in two steps (BOOKABLE) or three steps (RECHECK)

bookingListRS/bookings/booking/hotel/rooms/room/rates/rate/@paymentType

String

Identifies if it is pay-at-hotel or merchant 

bookingListRS/bookings/booking/hotel/rooms/room/rates/rate/@packaging

String

Identifies if the rate is for packaging

bookingListRS/bookings/booking/hotel/rooms/room/rates/rate/@boardCode

String

Internal board code

bookingListRS/bookings/booking/hotel/rooms/room/rates/rate/@net

Float

Room net rate

bookingListRS/bookings/booking/hotel/rooms/room/rates/rate/@gross

Float

Room gross rate, if it is included

bookingListRS/bookings/booking/hotel/rooms/room/rates/rate/@hotelNet

Float

Room net rate in hotelCurrency (for the pay at hotel model)

bookingListRS/bookings/booking/hotel/rooms/room/rates/rate/@hotelGross

Float

Room gross rate in hotelCurrency (for the pay-at hotel model)

bookingListRS/bookings/booking/hotel/rooms/room/rates/rate/@hotelCurrency

String

Hotel currency (for the pay at hotel model)

bookingListRS/bookings/booking/hotel/rooms/room/rates/rate/@recommended

Boolean

Identifies if the selling rate is recommended

bookingListRS/bookings/booking/hotel/rooms/room/rates/rate/@rooms

Int

Number of rooms requested with the same occupancy

bookingListRS/bookings/booking/hotel/rooms/room/rates/rate/@adults

Int

Number of adults requested per room

bookingListRS/bookings/booking/hotel/rooms/room/rates/rate/@children

Int

Number of children requested per room

Response XML example

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bookingListRS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.hotelbeds.com/schemas/messages" schemaLocation="http://www.hotelbeds.com/schemas/messages">
    <auditData processTime="10091" timestamp="2015-09-08 10:41:12.238" requestHost="212.170.239.110" serverId="ws3xmi01" environment="[itest, iSET_A, ehcache]" release="4726" token="a2c18c00-ff4d-4dde-9829-d67f8d6130b0"/>
    <bookings from="1" to="25" total="63">
        <booking reference="52-1059628" clientReference="zffxus8c7rzfabxp8rgkgt27" creationDate="2015-09-03" status="CANCELLED" totalAmount="0.000" currency="EUR" checkIn="2015-11-19" checkOut="2015-11-21">
            <holder name="ANDRÉS" surname="SÁNCHEZ"/>
            <hotel name="Subur" destinationCode="STS">
                <rooms>
                    <room status="CANCELLED" code="SGL.ST">
                        <paxes>
                            <pax type="AD"/>
                        </paxes>
                        <rates>
                            <rate paymentType="AT_HOTEL" boardCode="BB" rooms="1" amount="0.000"/>
                        </rates>
                    </room>
                </rooms>
            </hotel>
        </booking>
        <booking reference="102-5907208" clientReference="zffxus8c7rzfabxp8rgkgt27" creationDate="2015-09-03" status="CANCELLED" totalAmount="0.000" currency="EUR" checkIn="2015-11-19" checkOut="2015-11-21">
            <holder name="INTEGRATIONTESTFIRSTNAME" surname="INTEGRATIONTESTLASTNAME"/>
            <hotel name="NH Paseo de la Habana" destinationCode="MAD">
                <rooms>
                    <room status="CANCELLED" code="SGL.ST">
                        <paxes>
                            <pax type="AD"/>
                        </paxes>
                        <rates>
                            <rate paymentType="AT_WEB" boardCode="RO" rooms="1" amount="0.000"/>
                        </rates>
                    </room>
                </rooms>
            </hotel>
        </booking>
        <booking reference="1-2903092" clientReference="zffxus8c7rzfabxp8rgkgt27" creationDate="2015-09-03" status="CANCELLED" totalAmount="0.000" currency="EUR" checkIn="2015-11-19" checkOut="2015-11-21">
            <holder name="ANDRÉS" surname="SÁNCHEZ"/>
            <hotel name="Hesperia Ciutat de Mallorca" destinationCode="PMI">
                <rooms>
                    <room status="CANCELLED" code="DBT.ST">
                        <paxes>
                            <pax type="AD"/>
                        </paxes>
                        <rates>
                            <rate paymentType="AT_WEB" boardCode="RO" rooms="1" amount="0.000"/>
                        </rates>
                    </room>
                </rooms>
            </hotel>
        </booking>
        <booking reference="102-5907300" clientReference="zffxus8c7rzfabxp8rgkgt27" creationDate="2015-09-04" status="CANCELLED" totalAmount="0.000" currency="EUR" checkIn="2016-03-22" checkOut="2016-03-24">
            <holder name="TEST NAME 1441352604005" surname="TEST SURNAME 1441352604005"/>
            <hotel name="AinB Las Ramblas-Guardia Apartments" destinationCode="BCN">
                <rooms>
                    <room status="CANCELLED" code="STU.ST">
                        <paxes>
                            <pax type="AD"/>
                        </paxes>
                        <rates>
                            <rate paymentType="AT_WEB" boardCode="SC" rooms="1" amount="0.000"/>
                        </rates>
                    </room>
                </rooms>
            </hotel>
        </booking>
        <booking reference="102-5907301" clientReference="zffxus8c7rzfabxp8rgkgt27" creationDate="2015-09-04" status="CANCELLED" totalAmount="0.000" currency="EUR" checkIn="2016-03-22" checkOut="2016-03-24">
            <holder name="TEST NAME 1441352610708" surname="TEST SURNAME 1441352610708"/>
            <hotel name="AinB Las Ramblas-Guardia Apartments" destinationCode="BCN">
                <rooms>
                    <room status="CANCELLED" code="STU.ST">
                        <paxes>
                            <pax type="AD"/>
                        </paxes>
                        <rates>
                            <rate paymentType="AT_WEB" boardCode="SC" rooms="1" amount="0.000"/>
                        </rates>
                    </room>
                </rooms>
            </hotel>
        </booking>
     </bookings>
</bookingListRS>

 

Response JSON example

 

{
	"auditData": {
		"processTime": "727",
		"timestamp": "2015-09-15 09:27:20.859",
		"requestHost": "212.170.239.110",
 		"serverId": "ws3xmi01",
		"environment": "[itest, iSET_A, ehcache]",
		"release": "4877",
		"token": "a2c18c00-ff4d-4dde-9829-d67f8d6130b0"
	 },
	"bookings": {
		"bookings": [{
			"reference": "102-5908120",
			"clientReference": "zffxus8c7rzfabxp8rgkgt27",
			"creationDate": "2015-09-10",
			"status": "CANCELLED",
			"holder": {
				"name": "TEST NAME 1441873183275",
				"surname": "TEST SURNAME 1441873183276"
			},
			"hotel": {
				"checkIn": "2016-03-28",
				"checkOut": "2016-03-30",
				"name": "Castro Exclusive Residences Sant Pau",
				"destinationCode": "BCN",
				"rooms": [{
					"status": "CANCELLED",
					"code": "APT.1B-DP",
					"paxes": [{
						"type": "AD"
					}],
					"rates": [{
						"amount": "0.000",
						"paymentType": "AT_WEB",
						"boardCode": "SC",
						"rooms": 1
					}]
				}],
				"totalSellingRate": "0.000",
				"totalNet": "0.000",
				"currency": "EUR"
			}
		},
		{
			"reference": "102-5908121",
			"clientReference": "zffxus8c7rzfabxp8rgkgt27",
			"creationDate": "2015-09-10",
			"status": "CANCELLED",
			"holder": {
				"name": "TEST NAME 1441873195783",
				"surname": "TEST SURNAME 1441873195783"
			},
			"hotel": {
				"checkIn": "2016-03-28",
				"checkOut": "2016-03-30",
				"name": "Castro Exclusive Residences Sant Pau",
				"destinationCode": "BCN",
				"rooms": [{
					"status": "CANCELLED",
					"code": "APT.1B-DP",
					"paxes": [{
						"type": "AD"
					}],
					"rates": [{
						"amount": "0.000",
						"paymentType": "AT_WEB",
						"boardCode": "SC",
						"rooms": 1
					}]
				}],
				"totalSellingRate": "0.000",
				"totalNet": "0.000",
				"currency": "EUR"
			}
		},
		{
			"reference": "102-5908122",
			"clientReference": "zffxus8c7rzfabxp8rgkgt27",
			"creationDate": "2015-09-10",
			"status": "CANCELLED",
			"holder": {
				"name": "TEST NAME 1441873201757",
				"surname": "TEST SURNAME 1441873201757"
			},
			"hotel": {
				"checkIn": "2016-03-28",
				"checkOut": "2016-03-30",
				"name": "Castro Exclusive Residences Sant Pau",
				"destinationCode": "BCN",
				"rooms": [{
					"status": "CANCELLED",
					"code": "APT.1B-DP",
					"paxes": [{
						"type": "AD"
					}],
					"rates": [{
						"amount": "0.000",
						"paymentType": "AT_WEB",
						"boardCode": "SC",
						"rooms": 1
					}]
				}],
				"totalSellingRate": "0.000",
				"totalNet": "0.000",
				"currency": "EUR"
			}
		},
		{
			"reference": "102-5908160",
			"clientReference": "zffxus8c7rzfabxp8rgkgt27",
			"creationDate": "2015-09-10",
			"status": "CANCELLED",
			"holder": {
				"name": "TEST NAME 1441878812478",
				"surname": "TEST SURNAME 1441878812478"
			},
			"hotel": {
				"checkIn": "2016-03-28",
				"checkOut": "2016-03-30",
				"name": "Castro Exclusive Residences Sant Pau",
				"destinationCode": "BCN",
				"rooms": [{
					"status": "CANCELLED",
					"code": "APT.1B-DP",
					"paxes": [{
						"type": "AD"
					}],
					"rates": [{
						"amount": "0.000",
						"paymentType": "AT_WEB",
						"boardCode": "SC",
						"rooms": 1
					}]
				}],
				"totalSellingRate": "0.000",
				"totalNet": "0.000",
				"currency": "EUR"
			}
		}],
		"from": 1,
		"to": 25,
		"total": 119
	}

 

}

Docs Navigation