Air APIs v6 Release Notes

See the Air Release Notes v11 and v9 for other Air API versions.

• AirSearch
• Fare Family Search
• AirPrice
• AirReservation
• AirTicketing
• Seats

AirSearch API

AirSearch 22.6.21: Internal updates | 8 Sep 2022

Internal updates only.

AirSearch 22.6.20: Internal updates | 28 Jul 2022

Internal updates only.

AirSearch 22.6.19.1: Internal updates | 12 Jul 2022

Internal updates only.

AirSearch 22.6.19: Internal updates | 8 Mar 2022

Internal updates only.

AirSearch 21.6.18: Internal updates | 20 Dec 2022

Internal updates only.

AirSearch 21.6.17: Internal updates | 11 Nov 2021

Internal updates only.

AirSearch 21.6.16: Bound flights defect | 2 Sep 2021

Internal updates.

Known defect: An issue exists with boundFlightsInd mapping on v6 only. In a double connection, if the first flight must be sold with the second flight and the second flight with the third flight, boundFlightsInd is returned only for the first flight. The boundFlightsInd should also be returned for the second flight.

AirSearch 21.6.15: Bound flights indicator update | 5 Aug 2021

Updates the definition of the bound flights indicator (boundFlightsInd) to specify which flights in a single or double connection must be sold together, which results in fewer booking failures. Previously, boundFlightsInd specified which flights in a single or double connection are polled together, which in some instances can cause booking failures.

AirSearch 21.6.14: Defect fix | 24 Jun 2021

Resolved defects in which certain carriers were not being returned for specific PCCs.

AirSearch 21.6.13: Internal updates | 15 Jun 2021

Internal updates only.

AirSearch 21.6.12: Internal updates | 13 May 2021

Internal updates only.

AirSearch 21.6.11: Special characters | 13 May 2021

Adds support for returning special characters in the brand name, such as trademark symbols, in AirSearch and Fare Family Search.

AirSearch 20.6.10: Internal updates

AirSearch 20.6.10 was released 10 Dec 2020 and included only internal updates.

AirSearch 20.6.9: Internal updates

AirSearch 20.6.9 was released 22 Oct 2020 and included only internal updates.

AirSearch 20.6.8: Trace and transaction IDs

AirSearch 20.6.8 was released 27 Aug 2020. It introduced support for separate trace and transaction IDs. These assist in troubleshooting and can help customers who use both the JSON APIs and the SOAP/XML API track transactions across those APIs.

AirSearch 20.6.5: Internal Updates

AirSearch 20.6.5 was released 21 Apr 2020 and included only internal updates.

AirSearch 20.6.4

AirSearch 20.6.4, released 14 Mar 2020, includes the following:

• Minor updates to some of the GDS error messages.
• Support for requesting and returning branded fares for NDC content.
• The AirSearch response implemented different numbering in several identifiers for GDS vs. NDC content. See NDC and GDS Content for a summary.
• AirSearch now returns unique ProductAir id values as follows:

  • For GDS content, the ProductAir id is unique within the response.

  • For NDC content, the ProductAir id is unique within the response.

  • For NDC and GDS aggregated content, the ProductAir id is unique within the NDC offers and unique within the GDS offers.

• Support for displaying brand names as they are listed on the carrier's site, including proper case and any special characters. Brand names are returned in the response in ReferenceListBrand/Brand @name. AirSearch returns the external brand name only in the detail view.

AirSearch 19.6.3: Error Handling Updates

With this release AirSearch returns updated and more user-friendly error messages to support troubleshooting. Updated error messages are supported for GDS content only. Error handling for NDC is separate and enhanced error messaging is under development.

Known Issues:

• If a warning message is returned for the NDC carrier Qantas, the Result object returns an empty message tag.
• For the NDC carrier United Airlines, the AirSearch response returns an empty Result object even when there is no warning message.
• In the AirSearch request, if SearchCriteriaFlight @departureTime is sent and is blank, a code 500 - Internal Service Error is returned.
• At this time AirSearch returns only one error or warning message even if multiple conditions exist. Support for multiple messages will be part of a future release.

