Booking Prepare
The BookingCreate operation is a mandatory step in the booking flow that accepts a “Result Id” from an AvailabilitySearch as the “Quote Id”, to validate the rate and subsequently confirm the booking. It is necessary for this operation to be carried out 3 times during the booking flow twice with CommitLevel Prepare and once with CommitLevel Confirm. For further details of the workflow, please check the ‘Booking Flow’ section of our documentation.
BookingCreate with CommitLevel Prepare
- Verifies the details of the booking and confirms up to date availability, price and full cancellation policy
- Obtains any rate-specific notes relevant to the stay, which should be presented to the end-user prior to booking confirmation (E.g. the swimming pool is closed for maintenance, or a resort fee is applicable for this rate)
- The timeout for this operation is 30 seconds
BookingCreate Request Syntax
Request Header
Content-Type: “text/xml; charset=utf-8”
Content-Length: [Length of the content]
Host: [Web service hostname]
Accept-Encoding “gzip”
| Name | Type | Description |
|---|---|---|
|
<Authority> |
Complex |
Authentication information Authentication information, as |
|
<Org> |
String |
The organisation short code identifying the agent responsible for the request (Agency ID) |
|
<User> |
String |
The user’s logon, unique within the given organisation (User Name). |
|
<Password> |
String |
The given user’s password. |
|
<Currency> |
String |
Choose the currency used to return selling prices; accepts an ISO-4217 / SWIFT three character currency code (e.g. USD, GBP, EUR). Your account has a configured billing currency. Only the configured currency can be specified here. |
|
<Version> |
String |
The current interface version is 1.28.
|
|
<AgentReference> |
String |
A custom reference that will be added to the booking and is exposed in booking elements. |
|
<QuoteId> |
String |
The search result Id returned from AvailabilitySearch that corresponds to the rate to be booked. |
|
<HotelStayDetails> |
Complex |
Structured information about the requested hotel stay |
|
<Room> |
Complex |
Structure containing room requirement and occupant details. |
|
<Guests> |
Array |
An array of either <Adult> or <Child> elements representing the guests who will stay in this room. |
|
<CommitLevel> |
Enum |
Two-valued text enumeration, which for this stage in the booking flow the value should be: prepare – perform a dry-run booking, verifying all details such as prices and cancellation fees, as much as possible and obtaining hotel alert information, etc. |
Response Body Schema
| Name | Type | Description |
|---|---|---|
|
<Currency> |
String |
The currency used to return selling prices. Your account has a configured billing currency |
|
<Warning> |
String |
Details of any non-fatal issues with the request |
|
<CommitLevel> |
Enum |
Indicates the commit level with which the booking creation was performed |
|
<Booking> |
Complex |
A booking structure containing details of the booking, hotel, room/s, price & cancellation policy. |
|
<CreationDate> |
Date |
Date of booking creation |
|
<AgentReference> |
String |
A custom reference provided for booking with <Id> specified |
|
<HotelBooking> (1 or more) |
Complex |
A booking structure for each item associated with the booking |
|
<Id> |
Integer |
Numeric Id for the item |
|
<HotelId> |
Integer |
Numeric Id for the hotel |
|
<HotelName> |
String |
The name of the hotel |
|
<CreationDate> |
Date |
Date of booking creation |
|
<ArrivalDate> |
Date |
The date of the first night of the stay |
|
<Nights> |
Integer |
The duration of the stay as a number of nights |
|
<TotalSellingPrice> |
Complex |
The total price for HotelBooking with <Id> specified |
|
<Status> |
Enum |
Current status of the HotelBooking with <Id> specified |
|
<Room> (1 or More) |
Complex |
Structure containing room requirement and occupant details |
|
<RoomType> |
Complex |
A text enumeration (as a <code>, <text> pair) identifying a specific room type. These codes are obtained dynamically from the hotel and are obtained individually per hotel. |
|
<MealType> |
Enum |
A text enumeration identifying the meal type for the room If not returned the MealType is ‘room only’ |
|
<Guests> |
Array |
An array of either <Adult> or <Child> elements representing the guests who will stay in this room |
|
<Messages> (zero or more) |
Complex |
Special notes provided by the hotel are provided here. These must be displayed to the guests. |
|
<CanxFees> |
Complex |
A structure containing full details of the cancellation fees, including their start date where applicable and amount. |
|
<Cancellation PolicyStatus> |
String |
Three-value text enumeration for the indicative cancellation policy status of the room: Refundable – Room does not incur a cancellation charge at the time of booking. NonRefundable – Room is fully non- refundable Unknown – The cancellation condition status is not available and you should refer to the <CanxFees> for more details. |
|
<QuoteRefreshStatus> |
String |
Three-value text enumeration for the availability status of the quote. Not present if CommitLevel is confirm ok – There have been no changes in rate or availability and you can proceed to the next step. pricechanged – The price is different from the one returned earlier in the booking process. Only proceed to the next step if the new price is acceptable to you. unavailable – the room is no longer available and you should check to see if an alternative Quote Id is suitable. |
|
<HotelDetails> |
Complex |
Contains extra information about the hotel room booked / to be booked. |
XML Response Samples
Samples
