Get Room Inventory List

Description: Get room inventory list

Path: /api/v1/availability/getRoomInventoryList

Method: GET

Request

Attributes

* = required

hotelSn*

integer

Identify of hotel

startDate*

string

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

endDate*

string

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

bookingType*

integer

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

roomTypeSnList

array

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

startTime

string

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

endTime

string

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

Response

Attributes

roomTypeSn

integer

Identify of room type

date

string

Format: Y-m-d

timeSlotList.*.startTime

string

Format: H:i

timeSlotList.*.endTime

string

Format: H:i

timeSlotList.*.firstHours

integer

timeSlotList.*.priceFirstHours

integer

timeSlotList.*.additionalHours

integer

timeSlotList.*.priceAdditionalHours

integer

timeSlotList.*.priceOvernight

integer

timeSlotList.*.priceOneDay

integer

timeSlotList.*.maxRooms

integer

timeSlotList.*.bookedRooms

integer

timeSlotList.*.remainingRooms

integer

timeSlotList.*.status

integer

Posible enum values: booked, available, locked

timeSlotList.*.roomLockList.*.lockId

integer

Identify of room type

roomLockList.*.startDate

string

Format: Y-m-d

roomLockList.*.endDate

string

Format: Y-m-d

roomLockList.*.startTime

string

Format: H:i

roomLockList.*.endTime

string

Format: H:i

roomLockList.*.lockType

integer

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

timeSlotList.*.promotionList.*.promotionType

string

Posible enum values: flashSale, directDiscount

timeSlotList.*.promotionList.*.flashSaleProgramSn

integer

Identify of flash sale program

timeSlotList.*.promotionList.*.directDiscountProgramSn

integer

Identify of direct discount program

timeSlotList.*.promotionList.*.status

integer

Possible enum values: 1 = Active 2 = Pending

timeSlotList.*.promotionList.*.name

string

Name of flash sale/ direct discount program

timeSlotList.*.promotionList.*.bookingCapacity

integer

The rooms (allotment) remaining of flash sale program

timeSlotList.*.promotionList.*.priceFlashSale

integer

Flash Sale price

timeSlotList.*.promotionList.*.priceAdditionalHoursFlashSale

integer

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

timeSlotList.*.promotionList.*.priceFirstHours

integer

First Hours price when running Direct Discount program

timeSlotList.*.promotionList.*.priceAdditionalHours

integer

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

timeSlotList.*.promotionList.*.priceOvernight

integer

Overnight price when running Direct Discount program

timeSlotList.*.promotionList.*.priceOneDay

integer

Daily price when running Direct Discount program

timeSlotList.*.promotionList.*.applyType

integer

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

timeSlotList.*.promotionList.*.startTime

string

Start time FS / DD. Format: H:i

timeSlotList.*.promotionList.*.endTime

string

End time FS / DD. Format: H:i

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

timeSlotList.*.promotionList.*.startDate

string

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

timeSlotList.*.promotionList.*.endDate

string

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

timeSlotList.*.promotionList.*.specialDayList

array

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

timeSlotList.*.promotionList.*.dayOfWeekList

array

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

Applicable only for applyType = 2 (Weekday)

Example

PreviousAvailability APIsNextUpdate Room Allotment

Last updated