BookingPrepare

The BookingPrepare operation is a mandatory step that must be completed during each booking journey. It accepts a Quote ID returned from any availability search operation (e.g., RegionSearch or HotelSearch) and is used to validate booking details and pricing before confirmation.  

Booking 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

BookingPrepare Request Syntax

Request Header

POST            /BookingPrepare
Content-Type:    “application/json”
AuthApiKey:      <Your API Key>
Accept-Encoding: “gzip,br”

Request Body Schema

Field Name Data Type Description

QuoteId

String

The search Quote Id returned from RegionSearch & HotelSearch that corresponds to the hotel to be booked. 

Response Body Schema

Field Name Data Type Mandatory Description

Currency

String Yes

The currency code for prices.
All rates will be displayed in the default currency associated with your Stuba account. 

CommitLevel

String Yes

The commit level for the booking (e.g., “prepare”, “confirm”). 

Booking

Object Yes

Contains details of the booking.

CreationDate

Date Yes

Date of booking creation. (YYYY-MM-DD)

HotelBookings

Array of Object Yes

List of hotel bookings within this booking.

Id

Integer Yes

Unique identifier for this specific hotel booking. 

HotelId

Integer Yes

Unique identifier of the hotel. 

HotelName

String Yes

The name of the hotel

ArrivalDate

Date Yes

The date of the first night of the stay (YYY-MM-DD)

Nights

Integer Yes

Number of nights for this booking.

TotalPrice

Float Yes

The total price for Hotel Booking.

Status

String Yes

Status of the booking (e.g., “quoted”).

Rooms

Array of Object Yes

List of rooms booked in this hotel booking.

RoomType

Object Yes

Details of the room type. 

Code

String Yes

Code of the room type.

Text

String Yes

Description of the room type.

MealType

Object Yes

Details of the meal plan. 

Code

String Yes

Meal type code.

Text

String Yes

Description of the meal plan (e.g., “Breakfast”). 

Messages

(zero or more)

Array of Object Yes

Messages related to the room booking. 

Type

String No

Type of message (e.g., “General”, “Internal Note”).

Text

String No

Message text.

CanxFees

Array of Object Yes

List of cancellation fees for the room.

Startdate 

Date No

Date from which the cancellation fee applies. (YYYY-MM-DD) 

Note: 

If no start date returned, cancellation charges are applicable at booking confirmation.

Amount

Float Yes

Amount of the cancellation fee.

Cancellation PolicyStatus

String Yes

Cancellation policy type for the room (e.g., “Refundable”, “Nonrefundable, “Unknown”). 

QuoteRefreshStatus

String Yes

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.

HAPI Response Samples

Samples

