Air APIs v9 Release Notes

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

See Schema Retirement for details on supported versions.

AirSearch API

AirSearch 22.9.18: Internal updates | 17 Nov 2022

Internal updates only.

AirSearch 22.9.17: Internal updates | 8 Sep 2022

Internal updates only.

AirSearch 22.9.16: Internal updates | 28 Jul 2022

Internal updates only.

AirSearch 21.9.12 through 22.9.15: Internal updates | Oct 2021 - May 2022

Internal updates only. 

AirSearch 21.9.11: Bound flights indicator update | 19 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.9.10: Defect fix | 15 Jun 2021

Resolved a defect in which carrier JetBlue was not being returned for a specific PCC.

AirSearch 21.9.9: Commissions | 27 May 2021

Adds support for returning commissions when filed by the airline. GDS only.

AirSearch 21.9.8: 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 21.9.7: Internal updates | 3 Apr 2021

Internal updates only.

AirSearch 21.9.6: Internal updates | 4 Mar 2021

Internal updates only.

AirSearch 21.9.5: Internal updates | 18 Feb 2021

Internal updates only.

AirSearch 20.9.4: Specified brand features in request

AirSearch 20.9.4 was released 17 Dec 2020. It adds support for requesting only fares with specified brand features included in the price of the fare, using the new search modifier ProductInclusionPreference. Supported only for GDS.

AirSearch 20.9.3: United Airlines NDC ancillary bundles

AirSearch 20.9.3 was released 5 Nov 2020. It included internal updates and added support for United Airlines air ancillary bundles (air fare and ancillaries together) at the product level.

AirSearch 20.9.2: Trace and transaction IDs, defect fixes

AirSearch 20.9.2 was released 24 Sep 2020 with the following features:

  • Support on model 9 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.
  • Fixes for issues on model 9 in which an incorrect fare basis code and/or incorrect baggage allowance was sometimes returned for PTCs other than ADT.
  • Addition of the AllFares value to the fareType search modifier, supporting the return of all public and private fare offers and net fare offers in one request.

This release also resolved a defect in which AirSearch returned an empty Result object in CatalogOfferingsResponse when no Warning message was returned by NDC carrier UA.

AirSearch 20.9.1: Model upgrade, availability source indicator, dual PCC search

AirSearch 20.9.1 was released 27 Jun 2020. It updates to ODM model 10 v9; a complete list of code changes is summarized in the Code Changes Summary dropdown below.

Other features include:

  • Addition of an availability source code to the detailed response to aid in troubleshooting.
  • Dual PCC Search: This feature returns a TicketingAgency object in the response that identifies the PCC of the ticketing agency when different from the faring agency.

The following changes were made with this release.

AirSearch response:

CatalogAir object

  1. ReferenceListFlight/Flight > AvailabilitySourceCode object added
    • Optional, No repeat
    • Enumerated values: A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, S, T, U, X, Y, Z
  2. TermsAndConditions_Air > TicketingAgency object added
  • Optional, Repeat x10
  • Code object
    • Type: PseudoCityCode
    • Min length: 2 / Max length: 10
    • Mandatory, No repeat
  • ProductRef object
    • Type: ProductID
    • Optional, Repeat x30
  • SegmentSequenceList object
    • Type: SegmentSequenceList
    • Optional, No repeat

CatalogOfferingsResponse object

  1. AncillaryOffering object added
  • Optional
  • Repeat x100
  • productRefs attribute
    • Type: IDREFS (example UAp1, UAp2, etc.)
    • Optional
  • id (attribute)
    • Type: ID
    • Optional
  • ProductOptions object
    • Type: ProductOptions
    • Required
    • Repeat x10
  • sequence (attribute)
    • Type: NonnegativeInteger
    • Optional
  • ProductAncillary object
    • Optional
  • id attribute
    • Optional
  • Quantity object
    • Type: positiveInteger
    • Optional
    • Total Digits: 2
  • AncillaryAir object
    • Optional
  • quantity attribute
    • Type: NumberDoubleDigit
    • Optional
    • Total Digits: 2
  • Description object
    • Type: AncillaryDescription
    • Repeat x10
    • Mandatory
  • code attribute
    • Type: StringUpperCaseAlphaNumericMax10
    • Optional
    • Min length: 0 / Max length: 10
  • subCode attribute
    • Type: StringUpperCaseAlphaNumericMax10
    • Optional
    • Min length: 0 / Max length: 10
  • Price object
    • Type: Price
    • Required, No repeat
    • Base object
      • Type: Decimal
      • Optional, No repeat
    • TotalTaxes object
      • Type: Decimal
      • Optional, No repeat
    • TotalFees object
      • Type: Decimal
      • Optional, No repeat
    • TotalPrice object
      • Type: Decimal
      • Optional, No repeat

