Hotel Products
Get hotel available product list，The returned result is an array, and the order of the array corresponds to the date
Request Method#
POST
uri: /ari/products
Content-Type:application/json
Request parameter description#
RequestHeader#
Common Request Header[Reference]
RequestBody#
| Parameter | Type | Required | Maximum length | Example | Description |
|---|---|---|---|---|---|
| hotelId | String | Y | 32 | 12**567 | Huazhu Hotel ID |
| echoToken | String | N | 64 | 7550f7497b2d4dd9beea83cd2fe8cd76 | Signal notification identifier, if it is a synchronized product that receives a signal notification from Huazhou, you need to bring the unique identifier of the notification |
Response parameter description#
Common Response Parameters[Reference]
content#
| Parameter | Type | Required | Maximum length | Example | Description |
|---|---|---|---|---|---|
| hotelId | String | Y | 32 | 12**567 | Huazhu Hotel ID |
| products | List<Product > | N | - | Product information list |
Product#
| Parameter | Type | Required | Maximum length | Example | Description |
|---|---|---|---|---|---|
| roomTypeCode | String | Y | 64 | DR1 | roomTypeCode |
| roomTypeName | String | Y | 200 | Superior Big Bed Room | roomTypeName |
| rateCode | String | Y | 64 | Base-NTR | rateCode |
| rateCodeName | String | N | 500 | Early decision and early benefit | Rate Code Name |
| checkinType | String | Y | 16 | DAY | Check-in type, case-sensitive Enumeration Dictionary |
| promotion | Boolean | Y | - | false | Whether it is a promotion, true indicates a promotion rateCode, false indicates a regular rateCode |
| promotionCode | String | N | - | 2072200893 | Promotion Code, some promotion promotion are true but the promotionCode is null, which is compatible with the original member intercommunication level verification. If there is no such logic, do not pay attention to it |
| stayWindow | StayWindow | N | - | Check-in window attribute. ARI data in this range needs to be landed synchronously. null indicates that there is no limit (90 days can be booked, and the booking time is not limited per day). | |
| bookWindow | BookWindow | N | - | Booking window property, prompting the user to pay attention to the available time range, or not to display the quotation within this time range, null means no restriction(90-day bookable, unlimited booking time per day). | |
| hourage | Integer | N | - | 2 | The number of rental hours, vaild when checkin type parameter is "HOUR", currently supports 2 4 6 (hours) |
| tags | List<String> | N | - | ["NightSnack"] | For channel display (the relevant use logic must comply with the business agreement, and the loss caused by non-compliance shall be borne by the corresponding responsibility), label: label value, refer to enumeration |
| occupancy | Occupancy | N | - | Number of Occupancy Information |
StayWindow#
| Parameter | Type | Required | Maximum length | Example | Description |
|---|---|---|---|---|---|
| startDate | Date | N | - | 2021-10-01 | Effective date, format yyyy-MM-dd, null means unlimited (90 days can be ordered) |
| endDate | Date | N | - | 2021-10-02 | Expiration date, format yyyy-MM-dd, including this day, null means unlimited (90 days can be booked) |
| excludedDate | List<String> | N | - | Date removed, excluded date between start date and end date, format yyyy-MM-dd | |
| weekControl | String | N | 7 | 1111111 | Week Control, starting from Sunday, 1 means effective, 0 means invalid, and empty means effective |
| eachDayCheckinStartTime | String | N | 8 | 08:00 | The earliest check-in time per day, the format is HH:mm(including the minute). The default value is null, which means there is no limit |
| eachDayCheckinEndTime | String | N | 8 | 18:00 | The latest check-in time per day, format: HH:mm, including mm this minute, default null means no limit |
| eachDayCheckoutEndTime | String | N | 8 | 18:00 | The latest check-out time per day, format: HH:mm, including the minute of mm, default null means no limit |
| onlyDawn | Boolean | N | 8 | true | true indicates only bookable in early morning, false and null have no special meaning |
BookWindow#
| Parameter | Type | Required | Maximum length | Example | Description |
|---|---|---|---|---|---|
| startDate | Date | N | - | 2021-10-01 | For the start date that can be booked on the first day of stay, the format is yyyy-MM-dd, and null means there is no limit (90 days can be booked) |
| endDate | Date | N | - | 2021-10-02 | For the first day of check-in, the end date can be booked, the format is yyyy-MM-dd, including this day, null means no limit (90 days can be booked) |
| excludedDate | List<String> | N | - | Date removed, excluded date between startDate and endDate, format yyyy-MM-dd | |
| eachDayStartTime | String | N | 8 | 08:00 | The earliest bookable time per day, format: HH:mm, including the minute of mm, default null means no limit |
| eachDayEndTime | String | N | 8 | 18:00 | The latest bookable time per day, format: HH:mm, including mm this minute, default null means no limit |
Occupancy#
| Parameter | Type | Required | Maximum length | Example | Description |
|---|---|---|---|---|---|
| maxAdult | Integer | N | - | 2 | Maximum number of adults |
| maxChild | Integer | N | - | 2 | Maximum number of children |
| maxOccupancy | Integer | Y | - | 2 | Maximum occupancy |
ResponseCode#
| Exception Code | Exception Type | Description |
|---|---|---|
| 1000 | Success | |
| 4101 | Invalid hotel Id | Hotel ID does not exist |
| 4102 | Hotel is closed | Hotel closed |
| 4103 | No match found | No data found matching criteria |
| Other | Global Exception Code | Global Exception Code[Reference] |