Property

Get detailed information and room rates for a specific property that satisfies the given search criteria. This endpoint provides more comprehensive data about a single property, including its room types and available rates.

GET/properties/{uuid}

Path parameters

uuid*string

The unique identifier of the property

Query parameters

Header parameters

Response

200400401404429500

Successful response

Headers

Body

application/json

uuid*string

Unique identifier of the property

name*string

Name of the property

propertyTypeTranslationText (object)

descriptionTranslationText (object)

address*string

Street address of the property

suburbstring

Suburb where the property is located

state*string

State or region where the property is located

country*string

Country where the property is located

emailstring

Contact email address for the property

phoneNumber*string

Contact phone number for the property

language*string

Primary language used by the property

latitude*number

Latitude coordinate of the property's location

longitude*number

Longitude coordinate of the property's location

checkinStartTime*string

Earliest time guests can check in

checkinEndTimestring

Latest time guests can check in

checkoutEndTime*string

Latest time guests must check out

starRatingStarRatings (enum)

11.522.533.544.555.56

currency*string

Currency used for pricing at this property

photosarray of Photo (object)

Array of photos representing the property

amenitiesarray of TranslationText (object)

Amenities available at this property

acceptedCardTypes*array of enum

Credit card types accepted at this property

totalCommissionPercentage*number

Total commission percentage for bookings at this property

siteminderCommissionPercentage*number

SiteMinder's portion of the commission percentage

channelCommissionPercentage*number

Channel partner's portion of the commission percentage

roomTypes*array of object

Array of room types available at this property

specialConditions*nullable SpecialConditions (object)

Request

JavaScriptCurlPython

const response = await fetch('/properties/{uuid}?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",
  "photos": [
    {
      "url": "https://example.com",
      "captions": "text"
    }
  ],
  "amenities": [
    {
      "text": "text",
      "language": "text"
    }
  ],
  "acceptedCardTypes": [
    "AX"
  ],
  "totalCommissionPercentage": 0,
  "siteminderCommissionPercentage": 0,
  "channelCommissionPercentage": 0,
  "roomTypes": [
    {
      "name": {
        "text": "text",
        "language": "text"
      },
      "description": {
        "text": "text",
        "language": "text"
      },
      "roomArea": "text",
      "photos": [
        {
          "url": "https://example.com",
          "captions": "text"
        }
      ],
      "amenities": [
        {
          "text": "text",
          "language": "text"
        }
      ],
      "views": [
        {
          "text": "text",
          "language": "text"
        }
      ],
      "bedConfigurations": [
        {
          "bedCode": {
            "text": "text",
            "language": "text"
          },
          "quantity": 0
        }
      ],
      "roomRates": [
        {
          "uuid": "text",
          "ratePlanName": "text",
          "breakfastIncluded": false,
          "totalPrice": 0,
          "taxes": [
            {
              "name": "text",
              "amount": 0
            }
          ],
          "fees": [
            {
              "name": "text",
              "amount": 0
            }
          ],
          "cancellationPolicy": {
            "policyType": "non-refundable",
            "freeCancellationUntilDays": 0
          },
          "dealCode": "text",
          "totalCommissionPercentage": 0,
          "siteminderCommissionPercentage": 0,
          "channelCommissionPercentage": 0,
          "lowInventory": false
        }
      ]
    }
  ],
  "specialConditions": {
    "taxExemptions": [
      {
        "name": "is-nz-gst-opt-out"
      }
    ]
  }
}