Get Venue Room Rates

Get Room Rates

Get Room Rates

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

Return the room rates for the given rate plan and date and optionally provided room ids.

Request Body

Name
Type
Description

venueId*

integer

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

barId*

integer

The unique id of the rate plan.

startDate*

date

The start date of the rate.

endDate*

date

The end date of the rate.

roomIds

array

The room ids to filter the rates.

{
    "meta": {
        "totalResults": 4,
        "start": 0,
        "perPage": 4,
        "count": 4
    },
    "results": [
        {
            "barId": 63,
            "roomId": 122,
            "date": "2025-07-06",
            "cost": null,
            "costDouble": null,
            "costTriple": null,
            "costQuad": null
        },
        {
            "barId": 63,
            "roomId": 123,
            "date": "2025-07-06",
            "cost": 50,
            "costDouble": 60,
            "costTriple": 0,
            "costQuad": 80
        },
        {
            "barId": 63,
            "roomId": 122,
            "date": "2025-07-07",
            "cost": null,
            "costDouble": null,
            "costTriple": null,
            "costQuad": null
        },
        {
            "barId": 63,
            "roomId": 123,
            "date": "2025-07-07",
            "cost": 5,
            "costDouble": 6,
            "costTriple": 7,
            "costQuad": 0
        }
    ]
}

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

barId

integer

The unique id of the rate plan

date

date

The date of the inventory

roomId

integer

The unique id of the room

cost

float

The cost of the room for a given day for single occupancy

costDouble

float

The cost of the room for a given day for two occupants

costTriple

float

The cost of the room for a given day for three occupants

costQuad

float

The cost of the room for a given day for four occupants

Last updated