AirSearch 19.6.2: Meta Search

AirSearch 19.6.2, released 17 Oct 2019, introduces Meta Search. Meta Search offers these benefits:

• Provides faster response times.
• Targets lowest fare options and those itineraries that are most attractive to leisure travelers.
• Returns a maximum of 50 flights.

To use Meta Search, add the query parameter view=turbo to the AirSearch POST request. Meta Search does not support detail view, brand information, or NDC content.

Known Issues:

• When an AirSearch request specifies a carrier preference for more than one but not all O&D pairs, AirSearch is incorrectly applying the preference to all legs. (GDS only)
• When an AirSearch request specifies a class of service preference for more than one but not all O&D pairs, AirSearch is incorrectly applying the preference to all legs. (GDS only)
• For an AirSearch summary view request with pagination, second and subsequent retrievals return the PriceBreakdown object. The PriceBreakdown object should be returned only when requesting a detail view. (GDS only)

AirSearch 19.6.1: NDC Support, Model Update, Class of Service Request

AirSearch 19.6.1, released 12 Sep 2019, updates to ODM Model 10 v6.

With this release, AirSearch and all Air APIs support searching NDC content on Qantas.

In the request, the PassengerCriteria object has been updated as follows:

• The value attribute has been removed and replaced with the passengerTypeCode attribute.
• Attributes for local citizen fares are now in the TravelerGeographicLocation object. The travelerGeographicLocation attribute has been removed.
• The ClassOfServicePreference object has been added to support requesting class of service at either the leg or itinerary level.
• The CustomerLoyalty object was added; it is supported only for NDC content on Qantas at this time. If sent, the response returns the CustomerLoyaltyCredit object in TermsAndConditions.

In addition, AirSearch adds support for requesting net fares in addition to public and private fares.

Known Issues:

• When an AirSearch request specifies a carrier preference for more than one but not all O&D pairs, AirSearch is incorrectly applying the preference to all legs.
• When an AirSearch request specifies a class of service preference for more than one but not all O&D pairs, AirSearch is incorrectly applying the preference to all legs.
• The AirSearch response is exposing an internal error message about giving a Wrong Carrier Preference Type or Wrong Departure Time.
• When an Air Search request is sent with FareSelection fareType="PublicFaresOnly", the response is not returning fareType="PublicFares" in all offerings.

Fare Family Search API

Fare Family Search 21.6.9: Internal updates | 15 Apr 2021

Internal updates only.

Fare Family Search 21.6.8: Internal updates | 4 Mar 2021

Internal updates only.

Fare Family Search 21.6.7: Trace and transaction IDs, error messaging | 21 Jan 2021

Adds the following:

• Support for separate trace and transaction IDs. These assist in troubleshooting and can help customers who use both the JSON APIs and the SOAP/XML API track transactions across those APIs.

Fare Family Search 20.6.6: Tax breakdown for GDS

Fare Family Search 20.6.6 was released 3 Dec 2020 and added support for returning tax code details for GDS content, in Price/PriceBreakdown/Amount/Taxes/Tax. This tax breakdown was previously returned only for NDC.

Fare Family Search 20.6.5: Support for net fares and interline connections

The 5 Nov 2020 release of Fare Family Search 20.6.5 adds support for the return of interline connections and net fares for both Fare Family Search and Next Leg Search. Supported only for GDS, not NDC.

In addition, the 20.6.5 release adds support for Fare Family Search and Next Leg Search to return fares with multiple fare components, bringing to model v6 the same feature released with 20.9.3 per above.

Fare Family Search 20.6.4

Fare Family Search 20.6.4, released 11 Jul 2020, added support for returning brand attributes for NDC content by default in the Fare Family Search response.

