Rental Rates

Retrieve Rental Rates for the Inventory or specific Unit

Overview

The Rental Rates request is designed to provide partners with the ability to access Rental Rates for either the Inventory or a specific unit, which allows partners to efficiently manage pricing in their application and offer accurate Rental Rates to potential guests.

Through the Rental Rates request, partners can retrieve comprehensive and up-to-date information about the Rental Rates associated with a Unit.

Endpoints Available

Method	Endpoint	Description
GET	v2023.07.31/rates	Retrieve Rental Rates for Inventory
GET	v2023.07.31/rates/{unitId}	Retrieve Rental Rates for 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 Identifiers for Units in Inventory	array
ratesLength	Optional	The desired length of the rates to be returned if it is available	int
start	Optional	The desired start for the rental rates	date-time

Response Definition

Response Item	Description	Data Type
`"rates"`	An array containing rate details for a specific Unit. Each element in the array represents a rate set associated with the Unit	array

`"rates"` Object

Response Item	Description	Data Type
`"unit_id"`	The unique identifier for the Unit	int
`"rate_set_id"`	The unique identifier for the rate set associated with the Unit	int
`"nightly_rate"`	An object containing details about the rates for the Unit	object

`"nightly_rate"` Object

Response Item	Description	Data Type
`"start"`	The start date of the `"nighty_rate"` period	string
`"end"`	The end date of the `"nighty_rate"` period	string
`"length"`	The length of the `"nighty_rate"` in Days	int
`"iso_currency"`	The currency code for the `"nighty_rate"`	string
`"rates"`	An array containing rate details for the specified length. Each element in the array represents a specific day	array
`"length_of_stay_pricing"`	A flag indicating whether the pricing is based on the length of stay (true) or not (false)	boolean
`"rate_decimal_places"`	The number of decimal places in the `"rates"` value	int
`"stay_arrival_min_nights"`	An array containing the minimum number of nights required for a stay. Each element in the array represents a specific day	array
`"stay_arrival_max_nights"`	An array containing the maximum number of nights allowed for a stay. Each element in the array represents a specific day	array
`"allowed_arrival_days"`	An array containing allowed arrival days. Each element in the array represents a specific day	array
`"allowed_departure_days"`	An array containing allowed departure days. Each element in the array represents a specific day	array
`"applicable_taxes"`	An array containing details about applicable taxes for the `"nightly_rate"`	array
`"currency_exchanges"`	An array containing details about currency exchanges for the Unit	array
`"mc_user_id"`	Unique Identifier for Supplier of Inventory	int

`"applicable_taxes"` Object

Response Item	Description	Data Type
`"name"`	The name or description of the tax	string
`"value"`	The value of the tax - See `"value_type"`	float
`"value_type"`	The type of value, which is "PERCENTAGE" for percentage-based tax	string
`"tax_type"`	The type of tax, e.g., "TAX_ONE" or "TAX_TWO	string

🚧
If a Rate is set as 000, this was defined by the Property Manager. Please contact the PM and request they populate this data. As long as a rateband has been defined (even as 000) for the date period of a reservation and the user has set the property to be bookable online, the property can be booked and the quote will be calculated based on the defined rates.

Sample Request

curl --request GET \
     --url 'https://api.ciiruspartners.com/v2023.07.31/rates?page=1&pageSize=50'

Sample Response

{
    "rates": [
        {
            "unit_id": 219264,
            "rate_set_id": 72024,
            "nightly_rate": {
                "start": "2023-07-26T00:00:00",
                "end": "2024-12-31T00:00:00",
                "length": 30,
                "iso_currency": "USD",
                "rates": [
                    10000,
                    10000,
                    10000,
                    10000,
                    10000,
                    10000,
                  ...
                ],
                "length_of_stay_pricing": false,
                "rate_decimal_places": 2,
                "stay_arrival_min_nights": [
                    4,
                    4,
                    4,
                    4,
                    4,
                    4,
                  ...
                ],
                "stay_arrival_max_nights": [
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                  ...
                ],
                "allowed_arrival_days": [
                    127,
                    127,
                    127,
                    127,
                    127,
                    127,
                  ...
                ],
                "allowed_departure_days": [
                    127,
                    127,
                    127,
                    127,
                    127,
                    127,
                  ...
                ],
                "applicable_taxes": [
                    {
                        "name": "Sales Tax",
                        "value": 7.500,
                        "value_type": "PERCENTAGE",
                        "tax_type": "TAX_ONE"
                    },
                    {
                        "name": "Tourist Tax",
                        "value": 6.000,
                        "value_type": "PERCENTAGE",
                        "tax_type": "TAX_TWO"
                    }
                ]
            },
            "currency_exchanges": [],
            "mc_user_id": 42330
        }
    ],
    "next_page_url": "https://api.ciiruspartners.com/v20230731/rates?page=2&pageSize=50",
    "total_page_count": 8

Updated 3 months ago