HOTEL SEARCH
This method is used to search hotels available for booking in a specific city within a date range. This method checks:
1. General availability of hotels in a specific city.
2. Availability based on star rating of hotels (5 star or more, 4 star or more, etc).
3. Availability based on Preferred Hotel. If preferred hotel is not found then all hotels in same city will be in response.
1. 'RoomGuest' will repeat for multiple rooms search.
2. Child age(s) are compulsory when search request includes child.
3. Hotel price might vary for same Search Request with different GuestNationality.
Please note that the test API may occasionally fail to return results. If this happens, you can try again after a short while. For more reliable results, it's recommended to use commonly searched hotel locations such as Mumbai and New Delhi, as these cities typically return data consistently.
Service URL (REST) to be used:
Hotel Search Request
| Level | Element | Format | Comments | Mandatory |
|---|---|---|---|---|
| 1 | EndUserIp | String | Public IP address of the end user initiating the hotel search request. Used for security, tracking, and compliance purposes. | Mandatory |
| 2 | ClientId | String | Unique client identifier assigned to the agency during API registration and onboarding. | Mandatory |
| 3 | UserName | String | Username provided to the agency at the time of registration | Mandatory |
| 4 | Password | String | Password provided to the agency at registration | Mandatory |
| 5 | CheckInDate | Date | Start Date of the requested Stay (Format: YYYY-MM-DD) | Mandatory |
| 6 | CheckOutDate | Date | End Date of the requested Stay (Format: YYYY-MM-DD) | Mandatory |
| 7 | NoOfNights | String | Total number of nights for the hotel stay(Minimum value should be 1) | Mandatory |
| 8 | BookingMode | String | Specifies the hotel booking mode or search type | Mandatory |
| 9 | CountryCode | String | ISO 3166-1 alpha-2 country code of the destination country (2-letter code) Example: India → IN | Mandatory |
| 10 | CityId | String | Unique identifier of the destination city | Mandatory |
| 11 | ResultCount | String | For restricting no. of Hotel results in search response (Reserved for future use) | Optional |
| 12 | PreferredCurrency | String | Preferred Currency in which client is expecting price (Ex. India = IND, America = USA) | Mandatory |
| 13 | GuestNationality | String | ISO 3166-1 alpha-2 country code representing the guest's nationality | Mandatory |
| 14 | RequestType | String | Type of hotel search request (e.g., International, Special) | Optional |
| 15 | NoOfRooms | String | Total number of rooms requested for the stay | Mandatory |
| 16 | RoomGuests[] | Array | Array containing occupancy details for each room | Mandatory |
| 16.1 | NoOfAdults | String | Number of adults in the room | Mandatory |
| 16.2 | NoOfChild | String | Number of children in the room | Mandatory |
| 16.3 | ChildAge[] | Array | Child Age (Only when Child Count is more than 0) | Mandatory |
| 17 | PreferredHotel | String | Hotel name used to filter or search specific properties | Mandatory |
| 18 | MaxRating | String | Filter by Star Rating (To be used only in combination with MinRating. MaxRating should be greater than or equal to MinRating. Possible values can be 0 – 5). | Mandatory |
| 19 | MinRating | String | Filter by Star Rating (Can be used only in combination with MaxRating. MinRating should be less than or equal to MaxRating. Possible values can be 0 – 5). | Mandatory |
| 20 | ReviewScore | Decimal | Filter by Review Score (Reserved for future use) | Optional |
| 21 | IsNearBySearchAllowed | Boolean | To allow nearby search (Reserved for future use) | Optional |
Hotel Search Response
| Level | Element | Format | Comments | Mandatory |
|---|---|---|---|---|
| 1 | Error{} | Object | Contains error details returned by the API when the request cannot be processed successfully. | Mandatory |
| 1.1 | ErrorCode | Integer | Unique error code identifying the type of error encountered during request processing. | Mandatory |
| 1.2 | ErrorMessage | String | Human-readable description of the error returned by the API. | Mandatory |
| 2 | TraceId | Integer | Unique identifier assigned to the API request for tracking, debugging, and support purposes. | Mandatory |
| 3 | SrdvType | String | Response type identifier indicating the version or category of data returned by the SRDV system. | Mandatory |
| 4 | CityId | String | Unique identifier of the destination city | Mandatory |
| 5 | Remarks | String | Additional information, comments, or notes | Mandatory |
| 6 | CheckInDate | Date | Start Date of the requested Stay Format: (YYYY-MM-DD) | Mandatory |
| 7 | CheckOutDate | Date | End Date of the requested Stay Format: (YYYY-MM-DD) | Mandatory |
| 8 | PreferredCurrency | String | Preferred Currency in which client is expecting price | Mandatory |
| 9 | NoOfRooms[] | Array | Requested number of rooms | Mandatory |
| 9.1 | NoOfAdults | String | Number of adults in the room | Mandatory |
| 9.2 | NoOfChild | String | Number of children in the room (Minimum value should be 0) | Mandatory |
| 9.3 | ChildAge[] | Integer Array | Child Age (only when Child Count is more than 0) | Mandatory |
| 10 | Results[] | Array | Array of Result | Mandatory |
| 10.1 | SrdvIndex | String | Unique identifier for the hotel search result record. | Mandatory |
| 10.2 | ResultIndex | String | Unique result index used to identify and reference the selected hotel in subsequent requests. | Mandatory |
| 10.3 | OfferedFare | Integer | Final offered price of the hotel booking. | Mandatory |
| 10.4 | HotelCode | String | Unique hotel code (Hotel Code to be echoed back in further requests) | Mandatory |
| 10.5 | HotelName | String | Unique hotel Name | Mandatory |
| 10.6 | HotelCategory | String | Category classification of the hotel. | Optional |
| 10.7 | StarRating | Enumeration | Star Rating of the hotel – StarRating-All = 0, OneStar = 1, TwoStar = 2, ThreeStar = 3, FourStar = 4, FiveStar = 5 | Mandatory |
| 10.8 | HotelDescription | String | Description of the hotel | Mandatory |
| 10.9 | HotelPromotion | String | Promotional details of the hotel | Optional |
| 10.10 | HotelPolicy | String | Hotel Policy Details | Mandatory |
| 10.11 | HotelPicture | String | Hotel Image URL | Mandatory |
| 10.12 | HotelAddress | String | Complete address of the hotel. | Mandatory |
| 10.13 | City | String | City where the hotel is located. | Mandatory |
| 10.14 | State | String | State or province where the hotel is located. | Mandatory |
| 10.15 | PinCode | String | Postal or ZIP code of the hotel location. | Mandatory |
| 10.16 | Country | String | Country where the hotel is located. | Mandatory |
| 10.17 | HotelContactNo | String | Contact Number of hotel | Optional |
| 10.18 | HotelMap | String | Direction Map of the hotel | Optional |
| 10.19 | Latitude | String | Latitude information of the hotel | Optional |
| 10.20 | Longitude | String | Longitude information of the hotel | Optional |
| 10.21 | HotelLocation | String | General location or area description of the hotel. | Optional |
| 10.22 | SupplierPrice | String | Price provided by the hotel supplier before any markup or adjustments. | Optional |
| 10.23 | Facilities[] | Array | List of facilities and amenities available at the hotel. | Mandatory |
| 10.23.1 | FacilitiesNames[] | Array | Names of the facilities and amenities offered by the hotel. | Mandatory |
| 10.23.2 | RoomPrice | Decimal | Base price of the room before taxes and additional charges. | Mandatory |
| 10.24 | Rooms[] | Array | List of available room categories and their pricing details. | Mandatory |
| 10.24.1 | Cateogry | String | Room category or accommodation type (e.g., Deluxe, Suite, Standard). | Mandatory |
| 10.25 | Price[] | Array | Pricing details associated with the room category. | Mandatory |
| 10.25.1 | CurrencyCode | String | ISO currency code in which room prices are quoted. | Mandatory |
| 10.25.2 | RoomPrice | Decimal | Total room charge excluding taxes and additional fees. | Mandatory |
| 10.25.3 | Tax | Decimal | Total tax amount applicable to the room booking. | Optional |
| 10.25.4 | ExtraGuestCharge | Decimal | Extra Guest Charges applicable for the room | Optional |
| 10.25.5 | ChildCharge | Decimal | Child Charges applicable for the room | Optional |
| 10.25.6 | OtherCharges | Decimal | Other Charges applicable for the room | Optional |
| 10.25.7 | Discount | Decimal | Discount amount applied to the room rate, if applicable. | Mandatory |
| 10.25.8 | PublishedPrice | Decimal | Published Price of the room (This price would be different only if Room Price is on PUBLISHED. In case of NET, Published Price would be same as Offered Price) | Mandatory |
| 10.25.9 | PublishedPriceRoundedOff | Decimal | Published Price (rounded off) of the room (This price is for display purpose only) | Mandatory |
| 10.25.10 | OfferedPrice | Decimal | Offered Price of the room | Mandatory |
| 10.25.11 | OfferedPriceRoundedOff | Decimal | Offered Price (rounded off) of the room (This price is for display purpose only) | Mandatory |
| 10.25.12 | ServiceTax | Decimal | TDS applicable on Commission Earned (This would be deducted only when commission is paid to the agent) | Mandatory |
| 10.25.13 | TDS | Decimal | TDS applicable on Commission Earned (This would be deducted only when commission is paid to the agent) | Mandatory |
| 10.25.14 | ServiceCharge | Decimal | Additional service charge levied on the booking. | Optional |
| 10.25.15 | TotalGSTAmount | Decimal | Total GST amount applicable to the room booking. | Optional |
| 10.25.16 | GST{} | Object | GST tax breakup details for the booking | Optional |
| 10.25.16.1 | CGSTAmount | Decimal | Central Goods and Services Tax (CGST) amount. | Optional |
| 10.25.16.2 | CGSTRate | Decimal | CGST percentage rate applied. | Optional |
| 10.25.16.3 | CessAmount | Decimal | Cess amount applicable to the booking. | Optional |
| 10.25.16.4 | CessRate | Decimal | Cess percentage rate applied. | Optional |
| 10.25.16.5 | IGSTAmount | Decimal | Integrated Goods and Services Tax (IGST) amount. | Optional |
| 10.25.16.6 | IGSTRate | Decimal | IGST percentage rate applied. | Optional |
| 10.25.16.7 | SGSTAmount | Decimal | State Goods and Services Tax (SGST) amount. | Optional |
| 10.25.16.8 | SGSTRate | Decimal | SGST percentage rate applied. | Optional |
| 10.25.16.9 | TaxableAmount | Decimal | Total taxable amount on which GST has been calculated. | Optional |