Lock Reservation

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.

POST/properties/{uuid}/reservations

Path parameters

uuid*string

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

Header parameters

Body

application/json

checkin*string (date)

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

checkout*string (date)

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.

dealCodenullable string

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.

rooms*array of object

An array of room bookings for this reservation. Minimum 1, maximum 10 rooms.

Response

200400401404500

Successful response. A pending reservation has been created.

Headers

Body

application/json

propertyUuid*string

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

propertyEmailstring

The contact email address for the property.

propertyPhoneNumber*string

The contact phone number for the property.

bookingReferenceId*string

The unique identifier for this pending reservation.

expiresInMinutes*number

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

currencyCode*string

The currency code for all monetary values in this response.

paymentTotal*number

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

paymentTotalLessCommissionnumber

The total payment amount minus the commission.

taxesarray of object

An array of taxes applicable to this reservation.

feesarray of object

An array of fees applicable to this reservation.

rooms*array of object

An array of rooms included in this reservation.

licensesarray of object

An array of licenses applicable to this property or room.

cancellationPolicy*CancelationPolicy (object)

Request

JavaScriptCurlPython

const response = await fetch('/properties/{uuid}/reservations', {
    method: 'POST',
    headers: {
      "x-sm-api-id": "text",
      "x-sm-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "checkin": "2024-11-21",
      "checkout": "2024-11-21",
      "rooms": [
        {
          "roomRateUuid": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

200400401404500

{
  "propertyUuid": "text",
  "propertyEmail": "text",
  "propertyPhoneNumber": "text",
  "bookingReferenceId": "text",
  "expiresInMinutes": 0,
  "currencyCode": "text",
  "paymentTotal": 0,
  "paymentTotalLessCommission": 0,
  "taxes": [
    {
      "name": "text",
      "amount": 0
    }
  ],
  "fees": [
    {
      "name": "text",
      "amount": 0
    }
  ],
  "rooms": [
    {
      "roomUuid": "text",
      "roomTypeName": "text",
      "roomRateUuid": "text",
      "paymentTotal": 0,
      "totalCommissionPercentage": 0,
      "siteminderCommissionPercentage": 0,
      "channelCommissionPercentage": 0
    }
  ],
  "licenses": [
    {
      "licenseType": "property",
      "licenseNumber": "text",
      "licenseIssueDate": "text"
    }
  ],
  "cancellationPolicy": {
    "policyType": "non-refundable",
    "freeCancellationUntilDays": 0
  }
}