Book a quote
Write. Confirms a quote. Requires Idempotency-Key. Availability is re-checked under a lock, so
two partners can never book the last room. If the quote has an active hold, the hold is converted.
Headers
Required. A unique key (UUID recommended) per booking attempt; reuse it when retrying.
<= 255 characters
Example:8e03978e-40d5-43e8-bc93-6894a57f9324
Body
application/json
Body
ReservationRequest
pay_at_hotel: the guest pays the property; partner_collect: you collected payment and settle
with Kong Hotels under your contract (shown as a prepayment on the folio).
Allowed values:pay_at_hotelpartner_collect
Your booking reference; searchable via GET /reservations?partner_reference=.
<= 64 characters
Show Child Parameters
Show Child Parameters
>= 0<= 17
<= 2000 characters
Match pattern:^\d{2}:\d{2}$
Response
application/json
Response
Reservation confirmed.
Show Child Parameters
Authentication
Headers
Body
Get a reservation
Path Parameters
Example:KH4DEMO01
Response
application/json
Response
The reservation.
Show Child Parameters
Authentication
Path Parameters
Modify a reservation
Write. Send only the fields to change.
- Guest details (
guestis merged),additional_guests,special_requests,
estimated_arrival_time,partner_reference,children_ages: applied as-is. - Stay changes (
check_in,check_out,adults,children,rooms,room_type_code,
rate_plan_code): availability is re-checked, the stay is re-priced at current rates with the
original promotion and add-ons, andmeta.price_differenceshows the change. Not allowed on
rate plans withallows_modification: falseor once the stay has started.
Path Parameters
Example:KH4DEMO01
Body
application/json
Body
ReservationUpdate
Merged into the existing guest details.
Show Child Parameters
Show Child Parameters
Response
application/json
Response
Updated reservation.
Show Child Parameters
Show Child Parameters
Authentication
Path Parameters
Body
Get the cancellation fee
The fee that would apply if the reservation were cancelled right now, with the policy terms.
Path Parameters
Example:KH4DEMO01
Response
application/json
Response
Cancellation quote.
Show Child Parameters
Authentication
Path Parameters
Cancel a reservation
Write. Cancels a confirmed reservation and charges any fee due under its cancellation policy.
Send expected_fee (from the cancellation quote you showed the guest); if the fee has since risen,
the request fails with 409 cancellation-fee-changed instead of charging more.
Path Parameters
Example:KH4DEMO01
Headers
Optional. Makes the request safe to retry for 24 hours.
<= 255 characters
Example:8e03978e-40d5-43e8-bc93-6894a57f9324
Body
application/json
Body
<= 255 characters
The fee you displayed to the guest.
Response
application/json
Response
Cancelled reservation. See cancellation for the cancellation number and fee.