Deep Linking

What does deep-linking mean?

Deeplinking is used for our co-branded white label solution (Webapp) specifically. Below are steps on how you can create a URL link for customers to be redirected to the white label page with specific fields pre-populated.

Travel Restrictions

Direct the customer to a page listing travel restrictions for their journey.

Travel Restrictions Page

URL https://apply.joinsherpa.com/travel-restrictions/

Example: Populate the origin country as USA to display travel restrictions
https://apply.joinsherpa.com/travel-restrictions?affiliateId=sherpa&originCountry=USA

Destination Page

The traveller will be required to enter their origin when visiting this page.

Format https://apply.joinsherpa.com/travel-restrictions/<<COUNTRY_CODE_ISO3>>
Example: https://apply.joinsherpa.com/travel-restrictions/IND

Query Parameters

Query Parameters

Required

Type

Description

affiliateId

Required

String

Your {{affiliateId}}

language

Optional

String

Localize the web app for your users. See supported languages.

originCountry

Required
if originAirport or originRegion is not provided

String

ISO3 Country CodeISO3 Country Code - A country code in an ISO3 Format. For example, `USA`, `CAN`, `DEU`.

originAirport

Required
if originCountry or originRegion is not provided

String

IATA Airport Code

originRegion

Required
if originCountry or originAirport is not provided

String

ISO3 Region Code

destinationCountry

Required
if destinationAirport or destinationRegion is not provided

String

ISO3 Country CodeISO3 Country Code - A country code in an ISO3 Format. For example, `USA`, `CAN`, `DEU`.

destinationAirport

if destinationCountry or destinationRegion is not provided

String

IATA Airport Code

destinationRegion

if destinationCountry or destinationAirport is not provided

String

ISO3 Region Code

nationality

Optional

String

ISO3 Country CodeISO3 Country Code - A country code in an ISO3 Format. For example, `USA`, `CAN`, `DEU`.

tripType

Required

String
roundTrip, oneWay

Whether the trip is one way or round trip.

departureDate

Required

String
YYYY-MM-DD

Default date of the departure

returnDate

Required
if tripType is roundTrip

String
YYYY-MM-DD

Default return date

fullyVaccinated

Optional

Boolean

Default value of vaccination filter

Query Parameters for Connections

Query Parameters

Required

Type

Description

departureTransitCountries

If departureTransitRegions and departureTransitAirports is not provided

String

ISO3 Country CodeISO3 Country Code - A country code in an ISO3 Format. For example, `USA`, `CAN`, `DEU`.

departureTransitRegions

If departureTransitCountries and departureTransitAirports is not provided

String

ISO3 Region Code

departureTransitAirports

If departureTransitCountries and departureTransitAirports is not provided.

String

IATA Airport Code

Examples for Travel Restrictions

India Landing Page
https://apply.joinsherpa.com/travel-restrictions/IND?affiliateId=sherpa

Pre-populate origin for restrictions with USA as origin
https://apply.joinsherpa.com/travel-restrictions?affiliateId=sherpa&originCountry=USA

One Way Trip from Canada to Turkey
https://apply.joinsherpa.com/travel-restrictions/TUR?originCountry=CAN&affiliateId=sherpa

One Way Trip from Canada to Turkey with Canadian Passport
https://apply.joinsherpa.com/travel-restrictions/TUR?originCountry=CAN&nationality=CAN&affiliateId=sherpa

Round Trip from Canada to Turkey
https://apply.joinsherpa.com/travel-restrictions/TUR?originCountry=CAN&departureDate=2021-04-30&tripType=roundTrip&language=en-US&returnDate=2021-04-30&affiliateId=sherpa

Round Trip from Spain to India in Spanish
https://apply.joinsherpa.com/travel-restrictions/IND?originCountry=ESP&departureDate=2021-04-30&tripType=roundTrip&language=es-XL&returnDate=2021-04-30&affiliateId=sherpa

One Way Trip from Munich, Germany to Toronto, Canada via London Heathrow, the United Kingdom as a fully vaccinated traveller with a passport from Germany
https://apply.joinsherpa.com/travel-restrictions/CA-ON?originCountry=DEU&nationality=DEU&originRegion=DE-BY&originAirport=MUC&destinationAirport=YYZ&departureTransitCountries=GBR&departureTransitRegions=GB-ENG&departureTransitAirports=LHR&departureDate=2021-07-15&tripType=oneWay&transitType=departure&fullyVaccinated=true&language=en-US&affiliateId=sherpa

Examples for Evisa

Canadian passport holder travelling to Turkey
https://apply.joinsherpa.com/explore/CAN/TUR?affiliateId=sherpa


What’s Next
Did this page help you?