Returns all available rate plans for the selected hotels. This parameter requires that a checkIn date and checkOut date be supplied, as the API cannot return additional room rates on a dateless search. Including allRoomTypes=true in your query will automatically limit your response size to no more than 200 hotels. Including allRoomTypes=true and contentDetails=high will limit your response size to no more than 5 hotels.

availOnly

@Valid()

private final Boolean availOnly

Specifies whether to return only available hotels in the search results. If the value of this parameter is true, the search results will only return hotels that have availability during the requested dates. If there are no hotels with availability in your search then an empty record set will be returned. This parameter is ignored for dateless searches.

blockFullDepositRateplan

@Valid()

private final Boolean blockFullDepositRateplan

Specifies whether to return rateplan with FullDepositUponBooking as true. If blockFullDepositRateplans is true, the search results will not return rateplan with FullDepositUponBooking as true. The default value is false, if query without this parameter or the value of this parameter is false, all available rateplan will be returned. This parameter is ignored for dateless search.

checkIn

@Valid()

private final LocalDate checkIn

Check-in date for hotel stay in an ISO 8601 Date format YYYY-MM-DD. This parameter should be used in combination with the checkOut parameter. If checkIn and checkOut are not included, a dateless search will be conducted which returns a Featured Offer for each of the hotels found. If one of checkIn and checkOut is not included, an error will be returned. The maximum advanced search window is 500 days in the future, and the maximum length of stay is 28.

checkOut

@Valid()

private final LocalDate checkOut

Checkout date for hotel stay in an ISO 8601 Date format YYYY-MM-DD. This parameter should be used in combination with the checkIn parameter. If checkIn and checkOut are not included, a dateless search will be conducted which returns a Featured Offer for each of the hotels found. If one of checkIn and checkOut is not included, an error will be returned. The maximum advanced search window is 500 days in the future, and the maximum length of stay is 28.

contentDetails

private final GetLodgingListingsOperationParams.ContentDetails contentDetails

This parameter is optional and can be specified as the following values. - lowest - low (default) - medium - high ### lowest Returns the absolute minimum response for up to 1,000 hotels: - Count(Count of hotels that are actually returned) - TotalHotelCount(Count of hotels that are requested) - TransactionId - StayDates - LengthOfStay - NumberOfRooms - Occupants - Hotels - Id - Status - Links - RoomTypes - RoomKey Deprecated - OfferId - RatePlanType - RatePlans - RoomTypeId - RatePlanId - RateRuleId - InventorySourceId - RemainingCount - Price - MemberOnlyDeal - Promotions - PaymentMethod - FullDepositUponBooking - PaymentSchedule - CancellationPolicy - Price - BaseRate - TaxesAndFees - TotalPrice - TotalStrikeOutPrice - AvgNightlyRate - AvgNightlyStrikeOutRate - AvgNightlyRateWithFees - AvgNightlyStrikeOutRateWithFees - HotelMandatoryFees - TotalPriceWithHotelFees - NightlyRates - TaxesAndFeesDetails - RefundableDamageDeposit This minimal response is the best for partners that store static hotel location data locally, and who would like to have the smallest and fastest API response. ### low Returns basic hotel information in response for up to 1,000 hotels. Includes all elements returned when contentDetails=lowest plus: - Hotels - Name - PropertyType - PropertyDetails - LocalCurrencyCode - Location - Distance - Description(may not be localized) - ChainAndBrandInfo - ThumbnailUrl - StarRating - GuestRating - GuestReviewCount - PetFriendly - LgbtqiaFriendly - ImportantNotices - RoomTypes - Description - RatePlans - InventorySourceCode - PaymentTime - ReserveWithDeposit - FreeInternet - FreeWiFi - FreeParking - FreeBreakfast ### medium Returns more complete hotel information in response for up to 200 hotels. Includes all elements returned when contentDetails=low plus: - Hotels - HotelAmenities - RoomAmenities - RoomTypes - RatePlans - FreeInternetDetails - FreeBreakfastDetails - Amenities - Amenities Note: Setting the contentDetails to medium will automatically limit your response size to 200 hotels. ### high Returns extended hotel information in response for up to 5 hotels. Includes all elements returned when contentDetails=medium plus: - Hotels - RenovationsAndClosures - Policies - OptionalExtras - Media - Accessibility - RoomTypes - SmokingOption - BedTypeOptions - RoomOccupancyPolicy - Media Note: Setting the contentDetails to high will automatically limit your response size to 5 hotels.