Note: There were no 20.6.2 or 20.6.3 Fare Family Search releases.

Fare Family Search 20.6.1

This 14 Mar 2020 release adds support for the following:

• NDC content on 1G. NDC is supported only for one-way itineraries at this time. See NDC and GDS Content for a summary of differences in how Fare Family Search API handles NDC vs. GDS content.
• Support for displaying brand names as they are listed on the carrier's site, including proper case and any special characters. Brand names are returned in the response in ReferenceListBrand/Brand @name. Fare Family Search only returns a detailed response and always includes the external brand name.

AirPrice API

AirPrice 22.6.9: Internal updates | 8 Sep 2022

Internal updates only.

AirPrice 21.6.7: Internal updates | 23 Jun 2022

Internal updates only.

AirPrice 21.6.6: Internal updates | 24 Jun 2021

Internal updates only.

AirPrice 20.6.5: Internal Updates

AirPrice 20.6.5 was released 10 Dec 2020 and included only internal updates.

AirPrice 20.6.4: Internal Updates

AirPrice 20.6.4 was released Apr 2020 and included only internal updates.

AirPrice 20.6.3: Internal Updates

AirPrice 20.6.3 was released 13 Feb 2020 and included only internal updates.

AirPrice 19.6.2: Price from Fare Family Search

With the availability of the Fare Family Search API, AirPrice releases its support for pricing from a Fare Family Search response from the AirPrice 17 Oct 2019 release.

AirPrice 19.6.1: NDC Support, Model Update, Support for Permitted CabinPreference

AirPrice 19.6.1, released 14 Sep 2019, updates to ODM Model 10 v6. It also provides support for net fares and for using LowFareFinder with a permitted CabinPreference.

With this release, AirPrice and all Air APIs support NDC content on Qantas.

AirReservation API

AirReservation 22.6.10.1: Mandatory DOB for child PTCs | 19 May 2022

Makes date of birth details mandatory in Traveler/dob when adding travelers with any child PTC, including CHD and CNN.

AirReservation 21.6.10: Minimum secure flight | 18 May 2021

Adds support for adding minimum secure flight information that is added to the SSR DOCS shared with carriers. The release also updated several error messages.

AirReservation 21.6.9.3: Defect fix | 8 Apr 2021

Defect fixes:

• Issue that occurred when fare type PublicAndPrivateFares was requested but no account code was included. In this instance, non-account code private fares were omitted in the response. By default, if no fare type is sent, PublicAndPrivateFares is used.
• Issue in which account code restrictions were being set on the fare selections when filters AgencyPrivateFaresOnly or AirlinePrivateFaresOnly were sent.

AirReservation 21.6.9.2: Defect fix

AirReservation 20.6.9.2, released 4 Feb 2021, resolves a defect that prevented booking when combining private and public fares in one offer. Public and private fares can now be added in one offer in the booking workflow.

AirReservation 20.6.9.1: Additional PNR retrieve attempt, defect fix

AirReservation 20.6.9.1 was released 3 Dec 2020 with the following features:  

• Support for an additional attempt to retrieve a PNR when the carrier locator code, or PNR value, is not returned by the carrier during the interval between the commit and returning the PNR. See Carrier Locator Code for details.
• Resolved an issue in which passive segments on NDC bookings were not cancelled when the booking failed for round-trip, open jaw, and multi-city bookings.

Known issues:

• Form of payment details are not returned in the PNR retrieve for an exchanged ticket (ticket exchange functionality not currently available).

AirReservation 20.6.9: Retrieve multiple fax and mobile numbers, fare rules

AirReservation 20.6.9 was released 5 Nov 2020 with the following features:  

• In the PNR Retrieve response, support for multiple mobile and fax phone fields. Each number is returned in a separate Traveler/Telephone object with a role of either Mobile or Fax.
• The third of four iterative efforts to enhance fare rules in the PNR Retrieve has been implemented. With this update, the response now returns all stored/filed fares for each passenger type on the itinerary.

