AirFrance KL - AirShopping This document describes the AirFrance KL AirShopping Service Document Version: 1.0 Document Status: approved Date of last Update: 26/10/2017 Document Location: https://developer.airfranceklm.com/ Revision History Date Version Summary of Changes 25/10/2017 1.0 Document 1 st release Linked Documents Document Filename Version Location TABLE OF CONTENTS 1. Overview... 1 2. Invocation... 2 2.1. AirShoppingRQ... 2 2.2. AirShoppingRS... 4 3. Process Steps... 7 4. Business Rules... 8 4.1. Parties... 8 4.1.1. Sender... 8 4.1.2. Participant... 8 4.1.3. Recipient... 8 4.2. Sender authentication... 8 4.3. Flight scope... 8 4.4. Passengers scope... 8 4.4.1. Number of passenger... 8 4.4.2. Typology of passenger... 8 4.5. Offer... 9 4.5.1. Scope... 9 4.5.2. Rule... 9 4.5.3. Example of an Offer... 9 4.6. Offer item... 9 4.6.1. Definition... 9 4.6.2. Example Offer / Offer item... 9 Document : BSD SOA Business Service Description.doc Page: ii
4.7. Cabins... 10 4.8. Corporates... 10 4.8.1. Corporate Offers... 10 4.8.2. Corporate verification... 10 5. Business Exceptions... 10 5.1. andatory elements... 10 5.2. Error Codes... 10 6. Policies... 11 Document : BSD SOA Business Service Description.doc Page: iii
1. Overview Goal AFKL shopping message corresponds to the IATA NDC AirShopping schema version 17.1. It includes anonymous shopping. Personalised, affinity, attribute, rich criteria shopping are currently out of scope of this version. No rich media content will be provided in this version also. Next action : ask for the details of a selected offer (FlightPrice service) OR ask for the booking of a selected offer (CreateOrder service) Result(s) The response will provide a list of AF or KL offers, an offer is a combination of available flights and fare that answers to a request, it contains: Flights, and flights details : flight nr, ori/dest, departure date/time, terminals, operating airline Price and fare basis Branded fare code Offer time limit (after 30 minutes the offer is no more valid and can not be booked) The offer proposed is the lowest fare available per flight combination and branded fare or cabin. Only AF and KL marketed flights are in scope of this service. Only flight offers are returned, no ancillaries. SCOPE IN Request : One Way, or Round Trip, City and Airport code Specific Date (not a range) 1 to 9 passengers (groups are out of scope) Adult/child/baby Corporate OIN Results: AF and KL marketing Lowest fare per branded fare/cabin Public and corporate fares Only flights, no ancillaries (except if they are included in the fare) SCOPE Coming Soon Youth/senior Abonnés (subscribers cards) Branded fare labels/description SCOPE To be planned Private fares Rich Content ulti City (Open Jaw, Stop) Date Range, Calendar, Alternative dates Affinity, Attributes HOP marketing flights U Page: 1
ulti PTC Interaction Type: Request/Reply Pre-Condition(s): Requestors must have an agreement with AFKL and IT security pre requisite may apply (authentification process in place). Post-Condition(s): N/A Support Process 1. If any issues are encountered on the services, the third party support will do a 1 st analysis to exclude a problem on third party side 2. If the issue comes from AFKL, the third party support will raise an incident ticket to AFKL support. 3. AFKL wil analyse and resolve the issue and revert to the Third Party 2. Invocation This service is triggered by a request received from an external actor (travel agency, aggregator etc.). 2.1. AirShoppingRQ Information provided in Business information column are specific NDC terms. = andatory; O = Optional; C = Conditional Business Information Description /O Remark/Example PARTY: parties involved in the shopping transaction Sender The party who has triggered the request. Sender: travel agency Name Name of the travel agency Example: Tour Travel Type TA, OTA, TC IATA Number IATA number of the travel agency Example: 67890890 Agency ID ID of the travel agency This field is mandatory in the NDC grammar, but AFKL will not use it. Recommendation is to put the IATA nr in this field. Page: 2
Participants is the party through who the message will go O NDC Enabled System Participant Name Name of the enabled system participant ust be decided between the third party and AFKL System ID Unique external system ID ust be decided between the third party and AFKL. Aggregator participant C Needed if aggregator in the transaction Name Name of the aggregator Example: Travel Fusion Aggregator ID Unique external ID of the aggregator Example: TF C ust be decided between the third party and AFKL. ust be decided between the third party and AFKL. Corporate participant C Needed if corporate offers are requested Name Name of the corporate Example: SHELL The name is mandatory in NDC grammar but will not be used by AFKL. Only the ID will be used. ID OIN of the corporate Example: KV07 Recipient Is the airline which receives the request ORA Recipient Offer Responsible Airline who receives AF or KL the request Name Name of the airline O Example: Air France or KL Airline ID IATA code of the airline Possible Values : AF or KL. Travellers: Can contain up to 9 passenger type code. Indicates as much as PTC you want passengers Passenger Type Code Typology of passenger : currently supported ADT, CHD, INF; will come later YCD, YTH Possible values : ADT, CHD, INF Core Query: The shopping request contains O&D and dates information for a return or a one-way flight. By default: ADT Page: 3
Origin Destination Origin and destination of the travel. To be repeated in case of a return flight. Departure Airport Code IATA Code of the airport at departure City code can also be used Date Date of the departure YYYY--DD Arrival Airport Code IATA code of the airport at arrival City code can also be used Date Date of arrival YYYY--DD Cabin preference Cabin type / code 1 AF: First // KL: Business 2 AF: Business // KL: Business Encoding Scheme: PADIS code set element 9873 - Cabin Class of Service 3 AF // KL: Economy 4 AF: Premium Economy // KL: Economy apping between IATA cabin code and AFKL cabin code is provided below. 5 AF // KL: Economy 6 AF // KL: Economy 7 All : not available 2.2. AirShoppingRS Business InformationDescription / O Shopping Response The shopping response provided by AFKL will contain a list of offers. = andatory; O = Optional; C = Conditional Remark Shopping Response ID The shopping response ID enables to know the offers and follows a ID generated in the response Page: 4
conversation. List of offers: An offer will include flights and a total price. Offer Structure of an Offer provided in the business rule. Offer ID Unique identifier of the offer Alphanumeric characters Flights overview Total Price Flights references of the requested Example: FL1 detailed in flight and itineraries. flight segments block Total price of all offer items (includes Example: 114 EUR taxes) Total taxes Total taxes of all offer items Example: 10 EUR Offer time limit The offer is valid until this time limit. Time limit is set to 30minutes List of offer items: An offer can contain 1 or several offer Items Example: 2017-08-03T15:44:21 Offer item Offer Item ID Unique identifier of the offer item Alphanumeric characters Price Total Price Total price of the offer item (includes taxes) Example: 130EUR Base amount Price without taxes Example: 100EUR Total taxes Total tax of the offer item Example: 30EUR Passengers Reference of the passengers in this offer item Example: PAX 1, PAX 2 detailed in passenger list block Flights References of the flights included in this offer item Example: FL1, FL2 detailed in flight and flight segment list. Cabin References of the cabin included in this offer item Example: PC1 detailed in price class list block. Corporate fare If true, the offer is a corporate offer O Datalists Passengers List Type Typology of the passenger Example: ADT Page: 5
Quantity Number of passengers Example: 1 Origin Destination List Lists the origin and destination requested by the Sender and references above. Departure Code IATA code of the departure airport Example: CDG Arrival Code IATA code of the arrival airport Example: LIS Flight references References of the flights listed below Flight List List of all flight segments references Example: FL1 above Segment References Segment provided within the flights offers Example: SEG1 Total Journey Total duration of the segments (air time, connection time, stops included) Example: PT7H45 (7 hours and 45 minutes) Flight Segment List Information of each flight segment Example : SEG1 referenced above Departure/Arrival Airport Code IATA code of the airport of departure and arrival Use a three letter location identifier assigned according to the IATA Resolution 763 Date Date of departure and arrival Encoding Scheme: ISO 8601 Date Format YYYY--DD Airport Name Airport name of departure and arrival Airport: CDG Time Time of departure and arrival Example: 09:15 Encoding Scheme: ISO 8601 ilitary/ 24 Hour Format (HH:) In local time. Terminal Terminal name of departure and arrival O Example : 2 Page: 6
Change of Day Number of days between arrival and departure. C Example: +1 arketing/operating Carriers Information about the marketing And operating carrier. Airline ID The ID of the marketing and operating Carrier Example: AF Flight number Number of the marketing flight Example: 006 Equipment Aircraft code Code of the equipment Example: 318 Name Name of the equipment Example: A318 Price Class List Information about the cabin and class provided for each offer Fare Basis Code Coding reference of the fare basis Example: YFFYUR Class of service Booking class and cabin information. Code Booking class Example: A arketing Name Cabin code and marketing name of the cabin fare selected Example: > ECONOY FULL FLEX apping between IATA cabin code and AFKL cabin code is provided below. 3. Process Steps The AirShopping service can be used in the following sequence of services : 1. AirShoppingRQ/RS 2. FlightPriceRQ/RS - Optionnal 3. CreateOrderRQ/OrderViewRS 4. AirDocIssueRQ/OrderViewRS Page: 7
4. Business Rules 4.1. Parties 4.1.1. Sender The Sender must be the travel agent requesting for the offer. 4.1.2. Participant The Participant is either the party through which the NDC message (aggregator or NDC enabled system) or the party on behalf which the request is done (a corporate). 4.1.3. Recipient The Recipient is the party receiving the NDC message. It is either Air France or KL. 4.2. Sender authentication When a shopping request is received, NDC application has to authenticate the seller. The seller has to be referenced and allowed to use NDC application by AFKL. 4.3. Flight scope Only AF and KL marketed flights are offered. 4.4. Passengers scope 4.4.1. Number of passenger Our service only supports from 1 to 9 passengers. Groups are out of scope. 4.4.2. Typology of passenger Typology of passengers in scope are the following: Adults (ADT) Children (CHD) Infants (INF) In the next version of our shopping message, following type of passenger will be provided: Senior (YCD) Youth (YTH) Page: 8
4.5. Offer 4.5.1. Scope An offer is a requested flight journey and the passengers associated to this journey. No ancillaries are yet provided in an offer. 4.5.2. Rule An offer differs from another offer with its price or/and the combination of flights offered in the offer. 4.5.3. Example of an Offer 4.6. Offer item 4.6.1. Definition An offer item is included in an offer and each offer item is unique. An offer item is associated to one or multiple passengers consuming the exact same services at the same fare. 4.6.2. Example Offer / Offer item OFFER A - Offer item A1: 2 adults, CDG-JFK, 1250 - Offer item A2: 1 flying blue adult, CDG-JFK, 500 In the example provided, the difference is at the fare level. The passengers are sharing the same itinerary but not at the same price. Page: 9
4.7. Cabins apping between IATA and AFKL cabin codes. IATA code AIR FRANCE KL AFKL code 1 First Business F/C 2 Business Business C 3 Economy Economy 4 Premium Economy Economy W/ 5 Economy Economy 6 Economy Economy 7 All : not used by AFKL All : not used by AFKL N/A 4.8. Corporates 4.8.1. Corporate Offers A travel agency can request for corporate offers. Offers provided to the seller can include public and corporate fares. A corporate offer includes a corporate fare. Corporate offers are provided accordingly to the contract conditions established with AFKL. To benefit from its corporate advantages, the corporate will have to indicate his OIN. 4.8.2. Corporate verification When receiving an AirShoppingRQ with corporate ID, AF KL NDC application checks the validity of the corporate contract and sends an error if it is not valid. 5. Business Exceptions 5.1. andatory elements If one of the mandatory elements in the request are not provided, an error message should be sent to the consumer: please complete all mandatory fields 5.2. Error Codes Input PADIS Error Code Date before today or after today+1year 8 No cabin code specified or invalid 12 Recipient missing 107 Airline Code missing / invalid 107 Requestor ID missing 112 Travel Agency Sender missing 112 Agency IATA missing 112 No passenger list specified or empty 143 Invalid passenger type Page: 10
Too much OriginDestination elements 724 6. Policies Business Criticality < Sensitive > Business Volume < xx > calls to the service per day in 2018 Business Use 7/24 Information classification according AF/KL Security office Availability 3 Critical Downtime cannot exceed 4 hours (impact > 1) 2 Sensitive / Significant Downtime may exceed 4 hours but is less than a maximum defined in the GOA General Operating Agreement or specified in chapter 6. 1 - Normal Best effort (impact < 10 K) Confidentiality Integrity Accountability Specification of additional availability requirements 3 Secret Information whose unauthorized disclosure (even within the organization) would cause serious damage to the interests of AFKL 2 Confidential Information whose unauthorized disclosure (even within the organization) would cause significant harm to the interests of AFKL) 1 Internal use only Information whose unauthorized disclosure, particularly outside of AFKL, would be inappropriate and inconvenient 0 Unrestricted Public domain information which requires no special protection measures As well as the above classifications it is possible to make use of the following qualifiers: Under Embargo The information is to be put and remain at a certain classification level until a predetermined date. At that time the embargo is lifted and the information will revert to a lower classification. Both classifications and the date of change should be indicated Personal The information is intended for an individual and may contain sensitive personal information and should therefore be treated as Addressee only. Access is limited therefore to the person for whom the information is intended. Specification of additional confidentiality requirements 3 high No loss of integrity is tolerated and corrective measures are in place to prevent any change to the original state of the information 2 medium Loss of integrity would significantly damage AFKL interests and corrective measures are in place to restore to the original state within a predetermined amount of time 1 low Loss of integrity should be logged Specification of additional integrity requirements 3 High Authentication and access to the information must be logged and preserved for a fixed period. Non-adherence of these constraints would cause serious harm to the interests of AFKL Page: 11
Interface Variant 2 medium Access to the information must be logged and preserved for a fixed period 1 low Access to the information need not be logged Specification of additional accountability requirements Specification of requirements for additional variation in interface Page: 12