Properties

Returns shoppable properties on ChannelsPlus based on the search criteria submitted. The endpoint also returns content and the best available deal and non-deal room rate for each property in the resul

Request

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

• Latitude and Longitude at the centre of the search location

• 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)

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

Additionally, you may specify:

• Radius (in km) from the centre in which the property is to be located. If not specified, the default value will be a 15 km radius

• Maximum number of properties to return in the search results

• Sort criteria: Distance or Name (default value is distance)

• Sort direction: Ascending or descending (default value is ascending)

• Min and Max star rating for properties in the results

• Property Type: To limit search criteria to properties that fit your criteria

• Swimming Pool available: Only return rates for properties that have a swimming pool

• Breakfast included: Only return rates with breakfast included

• Free Cancellation: Only return rates with free cancellation periods

• Deal codes: Include best deal rate for properties participating in specified deal codes

• Deal only: Only return rates that are part of the deal

Response

• The response to the get properties request is an array of properties that match the criteria. The array is sorted by distance nearest to furthest unless otherwise specified.

• The response will always include a recommended package of the best available non-deal room rate.

• If the response also includes one or more deal codes, in addition to the best available non-deal rate, the response will also include the best available deal room rate for each deal code supported by the property.

• 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.

• Each property in the array will have:

  • A unique identifier for each property

  • The property name

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

  • The property’s description - Only included if a 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

  • Currency for all room rates at the property

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

  • An array of Amenity codes - Only included if property amenities are available (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 recommended package room rates. Each entry in the array will contain:

    • A unique identifier for the room rate

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

    • Room Type description - Only included if a 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 view available for the room type - Only included if a room type view is available (along with the language it is in)

    • Rate Plan Name

    • An indicator if breakfast is included in the price

    • 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)

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

    • Cancellation period for the room rate

    • An array for prices for the room rate with one entry for the non-deal rate and an entry for each eligible deal code provided

      • Total price

      • Deal code - Only included if a deal code is applicable

      • 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.

Find properties that matches given search criteria

GET/properties

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

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

siteminderCommissionPercentage*number

channelCommissionPercentage*number

rooms*array of object

Request

JavaScriptCurlPython

const response = await fetch('/properties?latitude=0&longitude=0&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",
    "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
      }
    ]
  }
]