Name | Description | Type | Additional information |
---|---|---|---|
Vendors |
List of the 3 character code Vendor codes to get OnSale data. |
Collection of string |
Required |
Destinations |
List of three character code destination markets or numerical region codes. |
Collection of string |
None. |
HotelRating |
List of integer hotel ratings to include. The valid choices comes from the /Choices route. |
Collection of integer |
None. |
TripAdvisorRatings |
List of integer TripAdvisor ratings to include. The valid choices comes from the /Choices route. These values are 0-10 for 0, .5, 1.0, 1.5, etc. |
Collection of integer |
None. |
NumberOfNights |
List of integer number of nights to include. The valid choices comes from the /Choices route. |
Collection of integer |
None. |
Origin |
Three character Origin market code. |
string |
None. |
PageNumber |
Integer page number starting with 1 |
integer |
None. |
PageSize |
PageSize is the quantity of OnSale items to be returned in each paging call. |
integer |
None. |
PriceRanges |
List of the OnSalePriceRanges to include or exclude in the paging call. |
Collection of OnSalePriceRange |
None. |
SortDirection |
Indicates to sort Ascending or Descending |
SortDirection |
None. |
SortType |
Integer value for the sort. The valid choices comes from the /Choices route. |
integer |
None. |
Themes |
List of integer themes to include. The valid choices comes from the /Choices route. |
Collection of integer |
None. |
TravelDateHigh |
TravelDate High limit. |
date |
None. |
TravelDateLow |
TravelDate Low limit. |
date |
None. |
DealTypes |
List of DealTypes. These values come from the Choices, for example 1="Hotel Only", 2="Hotel + Flight". |
Collection of integer |
None. |
SaleTypeFilter |
Indication of types of deals to include: normal, last-minute, and/or exclusive. |
OnSaleTypeFilter |
None. |
HotelCodes |
List of Hotel codes that should be included in the response. |
Collection of string |
None. |
BypassOfferMerchandiser |
Flag to bypass OfferMerchandiser. This shows the "definition" of the OnSale item's DepartureDate. You will see the actual 777777.77 or 99999 values that are the indicators for OfferMerchandiser to get the cached prices from CacheMasterReader. |
boolean |
None. |