BrandClassification ENUM

  • in the AirSearch response, added SeatAssignment, PersonalItem, PremiumSeat, LieFlatSeat to the enumerated values in BrandAttribute/@classification
    • v9 returns the seats value for BrandAttribute/@classification with SeatAssignment instead of the v6 value Seats
    • The other three new classifications will not be returned in the AirSearch response until a future release.

FareRuleInfo_Structured/StructuredFareRules/Penalties

  • Renamed Refund object to Cancel
  • Added Penalty element to Cancel and Change objects
    • Required
    • No repeat
  • Added higherPenaltyAppliesInd (indicator) to Cancel and Change objects
    • Optional
  • Cancellation and Change penalties will not be returned in the AirSearch response until a future release.

CommissionChoice

  • AmountPercent renamed
  • Commission alias added
  • Penalty alias added
  • AirSearch does not return commission

 

Fare Family Search API

The Fare Family Search and Next Leg Search APIs have been deprecated as of March 2022. Contact your Travelport representative with any questions.

Fare Family Search 21.9.11: Internal updates | 28 Oct 2021

Internal updates only. 

Fare Family Search 21.9.10: Bound flights indicator update | 2 Sep 2021

For Fare Family and Next Leg Search, 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.

Fare Family Search 21.9.9: Internal updates | 19 Aug 2021

Internal updates only.

Fare Family Search 21.9.8: Commissions | 22 Jul 2021

Adds support for returning commissions in the Fare Family and Next Leg Search responses when filed by the airline. GDS only.

Fare Family Search 21.9.7: Internal updates | 4 Mar 2021

Internal updates only.

Fare Family Search 21.9.6: Trace and transaction IDs, Search Control Console, error messaging | 21 Jan 2021

Adds the following for Fare Family Search and Next Leg Search:

  • Support for the Search Control Console, previously supported only for AirSearch. Note that the Fare Family Search APIs send SCC details in the request header, not as a query parameter as does AirSearch. SCC is supported only for GDS.
  • 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.
  • Updates to the Fare Family Search Error Messages.

Fare Family Search 20.9.5: Tax breakdown for GDS, request fares with specified brand features

Fare Family Search 20.9.5 was released 3 Dec 2020 and added support in both Fare Family Search and Next Leg Search for the following:

  • Returning tax code details for GDS content, in Price/PriceBreakdown/Amount/Taxes/Tax. This tax breakdown was previously returned only for NDC.
  • New feature to request only fares with specified brand attributes, using the new search modifier ProductInclusionPreference. Supported only for GDS.

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

The 5 Nov 2020 release of Fare Family Search 20.9.4 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.

Fare Family Search 20.9.3: Support for multi-component fares

Fare Family Search 20.9.3, released 22 Oct 2020, enhances both Fare Family Search and Next Leg Search to return fares with multiple fare components. Previously, only single component fares were returned even if lower, multi-component fares were available.

The following known issue applies to this release:

  • Fare Family Search fails for NDC requests that use modifiers.

Fare Family Search 20.9.2: Internal updates

Fare Family Search 20.9.2 was released 27 Aug 2020 and included only internal updates.

Fare Family Search 20.9.1: Model upgrade, additional NDC support

Fare Family Search 20.9.1, released 28 Jul 2020, updates to ODM model 10 v9. The model 9 changes include:

  • In CatalogProductOffering, a new ProductBrandOptions object groups the products for that leg of the itinerary. ProductBrandOptions includes up to five instances of ProductBrandOffering, which return the base fare plus up to four upsells. Each instance of ProductBrandOffering contains Price, Brand, Product (a product reference), and TermsAndConditions for one offer on that leg of the flight.

