Deep Links

Use the deep link service to generate valid deep links to Lufthansa's portal booking process on lh.com. The API will construct a correctly formatted deep link with all the necessary parameter encryption to the LH booking engine.

The deep link service provides two types of deep links FFP Deep Links and ITCO Deep Links

FFP Deep Links

FFP deep links will lead you/your customer to the flight selection screen in lh.com.

Flight Selection Screen

To receive an FFP link please make sure to enter the following parameters

  • catalogues
  • origin
  • destination
  • travel-date
  • return-date (leave blank for one-way journeys)
  • trackingid (you received after registration - please ensure correct spelling as this parameter tracks your purchase)
  • language
  • country

FFP Request URI

Code snippet: URL
/v1/offers/faresdeeplink/deeplink/ffp?catalogues={catalogues}&origin={origin}&destination={destination}&travel-date={outboundDate}[&return-date={returnDate}][&cabin-class={cabinClassCode}][&travelers=([adult={numberOfPassengers}];[child={numberOfPassengers}];[infant={numberOfPassengers}]&[partnerid={partnerID}][&encrytpion-key{encryptionKey}]&trackingid={trackingID}&language={language}&country={countryCode}

FFP input parameters

Variable Description Format
{origin} Origin airport/city code - Mandatory 3-letter IATA code, e.g. “FRA”.
{destination} Destination airport/city code - Mandatory 3-letter IATA code, e.g. "MUC".
{outboundDate} Outbound travel date - Mandatory yyyy-MM-dd. e.g. '2016-10-27'
{returnDate} Return travel date - Optional yyyy-MM-dd. e.g. '2016-10-27'
{cabinClassCode} Cabin Class Code - Optional Cabin class: 'economy', 'premium_economy', 'business', first'
{numberOfPassengers} Optional - Number of passengers of the corresponding type - Optional (adult=1 will be used as default) Two digit number
Adult=2
Child=2
Infant=1
{partnerID} Partner identification - Optional integer e.g.1071
{encryptionKey} Encryption key - Optional AES key
{trackingID} Web tracking identification - Mandatory alpha numeric string e.g. 'MYDummyID'
{language} Language code - Mandatory 2 letter language code e.g. "DE"
{country} Country code - Mandatory 2 letter country code e.g. "DE"

You don't need to worry about encryption key and partner id. These will be automatically set if not provided.

Request Examples

Code snippet: Call
/v1/offers/faresdeeplink/deeplink/ffp?origin=FRA&cabin-class=Economy&country=de&partnerid=13100&encryption-key=C49A99BBF61C2992A14E60D3F21ABCF&travel-date=2016-10-12&return-date=2016-11-12&language=de&travelers=(adult=3;child=2;infant=1)&trackingid=dummyTrackingID

ITCO Deep Links

ITCO deep links lead you/your customer to the booking screen of lh.com with the flights already in the shopping cart.

lh.com shopping cart

To receive an ITCO deep link make sure to fill all the FFP parameters from above as well as the following parameters:

  • fare
  • outbound-segments
  • return-segments

ITCO Request URI

Code snippet: URL
/v1/offers/faresdeeplink/deeplink/itco?&origin={origin}&destination={destination}&travel-date={outboundDate}[&return-date={returnDate}][&cabin-class={cabinClassCode}][&outbound-segments={outboundSegment}][&return-segments={returnSegment}][&travelers=([adult={numberOfPassengers}];[child={numberOfPassengers}];[infant={numberOfPassengers}][&fare=totalFare}][&net-fare=netFare}][&fare-currency=fareCurrency}]&[partnerid={partnerID}][&encrytpion-key{encryptionKey}]&trackingid={trackingID}&language={language}&country={countryCode}

ITCO input parameters

Variable Description Format
{origin} Origin airport/city code - Mandatory 3-letter IATA code, e.g. “FRA”.
{destination} Destination airport/city code- Mandatory 3-letter IATA code, e.g. "MUC".
{outboundDate} Outbound travel date- Mandatory yyyy-MM-dd. e.g. '2016-10-27'
{returnDate} Return travel date - Optional yyyy-MM-dd. e.g. '2016-10-27'
{cabinClassCode} Cabin Class Code - Optional Cabin class: 'economy', 'premium_economy', 'business', first'
{outBoundSegment} Enter outbound flight segments in the sequence of outbound travel - Mandatory e.g. 'e.g. LH096;LH480'
{returnSegment} Enter return flight segments in the sequence of return travel - Mandatory for return journey e.g. 'LH7465;LH431'
{numberOfPassengers} Number of passengers of the corresponding type - Optional (adult=1 will be used as default) Two digit number
Adult=2
Child=2
Infant=1
{totalFare} Total fare - Mandatory e.g 100.50
{netFare} Net fare - Optional e.g 10.20
{fareCurrency} Fare currency - Mandatory three letter currency code e.g. 'EUR'
{partnerID} Partner identification - Optional integer e.g.1071
{encryptionKey} Encryption key - Optional AES key
{trackingID} Web tracking identification - Mandatory alpha numeric string e.g. 'MYDummyID'
{language} Language code - Mandatory 2 letter language code e.g. "DE"
{country} Country code - Mandatory 2 letter country code e.g. "DE"

Request Examples

Code snippet: URL
/v1/offers/faresdeeplink/deeplink/itco?fare-currency=EUR&return-segments=LH401&origin=FRA&fare=1018.34&cabin-class=Economy&country=de&partnerid=13100&encryption-key=C49A99BBF61C2992A14E60D3F21ABCF&travel-date=2016-10-12&return-date=2016-11-12&language=de&outbound-segments=LH400&travelers=(adult=3;child=2;infant=1)&trackingid=dummyTrackingID

Response Structure Definition

Key Description
DeepLinkResponse Element contains the main body of the response
.DeepLinks Contains message response reference data
..DeepLink Message version
..@ID Response message creation time
@mode
  • mode = D for FFP link (provides a link to the flight screen within the booking portal)
  • mode = I for ITCO link (provides a linke to the pre-filled shopping cart within the booking portal)
@link contains the deep link URL
.Meta Container for meta links
..Link Use the links to access further detail related to the notified message
@Href Link to actual resource
@Rel Specifying the kind of link, such as 'self' (link that returned this response), ‘alternate’ (link that points to another resource) or ‘related’ (link that points to related resource).

Response Examples

<DeepLinkResponse>
  <DeepLinks>
    <DeepLink id="6a45efa2-1645-4947-895d-10a96fd2bbc6" mode="D" link="https://uat3.lufthansa.com/deeplink......."/>
    <DeepLink id="d98c3bdf-6b4b-4a57-9689-49ffe7972939" mode="I" link="https://uat3.lufthansa.com/deeplink......."/>
  </DeepLinks>
  <Meta Version="1.0.0">
    <Link Href="https://api-test.lufthansa.com/fares_v1.0.0/fares/deeplink?fare-currency=CZK&amp;............" Rel="self"/>
  </Meta>
</DeepLinkResponse>

version 9 as of 9 months ago by Matthias