currency

@Valid()

private final String currency

Value should be a standard ISO 3 letter currency code.

ecomHotelIds

@Valid()

private final Set<String> ecomHotelIds

Comma-separated list of Expedia hotel IDs. There can be no spaces between parameters.

excludedPropertyTypeIds

@Valid()

private final Set<String> excludedPropertyTypeIds

Return all hotels except those whose PropertyType ID is in the excludedPropertyTypeIds field. If the API query includes the parameter contentDetail=lowest the PropertyType parameter will not be returned in the response. Even in this case, the filtering is still being applied, even though there is no PropertyType parameter in the response with which to validate. includedPropertyTypeIds and excludedPropertyTypeIds fields are mutually exclusive - which means that each query may contain one of the parameters, or neither of the parameters, but the query may not contain both of the parameters. A complete list of supported Expedia Property Types can be found in Lodging Property Types.

freeCancellation

@Valid()

private final Boolean freeCancellation

Specifies whether to return only free cancelable room rates in the search results. If the value of this parameter is true, the search results will only return hotels that have free cancelable room rates during the requested dates. If there are no hotels with free cancelable room rates in your search then an empty record set will be returned. Default value is false, if query without this parameter or the value of this parameter is false, all available room rates will be returned. This parameter is ignored for dateless searches.

geoLocation

@Valid()

private final String geoLocation

The latitude and longitude values identifying the center point of a search radius (circle). North latitude will be represented by a positive value. South latitude by a negative value. East longitude will be represented by a positive value. West longitude by a negative value. The latitude and longitude values are joined together with a comma (,) character. There can be no spaces between parameters. This parameter should be used in combination with the radius and unit parameters below.

groupedAmenities

@Valid()

private final Boolean groupedAmenities

Specifies whether to return the grouped amenities. If groupedAmenities is true, DescriptiveAmenities node will be returned in response, otherwise Amenities node will be returned.

hcomHotelIds

@Valid()

private final Set<String> hcomHotelIds

Comma-separated list of Hotels.com hotel IDs. There can be no spaces between parameters.

imageSizes

private final GetLodgingListingsOperationParams.ImageSizes imageSizes

