Overview

The Retrieve Units request allows API users to access the Inventory available to them within the CiiRUS system. This method provides partners with comprehensive data about each unit, including details like the Property ID (UnitID), the property's enablement status, the Merchant of Record settings, and more.

Integrating this method into your system serves as the first step in incorporating Inventory management within your application.

This method also allows API users to retrieve permissions of a single unit, providing granular control for individual properties. It is important to note that this method may return an error message if there is an issue with the unit configuration, such as the property being deleted or disabled by the supplier.

Endpoints Available

Method	Endpoint	Description
GET	v2024.07.31/units	Returns all units in the inventory.
GET	v2024.07.31/units/{unit_id}	Returns a specific unit in the inventory.

Path Parameters

Path Parameter	Required / Optional	Description
{unit_id}	Required	Unique Identifier for a unit in the inventory.

Query String Parameters

Parameter	Required / Optional	Description	Data Type
page	Optional	The page to be shown (Defaults to 1).	int
page_size	Optional	Limits the number of returned results (Defaults to 25).	int
no_total	Optional	Removes the total page count for faster results.	boolean
last_unit_update_date	Optional	Only return objects that have been modified after the specified date.	date-time
last_reservation_update_date	Optional	Only return units that have received a booking (their own or a calendar sync) after the specified date.	date-time
last_agent_module_property_update_date	Optional	Only return units that have had their agent module property configuration modified after the specified date.	date-time
last_agent_module_agent_update_date	Optional	Only return units that have had their agent module agent configuration modified after the specified date.	date-time
unit_id	Optional	Unique identifier for the unit in the inventory.	int
unit_ids	Optional	Unique identifiers for units in the inventory.	array[int]
management_company_user_id	Optional	Unique identifier for the supplier.	int
management_company_user_ids	Optional	Unique identifiers for suppliers.	array[int]
enabled	Optional	Filter results by enabled or disabled units.	boolean
deleted	Optional	Only show properties that are deleted or not deleted.	boolean
display_on_website	Optional	Only show properties that are enabled for website	boolean
allocation_on_arrival	Optional	Return the allocation on arrival object.	boolean
allocation_on_arrival_unit	Optional	Return units that are the representative units in their group.	boolean
channel	Optional	Specify channel.	string
listing_id	Optional	Channel listing ID to lookup.	string

Response Definition

Response Item	Description	Data Type
`"units"`	An array of objects containing information about the inventory. Each element of the array represents a specific unit and its associated details	array[objects]

`"units"` Object

Response Item	Description	Data Type
`"unit_id"`	Unique identifier for the unit.	int
`"unit_name"`	Display name of the unit.	string
`"enabled"`	Indicates if the unit has been enabled by the Property Manager and is available for API interaction.	boolean
`"native"`	A flag indicating whether the unit is native to the Agent (true) or not (false). Native units are managed directly within the system.	boolean
`"agent_enabled"`	Specifies if the unit is enabled for the connected Agent.	boolean
`"supplier_enabled"`	Specifies if the unit is enabled by the original supplier (Property Manager).	boolean
`"clone"`	Indicates whether this unit is a cloned version of another property.	boolean
`"deleted"`	Marks whether the unit has been deleted or deactivated.	boolean
`"online_booking_enabled"`	A flag indicating whether online booking is enabled for the unit (`true`) or not (`false`).	boolean
`"booking_fence"`	Minimum lead time (in days) required before a reservation can be made.	int
`"gap_days"`	Number of gap days enforced between bookings for this unit.	int
`"include_mandatory_extras"`	A flag indicating whether pricing responses include mandatory extras (`true`) or not (`false`).	boolean
`"merchant_of_record"`	Indicates the entity that acts as the Merchant of Record for the unit.	string
`"relationship_to_unit"`	Describes the partner’s relationship to the unit.	string
`"timezone"`	The unit’s timezone in IANA format (e.g., `"America/New_York"`).	string
`"owner_user_id"`	The unique user ID of the unit’s owner.	int
`"owner_name"`	The display name of the unit owner.	string
`"management_company_rate_set_id"`	ID of the rate set configured by the management company for pricing.	int
`"management_company_user_id"`	Unique Identifier for the Supplier of the Inventory	int
`"master_unit_rate_set_use_nightly_floor_rates"`	Indicates whether floor rate logic is applied in the pricing engine for this unit.	boolean
`"rent_ready_date"`	The date the unit became or will become available for rent.	date-time
`"community_id"`	The ID of the community or resort this unit belongs to.	int
`"community_name"`	Name of the community or resort.	string
`"minimum_nights_stay"`	The default minimum required nights for a booking.	int
`"last_unit_update_date"`	Timestamp of the last update made to the unit’s configuration.	date-time
`"last_reservation_update_date"`	Timestamp of the last reservation update for this unit.	date-time
`"allocation_on_arrival"`*	A flag indicating whether the Unit is configured as allocation on arrival (true) or not (false). Allocation on arrival refers to the ability to book the unit without a specific pre-assigned unit.	boolean
`"address"`	Structured address information for the unit.	array[objects]
`"bedrooms"`	Total number of bedrooms in the unit.	int
`"bathrooms"`	Total number of bathrooms in the unit. Supports partial baths (e.g., `1.5`).	float
`"franchisee"`	Represents the franchise or property management entity branding this unit.	string
`"airbnb"`**	Information and settings related to the Airbnb channel connection for this unit.	array[objects]
`"vrbo"`**	Information and settings related to the Vrbo channel connection for this unit.	array[objects]
`"error"`	Details any issues preventing the unit from being accessed or managed via the API.	array[objects]

