BookingList

The booking list operation returns 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

BookingList Request

Endpoint

GET https://api.test.hotelbeds.com/hotel-api/1.0/bookings
TIMEOUT: 120 seconds

 

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 examples

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

 

BookingList Response

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/auditData/@internal 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/@clientReference

String

internal booking reference introduced by the client at booking time

bookingListRS/bookings/booking/@creationDate

Date

Booking creation date

Format: YYYY-MM-DD

bookingListRS/bookings/booking/@status

String

Booking status:

  • CONFIRMED
  • CANCELLED

bookingListRS/bookings/booking/@creationUser

String

apiKey that was used to confirm the booking

bookingListRS/bookings/booking/@totalSellingRate

Float

Total amount of the booking in hotelCurrency (for the pay at hotel model

bookingListRS/bookings/booking/@totalNet

Float

Total amount of the booking

bookingListRS/bookings/booking/@pendingAmount

Float

Remaining amount to be paid

bookingListRS/bookings/booking/@currency

String

Currency of the amount to be paid

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 booked hotel and associated rates

bookingListRS/bookings/booking/hotel/@checkOut

String

Hotel name

bookingListRS/bookings/booking/hotel/@checkIn

String

Hotel name

bookingListRS/bookings/booking/hotel/@code

Int

Hotelbeds internal hotel code

bookingListRS/bookings/booking/hotel/@name

String

Hotel name

bookingListRS/bookings/booking/hotel/@destinationCode

String

Destination code for hotel location

bookingListRS/bookings/booking/hotel/rooms

Array of room elements

List of rooms booked in that reservation

bookingListRS/bookings/booking/hotel/rooms/room

Element

Element that contains information about the room and associated rates

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

String

Booking status:
  • CONFIRMED
  • CANCELLED

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

Int

Internal room code

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

String

Booking reference of the booking/room for external product supplier bookings

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

Array of pax elements

List of passengers included in that room

bookingListRS/bookings/booking/hotel/rooms/room/paxes/pax

Element

Element that contains information about the passenger

bookingListRS/bookings/booking/hotel/rooms/room/paxes/pax/@roomId

Int

Room where the pax is located

bookingListRS/bookings/booking/hotel/rooms/room/paxes/pax/@type

String

Pax type. Two values are permitted for the attribute:

  • AD for adults
  • CH for child

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/@amount

Float

Room net rate

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

String

Identifies if it is merchant (AT_HOTEL)or pay-at-hotel (AT_WEB)

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

String

Internal board code

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

Int

Number of rooms requested with the same occupancy

bookingListRS/bookings/booking/invoiceCompany

Element

Element that contains information about the invoice company

bookingListRS/bookings/booking/invoiceCompany/@code

String

Code of the invoice company

bookingListRS/bookings/booking/invoiceCompany/@name

String

Name of the invoice company

bookingListRS/bookings/booking/invoiceCompany/@registrationNumber

String

Registration number of the invoice company

XML Response example

<?xml version="1.0" encoding="UTF-8"?>
<bookingListRS xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" schemaLocation="http://www.hotelbeds.com/schemas/messages">
	<auditData 	processTime="1165" timestamp="2018-03-21 14:46:42.165" requestHost="212.170.239.110" serverId="ws3xmi01" environment="[itest, iSET_A, ehcache]" release="4757" token="47411d2f-970a-4196-b790-337b37288670" internal="|01||73|423|0|3|12|N||||||||||1"/>
	<bookings from="4" to="8" total="603">
		<booking reference="1-3814850" clientReference="AgencyTest01" creationDate="2018-03-20" status="CONFIRMED" creationUser="6j486qn8u3l8443sdb7nmhli" totalSellingRate="664.02" totalNet="664.02" pendingAmount="0.00" currency="EUR">
			<holder name="JOHN" surname="SMITH"/>
			<hotel checkOut="2018-09-15" checkIn="2018-09-08" code="2805" name="Globales Mimosa" destinationCode="PMI">
				<rooms>
					<room status="CONFIRMED" code="DBT.ST">
						<paxes>
							<pax roomId="1" type="AD"/>
							<pax roomId="1" type="AD"/>
						</paxes>
						<rates>
							<rate amount="664.02" paymentType="AT_WEB" boardCode="HB" rooms="1"/>
						</rates>
					</room>
				</rooms>
			</hotel>
			<invoiceCompany code="E14" name="HOTELBEDS S.L.U." registrationNumber="ESB57218372"/>
		</booking>
		<booking reference="1-3815077" clientReference="AgencyTest02" creationDate="2018-03-20" status="CONFIRMED" creationUser="6j486qn8u3l8443sdb7nmhli" totalSellingRate="31.35" totalNet="31.35" pendingAmount="0.00" currency="EUR">
			<holder name="SAM" surname="JONES"/>
			<hotel checkOut="2018-03-24" checkIn="2018-03-22" code="497541" name="Urban Hostel Palma" destinationCode="PMI">
				<rooms>
					<room status="CONFIRMED" code="BED.ST" supplierReference="18431999M-HJ">
						<paxes>
							<pax roomId="1" type="AD"/>
						</paxes>
						<rates>
							<rate amount="31.35" paymentType="AT_WEB" boardCode="BB" rooms="1"/>
						</rates>
					</room>
				</rooms>
			</hotel>
			<invoiceCompany code="E14" name="HOTELBEDS S.L.U." registrationNumber="ESB57218372"/>
		</booking>
		<booking reference="1-3815155" clientReference="AgencyTest03" creationDate="2018-03-20" status="CONFIRMED" creationUser="6j486qn8u3l8443sdb7nmhli" totalSellingRate="759.36" totalNet="759.36" pendingAmount="0.00" currency="EUR">
			<holder name="CHARLES" surname="CALTHROP"/>
			<hotel checkOut="2018-07-27" checkIn="2018-07-21" code="4848" name="Grupotel Orient" destinationCode="PMI">
				<rooms>
					<room status="CONFIRMED" code="DBT.ST">
						<paxes>
							<pax roomId="1" type="AD"/>
							<pax roomId="1" type="AD"/>
						</paxes>
						<rates>
							<rate amount="759.36" paymentType="AT_WEB" boardCode="FB" rooms="1"/>
						</rates>
					</room>
				</rooms>
			</hotel>
			<invoiceCompany code="E14" name="HOTELBEDS S.L.U." registrationNumber="ESB57218372"/>
		</booking>
		<booking reference="1-3815186" clientReference="AgencyTest04" creationDate="2018-03-20" status="CONFIRMED" creationUser="6j486qn8u3l8443sdb7nmhli" totalSellingRate="144.52" totalNet="144.52" pendingAmount="0.00" currency="EUR">
			<holder name="PETER" surname="BEDFORD"/>
			<hotel checkOut="2018-09-24" checkIn="2018-09-20" code="4823" name="Niu d'Aus" destinationCode="PMI">
				<rooms>
					<room status="CONFIRMED" code="APT.ST">
						<paxes>
							<pax roomId="1" type="AD"/>
							<pax roomId="1" type="AD"/>
						</paxes>
						<rates>
							<rate amount="144.52" paymentType="AT_WEB" boardCode="SC" rooms="1"/>
						</rates>
					</room>
				</rooms>
			</hotel>
			<invoiceCompany code="E14" name="HOTELBEDS S.L.U." registrationNumber="ESB57218372"/>
		</booking>
		<booking reference="1-3815208" clientReference="AgencyTest05" creationDate="2018-03-20" status="CONFIRMED" creationUser="6j486qn8u3l8443sdb7nmhli" totalSellingRate="31.35" totalNet="31.35" pendingAmount="0.00" currency="EUR">
			<holder name="JULIAN" surname="PARKER"/>
			<hotel checkOut="2018-03-24" checkIn="2018-03-22" code="497541" name="Urban Hostel Palma" destinationCode="PMI">
				<rooms>
					<room status="CONFIRMED" code="BED.ST" supplierReference="16923904M-HJ">
						<paxes>
							<pax roomId="1" type="AD"/>
						</paxes>
						<rates>
							<rate amount="31.35" paymentType="AT_WEB" boardCode="BB" rooms="1"/>
						</rates>
					</room>
				</rooms>
			</hotel>
			<invoiceCompany code="E14" name="HOTELBEDS S.L.U." registrationNumber="ESB57218372"/>
		</booking>
	</bookings>
</bookingListRS>

JSON Response example

{
	"auditData": {
		"processTime": "1271",
		"timestamp": "2018-03-21 14:47:05.901",
		"requestHost": "212.170.239.110",
		"serverId": "sa3RKSJACHXE79K.env",
		"environment": "[int, ignite]",
		"release": "8f8516c469363d54ffa94ee260b468578804460f",
		"token": "47411d2f-970a-4196-b790-337b37288670",
		"internal": "null||||0|0||||||||||||0|||0|0||0|null|||",
	},
	"bookings": {
		"bookings": [{
			"reference": "1-3814850",
			"clientReference": "AgencyTest01",
			"creationDate": "2018-03-20",
			"status": "CONFIRMED",
			"creationUser": "6j486qn8u3l8443sdb7nmhli",
			"holder": {
				"name": "JOHN",
				"surname": "SMITH"
			},
			"hotel": {
				"checkOut": "2018-09-15",
				"checkIn": "2018-09-08",
				"code": 2805,
				"name": "Globales Mimosa",
				"destinationCode": "PMI",
				"rooms": [{
					"status": "CONFIRMED",
					"code": "DBT.ST",
					"paxes": [{
						"roomId": 1,
						"type": "AD"
					},
					{
						"roomId": 1,
						"type": "AD"
					}],
					"rates": [{
						"amount": "664.02",
						"paymentType": "AT_WEB",
						"boardCode": "HB",
						"rooms": 1
					}]
				}]
			},
			"invoiceCompany": {
				"code": "E14",
				"company": "HOTELBEDS S.L.U.",
				"registrationNumber": "ESB57218372"
			},
			"totalSellingRate": 664.02,
			"totalNet": 664.02,
			"pendingAmount": 0,
			"currency": "EUR"
		},
		{
			"reference": "1-3815077",
			"clientReference": "AgencyTest02",
			"creationDate": "2018-03-20",
			"status": "CONFIRMED",
			"creationUser": "6j486qn8u3l8443sdb7nmhli",
			"holder": {
				"name": "SAM",
				"surname": "JONES"
			},
			"hotel": {
				"checkOut": "2018-03-24",
				"checkIn": "2018-03-22",
				"code": 497541,
				"name": "Urban Hostel Palma",
				"destinationCode": "PMI",
				"rooms": [{
					"status": "CONFIRMED",
					"code": "BED.ST",
					"supplierReference": "18431999M-HJ",
					"paxes": [{
						"roomId": 1,
						"type": "AD"
					}],
					"rates": [{
						"amount": "31.35",
						"paymentType": "AT_WEB",
						"boardCode": "BB",
						"rooms": 1
					}]
				}]
			},
			"invoiceCompany": {
				"code": "E14",
				"company": "HOTELBEDS S.L.U.",
				"registrationNumber": "ESB57218372"
			},
			"totalSellingRate": 31.35,
			"totalNet": 31.35,
			"pendingAmount": 0,
			"currency": "EUR"
		},
		{
			"reference": "1-3815155",
			"clientReference": "AgencyTest03",
			"creationDate": "2018-03-20",
			"status": "CONFIRMED",
			"creationUser": "6j486qn8u3l8443sdb7nmhli",
			"holder": {
				"name": "CHARLES",
				"surname": "CALTHROP"
			},
			"hotel": {
				"checkOut": "2018-07-27",
				"checkIn": "2018-07-21",
				"code": 4848,
				"name": "Grupotel Orient",
				"destinationCode": "PMI",
				"rooms": [{
					"status": "CONFIRMED",
					"code": "DBT.ST",
					"paxes": [{
						"roomId": 1,
						"type": "AD"
					},
					{
						"roomId": 1,
						"type": "AD"
					}],
					"rates": [{
						"amount": "759.36",
						"paymentType": "AT_WEB",
						"boardCode": "FB",
						"rooms": 1
					}]
				}]
			},
			"invoiceCompany": {
				"code": "E14",
				"company": "HOTELBEDS S.L.U.",
				"registrationNumber": "ESB57218372"
			},
			"totalSellingRate": 759.36,
			"totalNet": 759.36,
			"pendingAmount": 0,
			"currency": "EUR"
		},
		{
			"reference": "1-3815186",
			"clientReference": "AgencyTest04",
			"creationDate": "2018-03-20",
			"status": "CONFIRMED",
			"creationUser": "6j486qn8u3l8443sdb7nmhli",
			"holder": {
				"name": "PETER",
				"surname": "BEDFORD"
			},
			"hotel": {
				"checkOut": "2018-09-24",
				"checkIn": "2018-09-20",
				"code": 4823,
				"name": "Niu d'Aus",
				"destinationCode": "PMI",
				"rooms": [{
					"status": "CONFIRMED",
					"code": "APT.ST",
					"paxes": [{
						"roomId": 1,
						"type": "AD"
					},
					{
						"roomId": 1,
						"type": "AD"
					}],
					"rates": [{
						"amount": "144.52",
						"paymentType": "AT_WEB",
						"boardCode": "SC",
						"rooms": 1
					}]
				}]
			},
			"invoiceCompany": {
				"code": "E14",
				"company": "HOTELBEDS S.L.U.",
				"registrationNumber": "ESB57218372"
			},
			"totalSellingRate": 144.52,
			"totalNet": 144.52,
			"pendingAmount": 0,
			"currency": "EUR"
		},
		{
			"reference": "1-3815208",
			"clientReference": "AgencyTest05",
			"creationDate": "2018-03-20",
			"status": "CONFIRMED",
			"creationUser": "6j486qn8u3l8443sdb7nmhli",
			"holder": {
				"name": "JULIAN",
				"surname": "PARKER"
			},
			"hotel": {
				"checkOut": "2018-03-24",
				"checkIn": "2018-03-22",
				"code": 497541,
				"name": "Urban Hostel Palma",
				"destinationCode": "PMI",
				"rooms": [{
					"status": "CONFIRMED",
					"code": "BED.ST",
					"supplierReference": "16923904M-HJ",
					"paxes": [{
						"roomId": 1,
						"type": "AD"
					}],
					"rates": [{
						"amount": "31.35",
						"paymentType": "AT_WEB",
						"boardCode": "BB",
						"rooms": 1
					}]
				}]
			},
			"invoiceCompany": {
				"code": "E14",
				"company": "HOTELBEDS S.L.U.",
				"registrationNumber": "ESB57218372"
			},
			"totalSellingRate": 31.35,
			"totalNet": 31.35,
			"pendingAmount": 0,
			"currency": "EUR"
		}],
		"from": 4,
		"to": 8,
		"total": 603
	}
}

Docs Navigation