Booking Details

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

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

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

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

Hotebeds 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/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
bookingDetailRS/booking/hotel/rooms/room/paxes/pax/@surname String Pax surname

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 date from

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

Date

Beginning date when the amount will be charged

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

Float

Amount that will be charged after date from 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

bookingChangeRQ/booking/remark String Booking comments

Response XML Example

 

<bookingDetailRS 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="4713" timestamp="2015-09-09 11:01:44.741" requestHost="212.170.239.110" serverId="ws3xmi01" environment="[itest, iSET_A, ehcache]" release="4757" token="720e56e2-39df-4422-9128-f884b9c542b9"/>
	<booking reference="1-2903311" clientReference="MY BOOKING REFERENCE" creationDate="2015-09-09" status="CONFIRMED" creationUser="XML" totalNet="144.120" pendingAmount="144.120" currency="EUR">
            <modificationPolicies cancellation="true" modification="true"/>
            <holder name="HOLDER NAME" surname="HOLDER SURNAME"/>
		<hotel checkOut="2017-09-21" checkIn="2017-09-19" code="6914" name="BelleVue Vistanova" categoryCode="3EST" categoryName="3 STARS" destinationCode="PMI" destinationName="Majorca" zoneCode="29" zoneName="Palmanova" latitude="39.511228" longitude="2.540229" totalNet="144.120" currency="EUR">
			<rooms>
				<room status="CONFIRMED" id="1" code="APT.1B" name="APARTMENT">
					<paxes>
						<pax roomId="1" type="AD" age="30" surname="ADULT SURNAME"/>
						<pax roomId="1" type="AD" age="30" surname="ADULT SURNAAME"/>
					</paxes>
					<rates>
						<rate rateClass="NOR" net="144.120" rateComments="Car park YES (without additional debit notes)   . " paymentType="AT_WEB" packaging="false" boardCode="HB" boardName="HALF BOARD" rooms="1">
							<cancellationPolicies>
								<cancellationPolicy amount="72.060" from="2017-09-16T23:59:00+02:00"/>
							</cancellationPolicies>
							<taxes allIncluded="true"/>
							<rateBreakDown>
								<rateDiscounts>
									<rateDiscount code="SD" name="SPECIAL DISCOUNT" amount="-13.040"/>
									<rateDiscount code="SD" name="SPECIAL DISCOUNT" amount="-23.000"/>
								</rateDiscounts>
								<rateSupplements>
									<rateSupplement code="SR" name="BOARD SUPPLEMENT" from="2017-09-19" to="2017-09-21" amount="65.120" nights="2" paxNumber="2"/>
								</rateSupplements>
							</rateBreakDown>
						</rate>
					</rates>
				</room>
			</rooms>
			<supplier name="HOTELBEDS PRODUCT,S.L.U." vatNumber="B38877676"/>
		</hotel>
	</booking>
</bookingDetailRS>

 

Response JSON Example

 

{
	"auditData": {
		"processTime": "462",
		"timestamp": "2017-09-15 09:24:17.578",
		"requestHost": "212.170.239.110",
		"serverId": "ws3xmi01",
		"environment": "[itest, iSET_A, ehcache]",
		"release": "4877"
		"token": "d2304386-1619-4abe-b7a6-c99467d58a76"
	},
	"booking": {
		"reference": "1-2903614",
		"clientReference": "MY BOOKING REFERENCE",
		"creationDate": "2017-09-15",
		"status": "CONFIRMED",
		"modificationPolicies": {
			"cancellation": true,
			"modification": true
		},
		"creationUser": "XML",
		"holder": {
			"name": "HOLDER NAME",
			"surname": "HOLDER SURNAME"
		},
		"hotel": {
			"checkOut": "2017-09-21",
			"checkIn": "2017-09-19",
			"code": 6914,
			"name": "BelleVue Vistanova",
			"categoryCode": "3EST",
			"categoryName": "3 STARS",
			"destinationCode": "PMI",
			"destinationName": "Majorca",
			"zoneCode": 29,
			"zoneName": "Palmanova",
			"latitude": "39.511228",
			"longitude": "2.540229",
			"rooms": [{
				"status": "CONFIRMED",
				"id":1,
				"code": "APT.1B",
				"name": "APARTMENT",
				"paxes": [
					{
						"roomId":1,
						"type": "AD",
						"name": "ADULT NAME",
						"surname": "ADULT SURNAME"
					},
					{
						"roomId":1,
			                 	"type": "AD",
				                "name": "ADULT NAME",
				                "surname": "ADULT SURNAAME"
					}
				],
				"rates": [{
					"rateClass": "NOR",
					"net": "144.120",
					"rateComments": "Car park YES (without additional debit notes)   . ",
					"paymentType": "AT_WEB",
					"packaging": false,
					"boardCode": "HB",
					"boardName": "HALF BOARD",
					"cancellationPolicies": [{
						"amount": "72.060",
						"from": "2017-09-16T23:59:00+02:00"
					}],
					"taxes": {
						"taxes": [],
						"allIncluded": true
					},
					"rateBreakDown": {
						"rateDiscounts": [
							{
								"code": "SD",
								"name": "SPECIAL DISCOUNT",
								"amount": "-13.040",
							},
							{
								"code": "SD",
								"name": "SPECIAL DISCOUNT",
								"amount": "-23.000",
							}
						],
						"rateSupplements": [
							{
								"code": "SR",
								"name": "BOARD SUPPLEMENT",
								"from": "2017-09-19",
								"to": "2017-09-21",
								"amount": "65.120",
								"nights": 2,
								"paxNumber": 2
							}
						]					
					},
					"rooms": 1
				}]
			}],
			"totalNet": "144.120",
			"currency": "EUR",
			"supplier": {
				"name": "HOTELBEDS PRODUCT,S.L.U.",
				"vatNumber": "B38877676"
			}
		},
		"totalNet": "144.120",
		"pendingAmount": "144.120",
		"currency": "EUR",
	}
}

Docs Navigation