Copy
{ "QuoteId": "1090225917-0" }
{ "currency": "USD", "commitLevel": "prepare", "booking": { "creationDate": "2025-11-11", "hotelBookings": [ { "id": 663174321, "hotelId": 78400, "hotelName": "Knight Armour Hotel (Formerly Mayfair)", "creationDate": "2025-11-11", "arrivalDate": "2025-11-15", "nights": 1, "totalPrice": 245.23, "status": "quoted", "rooms": [ { "roomType": { "code": "1002210", "text": "Double Deluxe" }, "mealType": { "code": "1000041", "text": "Room only" }, "messages": [ { "type": "General", "text": "<span style='color:red;font-weight:bold'>** ATTN **</span> Take extra care to read notes, especially for any nationality/market exclusions which could override guest nationality selected <span style='color:red;font-weight:bold'>** ATTN **</span><br/><b>No Show: </b>Should the guest fail to arrive on the check in date and we have not been notified of any cancellations or amendments in advance, they will be deemed a no show. For same day cancellation or no shows, 100% cancellation charges apply.<br>" }, { "type": "Internal Note", "text": "Estimated total amount of taxes & fees for this booking:10.00 Utd. Arab Emir. Dirham payable on arrival. Please note that the city tax for accommodations with more than 1 bedroom shall be charged per bedroom per night. Check-in hour 14:00-00:00.Car park YES (Without additional debit notes)." } ], "status": "quoted", "canxFees": [ { "startDate": "2025-11-11", "amount": 245.23 }, { "startDate": "2025-11-13", "amount": 245.23 } ], "cancellationPolicyStatus": "Refundable" } ], "quoteRefreshStatus": "ok" } ] } }
Copy
{ "QuoteId": "1090225918-1" }
{ "currency": "USD", "commitLevel": "prepare", "booking": { "creationDate": "2025-11-11", "hotelBookings": [ { "id": 663174322, "hotelId": 38076550, "hotelName": "DAMAC Maison Canal Views", "creationDate": "2025-11-11", "arrivalDate": "2025-11-15", "nights": 1, "totalPrice": 385.94, "status": "quoted", "rooms": [ { "roomType": { "code": "43616923", "text": "1 Bedroom Suite with Downtown View + Free Wifi" }, "mealType": { "code": "1000041", "text": "Room only" }, "messages": [ { "type": "General", "text": "<span style='color:red;font-weight:bold'>** ATTN **</span> Take extra care to read notes, especially for any nationality/market exclusions which could override guest nationality selected <span style='color:red;font-weight:bold'>** ATTN **</span><br/><b>No Show: </b>Should the guest fail to arrive on the check in date and we have not been notified of any cancellations or amendments in advance, they will be deemed a no show. For same day cancellation or no shows, 100% cancellation charges apply.<br>" }, { "type": "Internal Note", "text": "Exclusive privileges: enjoy 24/7 concierge support. Late check-out (2:00 PM) available upon request, excluding peak season and requiring at least 48 hours’ notice. Welcome amenities can be arranged on demand. To unlock these privileges and benefit from our dedicated concierge service, email concierge@hotelbeds.com with your booking number. https://www.privilege-terms.com/Children between 0 - 11 are allowed in parents bed- Children who are under 11 years of age will be sharing existing bed with parents.- Check in is 15:00 and check out is 12:00. - 2 bedrooms suite=2 bedroom suite Burj Khalifa view; 3 bedrooms=3 bedroom-Burj Khalifa View.- No show charges as cancellation policy,early departure charges full stay. - 2nd child charges as same as 1st child. Estimated total amount of taxes & fees for this booking:20.00 Utd. Arab Emir. Dirham payable on arrival. Please note that the city tax for accommodations with more than 1 bedroom shall be charged per bedroom per night. Check-in hour 15:00-15:00.Car park YES (With additional debit notes)." } ], "status": "quoted", "canxFees": [ { "amount": 385.94 }, { "startDate": "2025-11-13", "amount": 385.94 } ], "cancellationPolicyStatus": "NonRefundable" } ], "quoteRefreshStatus": "ok" } ] } }
Copy
{ "QuoteId": "1090225919-0" }
{ "currency": "USD", "commitLevel": "prepare", "booking": { "creationDate": "2025-11-11", "hotelBookings": [ { "id": 663174325, "hotelId": 162496070, "hotelName": "Rove Trade Centre", "creationDate": "2025-11-11", "arrivalDate": "2025-11-15", "nights": 2, "totalPrice": 354.22, "status": "quoted", "rooms": [ { "roomType": { "code": "43969369", "text": "Rover Room + Free Wifi" }, "mealType": { "code": "1000041", "text": "Room only" }, "messages": [ { "type": "General", "text": "<span style='color:red;font-weight:bold'>** ATTN **</span> Take extra care to read notes, especially for any nationality/market exclusions which could override guest nationality selected <span style='color:red;font-weight:bold'>** ATTN **</span><br/><b>No Show: </b>Should the guest fail to arrive on the check in date and we have not been notified of any cancellations or amendments in advance, they will be deemed a no show. For same day cancellation or no shows, 100% cancellation charges apply.<br>" }, { "type": "Internal Note", "text": "Estimated total amount of taxes & fees for this booking:20.00 Utd. Arab Emir. Dirham payable on arrival. Please note that the city tax for accommodations with more than 1 bedroom shall be charged per bedroom per night. Check-in hour 16:00-.Car park YES (Without additional debit notes).Identification card at arrival.Children get free accommodation, meals payable on the spot.Deposit on arrival." } ], "status": "quoted", "canxFees": [ { "startDate": "2025-11-11", "amount": 135.0 }, { "startDate": "2025-11-13", "amount": 177.11 } ], "cancellationPolicyStatus": "Refundable" } ], "quoteRefreshStatus": "ok" }, { "id": 663174326, "hotelId": 162496070, "hotelName": "Rove Trade Centre", "creationDate": "2025-11-11", "arrivalDate": "2025-11-15", "nights": 2, "totalPrice": 354.22, "status": "quoted", "rooms": [ { "roomType": { "code": "43969369", "text": "Rover Room + Free Wifi" }, "mealType": { "code": "1000041", "text": "Room only" }, "messages": [ { "type": "General", "text": "<span style='color:red;font-weight:bold'>** ATTN **</span> Take extra care to read notes, especially for any nationality/market exclusions which could override guest nationality selected <span style='color:red;font-weight:bold'>** ATTN **</span><br/><b>No Show: </b>Should the guest fail to arrive on the check in date and we have not been notified of any cancellations or amendments in advance, they will be deemed a no show. For same day cancellation or no shows, 100% cancellation charges apply.<br>" }, { "type": "Internal Note", "text": "Estimated total amount of taxes & fees for this booking:20.00 Utd. Arab Emir. Dirham payable on arrival. Please note that the city tax for accommodations with more than 1 bedroom shall be charged per bedroom per night. Check-in hour 16:00-.Car park YES (Without additional debit notes).Identification card at arrival.Children get free accommodation, meals payable on the spot.Deposit on arrival." } ], "status": "quoted", "canxFees": [ { "startDate": "2025-11-11", "amount": 135.0 }, { "startDate": "2025-11-13", "amount": 177.11 } ], "cancellationPolicyStatus": "Refundable" } ], "quoteRefreshStatus": "ok" } ] } }
Copy
{ "QuoteId": "1090225920-3" }
{ "currency": "USD", "commitLevel": "prepare", "booking": { "creationDate": "2025-11-11", "hotelBookings": [ { "id": 663174327, "hotelId": 319112, "hotelName": "Address Downtown", "creationDate": "2025-11-11", "arrivalDate": "2025-11-15", "nights": 2, "totalPrice": 1883.02, "status": "quoted", "rooms": [ { "roomType": { "code": "93849085", "text": "Deluxe Room" }, "mealType": { "code": "1000041", "text": "Room only" }, "messages": [ { "type": "General", "text": "<span style='color:red;font-weight:bold'>** ATTN **</span> Take extra care to read notes, especially for any nationality/market exclusions which could override guest nationality selected <span style='color:red;font-weight:bold'>** ATTN **</span><br/><b>No Show: </b>Should the guest fail to arrive on the check in date and we have not been notified of any cancellations or amendments in advance, they will be deemed a no show. For same day cancellation or no shows, 100% cancellation charges apply.<br>" }, { "type": "Internal Note", "text": "Exclusive privileges: enjoy 24/7 concierge support. Late check-out (2:00 PM) available upon request, excluding peak season and requiring at least 48 hours’ notice. Welcome amenities can be arranged on demand. To unlock these privileges and benefit from our dedicated concierge service, email concierge@hotelbeds.com with your booking number. https://www.privilege-terms.com/ Estimated total amount of taxes & fees for this booking:40.00 Utd. Arab Emir. Dirham payable on arrival. Please note that the city tax for accommodations with more than 1 bedroom shall be charged per bedroom per night. Check-in hour 15:00-00:00.Car park YES (With additional debit notes)." } ], "status": "quoted", "canxFees": [ { "amount": 1883.02 } ], "cancellationPolicyStatus": "NonRefundable" } ], "quoteRefreshStatus": "ok" }, { "id": 663174328, "hotelId": 319112, "hotelName": "Address Downtown", "creationDate": "2025-11-11", "arrivalDate": "2025-11-15", "nights": 2, "totalPrice": 1883.02, "status": "quoted", "rooms": [ { "roomType": { "code": "93849085", "text": "Deluxe Room" }, "mealType": { "code": "1000041", "text": "Room only" }, "messages": [ { "type": "General", "text": "<span style='color:red;font-weight:bold'>** ATTN **</span> Take extra care to read notes, especially for any nationality/market exclusions which could override guest nationality selected <span style='color:red;font-weight:bold'>** ATTN **</span><br/><b>No Show: </b>Should the guest fail to arrive on the check in date and we have not been notified of any cancellations or amendments in advance, they will be deemed a no show. For same day cancellation or no shows, 100% cancellation charges apply.<br>" }, { "type": "Internal Note", "text": "Exclusive privileges: enjoy 24/7 concierge support. Late check-out (2:00 PM) available upon request, excluding peak season and requiring at least 48 hours’ notice. Welcome amenities can be arranged on demand. To unlock these privileges and benefit from our dedicated concierge service, email concierge@hotelbeds.com with your booking number. https://www.privilege-terms.com/ Estimated total amount of taxes & fees for this booking:40.00 Utd. Arab Emir. Dirham payable on arrival. Please note that the city tax for accommodations with more than 1 bedroom shall be charged per bedroom per night. Check-in hour 15:00-00:00.Car park YES (With additional debit notes)." } ], "status": "quoted", "canxFees": [ { "amount": 1883.02 } ], "cancellationPolicyStatus": "NonRefundable" } ], "quoteRefreshStatus": "ok" } ] } }