For the complete documentation index, see llms.txt. This page is also available as Markdown.

Property

Return detailed information for a specific property contained in your group.

API: Direct Booking · Operation: Property · Direction: SM → Property · Method: Pull (Property-initiated)

Retrieve property details

get

Retrieve detailed information for a property.

Authorizations
x-sm-api-keystringRequired
Path parameters
propertyUuidstringRequired

UUID for a property.

Header parameters
x-sm-api-keystringRequired

API key used to authenticate the request.

Responses
200

Successful operation

application/json
uuidstring · uuidRequired

Unique identifier for the property in the SiteMinder Direct Booking product.

namestringRequired

The property name as it appears in the SiteMinder Direct Booking product.

latitudenumberRequired

Geographic latitude of the property.

longitudenumberRequired

Geographic longitude of the property.

timezonestringRequired

IANA time zone identifier for the property (e.g. Australia/Sydney).

currencyIsoCodestringRequired

ISO 4217 three-letter currency code used for pricing at this property.

bookingEngineUrlstring · uri · nullableRequired

URL to the property's booking engine.

descriptionstring · nullableRequired

The property description as it appears in the SiteMinder Direct Booking product.

termsAndConditionsstring · nullableRequired

The property's terms and conditions

instructionsToLocationstring · nullableRequired

Directions or instructions for reaching the property.

get/properties/{propertyUuid}
GET /properties/{propertyUuid} HTTP/1.1
x-sm-api-key: text
Accept: */*
{
  "uuid": "f63ce398-da03-4573-856d-ed8d71e57e3d",
  "name": "Demo Hotel",
  "latitude": -33.8688197,
  "longitude": 151.2092955,
  "timezone": "Australia/Sydney",
  "currencyIsoCode": "AUD",
  "bookingEngineUrl": "https://direct-book.com/properties/propertyChannelCode",
  "description": "A boutique hotel in the heart of the city.",
  "termsAndConditions": "Guests must present a valid ID at check-in.",
  "instructionsToLocation": "Enter via Cumberland Street.",
  "address": {
    "addressLine1": "88 Cumberland Street",
    "addressLine2": "Apartment",
    "postcode": "2000",
    "state": "NSW",
    "suburb": "The Rocks",
    "country": "Australia"
  },
  "features": {
    "facilities": [
      {
        "otaCode": 286,
        "name": "Complimentary wireless Internet"
      }
    ],
    "parking": [
      {
        "otaCode": 42,
        "name": "Free parking"
      }
    ],
    "transport": [
      {
        "otaCode": 41,
        "name": "Free airport shuttle"
      }
    ]
  },
  "policies": {
    "smokingPolicy": {
      "smokeFreeProperty": true,
      "nonSmokingRooms": null,
      "allPublicAreasNonSmoking": null
    },
    "checkInCheckOut": {
      "checkInStartTime": "14:00",
      "checkInEndTime": "23:00",
      "checkOutStartTime": "07:00",
      "checkOutEndTime": "11:00",
      "restrictedCheckInCheckOut": true
    }
  },
  "photos": [
    {
      "url": "https://images.example.com/attachments/property_photos/images/1/lobby.jpg",
      "caption": "Lobby",
      "sortOrder": 1
    },
    {
      "url": "https://images.example.com/attachments/property_photos/images/2/pool.jpg",
      "caption": null,
      "sortOrder": null
    }
  ]
}

sparkles

Still have questions?

Last updated

Was this helpful?