Sign in

v1

latestOpenAPI 3.0.02026-07-247251950.2 KB
Manage bookings

Amend booking checkin, checkout or occupancies

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

  1. The system searches for live availability at the same hotel with the new parameters.
  2. Up to maxPrebooks alternative rates are selected (sorted by price ascending). Defaults to 3 when omitted; capped at 10 (any larger value is silently clamped to 10).
  3. A prebook session is created for each rate.
  4. The caller receives a list of prebookId values ready to be used with POST /rates/rebook.

What You Get

  • Up to maxPrebooks prebook sessions — Each with a prebookId, final pricing, cancellation policies, and room details
  • Price comparison — priceDifferencePercent shows how each alternative compares to the original booking's selling price (negative = cheaper than what the guest paid, positive = more expensive)
  • Policy change flags — cancellationChanged and boardChanged highlight 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_PAY alternatives; every other booking (including pay-later, succeeded, credit_line) only sees NUITEE_PAY alternatives. 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

  1. Call this endpoint with the bookingId and new occupancies/dates — get back up to maxPrebooks prebookId values.
  2. Call POST /rates/rebook with the chosen prebookId and existingBookingId — new booking confirmed, original cancelled.
post/bookings/{bookingId}/alternative-prebooks

Path parameters

bookingIdstring required

(Required) The unique identifier of the confirmed booking to amend.

Request body

checkinstring date

The new check-in date in YYYY-MM-DD format. Must be before checkout.

checkoutstring date

The new check-out date in YYYY-MM-DD format. Must be after checkin.

refundableRatesOnlyboolean

When true, only fully refundable alternative rates are returned. Defaults to false (or true if the original booking was refundable).

boardTypestring

Filter results by board/meal-plan type (e.g. RO for Room Only, BB for Bed & Breakfast). Leave empty to return all board types.

maxPrebooksinteger

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.

Example request

{
  "occupancies": [
    {
      "adults": 2,
      "children": []
    }
  ],
  "checkin": "2026-02-28",
  "checkout": "2026-03-02",
  "boardType": "RO",
  "maxPrebooks": 5
}

Response

Up to maxPrebooks (default 3, max 10) alternative prebook sessions created successfully.

guestLevelinteger

Guest loyalty level used for loyalty programme pricing.

sandboxboolean

Present and true when the request was made in sandbox mode.