On-request Inventories

To retrieve on-request rates, additional implementation is required in the following areas: Price Search, Price Confirm and Booking Search

Price Search

• Request
• Use the "IsNeedOnRequest" parameter:
  • If set to "true", the system will accept and display on-request rates.
  • If set to "false", the system will reject and not display on-request rates.

Request Example

{
	"Header": {
		"ClientID": "DidaApiTestID",
		"LicenseKey": "TestKey"
	},
	"HotelIDList": [542586],
	"CheckInDate": "2021-09-13",
	"CheckOutDate": "2021-09-14",
	"IsRealTime": {
		"Value": true,
		"RoomCount": 1
	},
	"RealTimeOccupancy": {
		"ChildCount": 0,
		"AdultCount": 2,
		"ChildAgeDetails": []
	},
	"Nationality": "CN",
	"Currency": "CNY",
	"IsNeedOnRequest": true
}

• Response
• The "IsOnRequest" parameter in the response indicates the type of rate:
  • If "true", the rate is on-request.
  • If "false", the rate is instantly confirmed.

Response example

{
	"Success": {
		"PriceDetails": {
			"CheckOutDate": "2021-09-14 00:00:00",
			"CheckInDate": "2021-09-13 00:00:00",
			"HotelList": [{
					"HotelID": 542586,
					"Destination": {
						"CityCode": "930"
					},
					"RatePlanList": [{
							"TotalPrice": 127.07,
							"RoomStatus": 1,
							"BreakfastType": 2,
							"BedType": 2,
							"RoomOccupancy": {
								"ChildCount": 0,
								"AdultCount": 2,
								"RoomNum": 1
							},
							"PriceList": [{
									"StayDate": "2021-09-13 00:00:00",
									"Price": 127.07,
									"MealAmount": 2,
									"MealType": 2
								}
							],
							"RatePlanCancellationPolicyList": [{
									"Amount": 127.07,
									"FromDate": "2021-09-11 00:00:00"
								}
							],
							"IsOnRequest": true,
							"StandardOccupancy": 2,
							"InventoryCount": 10,
							"MaxOccupancy": 2,
							"Currency": "CNY",
							"RatePlanName": "限时特惠",
							"RatePlanID": "-8930392398183591101"
						}
					],
					"HotelName": "Wan Li Duo Hotel (Mingshu)"
				}
			]
		}
	}
}

Price Confirm

• Request
• Use the "IsNeedOnRequest" parameter:
  • If the rate is on-request, "true" is required.
  • If the rate is instantly confirmed, the following options apply:
    • "true": Allows instant confirm booking to change to on-request booking. This is a rare occurrence on the supplier side.
    • "false": Does not accept changes to on-request booking.

Response example

{
	"PreBook": true,
	"CheckInDate": "2021-09-13",
	"CheckOutDate": "2021-09-14",
	"NumOfRooms": 1,
	"HotelID": 542586,
	"Header": {
		"LicenseKey": "TestKey",
		"ClientID": "DidaApiTestID"
	},
	"OccupancyDetails": [{
			"ChildCount": 0,
			"AdultCount": 2,
			"RoomNum": 1
		}
	],
	"Currency": "CNY",
	"Nationality": "CN",
	"RatePlanID": "-8930392398183591101",
	"IsNeedOnRequest": true
}

• Response
• The "IsOnRequest" parameter in the response indicates the type of rate:
  • If "true", the rate is on-request.
  • If "false", the rate is instantly confirmed.

Response example

{
	"Success": {
		"PriceDetails": {
			"CheckOutDate": "2021-09-14 00:00:00",
			"CheckInDate": "2021-09-13 00:00:00",
			"HotelList": [{
					"HotelID": 542586,
					"Destination": {
						"CityCode": "930"
					},
					"RatePlanList": [{
							"TotalPrice": 127.07,
							"RoomStatus": 1,
							"BreakfastType": 2,
							"BedType": 2,
							"RoomOccupancy": {
								"ChildCount": 0,
								"AdultCount": 2,
								"RoomNum": 0
							},
							"PriceList": [{
									"StayDate": "2021-09-13 00:00:00",
									"Price": 127.07,
									"MealAmount": 2,
									"MealType": 2
								}
							],
							"RatePlanCancellationPolicyList": [{
									"Amount": 127.07,
									"FromDate": "2021-09-11 00:00:00"
								}
							],
							"IsOnRequest": true,
							"StandardOccupancy": 2,
							"InventoryCount": 10,
							"MaxOccupancy": 2,
							"Currency": "CNY",
							"RatePlanName": "限时特惠",
							"RatePlanID": "-8930392398183591101"
						}
					],
					"HotelName": "Wan Li Duo Hotel (Mingshu)"
				}
			]
		}
	}
}

Booking Search

• Response

• The "Status" parameter is used with a new enum value [6]:

  • Status after calling Booking Confirm:
    • [5] indicates instant confirm waiting (Pending)
    • [6] indicates on-request waiting (OnRequest)

Cancellation during the process of confirming a booking:

For bookings that are on-request: Cancellation is possible and works the same way as a normal booking cancellation. For bookings that are instantly confirmed: Cancellation is not supported.