BookingDetail

The BookingDetail operation allows to retrieve a booking with all its details from the booking reference locator.

BookingDetails Request

Endpoint

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

 

Request parameters

Parameter

Type

Mandatory

Description

booking_reference

String

Y

Booking reference number taken from the confirmation response or from the booking list function
Format: XXX-XXXXXX

Request Example

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

 

BookingDetails Response

The response of BookingDetails provides key information of the booking in the same format as Booking response, including:

  • Hotel confirmed
  • Rate confirmed with the confirmed amounts and dates
  • Holder and passengers

The response also contains the price breakdown, cancellation policies, supplements, and discounts.

Information of cancelled bookings can also be retrieved with BookingDetail, although names and surnames of passengers of cancelled bookings are not shown, as cancellation process deletes names of passengers and only passanger types remain in the passenger list of each room.

Response Parameters

Node/Attribute Type Description
bookingDetailRS Element Top Element
bookingDetailRS/auditData Element Relevant internal information
bookingDetailRS/auditData/@processTime Float Server process time in milliseconds
bookingDetailRS/auditData/@timestamp Date Date/time when the requests have been processed
bookingDetailRS/auditData/@requestHost String IP address of the system host
bookingDetailRS/auditData/@serverId String Server code or ID (for internal use)
bookingDetailRS/auditData/@environment String Environment where the request has been sent and processed
bookingDetailRS/auditData/@release String Release version identifier
bookingDetailRS/auditData/@token String Token identifier of the operation
bookingDetailRS/auditData/@internal String Internal identifier of the parameters of the operation

bookingDetailRS/booking/@reference

String

Booking reference

Format: XXX-XXXXXX

bookingDetailRS/booking/@clientReference

String

Client internal booking reference

bookingDetailRS/booking/@creationDate

Date

Booking creation date

Format: YYYY-MM-DD

bookingDetailRS/booking/@status

String

Booking status:

  • CONFIRMED
  • CANCELLED
bookingDetailRS/booking/@creationUser String apiKey used to make the booking

bookingDetailRS/booking/@totalNet

Float

Total amount of the booking

bookingDetailRS/booking/@pendingAmount Float Remaining amount to be paid

bookingDetailRS/booking/@currency

String

Currency of the amount to be paid

bookingDetailRS/booking/modificationPolicies Element Information regarding the allowed modifications to the booking
bookingDetailRS/booking/modificationPolicies/@cancellation Boolean Indicates if the booking can be cancelled
bookingDetailRS/booking/modificationPolicies/@modification Boolean Indicates if the booking can be modified
bookingDetailRS/booking/holder Element Information of the booking holder
bookingDetailRS/booking/holder/@name String Booking holder name
bookingDetailRS/booking/holder/@surname String Booking holder surname
bookingDetailRS/booking/hotel Element Element that contains information about the hotel and associated rates
bookingDetailRS/booking/hotel/@checkOut Date

Check-out date

Format: YYYY-MM-DD

bookingDetailRS/booking/hotel/@checkIn Date

Check-in date Format:

YYYY-MM-DD

bookingDetailRS/booking/hotel/@code Int Hotelbeds internal hotel code

bookingDetailRS/booking/hotel/@name

String

Hotel name

bookingDetailRS/booking/hotel/@categoryCode

String

Hotel category code

bookingDetailRS/booking/hotel/@categoryName

String

Category name

bookingDetailRS/booking/hotel/@destinationCode

String

Destination code for hotel location

bookingDetailRS/booking/hotel/@destinationName

String

Destination name for hotel location

bookingDetailRS/booking/hotel/@zoneCode

Int

Zone code for hotel location

bookingDetailRS/booking/hotel/@zoneName

String

Zone name for hotel location

bookingDetailRS/booking/hotel/@latitude

Float

Latitude data for geolocation

bookingDetailRS/booking/hotel/@longitude

Float

Longitude data for geolocation

bookingDetailRS/booking/hotel/@totalNet Float Total amount of the booking

bookingDetailRS/booking/hotel/@currency

String

Client currency

bookingDetailRS/booking/hotels/hotel/rooms

Array of room elements

List of rooms booked for the hotel of the reservation

bookingDetailRS/booking/hotels/hotel/rooms/room

Element

Element that contains information about the room and associated rates

bookingDetailRS/booking/hotel/rooms/room/@status

String

Booking status:

  • CONFIRMED
  • CANCELLED
bookingDetailRS/booking/hotel/rooms/room/@id Int Room reservation identifier

