Sign in
WidgetService

Builds a deeplink into travel search results

get/deeplink/{appId}

Path parameters

appIdinteger required

Application identifier

Query parameters

st1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 required

Enumerator defining type of search:<br>1=Flights, 2=Accommodation, 3=Packages, 4=TicketsAttractions, 5=Transfers, 6=AirportExtras, 7=Insurance, 8=CarRental, 9=Visas, 10=Tours, 11=DynamicPackaging, 12=CustomExtra, 13=Cruise, 14=TicketAccommodation, 15=TicketAccommodationFlight

Type of search to perform

unit1 | 2 | 3

Enumerator defining unit of distance:<br>1=KM, 2=Miles, 3=NauticalMiles

Distance units (default Miles)

langstring required
Example:en

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

currstring required
Example:GBP

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

natstring required
Example:GB

Nationality of lead traveller (e.g. GB)

srcstring

Optional tracking source

dlcodestring

Optional deeplink code for tracking

orgstring
Example:LON

Flight origin IATA airport or city code

dststring
Example:AGP

Flight destination IATA airport or city code

loct1 | 2 | 3 | 4 | 5 | 6

Enumerator defining type of a geographical place:<br>1=Country, 2=City, 3=Airport, 4=PointOfInterest, 5=Property, 6=Port

Accommodation location type lookup

locstring
Example:Barcelona

Accommodation location name

refnstring
Example:TEST1234

Accommodation reference

refestring
Example:TEST1234

Event reference

ctrystring
Example:ES

Accommodation location ISO639-1 2-letter country code

latnumber double

Latitude

lngnumber double

Longitude

radnumber double

Radius (default 10)

pupt1 | 2 | 3 | 4 | 5 | 6

Enumerator defining type of a geographical place:<br>1=Country, 2=City, 3=Airport, 4=PointOfInterest, 5=Property, 6=Port

Pickup location type lookup

pupstring
Example:Malaga

Pickup location name

pupctrystring
Example:ES

Pickup location ISO639-1 2-letter country code

drpt1 | 2 | 3 | 4 | 5 | 6

Enumerator defining type of a geographical place:<br>1=Country, 2=City, 3=Airport, 4=PointOfInterest, 5=Property, 6=Port

Dropoff location type lookup

drpstring
Example:Malaga

Dropoff location name

drpctrystring
Example:ES

Dropoff location ISO639-1 2-letter country code

dlatnumber double

Dropoff Latitude

dlngnumber double

Dropoff Longitude

frstring date-time
Example:2022-05-22

Date from (depart or check in)

dowstring

Array of preferred days of week for departure or check in (only used for flexible dates)

tostring date-time
Example:2022-05-30

Date to (return or check out)

frdinteger

Dynamic from date (depart or check in) from todays date (days)

durinteger

Duration (nights)

dur2integer

Duration 2 (nights)

flexboolean
Example:true

Flexible dates

rmsinteger
Example:2

Number of rooms (max 3)

adtinteger
Example:2

Number of adults

adt2integer
Example:2

Number of adults (room 2)

adt3integer
Example:2

Number of adults (room 3)

chdinteger
Example:2

Number of children

chd2integer
Example:2

Number of children (room 2)

chd3integer
Example:2

Number of children (room 3)

chdageinteger[]

Array of child ages (if chd greater then 0)

chdage2integer[]

Array of child ages for room 2 (if chd2 greater then 0)

chdage3integer[]

Array of child ages for room 3 (if chd3 greater then 0)

infinteger

Number of infants

inf2integer

Number of infants (room 2)

inf3integer

Number of infants (room 3)

ageinteger
Example:2

Driver age for car rental

dirboolean

Direct flights preferred

cabin0 | 1 | 2 | 3 | 4

Enumerator defining airline cabin classes:<br>0=Any, 1=Economy, 2=PremiumEconomy, 3=Business, 4=First

Preferred cabin class TravelAppAPI.Models.Enumerators.CabinClasses

carrierstring
Example:BA

Flight carrier preference

brd0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19

Enumerator defining accommodation board basis:<br>0=Any, 1=RoomOnly, 2=SelfCatering, 3=BedAndBreakfast, 4=DinnerBedBreakfast, 5=HalfBoard, 6=FullBoard, 7=AllInclusive, 8=AllInclusivePlus, 9=CateredChalet, 10=AssistedChalet, 11=ManagedChalet, 12=FullBoardPlus, 13=CateredLodge, 14=Mixed, 15=BedAndDinner, 16=BedAndLunch, 17=BedAndMeal, 18=MealPlan, 19=MealPlanPlus

Preferred board basis TravelAppAPI.Models.Enumerators.BoardBasis

ratnumber double
Example:3.5

Minimum star rating

suppstring
Example:1,2,3

Comma-delimited list of supplier ids

supp2string
Example:1,2,3

Comma-delimited list of alternative supplier ids

supp3string
Example:1,2,3

Comma-delimited list of alternative supplier ids

gtexboolean
Example:true

Optional flag to go straight to extras page (only used for ticket only searches)

Response

OK

successboolean

Indicator as to whether API request was successful.

errorstring nullable

Returns an error if success is returned as false.

{"stackTrail":"components:schemas:APIResponseData:properties:data","oasType":"schema","type":"unknown","description":"Data model.","nullable":true}

Changes

No recorded changes to this endpoint across all 1 revision of this API.