AirReservation 20.6.8: Bound flights indicator, fare rules  

AirReservation 20.6.8 was released 24 Sep 2020 with the following features:

• The indicator boundFlightsInd for bound/married segments, when true, is now returned in the PNR retrieve response, as in the AirSearch and AirPrice responses. This indicator is not returned when false.
• The second of four iterative efforts to enhance fare rules in the PNR Retrieve has been implemented. With this update, the response now returns fare rules for all passenger types and all offers on the itinerary.

AirReservation 20.6.7: Child SSR support, long fare rules in PNR retrieve

AirReservation 20.6.7, released 13 Aug 2020, added support for:

• Support for a child Special Service Request (SSR) for CHLD when the child traveler's date of birth (DOB) information is sent in the request. GDS only.
• On a PNR retrieve, requesting the return of long fare rules for the first offer on an itinerary.

AirReservation 20.6.6: Multiple updates

AirReservation 20.6.6, released 27 Jun 2020, added several updates.

Sending Visa DOCO remarks for PTC INF is now supported. This updates support for DOCO remarks to include all PTC codes.

The release also added support for the following for GDS only:

• Adding and retrieving carrier-specific reservation comments (OSI remarks). Reservation comments can be added either in the initial booking workflow or post-booking.
• Sending the ADT PTC for an adult passenger in the Add Traveler step is now optional. If PTC is omitted, or sent with a null value, AirReservation defaults the PTC to ADT. PTC is returned in the PNR retrieve.
• The PNR Retrieve response returns an additional instance of the ReceiptConfirmation object, which includes the new object OfferStatus. OfferStatus returns confirmation status for each flight on the PNR, including the IATA standard 2-byte status code for the reservation, e.g., HK or XX, and the accompanying enumeration, e.g., holds confirmed or cancelled.
• For connecting flights, the PNR retrieve response includes the connectionDuration attribute in Product/FlightSegment. When returned, connectionDuration lists the length of the connection layover and serves to indicate that two or more flights are bound in a single Product. This update aligns AirReservation with how AirSearch and AirPrice already return Product objects with connecting/bound flights.

• Issues were resolved with adding seats to a ticketed itinerary, and with booking and retrieving ticketless reservations.

AirReservation 20.6.5: Multiple updates

AirReservation 20.6.5, released 21 Apr 2020, added support for the following:

• Adding DOCO SSR remarks for visa information as part of the reservation workflow.
• Adding optional SSR remarks for CTCE (email contact), CTCM (mobile phone contact), and CTCR (contact information refused). GDS only.
• Returning additional flight details, including the IATA three-byte aircraft equipment code and two-byte operating carrier code, in the workbench retrieve step of the reservation workflow and PNR retrieve.

The following are now returned in the PNR retrieve for ticketless carriers Frontier (F9), Spirit (NK), and Sun Country Airlines (SY), for GDS:

• Fare details including total fare, fare remarks, and OSI OTHS remarks.
• The single ticket number for all travelers.

  • Note: In both cases, the PNR includes this information only once it is returned from the airline, which may be delayed for several hours after booking.

Known defects:

• Customers should not enter the frequent traveler number for cross accrual mileage/points on alliance airline carriers. Travelport recommends adding only the main frequent traveler number for each traveler. Otherwise the commit step may return a warning message and require that the reservation process is restarted. A future release will address this issue.

AirReservation 20.6.4.1

This fix updated the Add Traveler step of the booking workflow to add support in Traveler/Telephone @phoneNumber for alphanumeric values instead of only numeric, for example: "phoneNumber": "XYZ 770-555-1111 AB"

AirReservation 20.6.4: Internal features

AirReservation 20.6.4 was released 25 Jan 2020 and included only internal updates.

AirReservation 19.6.3: Parity Support for Pricing Modifiers