Indicates what size images will be displayed for hotelPhotos and roomPhotos are returned when contentDetails=high. The available image sizes are: - t : Thumbnail - s : Small - b : Big - y : 500x500v - z : 1000x1000v Resolution from smallest to largest is t < s < b < y < z. If no imageSizes is specified, the t size images will be returned. If an image is missing in one size, we will try to fall back to the same image with lower resolution. (If image \"_z\" is not available, we will try to return image \"_y\", and if it is also unavailable, we will return image \"_b\", and so on.) Only one image size is allowed.

includedInventorySourceIds

@Valid()

private final Set<String> includedInventorySourceIds

Querying with no includedInventorySourceIds parameter will return listings from all available inventory sources. Query with the includedInventorySourceIds parameter included will only return listings from the requested inventory sources. All others will be left out. includedInventorySourceId=24 will return only Expedia lodging inventory. includedInventorySourceId=83 will return only Vrbo lodging inventory. includedInventorySourceId=24,83 will return both Expedia and Vrbo lodging inventory.

includedPropertyTypeIds

@Valid()

private final Set<String> includedPropertyTypeIds

Only return hotels where the PropertyType ID is one of the IDs in the includedPropertyTypeIds field. If the API query includes the parameter contentDetail=lowest the PropertyType parameter will not be returned in the response. Even in this case, the filtering is still being applied, even though there is no PropertyType parameter in the response with which to validate. includedPropertyTypeIds and excludedPropertyTypeIds fields are mutually exclusive - which means that each query may contain one of the parameters, or neither of the parameters, but the query may not contain both of the parameters. A complete list of supported Expedia Property Types can be found in Lodging Property Types.

limit

@Valid()

private final Long limit

The maximum number of hotels returned in the response. Must be an integer greater than 0. If the value is greater than 1000, only the first 1000 hotels are returned. Settings on contentDetails and allRoomTypes parameters may cause this value to be overridden and a lower number of hotels to be returned. The limit parameter is intended to be used to control the response size, but partners should be careful about combining it with other filter parameters, as each parameter that you add will shrink the response, even to the point where you may even get a \"no hotel found\" error if none of the hotels in the base response meet the combined filter requirements. Filters are cumulative in effect, and results must meet all filter requirements to be displayed.

links

private final List<GetLodgingListingsOperationParams.Links> links

Comma-separated list to specify the types of deep links. - WD (link to Web Details site) - WS (link to Web Search Result page) - AD (link for Details API) - RC (link for RateCalendar API) - WEB (include all website links) - API (links for Details and RateCalendar API) There are two level of links returned in the API response: Property-level deeplinks and room-level deeplinks. When requesting API deeplinks you will receive both a RateCalendar API link at the property level, and Details API links at the room level, since the Lodging Details API only displays information on rate plan offers. When requesting AD deeplinks, you will only receive Details API links at the room level. Links node in property-level will be omitted. If you are looking for more complete details on a single property via the API, you should do another search in the Lodging API for the single Hotel ID, with contentDetails=high to get all details back in return (note that you can only get back a maximum of 5 hotels when contentDetails is set to high). NOTE: dateless searches will not return Details API links, since the Lodging Details API will only return details on a specific room offer for specific dates.

locale

@Valid()

private final String locale

locale is composed of language identifier and region identifier, connected by \"_\" that specifies the language in which the response will be returned. You can find a link to the complete list of locales along with the Point of Sale List in Supported Points of Sale. Note that even though the Listings API supports localization for all locales listed in the list, all locales are not valid for all Points of Sale. For example, Ecom US POS supports en_US, es_MX and zh_CN. For Ecom US POS, the Listings API will respond with content in Spanish for requests with either locale=es_MX or es_US. However, only the deeplinks for locale=es_MX should work properly and switch the website to Spanish, while the ones for locale=es_US will be fallen back to English. If not specified in the query, the native language for that POS will be returned. And if more than one language is supported, the response will be returned in the first language depending on the language setting of the POS.

locationKeyword

@Valid()

private final String locationKeyword

A keyword search for a location. The keyword can be a city, address, airport or a landmark. This parameter should be used in combination with the radius and unit parameters above to define a circle around the landmark. The default radius value is 25 if not specified. Combined search is not supported, if more than one search method is included in the request, an error will be returned.

maxStarRating

private final GetLodgingListingsOperationParams.MaxStarRating maxStarRating

The maximum star rating for hotels returned in the response.

minStarRating

private final GetLodgingListingsOperationParams.MinStarRating minStarRating

The minimum star rating for hotels returned in the response.

partnerTransactionId

@NotNull()

@Valid()

private final String partnerTransactionId

The Partner-Transaction-ID is a required API request header element that is not consumed by Expedia. It will be required in all XAP v3 API request headers and will be mirrored back to the partner in the corresponding API response header. The Partner-Transaction-ID may be any alphanumeric string of the partner's choosing.

queryText

@Valid()

private final String queryText

Query text is used for a full text search of hotel data. Text search based on hotel name, description, address, promotion description, amenities description.

radius

@Valid()

private final Long radius

The size of the search radius around a specified point when searching by geoLocation, locationKeyword, or regionids. radius is optional and the default value is 25 km for geoLocation and locationKeyword if not specified. radius must be less than 200 km or 124 mi. This parameter should be used in combination with the unit and geoLocation, locationKeyword, or regionids parameters.\"

ratePlanType

private final GetLodgingListingsOperationParams.RatePlanType ratePlanType

Note: This parameter is visible to partners only by configuration. Please contact your Expedia Account Manager if you need this parameter. To specify the desired rate plan types. The options are: - standalone : Ask for standalone rates - package : Ask for package rates, but standalone rate also may be returned if available. Otherwise only standalone rate plans will be returned. WebSearchResult and WebDetails links won't be returned for package rate.

rateType

private final GetLodgingListingsOperationParams.RateType rateType

Indicate which type of paymentMethod for each room will be returned.

regionIds

@Valid()

private final Set<String> regionIds

Comma-separated list of Expedia Region IDs. There can be no spaces between parameters. Search returns set of all hotels in the combined regions. You may search using a string of 1 - 10 Region ID's. More than 10 Region ID's are not supported and will generate and error. You can get the complete list of Expedia Region IDs from Static Data Platform ALL_REGIONS file. This parameter could be used in combination with the radius and unit parameters above to define a circle around the regionIds. The default radius value is 0 if not specified.

room1Adults

@Valid()

private final Long room1Adults

Specifies the number of adults staying in a specific room. Default value is one room with 2 adults. Example: room1.adults is used to specify the number of adults in the first room.

room1ChildAges

@Valid()

private final List<String> room1ChildAges

Comma-separated list that specifies the age(s) for each of the children in each of the rooms. Example: room2.childAges=1,3 means two children (1-year old and 3-year old) are staying in room #2. Children must be accompanied by an adult.

room2Adults

@Valid()

private final Long room2Adults

Specifies the number of adults staying in second room.

room2ChildAges

@Valid()

private final List<String> room2ChildAges

Comma-separated list that specifies the age(s) for each of the children in second room.

room3Adults

@Valid()

private final Long room3Adults

Specifies the number of adults staying in third room.

room3ChildAges

@Valid()

private final List<String> room3ChildAges

Comma-separated list that specifies the age(s) for each of the children in third room.

room4Adults

@Valid()

private final Long room4Adults

Specifies the number of adults staying in fourth room.

room4ChildAges

@Valid()

private final List<String> room4ChildAges

Comma-separated list that specifies the age(s) for each of the children in fourth room.

room5Adults

@Valid()

private final Long room5Adults

Specifies the number of adults staying in fifth room.

room5ChildAges

@Valid()

private final List<String> room5ChildAges

Comma-separated list that specifies the age(s) for each of the children in fifth room.

room6Adults

@Valid()

private final Long room6Adults

Specifies the number of adults staying in sixth room.

room6ChildAges

@Valid()

private final List<String> room6ChildAges

Comma-separated list that specifies the age(s) for each of the children in sixth room.

room7Adults

@Valid()

private final Long room7Adults

Specifies the number of adults staying in seventh room.

room7ChildAges

@Valid()

private final List<String> room7ChildAges

Comma-separated list that specifies the age(s) for each of the children in seventh room.

room8Adults

@Valid()

private final Long room8Adults

Specifies the number of adults staying in eighth room.

room8ChildAges

@Valid()

private final List<String> room8ChildAges

Comma-separated list that specifies the age(s) for each of the children in eighth room.

smokingPreference

private final GetLodgingListingsOperationParams.SmokingPreference smokingPreference

Specifies smoking preference.

sortOrder

private final GetLodgingListingsOperationParams.SortOrder sortOrder

Specifies the sort order of search results. If no sort order is specified, the default is asc. But for deals sorting, it only supports desc. To be used in conjunction with the sortType parameter above.

sortType

private final GetLodgingListingsOperationParams.SortType sortType

Specifies the field that the search results will be ordered by. To be used in conjunction with sortOrder parameter below. CMA Compliance Note (UK): partners doing business in the UK should be sorting their search results using the totalpricewithfees parameter in their query string so that the sorting complies with CMA regulations.

source

private final GetLodgingListingsOperationParams.Source source

Indicate the source where the request is coming from.

thumbnailImageSize

private final GetLodgingListingsOperationParams.ThumbnailImageSize thumbnailImageSize

Indicate what size of image will be used for the single thumbnail image that is returned when contentDetails is set to low, medium or high. The available thumbnail image sizes are: - t : Thumbnail - s : Small - b : Big - y : 500x500v - z : 1000x1000v Resolution from smallest to largest is t < s < b < y < z. If no thumbnailImageSize is specified, the t size images will be returned. if no thumbnail image found, it would not return thumbnail image. Only one thumbnail image size is allowed.

travelWithPets

@Valid()

private final Boolean travelWithPets

Indicates if the search should include pet-friendly properties. If set to \"True\" only properties that allow pets are returned. Pet fees, if available, are included in TaxesAndFees. The parameter is only applicable to the Vrbo brand.

unit

private final GetLodgingListingsOperationParams.Unit unit

The unit of measure for searches performed via geoLocation, locationKeyword, or regionids. Valid units are km and mi. This parameter should be used in combination with the radius and geoLocation, locationKeyword, or regionids.

Functions

builder

public final static GetLodgingListingsOperationParams.Builder builder()

getAllRoomTypes

public final Boolean getAllRoomTypes()

getAvailOnly

public final Boolean getAvailOnly()

getBlockFullDepositRateplan

public final Boolean getBlockFullDepositRateplan()

getCheckIn

public final LocalDate getCheckIn()

getCheckOut

public final LocalDate getCheckOut()

getContentDetails

public final GetLodgingListingsOperationParams.ContentDetails getContentDetails()

getCurrency

public final String getCurrency()

Value should be a standard ISO 3 letter currency code.

getEcomHotelIds

public final Set<String> getEcomHotelIds()

Comma-separated list of Expedia hotel IDs. There can be no spaces between parameters.

getExcludedPropertyTypeIds

public final Set<String> getExcludedPropertyTypeIds()

getFreeCancellation

public final Boolean getFreeCancellation()

getGeoLocation

public final String getGeoLocation()

getGroupedAmenities

public final Boolean getGroupedAmenities()

Specifies whether to return the grouped amenities. If groupedAmenities is true, DescriptiveAmenities node will be returned in response, otherwise Amenities node will be returned.

getHcomHotelIds

public final Set<String> getHcomHotelIds()

Comma-separated list of Hotels.com hotel IDs. There can be no spaces between parameters.

getHeaders

public Headers getHeaders()

getImageSizes

public final GetLodgingListingsOperationParams.ImageSizes getImageSizes()

getIncludedInventorySourceIds

public final Set<String> getIncludedInventorySourceIds()

getIncludedPropertyTypeIds

public final Set<String> getIncludedPropertyTypeIds()

getLimit

public final Long getLimit()

getLinks

public final List<GetLodgingListingsOperationParams.Links> getLinks()

getLocale

public final String getLocale()

getLocationKeyword

public final String getLocationKeyword()

getMaxStarRating

public final GetLodgingListingsOperationParams.MaxStarRating getMaxStarRating()

The maximum star rating for hotels returned in the response.

getMinStarRating

public final GetLodgingListingsOperationParams.MinStarRating getMinStarRating()

The minimum star rating for hotels returned in the response.

getPartnerTransactionId

public final String getPartnerTransactionId()

getPathParams

public Map<String, String> getPathParams()

getQueryParams

public Parameters getQueryParams()

getQueryText

public final String getQueryText()

Query text is used for a full text search of hotel data. Text search based on hotel name, description, address, promotion description, amenities description.

getRadius

public final Long getRadius()

getRatePlanType

public final GetLodgingListingsOperationParams.RatePlanType getRatePlanType()

getRateType

public final GetLodgingListingsOperationParams.RateType getRateType()

Indicate which type of paymentMethod for each room will be returned.

getRegionIds

public final Set<String> getRegionIds()

getRoom1Adults

public final Long getRoom1Adults()

Specifies the number of adults staying in a specific room. Default value is one room with 2 adults. Example: room1.adults is used to specify the number of adults in the first room.

getRoom1ChildAges