Overview

The Update Units request allows the Agent to manage the enablement status of the Inventory. With this request, partners can efficiently update the enablement status of specific units, granting or revoking access to the associated inventory.

The Update Units request allows API users to gain access to, or withdraw access from, the available inventory. By updating the enablement status of units, partners can effectively control which properties are accessible for integration and further utilization.

🚧
Note
The use of this request is the same as clicking "Enabled?" in the App. By using this function, you are agreeing to do business and abide by the terms of your direct agreement with the Property Manager for each respective property.

Endpoints Available

Method	Endpoint	Description
PUT	v2023.07.31/inventory	Updates the enablement status of specified Units in Invenotry
PUT	v2023.07.31/inventory/{unitId}	Updates the enablement status of a specific Unit in Inventory

Query String Parameters (Units)

Parameter	Required / Optional	Description	Data Type
enabled	Optional	Sets the enablement status of Inventory. Overridden by the `"enabled"` Body Parameter	boolean
permissions	Optional	Return additional context information	boolean
airbnb	Optional	Return additional context information relating to Airbnb	boolean

Body Parameters

Object	Required / Optional	Description	Data Type
`"unit_id"`	Required	Unique Identifier for Unit in Inventory	int
`"enabled"`	Optional	Enabled by the supplier (true if native, not present on Inventory response if query parameter 'enabled' is passed)	boolean

Path Parameters

Path Parameter	Required / Optional	Description
{unitId}	Required	Unique Identifier for Unit in Inventory

Query String Parameters (Unit)

Parameter	Required / Optional	Description	Data Type
enabled	Required	Sets the enablement status of Inventory. Overridden by the `"enabled"` Body Parameter in Update Units Request	boolean

Response Definition

Response Item	Description	Data Type
`"unit_id"`	The unique identifier for the Unit	int
`"enabled"`	A flag indicating whether the Unit is enabled (true) or disabled (false)	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
`"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
`"online_booking_enabled"`	A flag indicating whether online booking is enabled for the Unit (true) or not (false)	boolean
`"merchant_of_record"`	Indicates the entity that acts as the Merchant of Record for the Unit. Possible values can be "MANAGEMENT_COMPANY" or "AGENT"	string
`"include_mandatory_extras"`	A flag indicating whether mandatory extras are included in the booking for this Unit (true) or not (false). Mandatory extras are additional charges or services that must be included with the booking	boolean
`"mc_user_id"`	The unique identifier for the Supplier of the Unit	int

❗️
Properties will NOT be bookable and will NOT display as active until Enabled

Sample Request

curl --request PUT \
     --url 'https://api.ciiruspartners.com/v2023.07.31/inventory?enabled=true'
          --data '
[
  {
    "property_id": 219264
  },
  {
    "property_id": 219265
  }
]
'

Sample Response

{
    "unit_id": 219264,
    "enabled": true,
    "native": false,
    "allocation_on_arrival": false,
    "online_booking_enabled": true,
    "merchant_of_record": "MANAGEMENT_COMPANY",
    "include_mandatory_extras": true,
    "mc_user_id": 42330
},
...