This release adds support for displaying OSI and back office remarks in the PNR retrieve response. It also updates parity support for several pricing modifiers for additional providers as follows.

These modifiers are now supported:

• FareSelection @prohibitAdvancePurchaseFaresInd
• PricingModifiersAir @currencyCode
• FareSelection @refundableOnlyInd
• FareSelection @validatingCarrier
• FareSelection @prohibitMinStayFaresInd
• FareSelection @faretype value NetFaresOnly

These modifiers are now supported for Worldspan (1P):

• Price by PTC (specifiedPassengerTypeCodeOnlyInd indicator)
• FareSelection @faretype value NetFaresOnly

AirReservation 19.6.2: Remarks in PNR Retrieve, Multiple One-Way Offers

AirReservation 19.6.2, released 13 Nov 2019, adds the following:

• If general remarks are added in the reservation workflow, those remarks are returned in a PNR retrieve. GDS only.
• For NDC content, the reservation workflow supports multiple Add Offer steps to allow multiple one-way offers to be combined in one PNR.

AirReservation 19.6.1: Model Update

AirReservation 19.6.1, released 19 Sep 2019, updates to ODM Model 10 v6. The booking workflow remains the same; however, offer and traveler information are now returned when a PNR is generated.

This release adds support for canceling a PNR and for viewing terms and conditions when retrieving a PNR.

With this release, AirReservation and all Air APIs support NDC content on Qantas.

AirTicketing APIs

AirTicketing 21.6.16.1: Defect fix | 28 Sep 2021

Resolves a defect that in some cases caused ticketing errors on even exchanges.

AirTicketing 21.6.16: Defect fix | 19 Aug 2021

Resolves a defect that returned an error during ticketing when the traveler surname exceeded 16 characters.

AirTicketing 21.6.15: Defect fixes | 5 Aug 2021

Resolved issue with ticket exchange issuance on QF.

AirTicketing 21.6.14: Internal updates | 20 Jun 2021

Internal updates only.

AirTicketing 21.6.13.2: Defect fix | 18 May 2021

Defect fix for an issue in which the traveler ID was not returned in ticketing for some customers.

AirTicketing 21.6.13.1: Defect fix | 15 Apr 2021

Resolves a defect with a ticket display error.

AirTicketing 21.6.13: Internal updates | 4 Mar 2021

Internal updates only.

AirTicketing 20.6.12.3: Internal updates | 4 Feb 2021

Internal updates only.

AirTicketing 20.6.12, 20.6.12.1, and 20.6.12.2: Internal updates

These AirTicketing Dec 2020 releases included only internal updates.

AirTicketing 20.6.11: Ticket status and multiple fares in PNR Retrieve

AirTicketing 20.6.11 was released 5 Nov 2020 with the same features and defects as the 20.9.4 release; see above for a list.

AirTicketing 20.6.10.1: Internal updates

AirTicketing 20.6.10.1 was released 8 Oct 2020 and included only internal updates.

AirTicketing 20.6.10: Internal updates

AirTicketing 20.6.10 was released 8 Oct 2020 and included only internal updates.

AirTicketing 20.6.9: Defect fixes  

AirTicketing 20.6.9 was released 24 Sep 2020 with the following features:

• Resolves a defect with adding back-office remarks in which the bulk tour information was dropped when commission was added after bulk tour.
• When there is a vendor link error during ticket issuance, in the Result object in the ticket commit response, "Error in Receipt" has been updated to the text "VENDOR MSG: VENDOR LINK DOWN" along with the vendor approval code per the example below. Previously the automated approval code was not returned in the response.

"Result": {
      "Error": [
        {
          "@type": "Error",
          "StatusCode": "400",
          "Message": "VENDOR MSG: VENDOR LINK DOWN - CREDIT APPROVAL OBTAINED - 
               CREDIT CARD NUMBER: XXXXXXXXXXXX0129 AUTH: 092994"   "
        }
      ]
    }

