search

Get Room Inventory List

Description: Get room inventory list

Path: /api/v1/availability/getRoomInventoryList

Method: GET

hashtag
Request

hashtag
Attributes

* = required

chevron-righthotelSn*hashtag

integer

Identify of hotel

chevron-rightstartDate*hashtag

string

The maximum valid time is 365 days from now. Format: Y-m-d

chevron-rightendDate*hashtag

string

The maximum valid time is 365 days from now. Format: Y-m-d

chevron-rightbookingType*hashtag

integer

Posible enum values: 1 = Hourly 2 = Overnight 3 = Daily

chevron-rightroomTypeSnListhashtag

array

List of identify of room type. Each value separated by ","

chevron-rightstartTimehashtag

string

Optional, only applicable to Hourly booking type. Format: H:i

chevron-rightendTimehashtag

string

Optional, only applicable to Hourly booking type. Format: H:i

hashtag
Response

hashtag
Attributes

chevron-rightroomTypeSnhashtag

integer

Identify of room type

chevron-rightdatehashtag

string

Format: Y-m-d

chevron-righttimeSlotList.*.startTimehashtag

string

Format: H:i

chevron-righttimeSlotList.*.endTimehashtag

string

Format: H:i

chevron-righttimeSlotList.*.firstHourshashtag

integer

chevron-righttimeSlotList.*.priceFirstHourshashtag

integer

chevron-righttimeSlotList.*.additionalHourshashtag

integer

chevron-righttimeSlotList.*.priceAdditionalHourshashtag

integer

chevron-righttimeSlotList.*.priceOvernighthashtag

integer

chevron-righttimeSlotList.*.priceOneDayhashtag

integer

chevron-righttimeSlotList.*.maxRoomshashtag

integer

chevron-righttimeSlotList.*.bookedRoomshashtag

integer

chevron-righttimeSlotList.*.remainingRoomshashtag

integer

chevron-righttimeSlotList.*.statushashtag

integer

Posible enum values: booked, available, locked

chevron-righttimeSlotList.*.roomLockList.*.lockIdhashtag

integer

Identify of room type

chevron-rightroomLockList.*.startDatehashtag

string

Format: Y-m-d

chevron-rightroomLockList.*.endDatehashtag

string

Format: Y-m-d

chevron-rightroomLockList.*.startTimehashtag

string

Format: H:i

chevron-rightroomLockList.*.endTimehashtag

string

Format: H:i

chevron-rightroomLockList.*.lockTypehashtag

integer

Posible enum values: 0 = All of booking types 1 = Hourly Booking 2 = Overnight Booking 3= Daily Booking

chevron-righttimeSlotList.*.promotionList.*.promotionTypehashtag

string

Posible enum values: flashSale, directDiscount

chevron-righttimeSlotList.*.promotionList.*.flashSaleProgramSnhashtag

integer

Identify of flash sale program

chevron-righttimeSlotList.*.promotionList.*.directDiscountProgramSnhashtag

integer

Identify of direct discount program

chevron-righttimeSlotList.*.promotionList.*.statushashtag

integer

Possible enum values: 1 = Active 2 = Pending

chevron-righttimeSlotList.*.promotionList.*.namehashtag

string

Name of flash sale/ direct discount program

chevron-righttimeSlotList.*.promotionList.*.bookingCapacityhashtag

integer

The rooms (allotment) remaining of flash sale program

chevron-righttimeSlotList.*.promotionList.*.priceFlashSalehashtag

integer

Flash Sale price

chevron-righttimeSlotList.*.promotionList.*.priceAdditionalHoursFlashSalehashtag

integer

Additional Hours Flash Sale price. Only applies to hourly booking (bookingtype = 1). Returns null if no flash sale applies

chevron-righttimeSlotList.*.promotionList.*.priceFirstHourshashtag

integer

First Hours price when running Direct Discount program

chevron-righttimeSlotList.*.promotionList.*.priceAdditionalHourshashtag

integer

Additional Hours price when running Direct Discount program. Only applies to hourly booking (bookingtype = 1).

chevron-righttimeSlotList.*.promotionList.*.priceOvernighthashtag

integer

Overnight price when running Direct Discount program

chevron-righttimeSlotList.*.promotionList.*.priceOneDayhashtag

integer

Daily price when running Direct Discount program

chevron-righttimeSlotList.*.promotionList.*.applyTypehashtag

integer

Applicable date frame type. Possible enum values: 1= Today 2 = Weekday 3 = Special day

chevron-righttimeSlotList.*.promotionList.*.startTimehashtag

string

Start time FS / DD. Format: H:i

chevron-righttimeSlotList.*.promotionList.*.endTimehashtag

string

End time FS / DD. Format: H:i

The end time may be the time of the next day (T+1)

chevron-righttimeSlotList.*.promotionList.*.startDatehashtag

string

Start date FS/ DD. Format: Y-m-d Applicable only for applyType = 2 (Weekday) and 1 (Today)

chevron-righttimeSlotList.*.promotionList.*.endDatehashtag

string

End date FS/ DD. Format: Y-m-d Applicable only for applyType = 2 (Weekday) and 1 (Today)

chevron-righttimeSlotList.*.promotionList.*.specialDayListhashtag

array

Special day list. Only applies to applyType = 3 (Special day)

chevron-righttimeSlotList.*.promotionList.*.dayOfWeekListhashtag

array

Weekdays. The value is from 0-> 6 corresponding from Sunday to Saturday.

Applicable only for applyType = 2 (Weekday)

hashtag
Example

PreviousAvailability APIsNextUpdate Room Allotment

Last updated