This message allows us to block the service from the latest availability retrieved.
If more than one room is to be blocked, a separate bookRoom request must be made for each one, referencing the distribution being blocked using its identifier (id). Starting from the second request, the bookingToken must be included in order to keep adding rooms to the virtual cart.
Endpoint: https://hotel.new.hotetec.com/webservice/integrations/pull/bookRoom
bookRoom Request message
The message is composed of the following elements:
Element | Mandatory | Values / Type | Description |
sessionId | Y | Alphanumeric | Session ID generated |
languageCode | Y | DE, EN, ES, FR, IT, NL, PT | Language in which we want to receive the response.
ISO 639-1 codes are used. Currently, only the values indicated are accepted. |
currency | Y | EUR, USD, GBP, EGP, MXN, CHF, CUP | Currency in which we want to receive the prices of the request.
ISO 639-1 codes are used. Currently, only the values indicated are accepted . |
vendorCode | Y | Alphanumeric | Provider code |
hotelCode | Y | Alphanumeric | Hotel code |
checkInDate | Y | Date + Time | Check in Date. Example: "2023-01-15T00:00:00.000Z” |
numberOfNights | Y | Numeric | Number of nights for the stay. Example: "4” |
| |||
distribution | |||
| id | Y | Numeric | Indicates the identifier of the distribution that is going to be booked. A sequential identifier will be added for each of the rooms beeing blocked, each in different messages. |
person | |||
age | Y | Numeric | Age of each occupant in the booking is defined. Adults can be assigned a default age of 30 years, while for children it is mandatory to specify the actual age at the date of stay in order to price correctly. |
| |||
mealPlanCode | Y | Alphanumeric | Code for mealplan. |
roomCode | Y | Alphanumeric | Code for room. |
rateCode | Y | Alphanumeric | Code for rateplan. |
occupancyCode | Y | Alphanumeric | Occupancy of the room to be blocked. Must be indicated in the format returned in the availability and must match the number of persons indicated in the 'person' node. Exampel: "O@2-0-0" |
Example of request:
bookRoom Response message
The message is composed of the following elements:
Element | Description |
bookingToken | Unique lock identifier. |
booking | |
reference | Provisional booking locator |
dateCreation | Creation date. Julian date format is used |
| |
hotel | |
code | Code for hotel |
name | Complete name for the hotel |
chain | Chain to which the property belongs. |
| |
establishmentType | |
code | Property type code (e.g. 'HOTL') |
name | Property type descriptcion (e.g. 'Hotel') |
| |
category | |
code | Category code (e.g. 5*) |
name | Category description (e.g. 'Five stars') |
| |
address – country | |
code | Country code (e.g. 'ES') |
name | Country description (e.g. 'Spain') |
| |
address – location | |
code | Code for geographic zone. |
name | Description for geographic zone. |
postalCode | Postal code |
adressText | Adress details |
address - gps | |
latitude | Latitude |
longitude | Longitude |
| |
contact | Contact details for the hotel |
| |
reservationStatus | Booking status. |
| operationalStatus | |
process | Reports on the status of the booking process |
rate | Reports if the rate is available |
quota | Reports if the inventory is available |
room | |
| id | Identifyer for the room. |
| room | |
code | Room code |
name | Room name |
| |
rate | |
code | Rate code |
name | Rate name |
| |
mealPlan | |
code | Board code |
name | Board name |
distribution | |
| id | Unique identifyer for room distribution |
| person | |
| id | Unique identifyer for each person |
| type | Pax type. Values: Adult, Child, Baby |
| age | Passenger's age. Must match with the indicated in the availability. |
| checkIn | Check in date |
| checkOut | Check out date |
| nights | Number of nights of the stay |
| supplements | |
| type | Internal type of supplement |
| code | Internal code of supplement |
| name | Name of supplement |
| dateFrom | Starting date of application of the supplement. Julian format is used. |
| dateTo | Ending date of application of the supplement. Julian format is used. |
| amount | Supplement amount (in positive) or discount (in negative). |
| paymentOption | |
| code | Code of the amount to be paid. |
| amountToPay | Amount to be paid |
| priceDetail: this includes a breakdown of the different supplements, discounts, commissions, commercial policies, etc. | |
| code | Internal code for breakdown |
| name | Name for breakdown |
| type | Breakdown type. Values: Gift, Breakdown, Supplement |
| group | General group to which breakdown belongs. Values: Sale Policy, Comission, Supplement |
| optional | Indicates if it is optional or not |
| order | Indicates in which order the price breakdown is applied |
| amount | Amount for breakdown |
cancelPenaltyMode | Type of cancellation penalty |
| |
cancellationOption | |
fromDate | From which date cancellation fees are applying. Julian format is used. |
daysTo | Days left to cancellation fees start applying. Julian format is used. |
percentage | Cancellation fee percentage |
amount | Cancellation fee amount |
| |
status | Booking status |
baseAmount | Base amount of the booking |
discountAmount | Discount amount applied in the booking |
priceType | Price type. Values: PVP, Net |
commissionAmount | Commission amount of the booking |
commissionPercentage | Percentage of booking commission |
amount | Total amount of the booking |
| |
guest | |
id | Unique identifier for booking passenger |
languageCode | Language code |
commissionAmount | Commission amount of the booking |
totalAmount | Total amount of the booking |
currencyCode | Currency code of the booking |
paymentOption | |
paymentorder | Payment modality of the booking |
paymentType | Payment type of the booking |
description | Description of payment type |
paymentDate | Payment Date. Julian format is used. |
amountToPay | Amount to be paid. |
Example of response: