Inventories - Retrieve

Overview

Retrieves daily inventory availability for a specific property within a date range. Use this to check availability before initiating a booking or to build a property-level availability calendar.

Request

GET /v1/properties/{propertyId}/inventories

Headers

Header	Type	Required	Description
`Api-Key`	string	Yes	Your API key for authentication.
`Channel-Id`	string	Yes	Your distribution channel identifier.

Path Parameters

Parameter	Type	Required	Description
`propertyId`	string	Yes	Unique identifier of the property.

Query Parameters

Parameter	Type	Required	Description
`fromDate`	string (date)	Yes	Start date in `YYYY-MM-DD` format.
`toDate`	string (date)	Yes	End date in `YYYY-MM-DD` format. Must be on or after `fromDate`.

Example Request

curl -X GET "https://sandbox.elivaas.com/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"

Response — `200 OK`

Returns a single InventoryResponse object.

Field	Type	Description
`propertyId`	string	Unique identifier of the property.
`inventories`	array of DateInventory	Daily inventory entries for the requested date range.

Each DateInventory entry contains:

Field	Type	Description
`date`	string (date)	The calendar date.
`quantity`	integer	Available units. `0` means fully booked.
`stopSell`	boolean	`true` if blocked from sale on this date.
`minimumStay`	integer	Minimum nights required for bookings including this date.
`maximumStay`	integer	Maximum nights allowed for bookings including this date.

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
    }
  ]
}

Error Handling

Status	Meaning	Description
`200`	Success	Inventory returned.
`400`	Bad Request	Missing or invalid `fromDate` / `toDate`.
`401`	Unauthorized	Missing or invalid `Api-Key` or `Channel-Id`.
`404`	Not Found	Property ID does not exist.
`500`	Internal Server Error	Unexpected error.

Cities

Discovery

Bookings

Promotions

Inventory

Rate Plans

Rates

Inventories - Retrieve

Overview

Request

Headers

Path Parameters

Query Parameters

Example Request

Response — `200 OK`

Example Response

Error Handling

​Overview

​Request

​Headers

​Path Parameters

​Query Parameters

​Example Request

​Response — 200 OK

​Example Response

​Error Handling

Overview

Request

Headers

Path Parameters

Query Parameters

Example Request

Response — `200 OK`

Example Response

Error Handling