---
title: "Get hotel search results"
method: POST
path: "/v2/hotel/search"
tags: ["Hotel"]
---

# Get hotel search results

`POST /v2/hotel/search`

Get all available hotels for the requested search parameters.

## Request body

- HotelSearchRequest — Defines the structure of a hotel search request.
  - `searchParams` HotelSearchParams, required — The parameters required for searching hotels.
    - `occupancyDates` OccupancyDates, required
      - `occupancy` Occupancy[], required — List of occupancy details including the number of adults and children.
        - `numAdults` integer, required — The number of adults staying in the room.
        - `numChildren` integer — The number of children staying in the room.
      - `checkInDate` DateTimeLocal, required — Local date and time in ISO 8601 format.
        - `iso8601` string, required
      - `checkOutDate` DateTimeLocal, required — Local date and time in ISO 8601 format.
        - `iso8601` string, required
    - `searchBy` union, required — Criteria used for searching hotels. The `searchType` field can contain one criteria per request.
      - object
        - `searchType` string, required
        - `airport` string, required — IATA code of the airport. The search result will contain the list of hotels in close proximity to the specified airport.
      - object
        - `searchType` string, required
        - `coordinates` Latlng, required — Latitude and Longitude for a Location
          - `latitude` number, double, required — Latitude of the Location
          - `longitude` number, double, required — Longitude of the Location
      - object
        - `searchType` string, required
        - `hotelCode` string, required — Unique code for a hotel. The search result will also contain other hotels in close proximity to the requested hotel code.
      - object
        - `searchType` string, required
        - `hotelCodes` string[], required — List of hotel codes to be included in the search result.
  - `filters` HotelSearchFilters — Filters to refine the search result. Based on the user selected filters, the list of matching hotels will be displayed.
    - `prepaidQualifier` 'INCLUDE_PREPAID' | 'EXCLUDE_PREPAID' | 'PREPAID_ONLY' — Prepaid qualifiers.
    - `priceRange` SimpleMoneyRange — SimpleMoney range containing minimum and maximum amount.
      - `min` SimpleMoney — Money object containing just amount and currency code.
        - `amount` number, double, required — Amount
        - `currencyCode` string, required — The 3-letter currency code defined in ISO 4217.
      - `max` SimpleMoney — Money object containing just amount and currency code.
        - `amount` number, double, required — Amount
        - `currencyCode` string, required — The 3-letter currency code defined in ISO 4217.
    - `amenities` HotelAmenityType[] — List of preferred amenities to be included in the hotel search result.
    - `chainCodes` string[] — List of preferred hotel chain codes to be included in the search result. A hotel chain is a company that owns or operates multiple hotels across different locations. These hotel chains have a unique code which can be used here as an array.
    - `radius` Length — Specifies the length or a distance.
      - `length` number, double, required — Distance from search point.
      - `unit` 'UNKNOWN_UNIT' | 'KM' | 'MILE' | 'CENTIMETER' | 'METER', required — Unit of measure being applied.
    - `starRatings` integer[] — Indicates the star quality rating of a hotel. Filter search result using preferred star ratings.
    - `nameQuery` string — The name of the hotel to be included in the search query.
    - `eligibleForLoyalty` boolean — Include hotels that are eligible for loyalty points.
    - `showUnavailable` boolean — Include unavailable hotels.
    - `payByPoints` boolean — Include hotels that support payment by points.
    - `modifiableOnly` boolean — Include hotels that allow users to modify their booking.
    - `rateTypes` HotelRateType[] — List of rate type identifiers to filter the search results.
    - `propertyTypes` HotelPropertyType[] — Filter by property type such as a hotel, an apartment, bed and breakfast, and so on.
      - `type` 'ALL_SUITE' | 'ALL_INCLUSIVE_RESORT' | 'APARTMENT' | 'BED_AND_BREAKFAST' | 'CABIN_OR_BUNGALOW' | 'CAMPGROUND' | 'CHALET' | 'CONDOMINIUM' | 'CONFERENCE_CENTER' | 'CORPORATE_BUSINESS_TRANSIENT' | 'CRUISE' | 'EXTENDED_STAY' | 'GUEST_FARM' | 'GUEST_HOUSE_LIMITED_SERVICE' | 'HEALTH_SPA' | 'HOLIDAY_RESORT' | 'HOSTEL' | 'HOTEL' | 'INN' | 'LODGE' | 'MONASTERY' | 'MOTEL' | 'RANCH' | 'RESIDENTIAL_APARTMENT' | 'RESORT' | 'TENT' | 'VACATION_HOME' | 'VILLA' | 'WILDLIFE_RESERVE' | 'CASTLE' | 'GOLF' | 'PENSION' | 'SKI' | 'SPA' | 'BOATEL' | 'HISTORICAL' | 'RECREATIONAL_VEHICLE_PARK' | 'CHARM_HOTEL' | 'OTHER', required
      - `description` string — Description of the property type.
    - `refundableOnly` boolean — Include hotels that support refund of the booking.
    - `preferredOnly` boolean — Filter to show only preferred hotels.
  - `sortOptions` HotelSortOptions[] — Sort options for the search results.
    - `sortBy` 'PRICE' | 'DISTANCE' | 'SABRE_RATING', required — Sorting criteria for the hotel search results.
    - `sortOrder` 'ASCENDING' | 'DESCENDING', required — The order in which the search results should be displayed.
  - `userId` union, required — An identifier for the user involved in the hotel booking or search process.
    - object
      - `userIdType` string, required
      - `userId` UserId, required — User identifier
        - `id` string, uuid, required
    - object
      - `userIdType` string, required
      - `registrarUserId` UserId, required — User identifier
        - `id` string, uuid, required
  - `paginationParams` union — Pagination request for token-based pagination, where a token is used to retrieve the next page of results.
    - object — The page token.
      - `requestType` string, required — Discriminator for the type of pagination.
      - `pageToken` string, required — The page token.
    - object — The page size.
      - `requestType` string, required — Discriminator for the type of pagination.
      - `pageSize` integer — The page size.

## Response `200`

OK

