Properties

Find properties that match given search criteria. The response is an array of properties sorted by distance (nearest to furthest) unless otherwise specified. Each property includes a recommended package of the best available non-deal room rate. If deal codes are included, the best available deal room rate for each supported deal code will also be provided.

GET/properties

Query parameters

Header parameters

Response

200400401404429500

successful

Headers

Body

application/json

uuid*string

Unique identifier for the property.

name*string

The name of the property.

propertyTypeTranslationText (object)

descriptionTranslationText (object)

address*string

The address of the property.

suburbstring

The suburb where the property is located.

state*string

The state or region where the property is located.

country*string

The country where the property is located.

emailstring

The contact email for the property.

phoneNumber*string

The contact phone number for the property.

language*string

The primary language used by the property.

latitude*number

The latitude coordinate of the property.

longitude*number

The longitude coordinate of the property.

checkinStartTime*string

The earliest time guests can check in.

checkinEndTimestring

The latest time guests can check in.

checkoutEndTime*string

The latest time guests must check out.

starRatingStarRatings (enum)

11.522.533.544.555.56

currency*string

The currency of the price

photoPhoto (object)

amenitiesarray of TranslationText (object)

Amenities that are available at this property

acceptedCardTypes*array of enum

accepted credit card types at this property

totalCommissionPercentage*number

The total commission percentage for this property.

siteminderCommissionPercentage*number

SiteMinder's portion of the commission percentage.

channelCommissionPercentage*number

The channel partner's portion of the commission percentage.

rooms*array of object

Available rooms and their details.

specialConditions*nullable SpecialConditions (object)

Request

JavaScriptCurlPython

const response = await fetch('/properties?latitude=0&longitude=0&checkin=2024-11-21&checkout=2024-11-21', {
    method: 'GET',
    headers: {
      "x-sm-api-id": "text",
      "x-sm-api-key": "text"
    },
});
const data = await response.json();

Response

200400401404429500

[
  {
    "uuid": "text",
    "name": "text",
    "propertyType": {
      "text": "text",
      "language": "text"
    },
    "description": {
      "text": "text",
      "language": "text"
    },
    "address": "text",
    "suburb": "text",
    "state": "text",
    "country": "text",
    "email": "text",
    "phoneNumber": "text",
    "language": "text",
    "latitude": 0,
    "longitude": 0,
    "checkinStartTime": "text",
    "checkinEndTime": "text",
    "checkoutEndTime": "text",
    "starRating": 1,
    "currency": "text",
    "photo": {
      "url": "https://example.com",
      "captions": "text"
    },
    "amenities": [
      {
        "text": "text",
        "language": "text"
      }
    ],
    "acceptedCardTypes": [
      "AX"
    ],
    "totalCommissionPercentage": 0,
    "siteminderCommissionPercentage": 0,
    "channelCommissionPercentage": 0,
    "rooms": [
      {
        "roomRateUuid": "text",
        "roomTypeName": {
          "text": "text",
          "language": "text"
        },
        "roomTypeDescription": {
          "text": "text",
          "language": "text"
        },
        "ratePlanName": "text",
        "breakfastIncluded": false,
        "roomArea": "text",
        "photo": {
          "url": "https://example.com",
          "captions": "text"
        },
        "amenities": [
          {
            "text": "text",
            "language": "text"
          }
        ],
        "views": [
          {
            "text": "text",
            "language": "text"
          }
        ],
        "bedConfigurations": [
          {
            "bedCode": {
              "text": "text",
              "language": "text"
            },
            "quantity": 0
          }
        ],
        "cancellationPolicy": {
          "policyType": "non-refundable",
          "freeCancellationUntilDays": 0
        },
        "prices": [
          {
            "totalPrice": 0,
            "dealCode": "text",
            "totalCommissionPercentage": 0,
            "siteminderCommissionPercentage": 0,
            "channelCommissionPercentage": 0
          }
        ],
        "lowInventory": false
      }
    ],
    "specialConditions": {
      "taxExemptions": [
        {
          "name": "is-nz-gst-opt-out"
        }
      ]
    }
  }
]