Overview

The Check Alteration Availability request is designed to provide the Agent with a seamless way to verify date range availability for inventory alterations. This endpoint allows you to efficiently determine whether an alteration to an existing Booking, such as a change in dates or duration, is permissible based on the availability of the Unit.

Endpoints Available

Method	Endpoint	Description
PUT	v2023.07.31/availability/{unitId}	Returns results for checking date range availability for a Unit in Inventory

Path Parameters

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

Body Parameters

Path Parameter	Required / Optional	Description	Data Type
`"start"`	Required	Start Date of specified Date Range	date-time
`"end"`	Required	End Date of specified Date Range	date-time
`"booking_id"`	Required	Unique Identifier for Booking	int

Response Definition

Response Item	Description	Data Type
`"booking_id"`	Unique identifier for the booking associated with the availability data	int
`"unit_id"`	Unique identifier for the Unit associated with the availability data	int
`"start"`	Start date and time of the availability period	string
`"end"`	End date and time of the availability period	string
`"is_available"`	Indicates whether the Unit is available (true) or not available (false) within the specified date range	boolean

Sample Request

curl --request PUT \
     --url 'https://api.ciiruspartners.com/v2023.07.31/availability/219264'
     --data '
{
  "start": "2023-08-12",
  "end": "2023-08-21",
  "booking_id": 38739856
}
'

Sample Response

{
    "booking_id": 37608454,
    "unit_id": 219264,
    "start": "2023-12-01T00:00:00",
    "end": "2023-12-05T00:00:00",
    "is_available": true
}