Retrieve Content Details
Returns content details for the Inventory
Overview
The Retrieve Content Details request allows the Agent to obtain comprehensive information about the content details of either the Inventory or a specific Unit.
By making this request, partners can retrieve all relevant content details associated with a Property. The API provides various content elements, such as property descriptions, location descriptions, and other pertinent details.
Endpoints Available
| Method | Endpoint | Description |
|---|---|---|
| GET | v2023.07.31/content/details | Returns content details for Inventory |
| GET | v2023.07.31/content/details/{unitId} | Returns content details for a Unit in Inventory |
Path Parameters
| Path Parameter | Required / Optional | Description |
|---|---|---|
| {unitId} | Required | Unique Identifier for Unit in Inventory |
Query String Parameters
| Parameter | Required / Optional | Description | Data Type |
|---|---|---|---|
| page | Optional | The page to be shown | int |
| pageSize | Optional | Limits the number of returned results | int |
| lastUpdateDate | Optional | Only return objects which have been modified after a certain date | date-time |
| mcUserId | Optional | Unique Identifier for Supplier | int |
| mcUserIds | Optional | Unique Identifiers for Suppliers | array |
| unitId | Optional | Unique Identifier for Unit in Inventory | int |
| unitIds | Optional | Unique Identifier for Units in Inventory | array |
| airbnb | Optional | Return additional context information relating to Airbnb | boolean |
Response Definition
| Response Item | Description | Data Type |
|---|---|---|
"units" | An array containing details about the Unit | array |
"units" Object
"units" Object| Response Item | Description | Data Type |
|---|---|---|
"unit_id" | The unique identifier for the Unit | int |
"details" | An object containing various details about the Unit | object |
"details" Object
"details" Object| Response Item | Description | Data Type |
|---|---|---|
"unit_name" | The internal name of the Unit | string |
"description_set_id" | The unique identifier for the description set of the Unit | int |
"terms_and_conditions" | An object containing information about the terms and conditions of the Unit | object |
"time_zone" | The time zone of the property, specified in the format "-HH:mm:ss" | string |
"active" | A flag indicating whether the Unit is currently active (true) or not (false) | boolean |
"address" | An object containing the address details of the Unit | object |
"geo_code" | An object containing the geographic coordinates of the property | object |
"description" | An array of objects containing different types of property descriptions | array |
"arrival_time" | The time when guests can check-in to the Unit, in the format "HH:mm" | string |
"departure_time" | The time when guests must check-out from the Unit, in the format "HH:mm" | string |
"area" | The area of the Unit | int |
"area_unit" | The unit of measurement for the property area | string |
"max_occupants" | The maximum number of occupants allowed in the Unit | int |
"bedrooms" | The number of bedrooms in the Unit | int |
"king_beds" | The number of king-size beds in the Unit | int |
"queen_beds" | The number of queen-size beds in the Unit | int |
"full_beds" | The number of full-size beds in the Unit | int |
"single_twin_beds" | The number of single/twin beds in the Unit | int |
"bathrooms" | The number of bathrooms in the Unit | float |
"class" | The class or category of the Unit | string |
"type" | The type of property that defines the Unit | string |
"restrictions" | An object containing various restrictions or rules related to the Unit | object |
"channel_ids" | An object containing channel IDs associated with the Unit | object |
"tax_1_remitted_by_host"* | A flag indicating whether tax 1 is remitted by the host (true) or not (false) | boolean |
"tax_2_remitted_by_host"* | A flag indicating whether tax 2 is remitted by the host (true) or not (false) | boolean |
"tax_3_remitted_by_host"* | A flag indicating whether tax 3 is remitted by the host (true) or not (false) | boolean |
Response Items notaed with '*' will only be returned when using 'airbnb' Query Parameter set as
"True"
"terms_and_conditions" Object
"terms_and_conditions" Object| Response Item | Description | Data Type |
|---|---|---|
"id" | The unique identifier for the terms and conditions | int |
"mc_user_id" | The unique identifier for the Supplier associated with the terms and conditions | int |
"terms_name" | The name or title of the terms and conditions | string |
"plain_text_terms" | The plain text content of the terms and conditions | string |
"cancellation_policy" | The policy regarding cancellations for the property unit | string |
"address" Object
"address" Object| Response Item | Description | Data Type |
|---|---|---|
"address_line_1" | The first line of the property's address | string |
"address_line_2" | The second line of the property's address (if applicable) | string |
"city" | The city where the property is located | string |
"state_province" | The state or province where the property is located | string |
"country" | The country where the property is located | string |
"postal_code" | The postal code of the property | string |
"country_code" | The country code of the property ISO 3166 (alpha-2) format | string |
"geo_code" Object
"geo_code" Object| Response Item | Description | Data Type |
|---|---|---|
"latitude" | The latitude coordinate of the property location | float |
"longitude" | The longitude coordinate of the property location | float |
"description" Object
"description" Object| Response Item | Description | Data Type |
|---|---|---|
"text_type" | A description of what the "text" contains | string |
"text" | The content of the "text_type" | string |
"text_type" | A description of what the "text" contains | string |
"text" | The content of the "text_type" | string |
"restrictions" Object
"restrictions" Object| Response Item | Description | Data Type |
|---|---|---|
"min_guest_age" | The minimum age of guests allowed to book the Unit | int |
"smoking_allowed" | A flag indicating whether smoking is allowed in the Unit (true) or not (false) | boolean |
"pets_allowed" | A flag indicating whether pets are allowed in the Unit (true) or not (false) | boolean |
"channel_ids" Object
"channel_ids" Object| Response Item | Description | Data Type |
|---|---|---|
"Settings" | An array containing various Channel settings related to the Unit | array |
"airbnb" | The channel ID associated with Airbnb for the Unit | string |
If any Content Details are missing or blank, please contact the Property Manager and request that they update the Listing Content Details of the Description Set assigned to this Propertyfor your Agent channel.
Sample Request
curl --request GET \
--url 'https://api.ciiruspartners.com/v2023.07.31/content/details?page=1&pageSize=50'Sample Response
{
"units": [
{
"unit_id": 219266,
"details": {
"unit_name": "Test Property 3",
"description_set_id": 406517,
"terms_and_conditions": {
"id": 8835,
"mc_user_id": 42330,
"terms_name": "Terms&Conditions ",
"plain_text_terms": "Terms and Conditions\r\n\n\nAcceptance of Terms By accessing and using this website, you acknowledge and agree to be bound by these terms and conditions.\n\n\r\nIntellectual Property \r\nAll content on this website, including but not limited to text, graphics, logos, images, and software, is the property of the website owner and is protected by applicable intellectual property laws. You may not use, reproduce, distribute, or modify any content without prior written permission.\r\n\n\nUser Conduct \r\nWhen using this website, you agree not to engage in any prohibited activities, including but not limited to:\n\nViolating any applicable laws or regulations\r\n\nInterfering with the website's operation or other users' access\n\r\nUploading or transmitting harmful or offensive content\n\r\nAttempting to gain unauthorized access to the website's systems\n\n\r\nThird-Party Links This website may contain links to third-party websites for your convenience. However, we do not endorse or assume any responsibility for the content or practices of these websites. Use them at your own risk.\n\n\r\nLimitation of Liability \r\nThe website owner shall not be held liable for any damages arising from the use or inability to use the website, including but not limited to direct, indirect, incidental, or consequential damages.\n\n\r\nDisclaimer \r\nThis website is provided on an \"as is\" basis without any warranties, express or implied. We make no representations or warranties regarding the accuracy, completeness, or reliability of the content.\n\n\r\nPrivacy \r\nWe are committed to protecting your privacy. Please refer to our Privacy Policy for information on how we collect, use, and disclose personal data.\r\n\n\nModifications \r\nWe reserve the right to modify these terms and conditions at any time without prior notice. It is your responsibility to review them periodically.\n\n\r\nGoverning Law and Jurisdiction \r\nThese terms and conditions shall be governed by and construed in accordance with the laws of [your jurisdiction].",
"cancellation_policy": "We understand that plans can change, and sometimes it becomes necessary to cancel or modify a reservation. To ensure transparency and clarity, we have established the following cancellation policy for our short-term vacation rentals:\r\n\r\nCancellation Period:\r\n\r\n[Number of Days] or more prior to the check-in date: Full refund of the reservation amount.\r\nLess than [Number of Days] prior to the check-in date: No refund.\r\nModification Requests:\r\n\r\nRequests to modify the reservation dates are subject to availability and must be made [Number of Days] or more prior to the check-in date. Additional charges may apply based on the revised booking details.\r\nNo-Shows or Early Departures:\r\n\r\nNo-shows or early departures will not be eligible for any refund.\r\nRefund Process:\r\n\r\nRefunds, if applicable, will be processed within [Number of Days] of the cancellation date.\r\nPlease note that the refund may take additional time to reflect in your account depending on your bank or payment provider.\r\nPlease review and understand the cancellation policy before making a reservation. By proceeding with the booking, you acknowledge and accept the terms outlined in this policy."
},
"time_zone": "-05:00:00",
"active": true,
"address": {
"address_line_1": "1212 Florida Ave",
"address_line_2": "",
"city": "Lakeland",
"state_province": "Fl",
"country": "USA",
"postal_code": "33803",
"country_code": "US"
},
"geo_code": {
"latitude": 28.0269546,
"longitude": -81.9568594
},
"description": [
{
"text_type": "PlainTextDescription",
"text": "Test Unit 3 Plain Text<br><br>Lorem ipsum dolor sit ameti, consectetur adipiscing elit. Sed vel lectus vitae felis hendrerit porta malesuada quis magna. Praesent eu sapien est, eget semper mi. Vivamus feugiat nisl eget lacus gravida eget imperdiet felis adipiscing. Vestibulum semper placerat mi eu consectetur. Aliquam accumsan iaculis pretium. <br><br>Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Donec enim nulla, pellentesque nec malesuada eu, vulputate eu eros. Phasellus quis sem felis. Morbi auctor, lorem eu dignissim euismod, libero libero convallis nulla, vitae aliquam sem quam id urna. Sed suscipit semper elementum. Fusce sit amet quam sapien, vitae placerat diam. Aliquam tellus mauris, imperdiet varius faucibus ornare, aliquet non enim. <br><br>Sed tempus consequat consectetur. Vestibulum id sem dui. Suspendisse molestie ullamcorper est sit amet condimentum. Vivamus feugiat nisl eget lacus gravida eget.<br><br>Lorem ipsum dolor sit ameti, consectetur adipiscing elit. Sed vel lectus vitae felis hendrerit porta malesuada quis magna. Praesent eu sapien est, eget semper mi. Vivamus feugiat nisl eget lacus gravida eget imperdiet felis adipiscing. Vestibulum semper placerat mi eu consectetur. Aliquam accumsan iaculis pretium. <br><br>Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Donec enim nulla, pellentesque nec malesuada eu, vulputate eu eros. Phasellus quis sem felis. Morbi auctor, lorem eu dignissim euismod, libero libero convallis nulla, vitae aliquam sem quam id urna. Sed suscipit semper elementum. Fusce sit amet quam sapien, vitae placerat diam. Aliquam tellus mauris, imperdiet varius faucibus ornare, aliquet non enim. <br><br>Sed tempus consequat consectetur. Vestibulum id sem dui. Suspendisse molestie ullamcorper est sit amet condimentum. Vivamus feugiat nisl eget lacus gravida eget."
},
{
"text_type": "Title",
"text": "Test Property 3"
}
],
"arrival_time": "16:00",
"departure_time": "10:00",
"area": 25000,
"area_unit": "SQUARE_FEET",
"max_occupants": 2,
"bedrooms": 0,
"king_beds": 3,
"queen_beds": 5,
"full_beds": 2,
"single_twin_beds": 3,
"bathrooms": 1.0,
"class": "Standard",
"type": "Motel",
"restrictions": {
"min_guest_age": 0,
"smoking_allowed": false,
"pets_allowed": true
},
"channel_ids": {
"Settings": [],
"airbnb": "543639068816568824"
},
"tax_1_remitted_by_host": false,
"tax_2_remitted_by_host": false,
"tax_3_remitted_by_host": false
}
},
...
],
"next_page_url": "https://api.ciiruspartners.com/v20230731/content/details?page=2&pageSize=1",
"total_page_count": 3
}Updated 3 months ago
