post_bookings_bookingid_alternative_prebooks
Search for alternative rates at the same hotel and create ready-to-book prebook sessions to change a confirmed booking's dates or room occupancy.
Instructions
Overview
Hard Amendment — Search for alternative rates at the same hotel and create ready-to-book prebook sessions for a confirmed booking. Used when the guest needs to change their check-in/check-out dates or room occupancy.
When to Use
Date changes — Guest needs different check-in or check-out dates
Occupancy changes — Guest needs a different number of adults or children
Hard amendments — Situations where the booking must be cancelled and re-booked with new parameters
How It Works
The system searches for live availability at the same hotel with the new parameters.
Up to
maxPrebooksalternative rates are selected (sorted by price ascending). Defaults to 3 when omitted; capped at 10 (any larger value is silently clamped to 10).A prebook session is created for each rate.
The caller receives a list of
prebookIdvalues ready to be used withPOST /rates/rebook.
What You Get
Up to
maxPrebooksprebook sessions — Each with aprebookId, final pricing, cancellation policies, and room detailsPrice comparison —
priceDifferencePercentshows how each alternative compares to the original booking's selling price (negative = cheaper than what the guest paid, positive = more expensive)Policy change flags —
cancellationChangedandboardChangedhighlight any policy differences
Completing the Amendment
Pass the chosen prebookId and the original bookingId as existingBookingId to POST /rates/rebook. On success, the new booking is created and the original booking is automatically cancelled — no separate cancellation call is needed.
Key Notes
The booking must be in CONFIRMED status.
If the original booking is non-refundable, only non-refundable alternatives are returned (unless overridden with
refundableRatesOnly).Payment type is honoured — only rates that support the original booking's payment type are returned. A pay-at-property booking only sees
PROPERTY_PAYalternatives; every other booking (including pay-later, succeeded, credit_line) only seesNUITEE_PAYalternatives. Pay-later eligibility additionally requires a refundable rate, which is enforced automatically when the original booking was refundable.The nationality and currency of the original booking are used for the availability search.
If the cancellation of the original booking fails after the new booking is created, the error is logged but the new booking is still returned.
Quick Start
Call this endpoint with the
bookingIdand newoccupancies/dates — get back up tomaxPrebooksprebookIdvalues.Call
POST /rates/rebookwith the chosenprebookIdandexistingBookingId— new booking confirmed, original cancelled.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| checkin | No | The new check-in date in YYYY-MM-DD format. Must be before `checkout`. | |
| checkout | No | The new check-out date in YYYY-MM-DD format. Must be after `checkin`. | |
| boardType | No | Filter results by board/meal-plan type (e.g. `RO` for Room Only, `BB` for Bed & Breakfast). Leave empty to return all board types. | |
| bookingId | Yes | (Required) The unique identifier of the confirmed booking to amend. | |
| maxPrebooks | No | Maximum number of alternative prebook sessions to create. Defaults to 3 when omitted. Values above 10 are silently capped at 10; values ≤ 0 fall back to the default. The response may contain fewer entries when the hotel does not have enough distinct alternative offers. | |
| occupancies | Yes | The desired room occupancies for the amended stay. One entry per room. | |
| refundableRatesOnly | No | When true, only fully refundable alternative rates are returned. Defaults to false (or true if the original booking was refundable). |