Skip to main content

​
Overview

The Inventories List API allows you to retrieve inventory availability for all properties accessible to your distribution channel within a specified date range. Each response includes daily availability counts, stop-sell flags, and minimum/maximum stay restrictions.

​
Retrieving All Inventories

GET /v1/properties/inventories

​
Query Parameters

ParameterTypeRequiredDescription
fromDatestring (YYYY-MM-DD)YesStart date for the inventory query
toDatestring (YYYY-MM-DD)YesEnd date for the inventory query

​
Example Request

curl -X GET "https://api.elivaas.com/api/v1/properties/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
      }
    ]
  },
  {
    "propertyId": "prop_789",
    "inventories": [
      {
        "date": "2025-08-01",
        "quantity": 1,
        "stopSell": false,
        "minimumStay": 1,
        "maximumStay": 14
      },
      {
        "date": "2025-08-02",
        "quantity": 0,
        "stopSell": true,
        "minimumStay": 1,
        "maximumStay": 14
      }
    ]
  }
]

​
Response Fields

FieldTypeDescription
propertyIdstringIdentifier of the property
inventoriesarrayList of daily inventory details
inventories[].datestring (date)Date for the inventory entry
inventories[].quantityintegerNumber of units available on this date
inventories[].stopSellbooleanIf true, the property is not available for sale on this date
inventories[].minimumStayintegerMinimum nights required for bookings including this date
inventories[].maximumStayintegerMaximum nights allowed for bookings including this date

​
Understanding Inventory Data

  • quantity = 0 or stopSell = true: The property is not available for booking on this date.
  • minimumStay: If a guest wants to check in on this date, they must stay at least this many nights.
  • maximumStay: The maximum number of nights allowed for a stay that includes this date.

​
Authentication

All requests must include the following headers:
  • Api-Key: Your API key for authentication
  • Channel-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 date parameters
  • 401: Unauthorized
  • 500: Internal Server Error