WidgetService

Returns list of travel offers based on the criteria.

post/widgetsvc/traveloffers

Request

  • Base URL
    https://api.travelify.io
  • URL
    https://api.travelify.io/widgetsvc/traveloffers
  • Auth
    none declared

Request body

dealmapboolean

States if the request is for a deal map or offer box (default = false)

deduping1 | 2

Enumerator defining type of travel offer deduping:<br>1=None, 2=Aggressive

type0 | 1 | 2 | 3 | 4

Enumerator defining type of travel offers:<br>0=Any, 1=Flights, 2=Accommodation, 3=Packages, 4=CarRental

packageType0 | 1 | 2

Enumerator defining type of offer package types:<br>0=Any, 1=DynamicPackages, 2=PackageHolidays

maxOffersinteger

Maximum number of offers to return

budgetMininteger

Minimum budget

budgetMaxinteger

Maximum budget

pricingByType1 | 2 | 3

Enumerator defining pricing by types:<br>1=Total, 2=Person, 3=Night

currencystring required

ISO4217 3-letter currency code (e.g. GBP).

languagestring required

ISO639-1 2-letter language code (e.g. en).

nationalitystring required

ISO3166 2-letter nationality country code (e.g. GB).

originstring nullable

Optional 3-letter IATA airport/city code or 2-letter country code

originsstring[] nullable

Optional list of 3-letter IATA airport/city code or 2-letter country code

destinationstring nullable

Optional IATA airport code, 2-letter country code, resort or city name

destinationsstring[] nullable

Optional list of IATA airport code, 2-letter country code, resort or city name

rollingDatesboolean

Whether to use rolling dates (if true must set DatesMin and DatesMax)

datesMininteger nullable

Optional minimum days from today

datesMaxinteger nullable

Optional maximum days from today

startDatestring date-time nullable

Optional start date

endDatestring date-time nullable

Optional end date

exactDatesboolean

Whether date range is exact dates (if false then searches whole month)

returnOnlyboolean

Return travel options only (default=true)

durationMininteger nullable

Optional minimum duration

durationMaxinteger nullable

Optional maximum duration

carrierCodesstring[] nullable

Optional list of airline carrier codes

cabinClassesCabinClasses[] nullable

Optional list of flight cabin classes

ratingMinnumber double nullable

Optional minimum rating

propertyTypesPropertyTypes[] nullable

Optional list of property types

boardBasesBoardBasis[] nullable

Optional list of board basis

sortstring nullable

Sorting of travel offers returned

Example request

{
  "maxOffers": 10,
  "budgetMax": 100,
  "currency": "GBP",
  "language": "en",
  "nationality": "en"
}

Response

OK

successboolean

Indicator as to whether API request was successful.

errorstring nullable

Returns an error if success is returned as false.

dataunknown

Changes

No recorded changes to this operation across all 18 revisions of this API.