Add or Update Room Counts

Add or Update Room Counts

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

Add or update the dynamic inventory counts of venue rooms

Path Parameters

NameTypeDescription

venueId

integer

The unique id of the venue to which the room 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 count for a single date

{
    "venueId": 1,
    "items": [
        {
            "startDate": "2020-05-01",
            "endDate": "2020-05-01",
            "roomId": 2,
            "roomCount": 11
        }
    ]
}

Setting the room count for a date range

{
    "venueId": 1,
    "items": [
        {
            "startDate": "2020-05-01",
            "endDate": "2020-05-10",
            "roomId": 2,
            "roomCount": 11
        },
        {
            "startDate": "2020-05-01",
            "endDate": "2020-05-10",
            "roomId": 3,
            "roomCount": 21
        },
        {
            "startDate": "2020-05-01",
            "endDate": "2020-05-10",
            "roomId": 4,
            "roomCount": 16
        },
        {
            "startDate": "2020-05-11",
            "endDate": "2020-05-20",
            "roomId": 2,
            "roomCount": 11
        },
        {
            "startDate": "2020-05-11",
            "endDate": "2020-05-20",
            "roomId": 3,
            "roomCount": 21
        },
        {
            "startDate": "2020-05-11",
            "endDate": "2020-05-20",
            "roomId": 4,
            "roomCount": 16
        }
    ]
}

Returns

PropertyDescriptionType

success

Whether or not the room inventory counts were updated

boolean

Item Details

PropertyTypeRequiredDescription

roomId

integer

required

The unique id of the room for which the inventory count will be set

startDate

date

required

The start date from which the room inventory count will be set (Date Format)

endDate

date

required

The end date from which the room inventory count will be set (Date Format)

roomCount

integer

required

The inventory count of the room from startDate to endDate

Last updated