Add or Update Room Dynamic Rates

Add or Update Room Dynamics Rates

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

Add or update the dynamic rates of venue rooms

Path Parameters

NameTypeDescription

venueId

integer

The unique id of the venue to which the rate plan belongs

items

array

The array of items. See Item table below for individual item data.

{
  "success": true
}

NOTE: The dynamic data is only available to venues that integrate with a distribution channel.

Examples

Setting the room dynamic rate for a single date

{
    "venueId": 1,
    "items": [
        {
            "startDate": "2020-05-01",
            "endDate": "2020-05-01",
            "roomId": 2,
            "barId": 1,
            "cost": 100
        }
    ]
}

Setting the room dynamic rate for a date range

{
    "venueId": 1,
    "items": [
        {
            "startDate": "2020-05-01",
            "endDate": "2020-05-10",
            "roomId": 2,
            "barId": 1,
            "cost": 100
        },
        {
            "startDate": "2020-05-01",
            "endDate": "2020-05-10",
            "roomId": 2,
            "barId": 147,
            "cost": 150
        },
        {
            "startDate": "2020-05-01",
            "endDate": "2020-05-10",
            "roomId": 3,
            "barId": 1,
            "cost": 100
        },
        {
            "startDate": "2020-05-01",
            "endDate": "2020-05-10",
            "roomId": 3,
            "barId": 147,
            "cost": 100
        }
    ]
}

Returns

PropertyDescriptionType

success

Whether or not the room dynamic rates were updated

boolean

Item Details

PropertyTypeRequiredDescription

barId

integer

required

The unique id of the rate plan to which the dynamic rate applies

roomId

integer

required

The unique id of the room to which the rate applies

startDate

date

required

The start date from which the dynamic rate will be set (Date Format)

endDate

date

required

The end date from which the dynamic rate will be set (Date Format)

cost

integer

required

The rate amount from startDate to endDate. The amount must either include or exclude tax depending on how the venue has been configured

Last updated