Documentation Index
Fetch the complete documentation index at: https://docs.elivaas.com/llms.txt
Use this file to discover all available pages before exploring further.
Overview
The Inventories Retrieve API allows you to get inventory availability for a specific property within a date range. This is useful for checking availability before initiating a booking.
Retrieving Property Inventory
GET /v1/properties/{propertyId}/inventories
Path Parameters
| Parameter | Type | Required | Description |
|---|
| propertyId | string | Yes | Unique identifier of the property |
Query Parameters
| Parameter | Type | Required | Description |
|---|
| fromDate | string (YYYY-MM-DD) | Yes | Start date for the inventory query |
| toDate | string (YYYY-MM-DD) | Yes | End date for the inventory query |
Example Request
curl -X GET "https://api.elivaas.com/api/v1/properties/prop_456/inventories?fromDate=2025-08-01&toDate=2025-08-07" \
-H "Api-Key: YOUR_API_KEY" \
-H "Channel-Id: YOUR_CHANNEL_ID"
Example Response
{
"propertyId": "prop_456",
"inventories": [
{
"date": "2025-08-01",
"quantity": 3,
"stopSell": false,
"minimumStay": 2,
"maximumStay": 7
},
{
"date": "2025-08-02",
"quantity": 3,
"stopSell": false,
"minimumStay": 2,
"maximumStay": 7
},
{
"date": "2025-08-03",
"quantity": 1,
"stopSell": false,
"minimumStay": 2,
"maximumStay": 7
},
{
"date": "2025-08-04",
"quantity": 0,
"stopSell": true,
"minimumStay": 2,
"maximumStay": 7
}
]
}
Response Fields
| Field | Type | Description |
|---|
| propertyId | string | Identifier of the property |
| inventories | array | List of daily inventory details |
| inventories[].date | string (date) | Date for the inventory entry |
| inventories[].quantity | integer | Number of units available on this date |
| inventories[].stopSell | boolean | If true, the property is not available for sale on this date |
| inventories[].minimumStay | integer | Minimum nights required for bookings including this date |
| inventories[].maximumStay | integer | Maximum nights allowed for bookings including this date |
Availability Check Logic
To determine if a property is bookable for a date range:
- Ensure
quantity > 0 for all dates in the range
- Ensure
stopSell is false for all dates in the range
- Ensure the total stay length meets the
minimumStay requirement
- Ensure the total stay length does not exceed the
maximumStay limit
Authentication
All requests must include the following headers:
Api-Key: Your API key for authenticationChannel-Id: Identifier for the channel making the request
Error Handling
The API returns standard HTTP status codes:
- 200: Success
- 400: Bad Request - missing or invalid parameters
- 401: Unauthorized
- 404: Property not found
- 500: Internal Server Error
