Sign in

v1

latestOpenAPI 3.0.32026-07-23183961.3 KB

Create a pending reservation to lock in rates and availabilities for a specific property. This endpoint allows you to temporarily hold a reservation before confirming it, ensuring the rates and room availability are secured for a short period.

Pending Reservation Workflow:

  1. Call this endpoint to create a pending reservation
  2. The response includes a bookingReferenceId and expiresInMinutes
  3. Complete payment collection from the guest
  4. Call /reservations/{bookingReferenceId}/confirmation before expiration
  5. If not confirmed within the expiration window, the reservation is automatically released

Room Allocation Rules:

  • Maximum 10 rooms per reservation
  • Each room must specify roomRateUuid, adults, and children count
  • The roomRateUuid must correspond to a valid rate returned from property search endpoints
  • Occupancy (adults + children) should not exceed the room type's maximum capacity
  • Use applyDeal per room to selectively apply deal rates when a dealCode is specified

Deal Application:

  • Set dealCode at the reservation level to apply a deal
  • Use applyDeal: true for specific rooms to apply the deal rate to those rooms
  • Rooms with applyDeal: false or null will use standard rates even if a deal code is specified
  • This allows mixed bookings with both deal and non-deal rooms
post/properties/{uuid}/reservations

Path parameters

uuidstring required

The unique identifier of the property for which the reservation is being made

Headers

x-sm-api-idstring required

The api id for channel

x-sm-api-keystring required

The api key for channel

Request body

checkinstring date required

The arrival date. Must be within 500 days in the future and in the format yyyy-mm-dd.

checkoutstring date required

The departure date. Must be later than checkin. Must be between 1 and 30 days after checkin. Must be within 500 days in the future and in the format yyyy-mm-dd.

dealCodestring nullable

The code of any deal to be applied to the reservation. If null, no deal will be applied.

netInvoicingboolean

Indicates whether net invoicing should be applied to the reservation. When set to true, the commission is deducted from the booking amount, and the property receives the net amount (total minus commission).

Response

Successful response. A pending reservation has been created.

propertyUuidstring required

The unique identifier of the property for which the reservation is made.

propertyEmailstring

The contact email address for the property.

propertyPhoneNumberstring required

The contact phone number for the property.

bookingReferenceIdstring required

The unique identifier for this pending reservation.

expiresInMinutesnumber required

The number of minutes before the pending reservation expires and is no longer valid.

currencyCodestring required

The currency code for all monetary values in this response.

paymentTotalnumber required

The total payment amount for the reservation, including all taxes and fees.

paymentTotalLessCommissionnumber required

The total payment amount minus the commission.