- HotelSearchResponse — Defines the structure of a hotel search response.
  - `hotels` HotelSearchData[], required — List of hotels matching the search criteria.
    - `hotelDetailsKey` string, required — Unique key for the hotel details.
    - `hotelSpec` HotelSpec, required — Includes detailed specifications for a hotel, such as name, star rating, address, coordinates, amenities, and other information.
      - `name` string, required — Name of the hotel.
      - `address` PostalAddress, required — Postal Address Details
        - `addressLines` string[], required — Address lines
        - `administrativeArea` string — Code of administrative area. For example: DL for Delhi, India. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
        - `administrativeAreaName` string — Name of administrative area. This is full name corresponding to administrativeArea. Like Delhi for DL area code. For some places, code and name maybe same as well like Tokyo.
        - `description` string — Address description
        - `isDefault` boolean — Whether this address is default address in case multiple addresses are specified.
        - `languageCode` string — BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. Examples: "zh-Hant", "ja", "ja-Latn", "en".
        - `locality` string — Generally refers to the city/town portion of the address.
        - `locationCode` string — IATA 3-letter location code. See https://www.iata.org/en/services/codes.
        - `organization` string — The name of the organization at the address.
        - `postalCode` string — Postal code of the address. This is a required field when setting for a user/legal entity/company etc.
        - `continentCode` string — 2 letter continent code of the continent this address falls in.
        - `recipients` string[] — The recipient at the address.
        - `regionCode` string, required — Region code of the country/region of the address.
        - `regionName` string — Region name of the country/region of the address.
        - `revision` integer
        - `sortingCode` string — Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
        - `sublocality` string — Sublocality of the address. This can be neighborhoods, boroughs, districts.
        - `timezone` string — Time zone of the address.
        - `coordinates` Latlng — Latitude and Longitude for a Location
          - `latitude` number, double, required — Latitude of the Location
          - `longitude` number, double, required — Longitude of the Location
      - `coordinates` Latlng, required — Latitude and Longitude for a Location
        - `latitude` number, double, required — Latitude of the Location
        - `longitude` number, double, required — Longitude of the Location
      - `contactInfo` ContactInfo, required — Provides contact information for a hotel.
        - `phone` PhoneNumber[], required — List of phone numbers for the hotel.
          - `countryCode` integer — two digit country code
          - `countryCodeSource` 'UNSPECIFIED' | 'FROM_NUMBER_WITH_PLUS_SIGN' | 'FROM_NUMBER_WITH_IDD' | 'FROM_NUMBER_WITHOUT_PLUS_SIGN' | 'FROM_DEFAULT_COUNTRY'
          - `extension` string — phone number extension
          - `isoCountryCode` string — ISO alpha-2 code
          - `italianLeadingZero` boolean
          - `nationalNumber` integer
          - `numberOfLeadingZeros` integer
          - `preferredDomesticCarrierCode` string
          - `rawInput` string
          - `type` 'UNKNOWN_TYPE' | 'MOBILE' | 'LANDLINE'
        - `fax` string[] — List of fax numbers for the hotel.
        - `email` string[], required — List of email addresses for the hotel.
      - `amenities` HotelAmenity[], required — List of hotel amenities.
        - `hotelAmenityType` 'TWENTY_FOUR_HOUR_FRONT_DESK' | 'TWENTY_FOUR_HOUR_ROOM_SERVICE' | 'TWENTY_FOUR_HOUR_SECURITY' | 'ADJOINING_ROOMS' | 'AIR_CONDITIONING' | 'AIRLINE_DESK' | 'ATM_CASH_MACHINE' | 'BABY_SITTING' | 'BBQ_PICNIC_AREA' | 'BILINGUAL_STAFF' | 'BOOKSTORE' | 'BOUTIQUES_STORES' | 'BRAILED_ELEVATORS' | 'BUSINESS_LIBRARY' | 'CAR_RENTAL_DESK' | 'CASINO' | 'CHECK_CASHING_POLICY' | 'CHECK_IN_KIOSK' | 'COCKTAIL_LOUNGE' | 'COFFEE_SHOP' | 'COIN_OPERATED_LAUNDRY' | 'CONCIERGE_DESK' | 'CONCIERGE_FLOOR' | 'CONFERENCE_FACILITIES' | 'COURTYARD' | 'CURRENCY_EXCHANGE' | 'DESK_WITH_ELECTRICAL_OUTLET' | 'DOCTOR_ON_CALL' | 'DOOR_MAN' | 'DRIVING_RANGE' | 'DRUGSTORE_PHARMACY' | 'DUTY_FREE_SHOP' | 'ELEVATORS' | 'EXECUTIVE_FLOOR' | 'EXERCISE_GYM' | 'EXPRESS_CHECK_IN' | 'EXPRESS_CHECK_OUT' | 'FAMILY_PLAN' | 'FLORIST' | 'FOLIOS' | 'FREE_AIRPORT_SHUTTLE' | 'FREE_PARKING' | 'FREE_TRANSPORTATION' | 'GAME_ROOM' | 'GIFT_NEWS_STAND' | 'HAIRDRESSER_BARBER' | 'ACCESSIBLE_FACILITIES' | 'HEALTH_CLUB' | 'HEATED_POOL' | 'HOUSEKEEPING_DAILY' | 'HOUSEKEEPING_WEEKLY' | 'ICE_MACHINE' | 'INDOOR_PARKING' | 'INDOOR_POOL' | 'JACUZZI' | 'JOGGING_TRACK' | 'KENNELS' | 'LAUNDRY_VALET_SERVICE' | 'LIQUOR_STORE' | 'LIVE_ENTERTAINMENT' | 'MASSAGE_SERVICES' | 'NIGHTCLUB' | 'OFF_SITE_PARKING' | 'ON_SITE_PARKING' | 'OUTDOOR_PARKING' | 'OUTDOOR_POOL' | 'PACKAGE_PARCEL_SERVICES' | 'PARKING' | 'PHOTOCOPY_CENTER' | 'PLAYGROUND' | 'POOL' | 'POOLSIDE_SNACK_BAR' | 'PUBLIC_ADDRESS_SYSTEM' | 'RAMP_ACCESS' | 'RECREATIONAL_VEHICLE_PARKING' | 'RESTAURANT' | 'ROOM_SERVICE' | 'SAFE_DEPOSIT_BOX' | 'SAUNA' | 'SECURITY' | 'SHOE_SHINE_STAND' | 'SHOPPING_MALL' | 'SOLARIUM' | 'SPA' | 'SPORTS_BAR' | 'STEAM_BATH' | 'STORAGE_SPACE' | 'SUNDRY_CONVENIENCE_STORE' | 'TECHNICAL_CONCIERGE' | 'THEATRE_DESK' | 'TOUR_SIGHTSEEING_DESK' | 'TRANSLATION_SERVICES' | 'TRAVEL_AGENCY' | 'TRUCK_PARKING' | 'VALET_CLEANING' | 'DRY_CLEANING' | 'VALET_PARKING' | 'VENDING_MACHINES' | 'VIDEO_TAPES' | 'WAKEUP_SERVICE' | 'WHEELCHAIR_ACCESS' | 'WHIRLPOOL' | 'MULTILINGUAL_STAFF' | 'WEDDING_SERVICES' | 'BANQUET_FACILITIES' | 'BELL_STAFF_PORTER' | 'BEAUTY_SHOP_SALON' | 'COMPLIMENTARY_SELF_SERVICE_LAUNDRY' | 'DIRECT_DIAL_TELEPHONE' | 'FEMALE_TRAVELER_ROOM_FLOOR' | 'PHARMACY' | 'STABLES' | 'ONE_TWENTY_AC' | 'ONE_TWENTY_DC' | 'TWO_TWENTY_AC' | 'ACCESSIBLE_PARKING' | 'TWO_TWENTY_DC' | 'BARBEQUE_GRILLS' | 'WOMENS_CLOTHING' | 'MENS_CLOTHING' | 'CHILDRENS_CLOTHING' | 'SHOPS_AND_COMMERCIAL_SERVICES' | 'VIDEO_GAMES' | 'SPORTS_BAR_OPEN_FOR_LUNCH' | 'SPORTS_BAR_OPEN_FOR_DINNER' | 'ROOM_SERVICE_FULL_MENU' | 'ROOM_SERVICE_LIMITED_MENU' | 'ROOM_SERVICE_LIMITED_HOURS' | 'VALET_SAME_DAY_DRY_CLEANING' | 'BODY_SCRUB' | 'BODY_WRAP' | 'PUBLIC_AREA_AIR_CONDITIONED' | 'EFOLIO_AVAILABLE_TO_COMPANY' | 'INDIVIDUAL_EFOLIO_AVAILABLE' | 'VIDEO_REVIEW_BILLING' | 'BUTLER_SERVICE' | 'COMPLIMENTARY_IN_ROOM_COFFEE_OR_TEA' | 'COMPLIMENTARY_BUFFET_BREAKFAST' | 'COMPLIMENTARY_COCKTAILS' | 'COMPLIMENTARY_COFFEE_IN_LOBBY' | 'COMPLIMENTARY_CONTINENTAL_BREAKFAST' | 'COMPLIMENTARY_FULL_AMERICAN_BREAKFAST' | 'DINNER_DELIVERY_SERVICE_FROM_LOCAL_RESTAURANT' | 'COMPLIMENTARY_NEWSPAPER_DELIVERED_TO_ROOM' | 'COMPLIMENTARY_NEWSPAPER_IN_LOBBY' | 'COMPLIMENTARY_SHOESHINE' | 'EVENING_RECEPTION' | 'FRONT_DESK' | 'GROCERY_SHOPPING_SERVICE_AVAILABLE' | 'HALAL_FOOD_AVAILABLE' | 'KOSHER_FOOD_AVAILABLE' | 'LIMOUSINE_SERVICE' | 'MANAGERS_RECEPTION' | 'MEDICAL_FACILITIES_SERVICE' | 'TELEPHONE_JACK_ADAPTOR_AVAILABLE' | 'ALL_INCLUSIVE_MEAL_PLAN' | 'BUFFET_BREAKFAST' | 'COMMUNAL_BAR_AREA' | 'CONTINENTAL_BREAKFAST' | 'FULL_MEAL_PLAN' | 'FULL_AMERICAN_BREAKFAST' | 'MEAL_PLAN_AVAILABLE' | 'MODIFIED_AMERICAN_MEAL_PLAN' | 'FOOD_AND_BEVERAGE_OUTLETS' | 'LOUNGES_BARS' | 'BARBER_SHOP' | 'VIDEO_CHECKOUT' | 'ONSITE_LAUNDRY' | 'TWENTY_FOUR_HOUR_FOOD_AND_BEVERAGE_KIOSK' | 'CONCIERGE_LOUNGE' | 'PARKING_FEE_MANAGED_BY_HOTEL' | 'TRANSPORTATION' | 'BREAKFAST_SERVED_IN_RESTAURANT' | 'LUNCH_SERVED_IN_RESTAURANT' | 'DINNER_SERVED_IN_RESTAURANT' | 'FULL_SERVICE_HOUSEKEEPING' | 'LIMITED_SERVICE_HOUSEKEEPING' | 'HIGH_SPEED_INTERNET_ACCESS_FOR_LAPTOP_IN_PUBLIC_AREAS' | 'WIRELESS_INTERNET_CONNECTION_IN_PUBLIC_AREAS' | 'ADDITIONAL_SERVICES_AMENITIES_FACILITIES_ON_PROPERTY' | 'TRANSPORTATION_SERVICES_LOCAL_AREA' | 'TRANSPORTATION_SERVICES_LOCAL_OFFICE' | 'DVD_VIDEO_RENTAL' | 'PARKING_LOT' | 'PARKING_DECK' | 'STREET_SIDE_PARKING' | 'COCKTAIL_LOUNGE_WITH_ENTERTAINMENT' | 'COCKTAIL_LOUNGE_WITH_LIGHT_FARE' | 'MOTORCYCLE_PARKING' | 'PHONE_SERVICES' | 'BALLROOM' | 'BUS_PARKING' | 'CHILDRENS_PLAY_AREA' | 'CHILDRENS_NURSERY' | 'DISCO' | 'EARLY_CHECK_IN' | 'LOCKER_ROOM' | 'NON_SMOKING_ROOMS_GENERIC' | 'TRAIN_ACCESS' | 'AEROBICS_INSTRUCTION' | 'BAGGAGE_HOLD' | 'BICYCLE_RENTALS' | 'DIETICIAN' | 'LATE_CHECK_OUT_AVAILABLE' | 'PET_SITTING_SERVICES' | 'PRAYER_MATS' | 'SPORTS_TRAINER' | 'TURNDOWN_SERVICE' | 'DVDS_VIDEOS_CHILDREN' | 'BANK' | 'LOBBY_COFFEE_SERVICE' | 'BANKING_SERVICES' | 'STAIRWELLS' | 'PET_AMENITIES_AVAILABLE' | 'EXHIBITION_CONVENTION_FLOOR' | 'LONG_TERM_PARKING' | 'CHILDREN_NOT_ALLOWED' | 'CHILDREN_WELCOME' | 'COURTESY_CAR' | 'HOTEL_DOES_NOT_PROVIDE_PORNOGRAPHIC_FILMS_TV' | 'HOTSPOTS' | 'FREE_HIGH_SPEED_INTERNET_CONNECTION' | 'INTERNET_SERVICES' | 'PETS_ALLOWED' | 'GOURMET_HIGHLIGHTS' | 'CATERING_SERVICES' | 'COMPLIMENTARY_BREAKFAST' | 'BUSINESS_CENTER' | 'BUSINESS_SERVICES' | 'SECURED_PARKING' | 'RACQUETBALL' | 'SNOW_SPORTS' | 'TENNIS_COURT' | 'WATER_SPORTS' | 'CHILD_PROGRAMS' | 'GOLF' | 'HORSEBACK_RIDING' | 'OCEANFRONT' | 'BEACHFRONT' | 'HAIR_DRYER' | 'IRONING_BOARD' | 'HEATED_GUEST_ROOMS' | 'TOILET' | 'PARLOR' | 'VIDEO_GAME_PLAYER' | 'THALASSOTHERAPY' | 'PRIVATE_DINING_FOR_GROUPS' | 'HEARING_IMPAIRED_SERVICES' | 'CARRYOUT_BREAKFAST' | 'DELUXE_CONTINENTAL_BREAKFAST' | 'HOT_CONTINENTAL_BREAKFAST' | 'HOT_BREAKFAST' | 'PRIVATE_POOL' | 'CONNECTING_ROOMS' | 'DATA_PORT' | 'EXTERIOR_CORRIDORS' | 'GULF_VIEW' | 'ACCESSIBLE_ROOMS' | 'HIGH_SPEED_INTERNET_ACCESS' | 'INTERIOR_CORRIDORS' | 'HIGH_SPEED_WIRELESS' | 'KITCHENETTE' | 'PRIVATE_BATH_OR_SHOWER' | 'FIRE_SAFETY_COMPLIANT' | 'WELCOME_DRINK' | 'BOARDING_PASS_PRINT_OUT_AVAILABLE' | 'PRINTING_SERVICES_AVAILABLE' | 'ALL_PUBLIC_AREAS_NON_SMOKING' | 'MEETING_ROOMS' | 'MOVIES_IN_ROOM' | 'SECRETARIAL_SERVICE' | 'SNOW_SKIING' | 'WATER_SKIING' | 'FAX_SERVICE' | 'GREAT_ROOM' | 'LOBBY' | 'MULTIPLE_PHONE_LINES_BILLED_SEPARATELY' | 'UMBRELLAS' | 'GAS_STATION' | 'GROCERY_STORE' | 'TWENTY_FOUR_HOUR_COFFEE_SHOP' | 'AIRPORT_SHUTTLE_SERVICE' | 'LUGGAGE_SERVICE' | 'PIANO_BAR' | 'VIP_SECURITY' | 'COMPLIMENTARY_WIRELESS_INTERNET' | 'CONCIERGE_BREAKFAST' | 'SAME_GENDER_FLOOR' | 'CHILDREN_PROGRAMS' | 'BUILDING_MEETS_LOCAL_STATE_AND_COUNTRY_BUILDING_CODES' | 'INTERNET_BROWSER_ON_TV' | 'NEWSPAPER' | 'PARKING_CONTROLLED_ACCESS_GATES_TO_ENTER_PARKING_AREA' | 'HOTEL_SAFE_DEPOSIT_BOX_NOT_ROOM_SAFE_BOX' | 'STORAGE_SPACE_AVAILABLE_FEE' | 'TYPE_OF_ENTRANCES_TO_GUEST_ROOMS' | 'BEVERAGE_COCKTAIL' | 'CELL_PHONE_RENTAL' | 'COFFEE_TEA' | 'EARLY_CHECK_IN_GUARANTEE' | 'FOOD_AND_BEVERAGE_DISCOUNT' | 'LATE_CHECK_OUT_GUARANTEE' | 'ROOM_UPGRADE_CONFIRMED' | 'ROOM_UPGRADE_ON_AVAILABILITY' | 'SHUTTLE_TO_LOCAL_BUSINESSES' | 'SHUTTLE_TO_LOCAL_ATTRACTIONS' | 'SOCIAL_HOUR' | 'VIDEO_BILLING' | 'WELCOME_GIFT' | 'HYPOALLERGENIC_ROOMS' | 'ROOM_AIR_FILTRATION' | 'SMOKE_FREE_PROPERTY' | 'WATER_PURIFICATION_SYSTEM_IN_USE' | 'POOLSIDE_SERVICE' | 'CLOTHING_STORE' | 'ELECTRIC_CAR_CHARGING_STATIONS' | 'OFFICE_RENTAL' | 'PIANO' | 'INCOMING_FAX' | 'OUTGOING_FAX' | 'SEMI_PRIVATE_SPACE' | 'LOADING_DOCK' | 'BABY_KIT' | 'CHILDRENS_BREAKFAST' | 'CLOAKROOM_SERVICE' | 'COFFEE_LOUNGE' | 'EVENTS_TICKET_SERVICE' | 'LATE_CHECK_IN' | 'LIMITED_PARKING' | 'OUTDOOR_SUMMER_BAR_CAFE' | 'NO_PARKING_AVAILABLE' | 'BEER_GARDEN' | 'GARDEN_LOUNGE_BAR' | 'SUMMER_TERRACE' | 'WINTER_TERRACE' | 'ROOF_TERRACE' | 'BEACH_BAR' | 'HELICOPTER_SERVICE' | 'FERRY' | 'TAPAS_BAR' | 'CAFE_BAR' | 'SNACK_BAR' | 'GUESTROOM_WIRED_INTERNET' | 'GUESTROOM_WIRELESS_INTERNET' | 'FITNESS_CENTER' | 'ALCOHOLIC_BEVERAGES' | 'NON_ALCOHOLIC_BEVERAGES' | 'HEALTH_AND_BEAUTY_SERVICES' | 'LOCAL_CALLS' | 'MINIBAR' | 'REFRIGERATOR' | 'IN_ROOM_SAFE' | 'SMOKING_ROOMS_AVAILBLE' | 'MOUNTAIN_VIEW' | 'POOL_VIEW' | 'BEACH_VIEW' | 'OCEAN_VIEW' | 'ROOMS_WITH_BALCONY' | 'FAMILY_ROOM' | 'CRIB_CHARGE' | 'ROLLAWAY_ADULT' | 'FREE_WIFI_IN_MEETING_ROOMS' | 'ECO_FRIENDLY' | 'EXTRA_PERSON' | 'STAY_SAFE' | 'ENHANCED_HYGIENE_CLEANLINESS_PROTOCOLS', required
        - `additionalInfo` string — Amenity description
        - `isComplimentary` boolean — Is Amenity complimentary
      - `descriptions` HotelDescription[] — List of hotel descriptions.
        - `type` 'GENERAL' | 'ALERTS' | 'DINING' | 'FACILITIES' | 'RECREATION' | 'SERVICES' | 'ATTRACTIONS' | 'CANCELLATION_POLICY' | 'DEPOSIT_POLICY' | 'DIRECTIONS' | 'POLICIES' | 'SAFETY' | 'TRANSPORTATION' — Hotel description type
        - `value` string — Hotel description value
      - `imageSets` HotelImageSet[] — List of hotel image sets.
        - `category` 'UNKNOWN_CATEGORY' | 'EXTERIOR_VIEW' | 'LOBBY_VIEW' | 'POOL_VIEW' | 'RESTAURANT' | 'HEALTH_CLUB' | 'GUEST_ROOM' | 'SUITE' | 'MEETING_ROOM' | 'BALLROOM' | 'GOLF_COURSE' | 'BEACH' | 'SPA' | 'BAR_OR_LOUNGE' | 'RECREATIONAL_FACILITY' | 'LOGO' | 'BASICS' | 'MAP' | 'PROMOTIONAL' | 'HOT_NEWS' | 'MISCELLANEOUS' | 'GUEST_ROOM_AMENITY' | 'PROPERTY_AMENITY' | 'BUSINESS_CENTER', required — Category of image such as exterior, spa, etc.
        - `imageGroup` ImageGroup, required — Contains different sizes of the same image.
          - `caption` string — Caption for the image.
          - `images` Image[], required — List of images.
            - `data` string, byte
            - `dimensions` Dimensions — Image dimensions ie width and height.
              - …
            - `url` string
      - `hotelId` string, required — Unique hotel identifier.
      - `brandCode` string — The code of hotel brand.
      - `brandName` string — Brand name of the hotel.
      - `chainCode` string — The code of hotel chain.
      - `chainName` string — Name of the hotel chain.
      - `propertyTypes` HotelPropertyType[], required — List of property types for the hotel.
        - `type` 'ALL_SUITE' | 'ALL_INCLUSIVE_RESORT' | 'APARTMENT' | 'BED_AND_BREAKFAST' | 'CABIN_OR_BUNGALOW' | 'CAMPGROUND' | 'CHALET' | 'CONDOMINIUM' | 'CONFERENCE_CENTER' | 'CORPORATE_BUSINESS_TRANSIENT' | 'CRUISE' | 'EXTENDED_STAY' | 'GUEST_FARM' | 'GUEST_HOUSE_LIMITED_SERVICE' | 'HEALTH_SPA' | 'HOLIDAY_RESORT' | 'HOSTEL' | 'HOTEL' | 'INN' | 'LODGE' | 'MONASTERY' | 'MOTEL' | 'RANCH' | 'RESIDENTIAL_APARTMENT' | 'RESORT' | 'TENT' | 'VACATION_HOME' | 'VILLA' | 'WILDLIFE_RESERVE' | 'CASTLE' | 'GOLF' | 'PENSION' | 'SKI' | 'SPA' | 'BOATEL' | 'HISTORICAL' | 'RECREATIONAL_VEHICLE_PARK' | 'CHARM_HOTEL' | 'OTHER', required
        - `description` string — Description of the property type.
      - `starRating` HotelStarRatingInfo, required — Details about hotel star rating.
        - `starRating` number, float, required — Star rating of the hotel.
        - `ratingType` 'OFFICIAL' | 'SELF_RATED', required — Enum representing the type of star rating.
      - `additionalAmenities` string[] — Additional amenities provided by the hotel.
      - `checkinTime` TimeLocal — ISO8601 Local Time
        - `iso8601` string, required
      - `checkoutTime` TimeLocal — ISO8601 Local Time
        - `iso8601` string, required
    - `distance` Length, required — Specifies the length or a distance.
      - `length` number, double, required — Distance from search point.
      - `unit` 'UNKNOWN_UNIT' | 'KM' | 'MILE' | 'CENTIMETER' | 'METER', required — Unit of measure being applied.
    - `policyInfo` CommonPolicyInfo — Includes detailed information about a policy, such as its unique identifier, type, name, rules, version, and approval type.
      - `id` EntityId, required — Identifier of an object
        - `id` string, uuid, required
      - `policyType` 'DEFAULT' | 'GROUP' | 'INTERNAL', required — Policy type.
      - `policyName` string, required — Name of the policy.
      - `ruleResultInfos` PolicyRuleResultInfo[] — Information about the policy rules.
        - `violationInfos` PolicyViolationInfo[]
          - `predicateString` string
          - `predicate` 'UNKNOWN_PREDICATE_STRING' | 'MAX_FARE_PER_TRAVELLER_VIOLATION' | 'FARE_MORE_THAN_MINIMUM' | 'FARE_MORE_THAN_MEDIAN' | 'FARE_LESS_THAN_MEDIAN' | 'FARE_MORE_THAN_LLF' | 'MAX_FARE_PER_TRAVELLER_VIOLATION_INCLUDING_TAX' | 'MAX_FARE_PER_TRAVELLER_VIOLATION_EXCLUDING_TAX' | 'HOTEL_PAYMENT_OPTIONS_VIOLATION' | 'RAIL_BOOKING_WINDOW_GAP_VIOLATION' | 'RAIL_TRAVEL_CLASS_VIOLATION' | 'RAIL_TICKET_REFUNDABLE_VIOLATION' | 'RAIL_MAX_BOOKING_PRICE_VIOLATION_INCLUDING_TAX' | 'RAIL_MAX_BOOKING_PRICE_VIOLATION_EXCLUDING_TAX' | 'AIR_MAX_PRICE_MORE_THAN_LLF_VIOLATION_INCLUDING_TAX' | 'AIR_MAX_PRICE_MORE_THAN_LLF_VIOLATION_EXCLUDING_TAX' | 'HOTEL_RESTRICTED_KEYWORDS_VIOLATION' | 'RESTRICTED_LOCATION_VIOLATION' | 'FLIGHT_ADVANCE_BOOKING_WINDOW_DOMESTIC_VIOLATION' | 'FLIGHT_ADVANCE_BOOKING_WINDOW_INTERNATIONAL_VIOLATION' | 'FLIGHT_ADVANCE_BOOKING_WINDOW_VIOLATION' | 'ITINERARY_WITHIN_EVENT_TRAVEL_WINDOW' | 'HOTEL_IN_ALLOWED_HOTEL_LIST' | 'PAYMENT_ACCESS_VIOLATION' | 'AIRPORT_IN_ALLOWED_AIRPORT_LIST' | 'ITINERARY_TYPE_IS_NOT_IN_ALLOWED_BOOKING_TYPES' | 'PAYMENT_AIR_ADDON_VIOLATION' | 'MAX_HOTEL_BOOKING_PRICE_INCLUDING_TAX' | 'MAX_HOTEL_BOOKING_PRICE_EXCLUDING_TAX' | 'AIR_NUM_TRAVELERS_ALLOWED' | 'PREFERRED_VENDOR_VIOLATION' | 'SEAT_ADDON_VIOLATION' | 'BAGGAGE_ADDON_VIOLATION' | 'EARLY_BIRD_ADDON_VIOLATION' | 'WIFI_ADDON_VIOLATION' | 'RESTRICTED_BOOKING_VIOLATION' | 'HIGHEST_ALLOWED_CABIN_VIOLATION' | 'LOWEST_FARE_PER_HOTEL_PROPERTY_VIOLATION' | 'AIR_RESTRICTED_FARES_VIOLATION' | 'AIR_ANCILLARY_VIOLATION' — This contains the enum mentioning the policy rule which was violated.
          - `expectedValue` union
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
          - `actualValue` union
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
        - `subViolationInfos` PolicyViolationInfo[] — In case of complex rules this will contain extra information as to how the rule was calculated.
          - `predicateString` string
          - `predicate` 'UNKNOWN_PREDICATE_STRING' | 'MAX_FARE_PER_TRAVELLER_VIOLATION' | 'FARE_MORE_THAN_MINIMUM' | 'FARE_MORE_THAN_MEDIAN' | 'FARE_LESS_THAN_MEDIAN' | 'FARE_MORE_THAN_LLF' | 'MAX_FARE_PER_TRAVELLER_VIOLATION_INCLUDING_TAX' | 'MAX_FARE_PER_TRAVELLER_VIOLATION_EXCLUDING_TAX' | 'HOTEL_PAYMENT_OPTIONS_VIOLATION' | 'RAIL_BOOKING_WINDOW_GAP_VIOLATION' | 'RAIL_TRAVEL_CLASS_VIOLATION' | 'RAIL_TICKET_REFUNDABLE_VIOLATION' | 'RAIL_MAX_BOOKING_PRICE_VIOLATION_INCLUDING_TAX' | 'RAIL_MAX_BOOKING_PRICE_VIOLATION_EXCLUDING_TAX' | 'AIR_MAX_PRICE_MORE_THAN_LLF_VIOLATION_INCLUDING_TAX' | 'AIR_MAX_PRICE_MORE_THAN_LLF_VIOLATION_EXCLUDING_TAX' | 'HOTEL_RESTRICTED_KEYWORDS_VIOLATION' | 'RESTRICTED_LOCATION_VIOLATION' | 'FLIGHT_ADVANCE_BOOKING_WINDOW_DOMESTIC_VIOLATION' | 'FLIGHT_ADVANCE_BOOKING_WINDOW_INTERNATIONAL_VIOLATION' | 'FLIGHT_ADVANCE_BOOKING_WINDOW_VIOLATION' | 'ITINERARY_WITHIN_EVENT_TRAVEL_WINDOW' | 'HOTEL_IN_ALLOWED_HOTEL_LIST' | 'PAYMENT_ACCESS_VIOLATION' | 'AIRPORT_IN_ALLOWED_AIRPORT_LIST' | 'ITINERARY_TYPE_IS_NOT_IN_ALLOWED_BOOKING_TYPES' | 'PAYMENT_AIR_ADDON_VIOLATION' | 'MAX_HOTEL_BOOKING_PRICE_INCLUDING_TAX' | 'MAX_HOTEL_BOOKING_PRICE_EXCLUDING_TAX' | 'AIR_NUM_TRAVELERS_ALLOWED' | 'PREFERRED_VENDOR_VIOLATION' | 'SEAT_ADDON_VIOLATION' | 'BAGGAGE_ADDON_VIOLATION' | 'EARLY_BIRD_ADDON_VIOLATION' | 'WIFI_ADDON_VIOLATION' | 'RESTRICTED_BOOKING_VIOLATION' | 'HIGHEST_ALLOWED_CABIN_VIOLATION' | 'LOWEST_FARE_PER_HOTEL_PROPERTY_VIOLATION' | 'AIR_RESTRICTED_FARES_VIOLATION' | 'AIR_ANCILLARY_VIOLATION' — This contains the enum mentioning the policy rule which was violated.
          - `expectedValue` union
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
          - `actualValue` union
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
        - `actions` PolicyAction[] — Followed actions if rule was satisfied else violated actions.
          - union — Action that is required / done for policy.
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
      - `version` integer, required — Version of the policy.
      - `approvalType` 'HARD_APPROVAL' | 'SOFT_APPROVAL' | 'PASSIVE_APPROVAL' | 'PRE_APPROVAL', required — Type of APPROVAL
    - `hasNegotiatedRates` boolean, required — Indicates if the hotel has negotiated rates.
    - `preferences` Preference[] — List of preferences applicable to the hotel.
      - `preferredType` 'NOT_PREFERRED' | 'COMPANY_PREFERRED' | 'SPOTTERS_CHOICE' | 'COMPANY_BLOCKED' | 'TMC_PREFERRED', required — Preference type.
      - `blockedReason` string — Reason for blocking the leg, hotel or car.
      - `label` string — The label assigned to a specific tier of preference.
    - `rateInfo` HotelSearchRateInfo, required — Contains detailed rate information for a hotel search.
      - `averageNightlyRate` HotelRoomRate, required — Rate details for hotel room
        - `base` Money, required — Money object containing details such as the amount, the currency code, and the converted amount.
          - `amount` number, double, required — The numeric value for the amount of money.
          - `currencyCode` string, required — The 3-letter currency code for the money amount (defined using ISO 4217 standard).
          - `convertedAmount` number, double — The converted currency and amount that has been converted (if a currency conversion has been requested). For example, if the call requests that money be sent in a specified currency (because the frontend requested the backend to send money in the user's preferred currency).
          - `convertedCurrency` string — The 3-letter currency code for the converted currency (defined using ISO 4217 standard).
          - `otherCoinage` object[] — List of the dollar amount in other coinage systems like reward points, cryptocurrency etc.
            - `coinageCode` 'PAYMENT_METHOD_UNKNOWN' | 'CREDIT_CARD' | 'BREX_POINTS' | 'CASH' | 'QANTAS_POINTS' | 'VENDOR_PROGRAM_PAYMENT' | 'DELAYED_INVOICING' | 'FLIGHT_CREDITS' | 'QANTAS_TRAVEL_FUND' | 'CUSTOM_VIRTUAL_PAYMENT' | 'FLIGHT_PASS' | 'MISCELLANEOUS_CREDIT_ORDER' | 'NO_PREPAYMENT' — Payment method
            - `amount` number, double
            - `conversionRate` number, double — 1 coin in this system equals to how many currency value
            - `preferredCurrencyConversionRate` number, double — 1 coin in this system equals to how many currency value
            - `otherCoinageMetadata` FlightPassPaymentMetadataWrapper — Wrapper for Flight Pass payment metadata.
              - …
        - `tax` Money, required — Money object containing details such as the amount, the currency code, and the converted amount.
          - `amount` number, double, required — The numeric value for the amount of money.
          - `currencyCode` string, required — The 3-letter currency code for the money amount (defined using ISO 4217 standard).
          - `convertedAmount` number, double — The converted currency and amount that has been converted (if a currency conversion has been requested). For example, if the call requests that money be sent in a specified currency (because the frontend requested the backend to send money in the user's preferred currency).
          - `convertedCurrency` string — The 3-letter currency code for the converted currency (defined using ISO 4217 standard).
          - `otherCoinage` object[] — List of the dollar amount in other coinage systems like reward points, cryptocurrency etc.
            - `coinageCode` 'PAYMENT_METHOD_UNKNOWN' | 'CREDIT_CARD' | 'BREX_POINTS' | 'CASH' | 'QANTAS_POINTS' | 'VENDOR_PROGRAM_PAYMENT' | 'DELAYED_INVOICING' | 'FLIGHT_CREDITS' | 'QANTAS_TRAVEL_FUND' | 'CUSTOM_VIRTUAL_PAYMENT' | 'FLIGHT_PASS' | 'MISCELLANEOUS_CREDIT_ORDER' | 'NO_PREPAYMENT' — Payment method
            - `amount` number, double
            - `conversionRate` number, double — 1 coin in this system equals to how many currency value
            - `preferredCurrencyConversionRate` number, double — 1 coin in this system equals to how many currency value
            - `otherCoinageMetadata` FlightPassPaymentMetadataWrapper — Wrapper for Flight Pass payment metadata.
              - …
        - `roomFees` RoomFee[]
          - `amount` Money, required — Money object containing details such as the amount, the currency code, and the converted amount.
            - `amount` number, double, required — The numeric value for the amount of money.
            - `currencyCode` string, required — The 3-letter currency code for the money amount (defined using ISO 4217 standard).
            - `convertedAmount` number, double — The converted currency and amount that has been converted (if a currency conversion has been requested). For example, if the call requests that money be sent in a specified currency (because the frontend requested the backend to send money in the user's preferred currency).
            - `convertedCurrency` string — The 3-letter currency code for the converted currency (defined using ISO 4217 standard).
            - `otherCoinage` object[] — List of the dollar amount in other coinage systems like reward points, cryptocurrency etc.
              - …
          - `feeInclusions` string[] — Amenities included as part of the fee
          - `displayFee` boolean — Flag to determine whether to explicitly show this fee type on UI
          - `feeType` 'UNKNOWN' | 'BED_TAX' | 'CITY_HOTEL_FEE' | 'CITY_TAX' | 'COUNTRY_TAX' | 'ENERGY_TAX' | 'FEDERAL_TAX' | 'FOOD_AND_BEVERAGE_TAX' | 'LODGING_TAX' | 'MAINTENANCE_FEE' | 'OCCUPANCY_TAX' | 'PACKAGE_FEE' | 'RESORT_FEE' | 'SALES_TAX' | 'SERVICE_CHARGE' | 'STATE_TAX' | 'SURCHARGE' | 'TOTAL_TAX' | 'TOURISM_TAX' | 'VAT_GST_TAX' | 'SURPLUS_LINES_TAX' | 'INSURANCE_PREMIUM_TAX' | 'APPLICATON_FEE' | 'EXPRESS_HANDLING_FEE' | 'EXEMPT' | 'STANDARD' | 'ZERO_RATED' | 'MISCELLANEOUS' | 'ROOM_TAX' | 'EARLY_CHECKOUT_FEE' | 'COUNTRY_TAXES' | 'EXTRA_PERSON_CHARGE' | 'BANQUET_SERVICE_FEE' | 'ROOM_SERVICE_FEE' | 'LOCAL_FEE' | 'GOODS_AND_SERVICES_TAX' | 'VALUE_ADDED_TAX' | 'CRIB_FEE' | 'ROLLAWAY_FEE' | 'ASSESSMENT_LICENSE_TAX' | 'PET_SANITATION_FEE' | 'NOT_KNOWN' | 'CHILD_ROLLAWAY_CHARGE' | 'CONVENTION_TAX' | 'EXTRA_CHILD_CHARGE' | 'STANDARD_FOOD_AND_BEVERAGE_GRATUITY' | 'NATIONAL_GOVERNMENT_TAX' | 'ADULT_ROLLAWAY_FEE' | 'BEVERAGE_WITH_ALCOHOL' | 'BEVERAGE_WITHOUT_ALCOHOL' | 'TOBACCO' | 'FOOD' | 'TOTAL_SURCHARGES' | 'STATE_COST_RECOVERY_FEE' | 'MISCELLANEOUS_FEE' | 'DESTINATION_AMENITY_FEE' | 'REFUNDABLE_PET_FEE' | 'CHARITY_SUPPORT_FEE' | 'LOCAL_AMENITY_USAGE_MAINTENANCE_FEE' | 'CONVENTION_TOURISM_FEE' | 'DESTINATION_MARKETING_FEE' | 'HOTEL_DEVELOPMENT_FEE' | 'EVENT_FEE' | 'SUSTAINABILITY_FEE' | 'TRANSPORTATION_TRANSFER_FEE' | 'INSURANCE_FEE' | 'LOCAL_GOVERNMENT_FEE' | 'LOCAL_ORDINANCE_SURCHARGE' | 'GUARANTEED_EARLY_CHECK_IN_FEE' | 'GUARANTEED_LATE_CHECK_OUT_FEE' | 'MODIFICATION_FEE' | 'HOTEL_ANCILLARY_EARLY_CHECK_IN_FEE' | 'HOTEL_ANCILLARY_LATE_CHECK_OUT_FEE' | 'HOTEL_ANCILLARY_PET_FEE' | 'HOTEL_ANCILLARY_WIFI_FEE' | 'HOTEL_ANCILLARY_BREAKFAST_FEE' | 'HOTEL_ANCILLARY_PARKING_FEE' | 'HOTEL_ANCILLARY_MEAL_PLAN_FEE' | 'ACCESSIBILITY_EQUIPMENT_FEE' | 'TOURISM_MARKETING_FEE' — Fees Type
        - `commission` Commission — Commision on rate
          - `amount` Money, required — Money object containing details such as the amount, the currency code, and the converted amount.
            - `amount` number, double, required — The numeric value for the amount of money.
            - `currencyCode` string, required — The 3-letter currency code for the money amount (defined using ISO 4217 standard).
            - `convertedAmount` number, double — The converted currency and amount that has been converted (if a currency conversion has been requested). For example, if the call requests that money be sent in a specified currency (because the frontend requested the backend to send money in the user's preferred currency).
            - `convertedCurrency` string — The 3-letter currency code for the converted currency (defined using ISO 4217 standard).
            - `otherCoinage` object[] — List of the dollar amount in other coinage systems like reward points, cryptocurrency etc.
              - …
          - `commissionPercent` number, double — Commission percentage
        - `taxBreakdown` Tax[]
          - `amount` Money, required — Money object containing details such as the amount, the currency code, and the converted amount.
            - `amount` number, double, required — The numeric value for the amount of money.
            - `currencyCode` string, required — The 3-letter currency code for the money amount (defined using ISO 4217 standard).
            - `convertedAmount` number, double — The converted currency and amount that has been converted (if a currency conversion has been requested). For example, if the call requests that money be sent in a specified currency (because the frontend requested the backend to send money in the user's preferred currency).
            - `convertedCurrency` string — The 3-letter currency code for the converted currency (defined using ISO 4217 standard).
            - `otherCoinage` object[] — List of the dollar amount in other coinage systems like reward points, cryptocurrency etc.
              - …
          - `taxCode` string — Tax code
          - `percentage` number, double — Tax amount to total amount
          - `description` string — Tax name or Tax Description
        - `includesCommission` boolean — Whether the rate includes commission
      - `totalRate` HotelRoomRate, required — Rate details for hotel room
        - `base` Money, required — Money object containing details such as the amount, the currency code, and the converted amount.
          - `amount` number, double, required — The numeric value for the amount of money.
          - `currencyCode` string, required — The 3-letter currency code for the money amount (defined using ISO 4217 standard).
          - `convertedAmount` number, double — The converted currency and amount that has been converted (if a currency conversion has been requested). For example, if the call requests that money be sent in a specified currency (because the frontend requested the backend to send money in the user's preferred currency).
          - `convertedCurrency` string — The 3-letter currency code for the converted currency (defined using ISO 4217 standard).
          - `otherCoinage` object[] — List of the dollar amount in other coinage systems like reward points, cryptocurrency etc.
            - `coinageCode` 'PAYMENT_METHOD_UNKNOWN' | 'CREDIT_CARD' | 'BREX_POINTS' | 'CASH' | 'QANTAS_POINTS' | 'VENDOR_PROGRAM_PAYMENT' | 'DELAYED_INVOICING' | 'FLIGHT_CREDITS' | 'QANTAS_TRAVEL_FUND' | 'CUSTOM_VIRTUAL_PAYMENT' | 'FLIGHT_PASS' | 'MISCELLANEOUS_CREDIT_ORDER' | 'NO_PREPAYMENT' — Payment method
            - `amount` number, double
            - `conversionRate` number, double — 1 coin in this system equals to how many currency value
            - `preferredCurrencyConversionRate` number, double — 1 coin in this system equals to how many currency value
            - `otherCoinageMetadata` FlightPassPaymentMetadataWrapper — Wrapper for Flight Pass payment metadata.
              - …
        - `tax` Money, required — Money object containing details such as the amount, the currency code, and the converted amount.
          - `amount` number, double, required — The numeric value for the amount of money.
          - `currencyCode` string, required — The 3-letter currency code for the money amount (defined using ISO 4217 standard).
          - `convertedAmount` number, double — The converted currency and amount that has been converted (if a currency conversion has been requested). For example, if the call requests that money be sent in a specified currency (because the frontend requested the backend to send money in the user's preferred currency).
          - `convertedCurrency` string — The 3-letter currency code for the converted currency (defined using ISO 4217 standard).
          - `otherCoinage` object[] — List of the dollar amount in other coinage systems like reward points, cryptocurrency etc.
            - `coinageCode` 'PAYMENT_METHOD_UNKNOWN' | 'CREDIT_CARD' | 'BREX_POINTS' | 'CASH' | 'QANTAS_POINTS' | 'VENDOR_PROGRAM_PAYMENT' | 'DELAYED_INVOICING' | 'FLIGHT_CREDITS' | 'QANTAS_TRAVEL_FUND' | 'CUSTOM_VIRTUAL_PAYMENT' | 'FLIGHT_PASS' | 'MISCELLANEOUS_CREDIT_ORDER' | 'NO_PREPAYMENT' — Payment method
            - `amount` number, double
            - `conversionRate` number, double — 1 coin in this system equals to how many currency value
            - `preferredCurrencyConversionRate` number, double — 1 coin in this system equals to how many currency value
            - `otherCoinageMetadata` FlightPassPaymentMetadataWrapper — Wrapper for Flight Pass payment metadata.
              - …
        - `roomFees` RoomFee[]
          - `amount` Money, required — Money object containing details such as the amount, the currency code, and the converted amount.
            - `amount` number, double, required — The numeric value for the amount of money.
            - `currencyCode` string, required — The 3-letter currency code for the money amount (defined using ISO 4217 standard).
            - `convertedAmount` number, double — The converted currency and amount that has been converted (if a currency conversion has been requested). For example, if the call requests that money be sent in a specified currency (because the frontend requested the backend to send money in the user's preferred currency).
            - `convertedCurrency` string — The 3-letter currency code for the converted currency (defined using ISO 4217 standard).
            - `otherCoinage` object[] — List of the dollar amount in other coinage systems like reward points, cryptocurrency etc.
              - …
          - `feeInclusions` string[] — Amenities included as part of the fee
          - `displayFee` boolean — Flag to determine whether to explicitly show this fee type on UI
          - `feeType` 'UNKNOWN' | 'BED_TAX' | 'CITY_HOTEL_FEE' | 'CITY_TAX' | 'COUNTRY_TAX' | 'ENERGY_TAX' | 'FEDERAL_TAX' | 'FOOD_AND_BEVERAGE_TAX' | 'LODGING_TAX' | 'MAINTENANCE_FEE' | 'OCCUPANCY_TAX' | 'PACKAGE_FEE' | 'RESORT_FEE' | 'SALES_TAX' | 'SERVICE_CHARGE' | 'STATE_TAX' | 'SURCHARGE' | 'TOTAL_TAX' | 'TOURISM_TAX' | 'VAT_GST_TAX' | 'SURPLUS_LINES_TAX' | 'INSURANCE_PREMIUM_TAX' | 'APPLICATON_FEE' | 'EXPRESS_HANDLING_FEE' | 'EXEMPT' | 'STANDARD' | 'ZERO_RATED' | 'MISCELLANEOUS' | 'ROOM_TAX' | 'EARLY_CHECKOUT_FEE' | 'COUNTRY_TAXES' | 'EXTRA_PERSON_CHARGE' | 'BANQUET_SERVICE_FEE' | 'ROOM_SERVICE_FEE' | 'LOCAL_FEE' | 'GOODS_AND_SERVICES_TAX' | 'VALUE_ADDED_TAX' | 'CRIB_FEE' | 'ROLLAWAY_FEE' | 'ASSESSMENT_LICENSE_TAX' | 'PET_SANITATION_FEE' | 'NOT_KNOWN' | 'CHILD_ROLLAWAY_CHARGE' | 'CONVENTION_TAX' | 'EXTRA_CHILD_CHARGE' | 'STANDARD_FOOD_AND_BEVERAGE_GRATUITY' | 'NATIONAL_GOVERNMENT_TAX' | 'ADULT_ROLLAWAY_FEE' | 'BEVERAGE_WITH_ALCOHOL' | 'BEVERAGE_WITHOUT_ALCOHOL' | 'TOBACCO' | 'FOOD' | 'TOTAL_SURCHARGES' | 'STATE_COST_RECOVERY_FEE' | 'MISCELLANEOUS_FEE' | 'DESTINATION_AMENITY_FEE' | 'REFUNDABLE_PET_FEE' | 'CHARITY_SUPPORT_FEE' | 'LOCAL_AMENITY_USAGE_MAINTENANCE_FEE' | 'CONVENTION_TOURISM_FEE' | 'DESTINATION_MARKETING_FEE' | 'HOTEL_DEVELOPMENT_FEE' | 'EVENT_FEE' | 'SUSTAINABILITY_FEE' | 'TRANSPORTATION_TRANSFER_FEE' | 'INSURANCE_FEE' | 'LOCAL_GOVERNMENT_FEE' | 'LOCAL_ORDINANCE_SURCHARGE' | 'GUARANTEED_EARLY_CHECK_IN_FEE' | 'GUARANTEED_LATE_CHECK_OUT_FEE' | 'MODIFICATION_FEE' | 'HOTEL_ANCILLARY_EARLY_CHECK_IN_FEE' | 'HOTEL_ANCILLARY_LATE_CHECK_OUT_FEE' | 'HOTEL_ANCILLARY_PET_FEE' | 'HOTEL_ANCILLARY_WIFI_FEE' | 'HOTEL_ANCILLARY_BREAKFAST_FEE' | 'HOTEL_ANCILLARY_PARKING_FEE' | 'HOTEL_ANCILLARY_MEAL_PLAN_FEE' | 'ACCESSIBILITY_EQUIPMENT_FEE' | 'TOURISM_MARKETING_FEE' — Fees Type
        - `commission` Commission — Commision on rate
          - `amount` Money, required — Money object containing details such as the amount, the currency code, and the converted amount.
            - `amount` number, double, required — The numeric value for the amount of money.
            - `currencyCode` string, required — The 3-letter currency code for the money amount (defined using ISO 4217 standard).
            - `convertedAmount` number, double — The converted currency and amount that has been converted (if a currency conversion has been requested). For example, if the call requests that money be sent in a specified currency (because the frontend requested the backend to send money in the user's preferred currency).
            - `convertedCurrency` string — The 3-letter currency code for the converted currency (defined using ISO 4217 standard).
            - `otherCoinage` object[] — List of the dollar amount in other coinage systems like reward points, cryptocurrency etc.
              - …
          - `commissionPercent` number, double — Commission percentage
        - `taxBreakdown` Tax[]
          - `amount` Money, required — Money object containing details such as the amount, the currency code, and the converted amount.
            - `amount` number, double, required — The numeric value for the amount of money.
            - `currencyCode` string, required — The 3-letter currency code for the money amount (defined using ISO 4217 standard).
            - `convertedAmount` number, double — The converted currency and amount that has been converted (if a currency conversion has been requested). For example, if the call requests that money be sent in a specified currency (because the frontend requested the backend to send money in the user's preferred currency).
            - `convertedCurrency` string — The 3-letter currency code for the converted currency (defined using ISO 4217 standard).
            - `otherCoinage` object[] — List of the dollar amount in other coinage systems like reward points, cryptocurrency etc.
              - …
          - `taxCode` string — Tax code
          - `percentage` number, double — Tax amount to total amount
          - `description` string — Tax name or Tax Description
        - `includesCommission` boolean — Whether the rate includes commission
      - `isRefundable` boolean, required — Set to true if the hotel rate is refundable.
      - `rewardPointsEarned` RewardPointsEarned[] — Information about reward points earned.
        - `rewardPointsType` 'QBR' | 'QFF', required — Type of reward points.
        - `totalPointsEarned` number, double, required — Total points that will be credited.
        - `conversionMultiplier` number, double, required — Multiplier for converting points.
      - `promotionalOffers` PromotionalOffer[] — List of promotional offers applied to the hotel rate.
        - `name` string, required — Name of the promotional offer applied on this hotel rate.
    - `hotelCo2EmissionDetail` HotelCo2EmissionDetail — The co2 emission detail for the hotel.
      - `co2EmissionValue` number, double, required — CO2 emission value in kg per room for the entire stay.
  - `metadata` HotelSearchMetadata, required — Includes metadata for a hotel search.
    - `availableHotelChains` HotelChain[], required — A list of available hotel chains.
      - `chainCode` string — The code of hotel chain.
      - `chainName` string — The name of hotel chain.
    - `rateStatistics` HotelRateStatistics — Contains statistical information about hotel search results.
      - `median` HotelMedianRateInfo, required — Details median rate information for a hotel.
        - `total` Money, required — Money object containing details such as the amount, the currency code, and the converted amount.
          - `amount` number, double, required — The numeric value for the amount of money.
          - `currencyCode` string, required — The 3-letter currency code for the money amount (defined using ISO 4217 standard).
          - `convertedAmount` number, double — The converted currency and amount that has been converted (if a currency conversion has been requested). For example, if the call requests that money be sent in a specified currency (because the frontend requested the backend to send money in the user's preferred currency).
          - `convertedCurrency` string — The 3-letter currency code for the converted currency (defined using ISO 4217 standard).
          - `otherCoinage` object[] — List of the dollar amount in other coinage systems like reward points, cryptocurrency etc.
            - `coinageCode` 'PAYMENT_METHOD_UNKNOWN' | 'CREDIT_CARD' | 'BREX_POINTS' | 'CASH' | 'QANTAS_POINTS' | 'VENDOR_PROGRAM_PAYMENT' | 'DELAYED_INVOICING' | 'FLIGHT_CREDITS' | 'QANTAS_TRAVEL_FUND' | 'CUSTOM_VIRTUAL_PAYMENT' | 'FLIGHT_PASS' | 'MISCELLANEOUS_CREDIT_ORDER' | 'NO_PREPAYMENT' — Payment method
            - `amount` number, double
            - `conversionRate` number, double — 1 coin in this system equals to how many currency value
            - `preferredCurrencyConversionRate` number, double — 1 coin in this system equals to how many currency value
            - `otherCoinageMetadata` FlightPassPaymentMetadataWrapper — Wrapper for Flight Pass payment metadata.
              - …
        - `base` Money, required — Money object containing details such as the amount, the currency code, and the converted amount.
          - `amount` number, double, required — The numeric value for the amount of money.
          - `currencyCode` string, required — The 3-letter currency code for the money amount (defined using ISO 4217 standard).
          - `convertedAmount` number, double — The converted currency and amount that has been converted (if a currency conversion has been requested). For example, if the call requests that money be sent in a specified currency (because the frontend requested the backend to send money in the user's preferred currency).
          - `convertedCurrency` string — The 3-letter currency code for the converted currency (defined using ISO 4217 standard).
          - `otherCoinage` object[] — List of the dollar amount in other coinage systems like reward points, cryptocurrency etc.
            - `coinageCode` 'PAYMENT_METHOD_UNKNOWN' | 'CREDIT_CARD' | 'BREX_POINTS' | 'CASH' | 'QANTAS_POINTS' | 'VENDOR_PROGRAM_PAYMENT' | 'DELAYED_INVOICING' | 'FLIGHT_CREDITS' | 'QANTAS_TRAVEL_FUND' | 'CUSTOM_VIRTUAL_PAYMENT' | 'FLIGHT_PASS' | 'MISCELLANEOUS_CREDIT_ORDER' | 'NO_PREPAYMENT' — Payment method
            - `amount` number, double
            - `conversionRate` number, double — 1 coin in this system equals to how many currency value
            - `preferredCurrencyConversionRate` number, double — 1 coin in this system equals to how many currency value
            - `otherCoinageMetadata` FlightPassPaymentMetadataWrapper — Wrapper for Flight Pass payment metadata.
              - …
      - `mean` HotelMedianRateInfo — Details median rate information for a hotel.
        - `total` Money, required — Money object containing details such as the amount, the currency code, and the converted amount.
          - `amount` number, double, required — The numeric value for the amount of money.
          - `currencyCode` string, required — The 3-letter currency code for the money amount (defined using ISO 4217 standard).
          - `convertedAmount` number, double — The converted currency and amount that has been converted (if a currency conversion has been requested). For example, if the call requests that money be sent in a specified currency (because the frontend requested the backend to send money in the user's preferred currency).
          - `convertedCurrency` string — The 3-letter currency code for the converted currency (defined using ISO 4217 standard).
          - `otherCoinage` object[] — List of the dollar amount in other coinage systems like reward points, cryptocurrency etc.
            - `coinageCode` 'PAYMENT_METHOD_UNKNOWN' | 'CREDIT_CARD' | 'BREX_POINTS' | 'CASH' | 'QANTAS_POINTS' | 'VENDOR_PROGRAM_PAYMENT' | 'DELAYED_INVOICING' | 'FLIGHT_CREDITS' | 'QANTAS_TRAVEL_FUND' | 'CUSTOM_VIRTUAL_PAYMENT' | 'FLIGHT_PASS' | 'MISCELLANEOUS_CREDIT_ORDER' | 'NO_PREPAYMENT' — Payment method
            - `amount` number, double
            - `conversionRate` number, double — 1 coin in this system equals to how many currency value
            - `preferredCurrencyConversionRate` number, double — 1 coin in this system equals to how many currency value
            - `otherCoinageMetadata` FlightPassPaymentMetadataWrapper — Wrapper for Flight Pass payment metadata.
              - …
        - `base` Money, required — Money object containing details such as the amount, the currency code, and the converted amount.
          - `amount` number, double, required — The numeric value for the amount of money.
          - `currencyCode` string, required — The 3-letter currency code for the money amount (defined using ISO 4217 standard).
          - `convertedAmount` number, double — The converted currency and amount that has been converted (if a currency conversion has been requested). For example, if the call requests that money be sent in a specified currency (because the frontend requested the backend to send money in the user's preferred currency).
          - `convertedCurrency` string — The 3-letter currency code for the converted currency (defined using ISO 4217 standard).
          - `otherCoinage` object[] — List of the dollar amount in other coinage systems like reward points, cryptocurrency etc.
            - `coinageCode` 'PAYMENT_METHOD_UNKNOWN' | 'CREDIT_CARD' | 'BREX_POINTS' | 'CASH' | 'QANTAS_POINTS' | 'VENDOR_PROGRAM_PAYMENT' | 'DELAYED_INVOICING' | 'FLIGHT_CREDITS' | 'QANTAS_TRAVEL_FUND' | 'CUSTOM_VIRTUAL_PAYMENT' | 'FLIGHT_PASS' | 'MISCELLANEOUS_CREDIT_ORDER' | 'NO_PREPAYMENT' — Payment method
            - `amount` number, double
            - `conversionRate` number, double — 1 coin in this system equals to how many currency value
            - `preferredCurrencyConversionRate` number, double — 1 coin in this system equals to how many currency value
            - `otherCoinageMetadata` FlightPassPaymentMetadataWrapper — Wrapper for Flight Pass payment metadata.
              - …
      - `sampleSize` integer, required — Size of the sample set used to calculate the statistics.
      - `policyType` 'DEFAULT' | 'SET_BY_ADMIN', required — Enumeration of policy types for rate statistics.
      - `statisticalMethod` 'MEDIAN' | 'MEAN' — Statistical method used for the recommended hotel rate.
      - `preferredHotelsOnly` boolean — Whether mean and median were calculated using only preferred hotels.
    - `showOnlyBaseFare` boolean, required — Indicates if only base fare should be shown.
    - `sessionId` string — Unique session identifier for the search.
  - `paginationParams` TokenBasedPaginationResponse, required — Pagination response for token based pagination. Contains the next page token(if next page is available) and pagination parameters.
    - `nextPageToken` string — The next page token to retrieve the next page of results. If it is empty, it indicates that there are no more pages to retrieve.
    - `currentPageSize` integer, required — The number of results in the current page.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — The specified resource was not found.

---

[API](https://skmtc.net/spotnana/apis/hotel-api.md) · [All operations](https://skmtc.net/spotnana/apis/hotel-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/spotnana/hotel-api/revisions/34c735aa7110/schema)