`"allocation_on_arrival"` Object

Response Item	Description	Data Type
`"representative_unit"`	Indicates whether this unit is a representative (model) unit used for allocation.	boolean
`"representative_unit_id"`	If representative_unit is `true`, this field references the ID of the unit it represents.	int
`"category"`	Category ID this unit belongs to for allocation-on-arrival logic. Units within the same category may be assigned interchangeably.	int
`"enforce_stop_sale"`	If `true`, a stop-sale rule is enforced at the category level. If all units in the same category are unavailable (due to bookings, blocks, etc.), then your system should treat the entire category as unavailable.	boolean
`"units_in_category"`	Total number of active units in this category that could be allocated for arrival.	int

`"address"` Object

Response Item	Description	Data Type
`"address_line_1"`	Primary street address of the unit.	string
`"address_line_2"`	Secondary address information (e.g., unit, suite).	string
`"city"`	City where the unit is located.	string
`"state_province"`	State or province of the unit’s address.	string
`"postal_code"`	ZIP or postal code of the unit.	string

`"airbnb"` Object

Response Item	Description	Data Type
`"host_id"`	Airbnb host ID associated with the unit.	string
`"listing_id"`	Airbnb listing ID for the unit.	string
`"request_to_book_on_short_notice"`	Indicates if the listing allows short-notice bookings.	boolean
`"short_term_cancelation_policy"`	The Airbnb cancellation policy applied to the listing.	string
`"synchronization_category"`	Defines the Airbnb sync category	string
`"publish_listing"`	Indicates if the Airbnb listing is published and publicly viewable.	boolean

`"vrbo"` Object

Response Item	Description	Data Type
`"sync"`	Indicates if this unit is set to sync with Vrbo.	boolean
`"booking_policy"`	Vrbo-specific booking policy code. Used to determine how reservations are handled.	int
`"cancellation_policy"`	Vrbo-specific cancellation policy code.	int
`"pricing_mode"`	Determines pricing strategy used when syncing with Vrbo.	int

`"error"` Object

Response Item	Description	Data Type
`"message"`	Descriptive message explaining the error or limitation for the unit.	string

📘
Response Items notaed with '*' will only be returned when using 'allocationon_arrival' Query Parameter set as "true"_
Response Items notaed with '**' will only be returned when using 'channel' Query Parameter set with specified channel or "all".

Sample Request

curl --location 'https://api.ciiruspartners.com/v2024.07.31/units?page=1&page_size=500&no_total=true&management_company_user_id=42330' \
--header 'Authorization: Basic {APIUsername:APIPassword}'

Sample Response

{
    "units": [
        {
            "unit_id": 219264,
            "unit_name": "Test Property 1",
            "enabled": true,
            "native": false,
            "agent_enabled": true,
            "supplier_enabled": true,
            "clone": false,
            "deleted": false,
            "online_booking_enabled": true,
            "booking_fence": 1,
            "gap_days": 2,
            "include_mandatory_extras": true,
            "merchant_of_record": "management_company",
            "relationship_to_unit": "supersite_agent",
            "timezone": "America/New_York",
            "owner_user_id": 42334,
            "owner_name": "API Owner",
            "management_company_rate_set_id": 129286,
            "management_company_user_id": 42330,
            "master_unit_rate_set_use_nightly_floor_rates": false,
            "rent_ready_date": "2017-01-18T00:00:00",
            "community_id": 17511,
            "community_name": "Encore Resort at Reunion",
            "minimum_nights_stay": 1,
            "last_unit_update_date": "2025-04-16T12:26:59.737",
            "last_reservation_update_date": "2025-03-27T13:51:43.567",
            "address": {
                "address_line_1": "1012 Emmette St",
                "address_line_2": "Suite A",
                "city": "Kissimmee",
                "state_province": "Fl",
                "postal_code": "34741"
            },
            "bedrooms": 0,
            "bathrooms": 2.0,
            "franchisee": "",
            "airbnb": {
                "host_id": "431444876",
                "listing_id": "739807228214052587",
                "request_to_book_on_short_notice": false,
                "short_term_cancelation_policy": "flexible",
                "publish_listing": true
            },
            "vrbo": {
                "sync": true,
                "booking_policy": 0,
                "cancellation_policy": 2,
                "pricing_mode": 1
            },
            "error": {
                "message": "Neither you or the supplier has enabled this property connection."
            }
			},
			{
      ...
      ],
    "paging": {
        "next_page_url": "https://api.ciiruspartners.com/v2024.07.31/units?page=2&page_size=500&allocation_on_arrival=true&channel=all&no_total=true",
        "total_page_count": 3,
        "page": 1,
        "page_size": 500
    }
}

Overview

Endpoints Available

Path Parameters

Query String Parameters

Response Definition

"units" Object

"allocation_on_arrival" Object

"address" Object

"airbnb" Object

"vrbo" Object

"error" Object

📘

Sample Request

Sample Response

`"units"` Object

`"allocation_on_arrival"` Object

`"address"` Object

`"airbnb"` Object

`"vrbo"` Object

`"error"` Object