Reservation Detail
Get hotel reservation information for a specified reservation number
Request Method#
POST
uri: /reservation/detail
Content-Type: application/json
Request parameter description#
RequestHeader#
Common Request Header [reference]
RequestBody#
| Parameter | Type | Required | Maximum length | Example |
|---|---|---|---|---|
| resId | String | Y | 64 |
Response parameter description#
Common Response Parameters [reference]
content#
| Parameter | Type | Required | Maximum length | Example | Description |
|---|---|---|---|---|---|
| hotelId | String | Y | 32 | 12 * * 567 | Hotel ID |
| checkInType | String | Y | 16 | DAY | check-in type, DAY: full-time room HOUR: Hourly rate room |
| reservations | List<ReservationInfo> | Y | - | room list information, only single hotel and single product reservation are supported for the time being, only one collection is required | |
| distributorResId | String | Y | 64 | Channel reservation number | |
| paymentType | String | Y | 16 | Enum value: Enumeration Dictionary | |
| guestComment | String | N | 512 | no smoking | Guest notes, **Unsupported character: “\ |
| hotelComment | String | N | 512 | No invoicing required | Reservation notes, invisible for guest |
| resId | String | Y | 64 | Huazhu reservation number | |
| resCode | String | N | 32 | reservation code, not required | |
| bookingTime | Long | Y | - | Reservation time, total milliseconds from 00: 00: 00 GMT on January 1, 1970 | |
| status | String | Y | 32 | Order Status: HOTEL_RESERVATION Booking Success Reference Enumeration: Order Status | |
| occupyRoomFlag | Integer | N | - | Not support yet | |
| actualTotalPrice | BigDecimal | N | - | ActualTotalPrice cannot be blank when couponUseinfos has value. ActualTotalPrice is the sum of daily pricing, it represents the total cost of reservation. | |
| couponUseInfos | List<CouponUseInfo> | N | - | Coupon Information |
ReservationInfo#
| Parameter | Type | Required | Maximum length | Example | Description |
|---|---|---|---|---|---|
| roomTypeCode | String | Y | 64 | DR1 | Room Code |
| rateCode | String | Y | 64 | Base-NTR | rateCode |
| checkin | Date | Y | - | 2021-10-01 | Check-in date in yyyy-MM-dd format |
| checkout | Date | Y | - | 2021-10-02 | Check-out date, format: yyyy-MM-dd, price does not include date of departure, Hourly rate room leaves the same day as checkin. |
| amountBeforeTax | List<BigDecimal> | N | - | [ 100, 120] | Price excluding tax |
| amountAfterTax | List<BigDecimal> | Y | - | [ 100, 130] | Price including tax |
| currencyCode | String | Y | 8 | CNY | The currency corresponding to the price, refer to the international standard: ISO-4217 |
| roomCount | Integer | Y | - | 2 | Number of rooms |
| guaranteePolicyCode | String | Y | 32 | Guarantee policy code, Enumeration Dictionary | |
| cancelPolicyCode | String | Y | 64 | Cancel policy code, reference code rules | |
| estimatedArrivalTime | String | Y | - | 18:30 | The estimation of guest arrival time at the property when specified, the time format is HH:mm, the default time is 12:00. |
| adultCount | Integer | Y | - | 1 | Number of adults per room, the limit depends on hotel details |
| childCount | Integer | N | - | 2 | Number of children per room, the limit depends on hotel details |
| childAges | List<Integer> | N | - | list of length 2 |
CouponUseInfo:#
| Parameter | Type | Required | Maximum length | Example | Description |
|---|---|---|---|---|---|
| couponId | String | Y | 32 | Coupon ID | |
| actualDiscountAmount | BigDecimal | Y | - | The amount of the discounted value. For example, if a guest redeems a $10 coupon in the reservation, the amount would be $10 |
ResponseCode#
| Exception Code | Exception Type | Description |
|---|---|---|
| 1000 | Success | |
| 5301 | Reservation not belong to requester | Order does not match current channel |
| 5302 | Reservation not found | Order not found |
| Others | Global Exception Code | Global Exception [Reference] |