Property

get

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.

Path parameters

uuidstringRequired

The unique identifier of the property

Query parameters

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.

totalAdultsinteger · max: 655350Optional

Specify the total number of adults across all rooms. Must also specify totalRooms field. Do not use this if searching with the occupants rooms list.

totalChildreninteger · max: 655350Optional

Specify the total number of children across all rooms. Must also specify totalRooms field. Do not use this if searching with the occupants rooms list.

totalRoomsinteger · min: 1 · max: 10Optional

Specify the total number of rooms. Must also specify totalAdults and/or totalChildren fields. Do not use this if searching with the occupants rooms list.

dealCodestringOptional

Only return rates associated with the given deal code

languagestring · enumOptional

Specify the preferred language for returned content. Falls back to the property's default language if unavailable.

Possible values:

Header parameters

x-sm-api-idstringRequired

The api id for channel

x-sm-api-keystringRequired

The api key for channel

Responses

200

Successful response

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

404

The specified resource was not found

application/json

429

The number of requests for the last 5 minutes window has reached the limit for the given channel

application/json

500

Unexpected error occurred

application/json

get

HTTPcURLJavaScriptPython

GET /properties/{uuid}?checkin=2025-05-13&checkout=2025-05-13 HTTP/1.1
Host: 
x-sm-api-id: text
x-sm-api-key: text
Accept: */*

{
  "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": 1,
  "longitude": 1,
  "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": 1,
  "siteminderCommissionPercentage": 1,
  "channelCommissionPercentage": 1,
  "roomTypes": [
    {
      "uuid": "text",
      "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": 1
        }
      ],
      "roomRates": [
        {
          "uuid": "text",
          "ratePlanUuid": "text",
          "ratePlanName": "text",
          "breakfastIncluded": true,
          "totalPrice": 1,
          "taxes": [
            {
              "name": "text",
              "amount": 1
            }
          ],
          "fees": [
            {
              "name": "text",
              "amount": 1
            }
          ],
          "adults": 1,
          "children": 1,
          "cancellationPolicy": {
            "policyType": "non-refundable",
            "freeCancellationUntilDays": 1
          },
          "dealCode": "text",
          "totalCommissionPercentage": 1,
          "siteminderCommissionPercentage": 1,
          "channelCommissionPercentage": 1,
          "lowInventory": true
        }
      ]
    }
  ],
  "specialConditions": {
    "taxExemptions": [
      {
        "name": "is-nz-gst-opt-out"
      }
    ]
  }
}