Properties

Return a list of properties in your group, or return detailed information for a specific property contained in your group.

Retrieves all properties based on permissions

Retrieve the uuid and name for all properties which you have access to

GET/properties

Authorization

apiKey

Query parameters

Header parameters

Response

200400401403404500

OK

Body

application/json

pageinteger

page number

perPageinteger

number of records per page

totalinteger

total number of records

totalPagesinteger

total number of pages

resultsarray of PropertySummary (object)

Request

JavaScriptCurlPython

const response = await fetch('/properties', {
    method: 'GET',
    headers: {
      "x-api-key": "text",
      "x-sm-trace-token": "text"
    },
});
const data = await response.json();

Response

200400401403404500

{
  "results": [
    {
      "uuid": "f63ce398-da03-4573-856d-ed8d71e57e3d",
      "name": "Demo Hotel"
    }
  ],
  "page": 1,
  "perPage": 1,
  "total": 1,
  "totalPages": 1
}

Retrieve property details

Retrieve detailed information for a property.

GET/properties/{uuid}

Authorization

apiKey

Path parameters

uuid*string

uuid for a property

Header parameters

Response

200400401403404500

OK

Body

application/json

uuidstring

This will return the uuid assigned to the property in the SiteMinder Direct Booking product

namestring

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

latitudenumber

This will return the latitude of the of the selected property

longitudenumber

This will return the longitude of the of the selected property

timeZonestring

This will be the timezone of the selected property

currencystring

Property currency

bookingEngineUrlstring

Booking link to the select property's Booking Engine

addressobject

Full address returned, Address 1 & 2, postcode, state and suburb

Request

JavaScriptCurlPython

const response = await fetch('/properties/{uuid}', {
    method: 'GET',
    headers: {
      "x-api-key": "text",
      "x-sm-trace-token": "text"
    },
});
const data = await response.json();

Response

200400401403404500

{
  "uuid": "f63ce398-da03-4573-856d-ed8d71e57e3d",
  "name": "Demo Hotel",
  "latitude": -33.8688197,
  "longitude": 151.2092955,
  "timeZone": "Australia/Sydney",
  "currency": "AUD",
  "bookingEngineUrl": "https://direct-book.com/properties/propertyChannelCode",
  "address": {
    "addressLine1": "88 Cumberland Street",
    "addressLine2": "Apartment",
    "postcode": "2000",
    "state": "NSW",
    "suburb": "The Rocks"
  }
}