Embedded Files
Request
Request
The property prebook request is the second stage of the property booking process. It is used to get pricing information for the property and room included in the prebook. A complete reference for what can be included in a property prebook is given below.
The minimum information a property prebook request should contain is login details (required in every request), a booking token (from the property search response), the arrival date of the holiday, number of days duration and a room booking, including the room booking token (from the property search results) and the occupancy of the room (i.e. the number of adults, children and infants). The guest configuration must contain at least one adult per room booking and if any children are specified on the room booking. To find the exact structure of the guest configuration, please click on the link to the guest configuration in the DataType column of the below schema.
To book optional supplements you must enter the ContractSupplementID of the supplements you want into the prebook. This ContractSupplementID is returned with the supplements in the property search. All the information about the optional supplement will be added to the token returned and then passed to the book. If you wish to remove a supplement you must prebook again without the optional supplement to remove it from the token.Â
The structure of the XML will be:
Response
Response
The prebook response returned will include the return status (included in every response) to give basic information about whether the call was successful, along with the price of the rooms prebooked, any prices of cancelling the booking and the date that the booking must be cancelled before for that price to be valid and any auto generated booking comments.
If a prebook was successful the return status will be <Success>true</Success>. If the prebook was unsuccessful, the prebook response will give a return status of <Success>false</Success> and list any exceptions that explain why the prebook failed.
At this point, the user can drop out of the booking process if they do not wish to go ahead and book, or move on to the book stage to make the booking. As no reservations have been made at the prebook stage, no further action is required if you choose to leave the booking process at this point.
The structure of the XML will be:
Example
Example
Request
Request
The user decides to book double deluxe room in the hotel and sends the following prebook request.
<PropertyPreBookRequest>
<LoginDetails>
<Login>TestLogin</Login>
<Password>TestPassword</Password>
</LoginDetails>
<BookingToken>77XHIv7Wgmh5VXW2Svh0698bMp8lK3O/0x1AJZI4a3A=</BookingToken>
<ArrivalDate>2013-09-24</ArrivalDate>
<Duration>7</Duration>
<RoomBookings>
<RoomBooking>
<RoomBookingToken>...</RoomBookingToken>
<GuestConfiguration>
<Adults>2</Adults>
<Children>0</Children>
<Infants>0</Infants>
</GuestConfiguration>
</RoomBooking>
</RoomBookings>
</PropertyPreBookRequest>
Response
Response
<PropertyPreBookResponse>
<ReturnStatus>
<Success>true</Success>
<Exceptions />
</ReturnStatus>
<BookingToken>77XHIv7Wgmh5VXW2Svh06/5h3n4BK3QdBdzUR9+gmJ0=</BookingToken>
<TotalPrice>280</TotalPrice>
<TotalCommission>0</TotalCommission>
<VATOnCommission>0</VATOnCommission>
<Cancellations>
<Cancellation>
<StartDate>2013-08-06T00:00:00</StartDate>
<EndDate>2013-08-12T00:00:00</EndDate>
<Amount>55.35</Amount>
</Cancellation>
<Cancellation>
<StartDate>2013-08-13T00:00:00</StartDate>
<EndDate>2013-08-26T00:00:00</EndDate>
<Amount>129.15</Amount>
</Cancellation>
<Cancellation>
<StartDate>2013-08-27T00:00:00</StartDate>
<EndDate>2013-09-02T00:00:00</EndDate>
<Amount>147.6</Amount>
</Cancellation>
<Cancellation>
<StartDate>2013-09-03T00:00:00</StartDate>
<EndDate>2013-09-09T00:00:00</EndDate>
<Amount>184.5</Amount>
</Cancellation>
<Cancellation>
<StartDate>2013-09-10T00:00:00</StartDate>
<EndDate>2013-09-18T00:00:00</EndDate>
<Amount>280.00</Amount>
</Cancellation>
</Cancellations>
<PaymentsDue>
<PaymentDue>
<Amount>280.00</Amount>
<DateDue>2013-08-06T00:00:00</DateDue>
</PaymentDue>
</PaymentsDue>
<Errata />
<Comments />
<TermsAndConditions>Please read the terms and conditions.</TermsAndConditions>
<TermsAndConditionsURL>http://www.terms.co.uk/terms</TermsAndConditionsURL>
</PropertyPreBookResponse>
Page updated
Report abuse