bookingDetailRS/booking/hotel/rooms/room/@code

Int

Internal room code

bookingDetailRS/booking/hotel/rooms/room/@name

String

Room name/description

bookingDetailRS/booking/hotel/rooms/room/@supplierReference

String

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

bookingDetailRS/booking/hotel/rooms/room/paxes Array of pax elements List of paxes for the room
bookingDetailRS/booking/hotel/rooms/room/paxes/pax Element Element that describes pax information
bookingDetailRS/booking/hotel/rooms/room/paxes/pax/@roomId Int Room where the pax is located
bookingDetailRS/booking/hotel/rooms/room/paxes/pax/@type String

Pax type

Two values are permitted for the attribute:

  • AD for adults
  • CH for child
bookingDetailRS/booking/hotel/rooms/room/paxes/pax/@name String Pax name

NOTE: Not shown on cancelled bookings.

bookingDetailRS/booking/hotel/rooms/room/paxes/pax/@surname String Pax surname

NOTE: Not shown on cancelled bookings.

bookingDetailRS/booking/hotel/rooms/room/rates

Array of rate elements

List of rates for a particular hotel

bookingDetailRS/booking/hotel/rooms/room/rates/rate

Element

Price information for a room type and board

bookingDetailRS/booking/hotel/rooms/room/rates/rate/@rateClass

String

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

bookingDetailRS/booking/hotel/rooms/room/rates/rate/@net Float Room net price
bookingDetailRS/booking/hotel/rooms/room/rates/rate/@rateComments String Rate comments that contain important information (max lenght = 4000 characters)

bookingDetailRS/booking/hotel/rooms/room/rates/rate/@rateType

String

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

bookingDetailRS/booking/hotel/rooms/room/rates/rate/@paymentType

String

Identifies if it is pay at hotel or merchant

bookingDetailRS/booking/hotel/rooms/room/rates/rate/@packaging

String

Identifies if the rate is for packaging

bookingDetailRS/booking/hotel/rooms/room/rates/rate/@boardCode

String

Internal board code

bookingDetailRS/booking/hotel/rooms/room/rates/rate/@boardName String Board name/description

bookingDetailRS/booking/hotel/rooms/room/rates/rate/@sellingPrice

Float

Room gross price, if it is included

bookingDetailRS/booking/hotel/rooms/room/rates/rate/@comission

Float

Commission

bookingDetailRS/booking/hotel/rooms/room/rates/rate/@hotelSellingRate

Float

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

bookingDetailRS/booking/hotel/rooms/room/rates/rate/@hotelCurrency

String

Hotel currency (for the pay at hotel model)

bookingDetailRS/booking/hotel/rooms/room/rates/rate/@hotelMandatory

Boolean

Identifies if the selling rate is recommended

bookingDetailRS/booking/hotel/rooms/room/rates/rate/@rooms

Int

Number of rooms requested with the same occupancy

bookingDetailRS/booking/hotel/rooms/room/rates/rate/@adults

Int

Number of adults requested per room

bookingDetailRS/booking/hotel/rooms/room/rates/rate/@children

Int

Number of children requested per room

bookingDetailRS/booking/hotel/rooms/room/rates/rate/cancellationPolicies

Array of policies elements

List of cancellation policies

bookingDetailRS/booking/hotel/rooms/room/rates/rate/cancellationPolicies/policy

Element

Cancellation policies

bookingDetailRS/booking/hotel/rooms/room/rates/rate/cancellationPolicies/policy/@amount

Float

Amount that will be charged after '@from' date

bookingDetailRS/booking/hotel/rooms/room/rates/rate/cancellationPolicies/policy/@from

String

Date from which the amount will be charged in ISO 8601 format (Format: yyyy-MM-ddTHH:mm:ssZ)

bookingDetailRS/booking/hotel/rooms/room/rates/rate/cancellationPolicies/policy/@hotelAmount

Float

Amount that will be charged after '@from' date, provided in hotel currency (for the pay at hotel model)

bookingDetailRS/booking/hotel/rooms/room/rates/rate/cancellationPolicies/policy/@hotelCurrency

String

Currency in which the booking must be paid on arrival

bookingDetailRS/booking/hotel/rooms/room/rates/rate/rateBreakDown

Element

Rate breakdown element

bookingDetailRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/@agComission

Float

Agency commission

bookingDetailRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/@comissionPct

Float

Commission percentage

bookingDetailRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/@comissionVat

Float

Commission taxes

bookingDetailRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateDiscounts Array of rateDiscounts elements List of discounts for a particular rate
bookingDetailRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateDiscounts/rateDiscount Element Discount element
bookingDetailRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateDiscounts/rateDiscount/@code Int Discount internal code
bookingDetailRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateDiscounts/rateDiscount/@name String Discount name/description
bookingDetailRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateDiscounts/rateDiscount/@amount Float Amount of the discount

bookingDetailRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements

Array of rateSupplements elements

List of supplements for a particular rate

bookingDetailRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement Element Rate supplements element
bookingDetailRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@code Int Supplement code
bookingDetailRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@name String Supplement name
bookingDetailRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@from Date

Date from when the supplement begins to apply

bookingDetailRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@to Date Date that the supplement no longer applies

bookingDetailRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@amount

Float

Supplement amount

bookingDetailRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@nights

Int

Number of nights the supplement applies

bookingDetailRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@paxNumber

Int

Number of paxes to whom the supplement applies

bookingDetailRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@paxType

String

Type of pax

bookingDetailRS/booking/hotel/rooms/room/rates/rate/taxes

Array of tax elements

List of prices with taxes included or excluded

bookingDetailRS/booking/hotel/rooms/room/rates/rate/taxes/@allIncluded

Boolean

Indicates if all taxes are included or not

bookingDetailRS/booking/hotel/rooms/room/rates/rate/taxes/tax

Element

Element that contains the information about the tax

bookingDetailRS/booking/hotel/rooms/room/rates/rate/taxes/tax/@included

Boolean

Indicates if the tax is included in the price or not

bookingDetailRS/booking/hotel/rooms/room/rates/rate/taxes/tax/@import

Float

Value of the tax

bookingDetailRS/booking/hotel/rooms/room/rates/rate/taxes/tax/@hotelImport

Float

Value of the tax in hotel currency if the tax is not included in the price

bookingDetailRS/booking/hotel/rooms/room/rates/rate/taxes/tax/@hotelCurrency

String

Hotel currency

bookingDetailRS/booking/hotel/rooms/room/rates/rate/taxes/tax/@percentage

Float

Percentage to be paid at the hotel

bookingDetailRS/booking/hotel/supplier

Element

Element that contains supplier information

bookingDetailRS/booking/hotel/supplier/@name

String

Supplier name

bookingDetailRS/booking/hotel/supplier/@vatNumber

String

Supplier VAT number

bookingDetailRS/booking/invoiceCompany Element Element that contains information about the invoice company
bookingDetailRS/booking/invoiceCompany/@code String Code of the invoice company
bookingDetailRS/booking/invoiceCompany/@name String Name of the invoice company
bookingDetailRS/booking/invoiceCompany/@registrationNumber String Registration number of the invoice company
bookingDetailRS/booking/remark String Booking comments

Response XML Example

<?xml version="1.0" encoding="UTF-8"?>
<bookingDetailRS 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="171" timestamp="2018-03-23 09:46:03.453" requestHost="212.66.164.12" serverId="sa37AUX3ROLBLIS.env" environment="[int]" release="5c2a98762e8da116cf86a57a17c9db9d2e4d80eb" token="e7ff5253-c245-41d7-ba84-72dff7b9e2da" internal="null||||0|1||||||||||||1|||0|0||0|null|||"/>
	<booking reference="1-3816249" clientReference="BRUNOTESTBOOKING" creationDate="2018-03-23" status="CONFIRMED" creationUser="wuupfvswdqfz342cejxfv3ku" totalNet="250.19" pendingAmount="250.19" currency="EUR">
		<modificationPolicies cancellation="true" modification="true"/>
		<holder name="HOLDERFIRSTNAME" surname="HOLDERLASTNAME"/>
		<hotel checkOut="2018-04-24" checkIn="2018-04-23" code="229318" name="Hotel Hostal Cuba" categoryCode="4EST" categoryName="4 STARS" destinationCode="PMI" destinationName="Majorca" zoneCode="10" zoneName="Palma" latitude="39.570177" longitude="2.639077" totalNet="250.19" currency="EUR">
			<rooms>
				<room status="CONFIRMED" id="1" code="JSU.ST" name="JUNIOR SUITE STANDARD" supplierReference="18431999M-MJ">
					<paxes>
						<pax roomId="1" type="AD" name="Second Adult Name" surname="Surname"/>
						<pax roomId="1" type="AD" name="First Adult Name" surname="Surname"/>
					</paxes>
					<rates>
						<rate rateClass="NOR" net="250.19" sellingRate="280.00" hotelMandatory="true" rateComments="1x JUNIOR SUITE Estimated total amount of taxes &amp; fees for this booking: 6.60 Euro   payable on arrival  &#xd;. Car park NO   . Key Collection 15:00 – . Check-in hour 15:00 – 00:00. No hen/stag or any other parties allowed  – . " paymentType="AT_WEB" packaging="false" boardCode="BB" boardName="BED AND BREAKFAST" rooms="1" adults="2" children="0">
							<cancellationPolicies>
								<cancellationPolicy amount="250.19" from="2018-04-19T23:59:00+02:00"/>
							</cancellationPolicies>
							<taxes allIncluded="false">
								<tax included="false" amount="6.60" currency="EUR"/>
							</taxes>
						</rate>
					</rates>
				</room>
			</rooms>
			<supplier name="HOTELBEDS PRODUCT,S.L.U." vatNumber="ESB38877676"/>
		</hotel>
		<remark>Booking remarks are to be written here.</remark>
		<invoiceCompany code="E14" name="HOTELBEDS SPAIN, S.L.U" registrationNumber="ESB57218372"/>
	</booking>
</bookingDetailRS>

Response JSON Example

{
	"auditData": {
		"processTime": "165",
		"timestamp": "2018-03-23 09:35:34.122",
		"requestHost": "212.66.164.12",
		"serverId": "sa37AUX3ROLBLIS.env",
		"environment": "[int]",
		"release": "5c2a98762e8da116cf86a57a17c9db9d2e4d80eb",
		"token": "ce838668-06cd-4009-a705-fc234626ff91",
		"internal": "null||||0|1||||||||||||1|||0|0||0|null|||"
	},
	"booking": {
		"reference": "1-3816248",
		"clientReference": "BRUNOTESTBOOKING",
		"creationDate": "2018-03-23",
		"status": "CONFIRMED",
		"modificationPolicies": {
			"cancellation": true,
			"modification": true
		},
		"creationUser": "wuupfvswdqfz342cejxfv3ku",
		"holder": {
			"name": "HOLDERFIRSTNAME",
			"surname": "HOLDERLASTNAME"
		},
		"hotel": {
			"checkOut": "2018-04-24",
			"checkIn": "2018-04-23",
			"code": 229318,
			"name": "Hotel Hostal Cuba",
			"categoryCode": "4EST",
			"categoryName": "4 STARS",
			"destinationCode": "PMI",
			"destinationName": "Majorca",
			"zoneCode": 10,
			"zoneName": "Palma",
			"latitude": "39.570177",
			"longitude": "2.639077",
			"rooms": [{
				"status": "CONFIRMED",
				"id": 1,
				"code": "JSU.ST",
				"name": "JUNIOR SUITE STANDARD",
				"supplierReference": "16923904M-MJ",
				"paxes": [{
					"roomId": 1,
					"type": "AD",
					"name": "Second Adult Name",
					"surname": "Surname"
				},
				{
					"roomId": 1,
					"type": "AD",
					"name": "First Adult Name",
					"surname": "Surname"
				}],
				"rates": [{
					"rateClass": "NOR",
					"net": "250.19",
					"sellingRate": "280.00",
					"hotelMandatory": true,
					"rateComments": "1x JUNIOR SUITE Estimated total amount of taxes & fees for this booking: 6.60 Euro   payable on arrival  \r. Car park NO   . Key Collection 15:00 – . Check-in hour 15:00 – 00:00. No hen/stag or any other parties allowed  – . ",
					"paymentType": "AT_WEB",
					"packaging": false,
					"boardCode": "BB",
					"boardName": "BED AND BREAKFAST",
					"cancellationPolicies": [{
						"amount": "250.19",
						"from": "2018-04-19T23:59:00+02:00"
					}],
					"taxes": {
						"taxes": [{
							"included": false,
							"amount": "6.60",
							"currency": "EUR"
						}],
						"allIncluded": false
					},
					"rooms": 1,
					"adults": 2,
					"children": 0
				}]
			}],
			"totalNet": "250.19",
			"currency": "EUR",
			"supplier": {
				"name": "HOTELBEDS PRODUCT,S.L.U.",
				"vatNumber": "ESB38877676"
			}
		},
		"remark": "Booking remarks are to be written here.",
		"invoiceCompany": {
			"code": "E14",
			"company": "HOTELBEDS SPAIN, S.L.U",
			"registrationNumber": "ESB57218372"
		},
		"totalNet": 250.19,
		"pendingAmount": 250.19,
		"currency": "EUR"
	}
}

Docs Navigation