Other features in this release include support for NDC content on round-trip itineraries in Fare Family Search, and for NDC content in Next Leg Search. This feature will enable base and upsell QF NDC offers for Fare Family Search round trips (two O&D) using QF combinability rules and next leg functionality.

The following model changes were made with this upgrade.

Fare Family Search response:

CatalogProductOffering object:

  1. The object ProductBrandOptions was added to CatalogProductOffering.
  2. ProductBrandOptions includes the new object ProductBrandOffering. Each instance of ProductBrandOptions applies to one leg of the itinerary 
  3. The objects ProductBrandOffering and Product were removed from CatalogProductOffering.

AirPrice API

AirPrice 21.9.9: Internal updates | 23 Jun 2022

Internal updates only.

AirPrice 21.9.8: Internal updates | 22 Jul 2021

Internal updates only.

AirPrice 21.9.7: Internal updates | 29 Apr 2021

Internal updates only.

AirPrice 21.9.6: Internal updates | 4 Mar 2021

Internal updates only.

AirPrice 21.9.5: Fare Family Search price support | 21 Jan 2021

Adds support for booking an itinerary from either Fare Family Search or Next Leg Search without pricing; customers can now book directly after the search.

AirPrice 20.9.4: Next Leg Search round-trips

AirPrice 20.9.4 was released 17 Dec 2020. It added support for pricing round-trip itineraries from Next Leg Search. Previously, pricing for Fare Family Search itineraries was limited to one-way itineraries

AirPrice 20.9.3: Internal updates

AirPrice 20.9.3 and included only internal updates.

AirPrice 20.9.2: Internal updates

AirPrice 20.9.2 was released 27 Aug 2020. At this time its features are internal only and no customer action is required.

AirPrice 20.9.1: Model update

AirPrice 20.9.1, released 23 Jul 2020, updates to ODM model 10 v9.

Other features include support on model v9 only for:

  • Requesting structured fare rules in the pricing request. The response returns structured fare rules for categories 5, 6, 7, 8, and 16.
  • A new full brand details price request to return rich content and full brand details as a follow-on to a brand pricing request.

The following code changes were made with this release.

AirPrice request:

The PassengerCriteria @value attribute changed to @passengerTypeCode.

AirPrice response:

The name of the wrapper object for the AirPrice response has changed from OfferResponse to OfferListResponse.

AirReservation API

AirReservation 22.9.7.2: 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.9.7.1: Defect fix | 5 Aug 2021

Resolves a defect that was causing a PNR retrieve error message on v9.

AirReservation 21.9.7: Internal updates | 27 Jun 2021

Internal updates only.

AirReservation 21.9.6: Internal updates | 15 Apr 2021

Internal updates only.

AirReservation 21.9.5.1 & .2: Defect fixes | 13 Mar 2021

Defect fixes:

  • Fix for an issue in which private fares that weren't specific to an account code were omitted when both public and private fares were requested.
  • Fix for account code issues when only agency private fares or only airline private fares were requested.
  • Fix for an error when committing traveler information with an email address that included a hyphen.
  • Fix for a rare issue that caused form of payment information to be erased.
  • Fix for book failures due to issues with cached data.

AirReservation 21.9.5: Enhanced traveler booking; defect fix; internal identifiers | 21 Jan 2021

Added the following features:

  • Enhanced booking workflow to fully support adding a traveler before an offer or vice versa, and additional support for adding traveler information. Previously, if invalid SSR information was added during the Add Traveler step, the add traveler request would fail at commit. With 21.9.5 and later, the invalid SSR information will not be added, but the Add Traveler step will succeed, adding the traveler but returning an appropriate warning message about the invalid information.
  • Added a transaction ID for the following transactions in the booking workflow; intended only for improved handling at Travelport: create workbench, add offer, add traveler, add FOP, add payment, commit, and all PNR retrieves. These identifiers have no customer purpose at this time.
  • Resolves a defect in which passive segments were not properly cancelled for NDC bookings that failed on round-trip/multi-city/open-jaw itineraries.

AirReservation 20.9.4: Additional PNR retrieve attempt, support for multiple phone fields, LCC support

AirReservation 20.9.4 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.
  • 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.
  • Internal changes to support booking on Indigo (6E) and other low cost carriers (LCCs). No customer change is required to book on these carriers.

