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

uuidstringrequired

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

Header parameters

x-sm-api-idstringrequired

The api id for channel

x-sm-api-keystringrequired

The api key for channel

Body

checkinstring · daterequired

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

checkoutstring · daterequired

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 · default: false

Indicates whether net invoicing should be applied to the reservation.

roomsobject[]required

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/properties/{uuid}/reservations' \
  --header 'x-sm-api-id: text' \
  --header 'x-sm-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "checkin": "2025-02-28",
    "checkout": "2025-02-28",
    "dealCode": "text",
    "netInvoicing": false,
    "rooms": [
      {
        "roomRateUuid": "text",
        "adults": 1,
        "children": 1,
        "applyDeal": true
      }
    ]
  }'

200

400

401

404

500

200

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

Successful response. A pending reservation has been created.