Get Venue Room Inventory

Get Room Inventory

Get Room Inventory

POST [PlatformAddress]/api/1.0/venue?action=getRoomInventory

Return the inventory and available count for the given date and optionally provided room ids.

Request Body

Name
Type
Description

venueId*

integer

The unique id of the venue to which the room belongs.

startDate*

date

The start date of the inventory.

endDate*

date

The end date of the inventory.

roomIds

array

The room ids to filter the inventory.

{
    "meta": {
        "totalResults": 2,
        "start": 0,
        "perPage": 2,
        "count": 2
    },
    "results": [
        {
            "date": "2025-12-16",
            "roomId": 7,
            "inventoryCount": 3,
            "availableCount": 3
        },
        {
            "date": "2025-12-16",
            "roomId": 2,
            "inventoryCount": 130,
            "availableCount": 130
        },
    ]
}

Date Range Restrictions

  • startDate and endDate: The maximum date range is 31 days. Past dates are not allowed.

Returns

A collection object with the following properties in result

Property
Data Type
Description

date

date

The date of the inventory

roomId

integer

The unique id of the room

inventoryCount

integer

The total rooms

availableCount

integer

The total available rooms after bookings

Last updated