Property

Returns content and available room rates at a specific property that matches the occupancy combination defined in the request.

Request

To successfully call this endpoint, you must provide the following data points:

• The Unique Identifier for the property

• Check-in Date

• Check-out Date

• Either:

• Total Number of Adults. Total Number of Children and total rooms (up to 10) in the reservation;

  • This provides less accurate pricing as we will assume an even distribution of adults and children into rooms to return the best available rate for each property in the search results

• Total Number of Adults and Total Number of Children in each room (up to 10 rooms)

  • This provides more accurate pricing as we will return the best available rate that matches the search criteria

Additionally, you may specify:

• Deal code: Only Return rates for the specified deal code

• Language: Can specify a language to receive content in. If the language is unavailable the response will be in the property’s default language. Language must be one of: English, Spanish, French, Portuguese, German, Italian, Indonesian or Thai.

Response

If the request results in multiple rooms with the same occupancy combination, there will not be multiple entries in the room rates array. The room rates in the array will only be displayed if they can fulfil the number of rooms in the request.

The response will provide:

• The unique identifier for the property

• The property name

• The property type (along with the language it is in)

• The property’s description - Only included if property description is available (along with the language it is in)

• The property’s address including state, suburb and country

• The property’s email address

• The property’s phone number

• Latitude and longitude for the property

• Check-in Start time

• Check-in End time - Only included if property has restricted check-in periods

• Check-out End time

• Star Rating - Only included if the property has nominated a star rating

• Currency for all room rates at the property

• Media for the property with any captions - Only included if media is available for the property

• An array of amenity codes - Only included if amenities are available for the property (along with the language it is in)

• An array of card types accepted at the property (i.e. The card schemes that the property can accept to collect payment on reservations)

• The total commission rate (SiteMinder + Partner share of commission) payable by the property

• SiteMinder’s share of the total commission rate

• The Channel Partner’s share of the total commission rate

• An array of room types. Each entry in the array will contain:

  • Room Type Name (along with the language it is in)

  • Room Type description - Only included if room type description is available (along with the language it is in)

  • Room Area - Only included if room area is available

  • An array of Bed Configurations available for the room type - Only included if a room type configuration is available (along with the language it is in)

  • An array of views available for the room type - Only included if a room type view is available (along with the language it is in)

  • Media for the room type with any captions - Only included if room type media is available

  • An array of amenities in the room type - Only included if room type amenities are available (along with the language it is in)

  • An array of room rates for the room type that match the occupancy combination in the request:

    • A unique identifier for the room rate

    • Rate Plan Name

    • An indicator if breakfast is included in the price

    • Total Price

    • The occupancy combination for the room rate (number of adults and children)

    • Cancellation period for the room rate

    • A deal code - Only included if applicable to the room rate

    • The total commission rate (SiteMinder + Partner share of commission) payable by the property for this specific room rate. If the room rate has a deal applied, the total commission rate may be different from the standard total commission rate in the parent property object.

    • SiteMinder’s share of the total commission rate. Is the same as the standard SiteMinder share of total commission in the parent property object.

    • The Channel Partner’s share of the total commission rate. If the room rate has a deal applied, the Channel Partner’s share of the total commission rate may be different from the standard Channel Partner’s share of the total commission rate in the parent property object.

Get room rates under this property that satisfies the search criteria

GET/properties/{uuid}

Path parameters

uuid*string

The id of the property

Query parameters

Header parameters

Response

200400401404429500

successful

Headers

Body

application/json

uuid*string

name*string

propertyTypeTranslationText (object)

descriptionTranslationText (object)

address*string

suburbstring

state*string

country*string

emailstring

phoneNumber*string

language*string

latitude*number

longitude*number

checkinStartTime*string

checkinEndTimestring

checkoutEndTime*string

starRatingStarRatings (enum)

11.522.533.544.555.56

currency*string

The currency of the price

photosarray of Photo (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

siteminderCommissionPercentage*number

channelCommissionPercentage*number

roomTypes*array of object

Request

JavaScriptCurlPython

const response = await fetch('/properties/{uuid}?checkin=2024-09-19&checkout=2024-09-19', {
    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
        }
      ]
    }
  ]
}