# Property

## GET /properties/{uuid}

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

```json
{"openapi":"3.0.0","info":{"title":"Channels Plus Channel API","version":"0.0.1"},"paths":{"/properties/{uuid}":{"get":{"operationId":"showProperty","description":"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.","parameters":[{"$ref":"#/components/parameters/SmApiId"},{"$ref":"#/components/parameters/SmApiKey"},{"name":"uuid","description":"The unique identifier of the property","required":true,"in":"path","schema":{"type":"string"}},{"name":"checkin","description":"The arrival date. Must be within 500 days in the future and in the format yyyy-mm-dd.","required":true,"in":"query","schema":{"type":"string","format":"date"}},{"name":"checkout","description":"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.","required":true,"in":"query","schema":{"type":"string","format":"date"}},{"name":"rooms","description":"Use the rooms list to specify exact occupants in each room. Provides more accurate pricing. Do not use this if searching by totalAdults, totalChildren & totalRooms.","in":"query","schema":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"object","additionalProperties":false,"properties":{"adults":{"type":"integer","minimum":0,"maximum":65535,"description":"Number of adults in the room"},"children":{"type":"integer","minimum":0,"maximum":65535,"description":"Number of children in the room"}},"required":["adults","children"]}}},{"name":"totalAdults","description":"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.","in":"query","schema":{"type":"integer","minimum":0,"maximum":655350}},{"name":"totalChildren","description":"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.","in":"query","schema":{"type":"integer","minimum":0,"maximum":655350}},{"name":"totalRooms","description":"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.","in":"query","schema":{"type":"integer","minimum":1,"maximum":10}},{"name":"dealCode","description":"Only return rates associated with the given deal code","in":"query","schema":{"type":"string"}},{"name":"language","description":"Specify the preferred language for returned content. Falls back to the property's default language if unavailable.","in":"query","schema":{"type":"string","enum":["de","en","es","fr","id","it","pt","th"]}}],"responses":{"200":{"description":"Successful response","headers":{"ratelimit-policy":{"schema":{"type":"string"},"description":"Shows the number of requests allowed per number of seconds window. e.g. '100;w=60' means 100 requests in a 60 seconds window."},"ratelimit-limit":{"schema":{"type":"integer"},"description":"The number of requests allowed per window"},"ratelimit-remaining":{"schema":{"type":"integer"},"description":"The number of requests left for the time window."},"ratelimit-reset":{"schema":{"type":"integer"},"description":"The number of seconds left for the window to reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"uuid":{"type":"string","description":"Unique identifier of the property"},"name":{"type":"string","description":"Name of the property"},"propertyType":{"$ref":"#/components/schemas/TranslationText","description":"Type of the property with language information"},"description":{"$ref":"#/components/schemas/TranslationText","description":"Detailed description of the property with language information"},"address":{"type":"string","description":"Street address of the property"},"suburb":{"type":"string","description":"Suburb where the property is located"},"state":{"type":"string","description":"State or region where the property is located"},"country":{"type":"string","description":"Country where the property is located"},"email":{"type":"string","description":"Contact email address for the property"},"phoneNumber":{"type":"string","description":"Contact phone number for the property"},"language":{"type":"string","maxLength":16,"description":"Primary language used by the property"},"latitude":{"type":"number","description":"Latitude coordinate of the property's location"},"longitude":{"type":"number","description":"Longitude coordinate of the property's location"},"checkinStartTime":{"type":"string","minLength":1,"maxLength":10,"description":"Earliest time guests can check in"},"checkinEndTime":{"type":"string","minLength":1,"maxLength":10,"description":"Latest time guests can check in"},"checkoutEndTime":{"type":"string","minLength":1,"maxLength":10,"description":"Latest time guests must check out"},"starRating":{"$ref":"#/components/schemas/StarRatings","description":"Star rating of the property"},"currency":{"type":"string","description":"Currency used for pricing at this property"},"photos":{"type":"array","description":"Array of photos representing the property","items":{"$ref":"#/components/schemas/Photo"}},"amenities":{"type":"array","description":"Amenities available at this property","items":{"$ref":"#/components/schemas/TranslationText"}},"acceptedCardTypes":{"type":"array","description":"Credit card types accepted at this property","items":{"type":"string","enum":["AX","DN","DS","JC","MC","CU","VI"]},"minItems":1},"totalCommissionPercentage":{"type":"number","description":"Total commission percentage for bookings at this property"},"siteminderCommissionPercentage":{"type":"number","description":"SiteMinder's portion of the commission percentage"},"channelCommissionPercentage":{"type":"number","description":"Channel partner's portion of the commission percentage"},"roomTypes":{"type":"array","description":"Array of room types available at this property","items":{"type":"object","additionalProperties":false,"properties":{"uuid":{"type":"string","description":"Unique identifier for this room type"},"name":{"$ref":"#/components/schemas/TranslationText","description":"Name of the room type with language information"},"description":{"$ref":"#/components/schemas/TranslationText","description":"Detailed description of the room type with language information"},"roomArea":{"type":"string","description":"Size of the room, including the unit of measurement","nullable":true},"photos":{"type":"array","description":"Array of photos representing the room type","items":{"$ref":"#/components/schemas/Photo"}},"amenities":{"type":"array","description":"Amenities available in this room type","items":{"$ref":"#/components/schemas/TranslationText"}},"views":{"type":"array","description":"Views available from this room type","items":{"$ref":"#/components/schemas/TranslationText"}},"bedConfigurations":{"type":"array","description":"Possible bed configurations for this room type","items":{"type":"object","additionalProperties":false,"properties":{"bedCode":{"$ref":"#/components/schemas/TranslationText","description":"Type of bed (e.g., \"King\", \"Twin\") with language information"},"quantity":{"type":"number","minimum":1,"description":"Number of beds of this type in the room"}}}},"roomRates":{"type":"array","description":"Available rates for this room type","items":{"type":"object","additionalProperties":false,"properties":{"uuid":{"type":"string","description":"Unique identifier for this room rate"},"ratePlanUuid":{"type":"string","description":"Unique identifier for the rate plan"},"ratePlanName":{"type":"string","description":"Name of the rate plan. For Internal use only, not to be displayed to guests."},"breakfastIncluded":{"type":"boolean","description":"Indicates if breakfast is included in the rate"},"totalPrice":{"type":"number","description":"Total price for the stay in this room","minimum":0},"taxes":{"type":"array","description":"Breakdown of taxes applicable to this rate","items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"Name of the tax"},"amount":{"type":"number","description":"Amount of the tax"}},"required":["name","amount"]}},"fees":{"type":"array","description":"Breakdown of fees applicable to this rate","items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"Name of the fee"},"amount":{"type":"number","description":"Amount of the fee"}},"required":["name","amount"]}},"adults":{"type":"integer","description":"Number of adults this rate is for"},"children":{"type":"integer","description":"Number of children this rate is for"},"cancellationPolicy":{"$ref":"#/components/schemas/CancelationPolicy","description":"Cancellation policy for this rate"},"dealCode":{"type":"string","description":"Code of any deal applied to this rate"},"totalCommissionPercentage":{"type":"number","description":"Total commission percentage for this specific rate"},"siteminderCommissionPercentage":{"type":"number","description":"SiteMinder's portion of the commission for this rate"},"channelCommissionPercentage":{"type":"number","description":"Channel partner's portion of the commission for this rate"},"rateType":{"type":"string","enum":["sell","net"],"description":"Indicates whether this is a sell rate or net rate."},"lowInventory":{"type":"boolean","description":"Indicates if this room type has low inventory available"}},"required":["uuid","ratePlanUuid","ratePlanName","breakfastIncluded","totalPrice","taxes","fees","adults","children","cancellationPolicy","totalCommissionPercentage","siteminderCommissionPercentage","channelCommissionPercentage","rateType","lowInventory"]}}},"required":["uuid","name"]}},"specialConditions":{"$ref":"#/components/schemas/SpecialConditions","description":"Special conditions that apply to this property."}},"required":["uuid","name","address","state","country","phoneNumber","language","latitude","longitude","checkinStartTime","checkoutEndTime","acceptedCardTypes","totalCommissionPercentage","siteminderCommissionPercentage","channelCommissionPercentage","currency","roomTypes","specialConditions"]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimitError"},"500":{"$ref":"#/components/responses/ServerError"}}}}},"components":{"parameters":{"SmApiId":{"name":"x-sm-api-id","description":"The api id for channel","required":true,"in":"header","schema":{"type":"string"}},"SmApiKey":{"name":"x-sm-api-key","description":"The api key for channel","required":true,"in":"header","schema":{"type":"string"}}},"schemas":{"TranslationText":{"type":"object","additionalProperties":false,"description":"Represents multilingual text content with language information. Used for property descriptions, amenities, room types, and other user-facing content.","properties":{"text":{"type":"string","description":"The translated text content in the specified language."},"language":{"type":"string","description":"ISO 639-1 language code indicating the language of the text. Supported languages: de (German), en (English), es (Spanish), fr (French), id (Indonesian), it (Italian), pt (Portuguese), th (Thai)."}},"required":["text","language"]},"StarRatings":{"type":"number","enum":[1,1.5,2,2.5,3,3.5,4,4.5,5,5.5,6]},"Photo":{"type":"object","additionalProperties":false,"properties":{"url":{"type":"string","format":"uri","description":"The photo url"},"captions":{"type":"string","description":"The photo's captions"}},"required":["url"]},"CancelationPolicy":{"type":"object","additionalProperties":false,"description":"Defines the cancellation policy for a reservation or rate. Policies can be either non-refundable or allow free cancellation up to a specified number of days before check-in.","properties":{"policyType":{"type":"string","enum":["non-refundable","free-cancellation"],"description":"The type of cancellation policy. 'non-refundable' means no refund will be provided regardless of when cancellation occurs. 'free-cancellation' allows cancellation without penalty up to the specified number of days before check-in."},"freeCancellationUntilDays":{"type":"number","nullable":true,"description":"Number of days before check-in when free cancellation is allowed. Only applicable when policyType is 'free-cancellation'. Null for non-refundable policies. For example, a value of 7 means guests can cancel up to 7 days before check-in without penalty."}},"required":["policyType"]},"SpecialConditions":{"type":"object","additionalProperties":false,"nullable":true,"description":"Special conditions or exemptions that apply to a property. These conditions may affect pricing, taxation, or booking requirements.","properties":{"taxExemptions":{"type":"array","description":"Array of tax exemptions applicable to this property. Tax exemptions affect how taxes are calculated and displayed in the booking flow.","items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["is-nz-gst-opt-out"],"description":"The name/type of the tax exemption. 'is-nz-gst-opt-out' indicates the property has opted out of New Zealand GST collection."}},"required":["name"]}}},"required":["taxExemptions"]},"Error":{"type":"object","required":["errors"],"properties":{"errors":{"minItems":1,"type":"array","description":"An array of error objects, for most errors, this array would only contain one error object. An errors array must contain at least one error object.","items":{"type":"object","required":["code"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"meta":{"type":"object"}}}}}}},"responses":{"BadRequest":{"description":"Invalid request","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"The specified resource was not found","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"RateLimitError":{"description":"The number of requests for the last 5 minutes window has reached the limit for the given channel","headers":{"ratelimit-policy":{"schema":{"type":"string"},"description":"Shows the number of request allowed per number of seconds window. e.g. '100;w=60' means 100 request in a 60 seconds window."},"ratelimit-limit":{"schema":{"type":"integer"},"description":"The number of requests allowed per window"},"ratelimit-remaining":{"schema":{"type":"integer"},"description":"The number of requests left for the time window."},"ratelimit-reset":{"schema":{"type":"integer"},"description":"The number of seconds left for the window to reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"ServerError":{"description":"Unexpected error occurred","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}
```

{% hint style="success" icon="sparkles" %}

## Still have questions?

Use the <i class="fa-gitbook-assistant">:gitbook-assistant:</i> **Ask** button at the top of the page to chat with our AI assistant — it can help you navigate the guide, understand requirements, and troubleshoot issues.

If you need more support, visit [Integration Support](/integration-support/integration-support.md).
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.siteminder.com/channels-plus-api/reference/property.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
