Property Search
Returns a list of property ids or full property content for the requested active properties. Use this API to retrieve property ids or full property content based on your search criteria.
Parameters
Name
Description
Accept
string
( header )
Must be application/json
Accept - Encoding
string
( header )
Must be gzip
Authorization
string
( header )
Must be Your PID
Must be Your API Key
Customer-Ip
string
( header )
Must be IP address of the customer, as captured by your integration. Send IPV4 addresses only.
Ensure your integration passes the customer’s IP, not your own. This value helps determine their location and other settings.
Also used for fraud recovery and other important analytics.
Definition and request parameters for hotel search
action
string
( query )
Must be "hotelSearch" as parameter
Action methods in Web API controller can have one or more parameters of different types. It can be either primitive type or complex type. Web API binds action method parameters either with URL's query string or with request body depending on the parameter type.
cityId
string
( query )
Destination City Id ie. "cityId":"130443"
City Id you will get in previous method "Autocomplete" as a "regionid"
countryCode
string
( query )
Country Code of Destination ie. India = IN, Great Britain = GB)
currency
string
( query )
Preferred Currency
checkIn
string
( query )
The date by which a guest must check in. Must follow YYYY-MM-DD format. ie. "checkIn:2019-05-30"
checkOut
string
( query )
The date by which a guest must check out. Must follow YYYY-MM-DD format. ie. "checkIn:2019-05-31"
rooms
number
( query )
Number of rooms to be set for the search, can be between 1-7
RoomGuests[]
Array
Number and type of guests in a room
NoOfAdults
Integer
Number of adults in the room
NoOfChild
Integer
Number of children in the room
Minimum value should be 0
ChildAge[ ]
Integer array
Child age
Mandatory * (only when ChildCount is more than 0)
REQUEST
API Endpoint: https://www.abengines.com/api/v1/travel-api/hotels/
header: array(
'Content-Type:application/json',
'Accept-encoding: gzip',
'PID:'ADD-YOUR-KEY',
'x-api-key:'ADD-YOUR-KEY'
);
POST:
{
"action": "hotelSearch",
"mode": "Test",
"cityId": "130443",
"countryCode": "IN",
"currency": "INR",
"checkIn": "2023-09-16",
"checkOut": "2023-09-17",
"rooms": "1",
"RoomGuests": [
{
"NoOfAdults": 1,
"NoOfChild": 1,
"ChildAge": [
3
]
}
]
}
Response
The API returns an HTTP response, which generally includes the result of the request invocation
{
"status": 200,
"status_message": "OK",
"responseData": {
"HotelSearchResult": {
"ResponseStatus": 1,
"Error": {
"ErrorCode": 0,
"ErrorMessage": ""
},
"TraceId": "49e79a5d-0048-4af8-add9-b4bd577834ce",
"CityId": "130443",
"Remarks": "india - land of mystries \"\/\/\" \" \/\/\/ \" ",
"CheckInDate": "2023-09-09",
"CheckOutDate": "2023-09-10",
"PreferredCurrency": "INR",
"NoOfRooms": 1,
"RoomGuests": [
{
"NoOfAdults": 2,
"NoOfChild": 0,
"ChildAge": null
}
],
"HotelResults": [
{
"IsHotDeal": false,
"ResultIndex": 3,
"HotelCode": "22728114",
"HotelName": "Hotel Delhi Regency",
"HotelCategory": "",
"StarRating": 3,
"HotelDescription": "",
"HotelPromotion": "",
"HotelPolicy": "",
"Price": {
"CurrencyCode": "INR",
"RoomPrice": 416.35,
"Tax": 0,
"ExtraGuestCharge": 0,
"ChildCharge": 0,
"OtherCharges": 62.13,
"Discount": 0,
"PublishedPrice": 478.48,
"PublishedPriceRoundedOff": 478,
"OfferedPrice": 478.48,
"OfferedPriceRoundedOff": 478,
"AgentCommission": 0,
"AgentMarkUp": 0,
"ServiceTax": 17.85,
"TCS": 0,
"TDS": 0,
"ServiceCharge": 0,
"TotalGSTAmount": 17.85,
"GST": {
"CGSTAmount": 0,
"CGSTRate": 0,
"CessAmount": 6.43,
"CessRate": 10,
"IGSTAmount": 11.43,
"IGSTRate": 18,
"SGSTAmount": 0,
"SGSTRate": 0,
"TaxableAmount": 62.13
}
},
"HotelAddress": "8184 Arakashan Road,Paharganj,Near New Delhi Railway Station,New Delhi,IN, , , , ",
"HotelContactNo": "",
"HotelMap": null,
"Latitude": "",
"Longitude": "",
"HotelLocation": null,
"SupplierPrice": null,
"RoomDetails": [
]
},
{
"IsHotDeal": false,
"ResultIndex": 4,
"HotelCode": "31482930",
"HotelName": "Hotel Paragon Suites",
"HotelCategory": "",
"StarRating": 3,
"HotelDescription": "",
"HotelPromotion": "",
"HotelPolicy": "",
"Price": {
"CurrencyCode": "INR",
"RoomPrice": 691.3,
"Tax": 0,
"ExtraGuestCharge": 0,
"ChildCharge": 0,
"OtherCharges": 103.55,
"Discount": 0,
"PublishedPrice": 794.85,
"PublishedPriceRoundedOff": 795,
"OfferedPrice": 794.85,
"OfferedPriceRoundedOff": 795,
"AgentCommission": 0,
"AgentMarkUp": 0,
"ServiceTax": 28.57,
"TCS": 0,
"TDS": 0,
"ServiceCharge": 0,
"TotalGSTAmount": 28.57,
"GST": {
"CGSTAmount": 0,
"CGSTRate": 0,
"CessAmount": 10,
"CessRate": 10,
"IGSTAmount": 18.57,
"IGSTRate": 18,
"SGSTAmount": 0,
"SGSTRate": 0,
"TaxableAmount": 103.55
}
},
"HotelAddress": "A-260, Road # 6, Near IGI Aiport,NH 8, Mahipalpur,New Delhi,Delhi,IN, , , , ",
"HotelContactNo": "",
"HotelMap": null,
"Latitude": "",
"Longitude": "",
"HotelLocation": null,
"SupplierPrice": null,
"RoomDetails": [
]
}
]
}
}
}