Note: There was no 20.9.3 release.

AirReservation 20.9.2: Bound flights indicator, fare rules, SSR support for disabilities, defect fix  

AirReservation 20.9.2 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.
  • Support for adding SSRs for disabilities for 1G GDS content.
  • Fixes a defect in which the PNR Retrieve may fail for certain carriers when a wheelchair was requested with a measurement.

AirReservation 20.9.1: Model update, minor changes

AirReservation 20.9.1, released 28 Jul 2020, updates to ODM model 10 v9. Changes include the following:

  • In the PrimaryContact payload for sending remarks, the travelerRef attribute has been updated to a TravelerIdentifier object.
  • In the PNR Retrieve response for a ticketed itinerary, ticketing information is returned in an instance of Receipt with @type ReceiptPayment, which includes a Document object with ticket number in Number.
  • The Cancel PNR response has been updated. ConfirmationLocator and StatusDetail were removed and the Cancellation object was added.
  • In the AirReservation workflow, in responses that returned the OfferResponse wrapper object, OfferResponse has been renamed OfferListResponse. Offer has been renamed OfferID.

The following model changes were made with this upgrade.

Add Offer response

OfferResponse (object):

  • The name of the OfferResponse object was changed to OfferListResponse.
Primary Contact request

TravelerIdentifier (object):

  1. In the request to add an SSR/Primary contact remark, the travelerRef attribute for sending the traveler identifier changed from a string in v6 to a separate model object:
    1. The TravelerIdentifier object was added.
    2. TravelerIdentifier contains the object Identifier.
    3. Identifier has the attribute value for sending the traveler identifier.
PNR Retrieve response

Retrieve object:

  1. Added @type ReceiptPayment to return ticketing information.

  2. Instances of @type ReceiptPayment have new Document object:

    • Type: Document
    • Number: the ticket number
    • Added TravelerRef: Trav_1

  3. Removed ConfirmationStatusEnum

  4. Removed Ticket

  5. Removed PersonName

PNR Cancel Response

ReceiptID (object):

  1. The ConfirmationLocator and StatusDetail objects were removed.
  2. The Cancellation object was added:
    1. Includes the Locator object with the following attributes:
      1. type
      2. source
      3. sourceContext
      4. value

AirTicketing APIs

AirTicketing 21.9.7: Defect fix | 27 Jul 2021

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

AirTicketing 21.9.6.1: Defect fix | 15 Apr 2021

Resolved a defect in which responses were not being logged for all ticketing services.

AirTicketing 21.9.6: Defect fixes | 18 Mar 2021

Enhanced support for adding the traveler before the offer as part of the booking workflow.

AirTicketing 21.9.5: Internal updates | 4 Mar 2021

Internal updates only.

AirTicketing 20.9.4.1: Defect fixes | 4 Feb 2021

Defect fixes:

  • Ticket Display request failed when PNR record locator contains 1G
  • Segment reference issues in remarks for AA, QF, SQ airlines
  • Cancel PNR did not remove the segments from a passive booking

Seats

Seats 21.9.4: Internal updates | 20 Jun 2021

Internal updates only.

Seats 21.9.3: Transaction and trace IDs, improved error messaging | 15 Apr 2021

Adds the following updates:

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

  • Seat book response for GDS returns an Offer object with @type OfferIdentifier

  • Enhanced seat error responses to provide more meaningful error messages and HTTP status codes

Seats 21.9.2: Paid Seats | 18 Feb 2021

Adds support for returning paid seats in the Seat Map response. Booking paid seats will be supported in model v11 through the ancillary booking feature when available.

Seats 20.9.1: Model upgrade, support for multiple segments in request

Seats 20.9.1, released 28 Jul 2020, updates to ODM model v9. It added support for multiple segments in one request for seat map and for seat book, for GDS only. The following code changes were made: 

  • The Seat Map request changed from a GET request to a POST request with a payload.
  • The structure of the Seat Map response was updated.

The model changes for Seats v9 were extensive and include new structures for both the request and response. See the Seats v9 API Reference for a complete listing.

Exchange APIs

Exchange APIs prior to model v11 (releases before 21.11.1) are no longer supported.