Lock Reservation

Used to lock a room rate or room rates at a specific property for a limited period (10 minutes).

Request

To successfully call this endpoint, you must provide the following data points:

• Check-in Date

• Check-out Date

• Deal code: The deal code that is applicable to the reservation

• Array of up to 10 rooms:

  • Unique identifier for the room rate to be booked

  • Number of adults in the room

  • Number of children in the room

  • A flag on if the deal should be applied to the room rate for this room

Response

The response will provide:

• The unique identifier for the property

• The property’s email address

• The property’s phone number

• A booking reference for the reservation

• The amount of time that the reservation is locked for before it expires (in minutes)

• The currency for the prices in the response

• The total payment amount for the reservation inclusive of taxes and fees

• An array of itemised taxes applicable to the reservation - Only included if the property has defined taxes

  • The name of the tax

  • The amount of the tax

• An array of itemised fees applicable to the reservation - Only included if the property has defined fees

  • The name of the fee

  • The amount of the fee

• An array of rooms booked in the reservation:

  • A unique identifier for the room

  • The name of the room type for the room

  • A unique identifier for the room rate that applies to the room

  • Number of adults and children in the room

  • The total payment amount for the room

  • The total commission rate (SiteMinder + Partner share of commission) payable by the property on this room rate

  • SiteMinder’s share of the total commission rate on this room rate

  • The Channel Partner’s share of the total commission rate on this room rate

• An array of licences that apply to the property. A licence is defined as any business licence the property needs to operate in its jurisdiction - Only included if the property has defined licences:

  • Licence Type: Whether the licence applies to the entire property or to each room

  • Licence Number: An alphanumeric number for the licence

  • Licence Issue Date: The date the licence was issued

• The cancellation policy that will apply to this reservation. In a multi-room booking scenario, If two room rates with different cancellation policies are booked, the room rate with the earlier cancellation period will be used for the entire booking.

Lock in rates and availabilities

POST/properties/{uuid}/reservations

Path parameters

uuid*string

The id of the property

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

rooms*array of object

Response

200400401404500

successful

Headers

Body

application/json

propertyUuid*string

the property's id

propertyEmailstring

propertyPhoneNumber*string

bookingReferenceId*string

the pending reservation id

expiresInMinutes*number

number of minutes before the pending reservation is no longer valid

currencyCode*string

paymentTotal*number

taxesarray of object

feesarray of object

rooms*array of object

licensesarray of object

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-10-07",
      "checkout": "2024-10-07",
      "rooms": [
        {
          "roomRateUuid": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

200400401404500

{
  "propertyUuid": "text",
  "propertyEmail": "text",
  "propertyPhoneNumber": "text",
  "bookingReferenceId": "text",
  "expiresInMinutes": 0,
  "currencyCode": "text",
  "paymentTotal": 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
  }
}