AirTicketing 20.6.8: Return fees in Ticket Commit response

AirTicketing 20.6.8, released 13 Aug 2020, added support for returning OB fees in the Ticket commit response, for GDS only. See the AirPrice API Reference for more about OB fees.

AirTicketing 20.6.7: Carrier comments and defect fix

The 11 Jul 2020 release adds support to return comments from carriers separately instead of as a single block. Comments from the carrier are identified in the PNR Retrieve response by a value of Supplier in ReservationComment @commentSource, and for ticketless carriers the value Ticketless is returned in Comment @name. This release also resolved a defect that caused the Commit transaction response to return a warning message.

Note: There was no 20.6.6 release.

AirTicketing 20.6.5: Multiple updates

AirTicketing 20.6.5, released 23 Apr 2020, added support for the following:

• Adding multiple forms of payment in the reservation workflow or after booking.
• Returning fee details in the Commit response when booking an NDC itinerary in the hold and pay and instant pay booking flows.
• If an approval code is available for a form of payment, that approval code is returned in the new PaymentCard @approvalCode attribute in the retrieve workbench and commit steps of the reservation flow, and in the PNR retrieve.
• Returning price details in the Commit response.
• Returning the city of origin to the Ticket Display response in AgencyInfo @ticketingcity.

In addition this release resolved a defect in the Ticket Display response in which the INF ticket tax details were not returned for some tickets.

AirTicketing 20.6.4.2: Update to TicketDisplay response

AirReservation 20.6.4.2, released 5 Mar 2020, modified the TicketDisplay response to return a TicketID type of TicketDetail instead of TicketDetailEligibility, remove the FareInfo object, and other minor changes.

AirTicketing 20.6.4.1: Return ticket designator in Ticket Display response for 1G

AirReservation 20.6.4.1, released 25 Jan 2020, added support for returning the ticket designator in the Ticket Display response in the FlightProduct @fareBasisCode attribute.

AirTicketing 19.6.4: Tour Code and Remarks in PNR and Ticket Display Responses

AirReservation 19.6.4, released 21 Dec 2019, adds support for:

• Displaying tour code in the ticket display response. GDS only.
• Displaying OSI and back office remarks in the PNR retrieve response. GDS only.

AirTicketing 19.6.3: Accounting Remarks

AirReservation 19.6.3, released 21 Nov 2019, adds support for Accounting back office remarks.

AirTicketing 19.6.1: Model Update and Minor Changes

AirTicketing 19.6.1, released 12 Oct 2019, updates to ODM Model 10 v6. It also includes the following minor updates:

• Support on Worldspan (1P) for the following; both are already supported for Worldspan (1P):
  • Linking form of payment with a fare when adding form of payment.
  • Detailed reservation response when committing transaction.
• Adds the country code to ticket display with the new ticketingCountry attribute in TermsAndConditions/AgencyInfo.
• Includes the ticket number and form of payment in the PNR retrieve response for a ticketed itinerary.

Seats

Seats 21.6.5: Internal updates | 15 Apr 2021

Internal updates only.

Seats 20.6.4: Internal updates

Seats 20.6.4 was released 17 Dec 2020 and included only internal updates.

Seats 20.6.3: Internal updates

Seats 20.6.3 was released 11 Jul 2020 and included only internal updates.

Seats 20.6.2.1: Internal updates

Seats 20.6.2.1 was released 23 May 2020 and included only internal updates.

Seats 20.6.3

The Seats 20.6.3 release added support for requesting seat availability and booking seats on an existing NDC reservation.

Seats 20.6.2

The Seats 20.6.2 release supported requesting seat availability and booking seats for GDS itineraries as part of the initial reservation workflow. 

Seats 20.6.1

The Seats 20.6.1 release supported seat availability and booking seats for NDC itineraries as part of the initial reservation workflow.