Archived Release Notes

Below are archived release notes for previous years' releases of the Travelport JSON Air APIs, covering releases on model 11 from 2021-2024. These include all releases numbered starting 21.11.x through 24.11.x.

Minor versions (2x.11.x.y) are listed only when they provide customer-facing functionality.

For current year releases see Release Notes.

See Schema Retirement for details on supported versions. Version numbering uses this format:
{year of release}.{model and thus major version of release}.{minor version of release}

General Functionality

JSON APIs: PCC in header | Ongoing 2024

Ongoing releases in 2024 support sending the PCC in the header as an alternative to sending the access group. See Common Air Headers for a current list of the APIs that have been updated to use the new TVP-PCC-CORE header field.

JSON APIs: Error messaging updates | 27 Jun 2024

This release supports comprehensive error handling across all JSON APIs to return consistent error messages for all content, including GDS and NDC, across all JSON APIs. See Error Messaging for a description of the updates and a list of all error messages returned across the JSON APIs.

General NDC

Deployments of NDC functionality are generally included in one of the API-specific releases detailed below. More general NDC updates follow.

NDC Ticket Cancel: Refund Quote mandatory for ticket cancel outside void | 18 Nov 2024

Refund Quote has been made a mandatory step when canceling a ticket outside the void period if the value of any potential refund is different from the purchase price. If Refund Quote is not sent, and there is not an available refund in the exact amount of the purchase price, Order Cancel returns the error message OFFER CANNOT BE CANCELED WHEN REFUND AMOUNT DOES NOT EQUAL OFFER PRICE. PERFORM A REFUND QUOTE AND TRY AGAIN.

Search API

Search 24.11.48.3: Carrier/alliance preference at leg level | 4 Dec 2024

Adds support to the Search request for applying carrier/alliance preferences at the leg level by sending legSequence in CarrierPreference.

Search 24.11.47.3: Sorting | 4 Dec 2024

Adds the sortBy object to the Search request. Send with the value Price-LowToHigh to sort the offers by the value in BestCombinablePrice/TotalPrice from lowest to highest price.

Search 24.11.47: Internal | 2 Oct 2024

Internal updates only.

Search 24.11.46.4: RouteHappy flight amenities | 25 Sep 2024

Adds support for requesting and returning additional flight amenities, provided by ATPCO as RouteHappy data. Adds the new indicator includeFlightAmenitiesInd to CustomResponseModifiersAir in the request for Search, Next Leg Search, and Flight Specific Search full and reference payloads. Send with true to return RouteHappy flight amenities. When requested, the response lists available amenities in the new ReferenceListAmenity object. For each flight, a new amenityRefs object in ReferenceListProduct\Product\FlightSegment lists ids for the amenities on that flight, which cross-reference to ids in ReferenceListAmenity\Amenity\id. Several categories of amenities may be returned, including beverages, food, wi-fi, entertainment, and power.

Search 24.11.46.3: Modifiers for tax exempt, increase/decrease fare | 18 Sep 2024

Adds the following pricing modifiers to the PricingModifiersAir object in the Search, Next Leg Search, and Flight Specific full and reference payload requests; GDS only; not supported for NDC:

  • ManualFareAdjustment supports adjusting the base fare amount. Fares can be increased or decreased by either an amount or a percentage.

  • TaxExemption marks specific taxes as tax exempt. TaxExemption can mark all taxes in all offers as exempt, or can send a list of either or both country codes or tax codes to mark as exempt. TaxExemption supports up to nine specific values for countries, or for tax codes, or for countries and tax codes combined. When TaxExemption is sent, for any exempt tax, the response returns the indicator exemptInd as true and returns the tax value as 0.

Adds the validating airline code to the baggage allowance information returned in the Search response, in TermsAndConditionsAir, BaggageAllowanceDetail.

Search 24.11.46.1: Tour codes | 4 Sep 2024

Adds the TourCodes object to ReferenceListTermsAndConditions/TermsAndConditions in the Search, Next Leg Search, and Flight Specific Search responses for tour code fares. GDS only; not supported for NDC.

Search 24.11.46: Internal | 28 Aug 2024

Internal updates only.

Search 24.11.45.2: Model update | 7 Aug 2024

Updates all Search APIs (Search, Next Leg Search, Flight Specific Search full and reference payloads) to version 11.17 of the OD Model with the following changes; these updates are not yet in use and will be used with future functionality.

Adds the following to the request:

  • Update CustomResponseModifiersAir

    • new includeFlightAmenitiesInd

    • optional

    • description: If true, flight amenities will be included in the response

  • Update ContentSourceEnum

    • add “API”

    • description: API connected carriers, LCC’s and other API (non-NDC)

  • New enum SortByEnum

    • Price-LowToHigh

    • Update BuildOptions_FromProducts

  • Add attribute sortBy

    • type: SortByEnum

    • optional

  • Update CatalogProductOfferingsRequest_Air

    • Add attribute sortBy

    • type: SortByEnum

    • optional

  • New choice object ManualFareAdjustment

    • contains attribute passengerTypeCodes

    • type: passengerTypeCodeList

    • optional

    • Description: A list of PTCs to apply this adjustment to

    • choice facet Increase

    • element AmountPercent

    • required

    • Description: The amount or percent the fare should be increased by

    • choice facet “Discount”

    • element “AmountPercent”

    • required

    • Description: The amount or percent the fare should be discounted by

  • Add ManualFareAdjustment to PricingModifiersAir

    • optional

    • repeat x 10

Makes the following changes to the response:

  • Update FlightProduct

    • attribute amenityRef

    • type; IDRefs

    • optional

    • description: A list of amenity refs included on this flight

  • New custom facet ReferenceList_Amenity

    • Amenity

    • required

    • repeat x 1000

    • New core object “Amenity”

    • id

    • attribute

    • type: xsd:ID

    • required

    • description: A unique amenity id used for referencing

    • Category

    • type: stringShort

    • required

    • description: The amenity category

    • Text

    • type: AmenityText

    • optional

    • description: Descriptive text of the amenity

    • Under Text

    • value

    • string

    • attribute language

    • type: language

    • optional

  • Update BaggageAllowance

    • add attribute validatingAirlineCode

    • type: AirlineCode

    • optional

    • Example: BA

Search 24.11.45.1: excludeUnbundledFaresInd | 31 Jul 2024

Adds support for excludeUnbundledFaresInd to the Flight Specific Search full payload request. This indicator is used to request that unbundled fares are excluded from the response. Previously, excludeUnbundledFaresInd was supported only for Search and Next Leg Search, and the Flight Specific Search reference payload request.

Search 24.11.44.3: Credit card OB fees | 17 Jul 2024

This release adds support for sending a BIN number for credit card FOP airline fees, also called F-type fees, in the Search, Next Leg Search, and Flight Specific Search requests. These payloads now support sending PaymentCriteria/IssuerIdentificationNumber with the eight-digit BIN number. Any applicable fees are returned in BestCombinablePrice/PriceBreakdown/Amount/Fees/Fee. Previously, PaymentCriteria could be sent only at pricing. GDS only; not supported for NDC.

Search 24.11.44: Internal | 19 Jun 2024

Internal updates only.

Search 24.11.43.1: Model update | 6 Jun 2024

Adds support for additional string values in FareQualiferString in PricingModifiersAir/FareSelection to support additional private fares for carriers AF/KLM and BA.

Makes the following updates for v11.16 of the ODM model. These updates are not in use yet and will be used with future functionality:

Update to TermsAndConditionsAir:

  • TourCodes

  • repeat x 10

Update to SponsoredProductBrandOptions:

  • Change ProductBrandOffering array from 100 to 5

Updates to productBrandOffering:

  • Add attribute “adID”

    • Type: stringTiny

    • Description: The advertisement ID for the sponsored offering

  • Add attribute “sponsoredOfferingPositionNumber”

    • Type: numberdoubleDigit

    • Description: The display position of the sponsored offering.

Search 24.11.43: Internal updates | 23 May 2024

Internal updates only.

Search 24.11.42.1: Error handling updates | 2 May 2024

As part of a multi-phase update to JSON API error handling, this release updates the Search, Next Leg Search, and Flight Specific Search APIs to return the following in the Result/Error object for any communication error:

  • StatusCode: 200

  • Message: COMMUNICATION ERROR

  • SourceCode: 2599

  • SourceID:

    • For GDS, returns the value 1G.

    • For NDC content, returns the carrier code for the NDC airline.

Search 24.11.42: Internal updates | 25 Apr 2024

Internal updates only.

Search 24.11.41: Internal updates | 28 Mar 2024

Internal updates only.

Search 24.11.40.4: operatingCarrierNumber | 21 March 2024

Adds the object operatingCarrierNumber to ReferenceListFlight/Flight to improve matching logic for CO2 emissions data for operating carriers. If there is no operating carrier number, then CO2 emission estimates for operating carriers is not supported. GDS only; not returned for NDC.

Search 24.11.40.3: Search by connection preferences | 14 Mar 2024

Adds the new modifier SearchModifiersAir/ConnectionPreferences to the Search request to search by connection preferences. GDS only; not supported for NDC.

Search 24.11.40: Structured fares for NDC after Search | 21 Feb 2024

Adds support for returning structured fare rules for NDC with a Fare Rules request after Search. Supported only for Penalties. Previously, structured fare rules after Search could be requested only for GDS.

Search 24.11.39: Internal | 1 Feb 2024

Internal updates only.

Search 24.11.38: PCC in header | 1 Feb 2024

Adds the new header field TVP-PCC-CORE to all search APIs. TVP-PCC-CORE supports sending the PCC for authentication as an alternative to sending the access group.

Search 23.11.37: Internal updates | 13 Dec 2023

Internal updates only.

Search 23.11.36: CO2 emissions data | 29 Nov 2023

Adds support for requesting and returning CO2 emissions data in search responses. Adds the following new objects:

  • In the request, the new indicator includeCo2EmissionsDataInd in CustomResponseModifiersAir. Send with true to return CO2 emissions data.

  • CO2EmissionsData In ProductBrandOffering, which returns the actual and typical CO2 emissions for the flight/s on the product (one leg of the itinerary).

  • Co2Actual to ReferenceListProduct/Product/FlightSegment, which returns the actual carbon emissions for a specific flight.

If CO2 data is not available for a flight or route, only available data is returned and the above objects may be returned blank. CO2 data is not returned for non-flight segments (equipment codes BUS, HOV, LCH, LMO, TRN, TRS).

Known limitations to be addressed in future releases:

  • Actual CO2 emissions data for a non-stop flight is returned for direct flights that have one ore more intermediate stops.

  • Actual CO2 emissions data might not be returned when the marketing carrier flight is operated by another carrier.

  • Typical CO2 emissions data is not returned when the cabin is different between connecting flights.

CustomResponseModifiersAir

  • Update "excludeCo2EmissionsDataInd" to " "includeCo2EmissionsDataInd"

  • Update description to state: "if true, Co2 emissions data will be included in the response"

CO2EmissionsData added to ProductBrandOffering

  • Actual element

    • Assigned Type=Measurement

    • Optional

    • Description=The actual carbon emissions for this route

    • Attributes:

      • value

        • Assigned Type=decimal

        • Optional

        • Description=Used for dimensional units (width, height, depth) or weight

      • measurementType

        • Assigned Type=MeasurementTypeEnum

        • Optional

        • Description=The type of measurement, such as width, height, weight

      • unit

        • Assigned Type=UnitOfMeasureEnum

        • Optional

        • Description=The unit that applies to the amount, such as feet, meters, pounds

  • Typical element

    • Assigned Type=Measurement

    • Optional

    • Description=The typical carbon emissions for this route

    • Attributes:

      • value

        • Assigned Type=decimal

        • Optional

        • Description=Used for dimensional units (width, height, depth) or weight

      • measurementType

        • Assigned Type=MeasurementTypeEnum

        • Optional

        • Description=The type of measurement, such as width, height, weight

      • unit

        • Assigned Type=UnitOfMeasureEnum

        • Optional

        • Description=The unit that applies to the amount, such as feet, meters, pounds

  • Variance element

    • Assigned Type=integer

    • Optional

    • Description=The variance of CO2 emission from the typical emission value represented as a percent. If positive the CO2 emission is higher than the industry average. If negative

 

Co2Actual added to FlightSegment

  • Actual element

    • Assigned Type=Measurement

    • Optional

    • Description=The actual Co2 Emission for this flight segment

    • Attributes:

      • value

        • Assigned Type=decimal

        • Optional

        • Description=Used for dimensional units (width, height, depth) or weight

      • measurementType

        • Assigned Type=MeasurementTypeEnum

        • Optional

        • Description=The type of measurement, such as width, height, weight

      • unit

        • Assigned Type=UnitOfMeasureEnum

        • Optional

        • Description=The unit that applies to the amount, such as feet, meters, pounds

Search 23.11.5.2: Split ticketing searches and CCL general availability | 1 Nov 2023

The Content Curation Layer (CCL) feature introduced in Search 23.11.31, available at that time only to customers specifically provisioned for CCL, moves to general availability. The search response for all customers now merges duplicate GDS and NDC offers and removes the duplicated offers. This release adds support for opting out of this duplication removal feature; contact your Travelport representative if you would like to opt out.

Adds support for searching for split ticketing itineraries. Split ticketing allows you to book a roundtrip ticket by sending two separate pricing solutions in one booking request. In other words, a split ticket has two separate one-way reservations instead of a single round-trip reservation. Split ticketing may offer a lower price or better options than booking those same flights as a single round-trip ticket. Prior to this release, you had to search for two itineraries, one for the outbound itinerary and the other for the inbound itinerary. Adds the following to PricingModifiersAir:

  • New indicator includeSplitPaymentInd: Boolean. Set to true to return split ticketing offers.

  • New object SplitPaymentOfferings: Percent. Optional object to specify a percentage of round trip offers to return in the results. These round trip offers are not split ticket results. By default, when split ticketing is requested, 34% of the search results are for round-trip offerings. Send a percentage value in this object to change that default.

Your PCC must be provisioned for split ticketing; contact your Travelport representative if you need assistance. GDS only; not supported for NDC.
At this time split ticketing is available only in the Search API, and only for customers specifically provisioned for split ticketing. Split ticket itineraries cannot yet be priced, booked, or ticketed.

Search 23.11.35: Internal updates | 11 Oct 2023

Internal updates only.

Search 23.11.34: Search by arrival time range, model update | 28 Sep 2023

Adds the following objects to the SearchCriteriaFlight object in the Search and Next Leg Search requests to support searching for flights by an arrival time, or within an arrival time window; GDS only, not supported for NDC:

  • ArrivalTime: Specify an arrival time to search for flights arriving at the destination close to that time.

  • ArrivalTimeRange: Includes start and end objects to specify an arrival time range to search for flights arriving at destination within that window.

Updates to model v11.11 and adds the following to the model. Not all functionality implied in these objects is yet supported in Search; upcoming functionality will be noted on this page as it is released.

Add CustomResponseModifiersAir

  • Type: CustomResponseModifiersAir

  • Description: Allows user to customize the search response

  • Optional

 

CustomResponseModifiersAir

  • Update "excludeCo2EmissionsDataInd" to " "includeCo2EmissionsDataInd"

  • Update description to state: "if true, Co2 emissions data will be included in the response"

 

SearchRepresentation

  • Update SearchRepresentationENUM

  • Add LegWithJourneyData

 

Flight

  • Add attribute "operatingCarrierNumber"

  • type: FlightNumber

  • Optional

  • Description: The operating carrier flight number

 

PricingModifiersAir

New choice object "CalculatedFareAdjustment"

 

New choice facet "Discount" contributed to "CalculatedFareAdjustment"

  • element "AmountPercent"

  • type: AmountPercent

  • required

  • Description: The Amount or Percent the fare will be discounted by

 

New choice facet "Increase" contributed to "CalculatedFareAdjustment"

  • element "AmountPercent"

  • type: AmountPercent

  • required

  • Description: The Amount or Percent the fare will be increased by. Only increase by Amount is supported at this time.

 

Add CalculatedFareAdjustment

  • type: CalculatedFareAdjustment

  • optional

  • Description: Allows user to increase or decrease the fares by an amount or percent

 

CabinPreference

Update "CabinPreferenceENUM"

  • Add value "Prohibited"

  • Description: The specified cabins are prohibited

 

Brand

  • Add attribute "code"

  • type: stringTiny

  • Description: The ATPCO Brand Code

Search 23.11.33: Return ticket designator, short text fare rules for NDC | 7 Sep 2023

Adds support for the following:

  • Caching short text fare rules for an NDC offer to support returning those fare rules with Standalone Fare Rules for NDC after Search and before pricing. Previously supported only for GDS.

  • Returning a ticket designator for GDS in the object ReferenceList/Product/PassengerFlight/FlightProduct/ticketDesignator. The ticket designator is a code used by airlines to indicate the type of discount applied to a fare. An airline may have a specific ticket designator used to differentiate its fares, which may also signify anything from private fares, wholesale, promotion, or discounted fares. GDS only; not returned for NDC. Ticket designators are already returned for NDC in FlightProduct/fareBasisCode by appending a slash (/) and the ticket designator after the fare basis code.

Search 23.11.32: Return only fares for a specific account code | 24 Aug 2023

Adds support for a new indicator, accountCodeFaresOnlyInd, to limit the fares returned to only fares filed for that account code. Send OrganizationIdentifier/accountCodeFaresOnlyInd set to true, along with one or more account codes in OrganizationIdentifier/value. If sending multiple account codes send each instance with accountCodeFaresOnlyInd set to true. If not sent the default is false. GDS only; not supported for NDC. Note the following:

  • If an account code is sent without accountCodeFaresOnlyInd set to true, the response includes any fares filed for that account code plus fares that are not specific to the account code.

  • If accountCodeFaresOnlyInd is sent with true and no account code, the indicator is ignored and the response returns all fares and the following warning: accountCodeFaresOnlyInd set to true requires an account code to be specified in the request.

Search 23.11.31: Pricing and ticketing PCCs, GDS/NDC content curation and new Identifier | 19 Jul 2023

Adds two new pricing modifiers for PCCs (pseudo city code; a travel provider's identification code for the JSON APIs, provisioned from Travelport) to PricingModifiersAir, one for ticketing and another for faring:

  • Use TicketingPCC to send a PCC to use for ticketing and override the default PCC associated with your account. GDS only; not supported for NDC.

  • Use PricingPCC to send a PCC for which a selective access or code group agreement exists between that PCC and the PCC associated with your account. Send along with fareType with a value of PrivateFaresOnly. GDS only; not supported for NDC.

Introduces the first phase of Travelport's content curation layer (CCL). CCL merges offers by comparing flights based on carrier/airline, flight numbers, fare brand/s, and total price and removes duplicate offers. See Merged GDS and NDC Offers (Content Curation Layer) for details. Although CCL is available at this time only to pilot customers specifically provisioned for this feature, some changes apply to all customers:

  • For all customers, the leg-based search response for all NDC offers is updated with a new standard Identifier object in ProductBrandOffering.

  • For customers who are enabled for CCL and request both GDS and NDC content, when the response includes offers for the same itinerary at the same price from both GDS and NDC sources, Search combines those offers into a single merged offer to avoid duplication.

    • A merged offer returns a value in CatalogProductOffering/id that combines the standard GDS and NDC id numbers. For example, if CCL merges a GDS offer that has id 03 with an NDC offer that has id UA_CPO0, the merged id is 03-UA_CPO0.

  • Customers enabled for CCL receive a new error message when both GDS and NDC content have been requested and either source times out. The message is returned in ErrorDetail with StatusCode 200, SourceCode 9040. For GDS the message is GDS content not available. For NDC the message is  XX: NDC content not available, in which XX is the carrier code.

Search 23.11.30: Unbundled fare updates | 12 Jul 2023

In the Search request, adds the excludeUnbundledFaresInd indicator to exclude unbundled fares from the search response. GDS only; not supported for NDC.

In the response, adds the new object fareTypeCode to PassengerFlight/FlightProduct to the response to provide a type for unbundled fares; see the Search API Reference for a list of the ATPCO unbundled industry fare types that may be returned. GDS only; not supported for NDC.

Search 23.11.28: New indicator and brand attributes | 1 June 2023

Adds support for the following:

  • Removes the FareRuleInfo object from TermsAndConditionsAir in the Search, Next Leg Search and Flight Specific Search reference and full payload responses for NDC content. Applies to NDC only; FareRuleInfo was never returned for GDS.

  • An optional new indicator to request the return of the fare calculation ladder. Set to true to return the fare calculation ladder in BestCombinablePrice/PriceBreakdown/FareCalculation. GDS only; not supported for NDC or in the full payload Flight Specific Search request.

"CustomResponseModifiersAir": {
                "@type": "CustomResponseModifiersAir",
                "includeFareCalculationInd": "true"
            }
"BestCombinablePrice": {
                                        "@type": "BestCombinablePriceDetail",
                                        "CurrencyCode": {
                                            "decimalPlace": 2,
                                            "value": "AUD"
                                        },
                                        "Base": 1356,
                                        "TotalTaxes": 235.5,
                                        "TotalPrice": 1591.5,
                                        "PriceBreakdown": [
                                            {
                                                "@type": "PriceBreakdownAir",
                                                "quantity": 3,
                                                "requestedPassengerType": "ADT",
                                                "Amount": {
                                                    "@type": "Amount",
                                                    "CurrencyCode": {
                                                        "decimalPlace": 2,
                                                        "value": "AUD"
                                                    },
                                                    "Base": 452,
                                                    "Taxes": {
                                                        "@type": "TaxesDetail",
                                                        "TotalTaxes": 78.5,
                                                        "Tax": [
                                                            {
                                                                "taxCode": "AY",
                                                                "value": 16.8
                                                            },
                                                            {
                                                                "taxCode": "US",
                                                                "value": 33.9
                                                            },
                                                            {
                                                                "taxCode": "XF",
                                                                "value": 13.4
                                                            },
                                                            {
                                                                "taxCode": "ZP",
                                                                "value": 14.4
                                                            }
                                                        ]
                                                    },
                                                    "Total": 530.5
                                                },
                                                "FareCalculation": "DEN UA ATL 151.63TAA2AKEN UA DEN 151.63TAA2AKEN USD303.26END"
                                            }
                                        ]
                                    }

Search 23.11.27: Internal updates | 6 Apr 2023

Internal updates only.

Search 23.11.26: Internal updates | 16 Mar 2023

Internal updates only.

Search 23.11.25: Internal updates | 16 Feb 2023

Internal updates only.

Search 23.11.24: Up to 12 fare selection inputs, model updates | 26 Jan 2023

Adds support for the following:

  • Sending up to 12 fare selection input options (refundability and changeability criteria) in the Search, Next Leg Search, and Flight Specific reference payload requests in PricingModifiersAir/FareSelection. Previously, up to 6 were supported. GDS only; up to 6 are still supported for NDC.

  • Model updates to add to the Search request the new object ConnectionPreferences, which will support searching by specific connection points, and SearchCriteriaFlight objects arrival date and arrival time, which will support searching by flight arrival date and time. See details about the model changes in the dropdown below. These new objects are not yet supported in the JSON APIs. If a Search request sends arrival date/time but no departure date, Search returns no results and the following error message: "Arrival date is not supported for this transaction type.Departure date is required". If connection preferences are specified, Search ignores the connection preferences and returns search results along with the following warning message: "Connection point is not supported for this transaction type"

SearchCriteriaFlight attributes:

  • "arrivalDate"

    • type: xsd:Date, optional

  • "arrivalTime"

    • type: xsd:time

Connection preferences (object name ConnectionPreferences):

  • attribute "preferenceType"

    • Type: ConnectionPointPreference

    • TypeENUM: Preferred, Permitted, Prohibited

  • Optional, no repeat

Examples
"ConnectionPreferences": [
    {
        "@type": "ConnectionPreferencesAir",
        "preferenceType": "Preferred",
        "legSequence": [
            1
        ],
        "ConnectionPoint": [
            "DEN"
        ]
    }
]

 

{
 "SearchCriteriaFlight": {
  "departureDate": "2023-01-24",
  "legSequence": 1,
  "arrivalDate": "2023-01-25",
  "arrivalTime": "06:45:00",
  "From": {
   "value": "ORD"
  },
  "To": {
   "value": "LHR"
  }
 }
}

Search 22.11.23: Flight references for ProductBrandOptions | 15 Dec 2022

This update adds @type ProductBrandOptions/flightRefs to the ProductBrandOptions object in all Search responses (Search, Next Leg Search, Flight Specific Search reference and full payload). Adding the flight references to ProductBrandOptions, which is a wrapper for all its included instances of ProductBrandOffering, is intended to make it easier for developers to associate each instance of ProductBrandOffering with the flight references to which it applies. GDS only; not returned for NDC.

                                     "ProductBrandOptions": [
      {
       "@type": "ProductBrandOptions",
       "flightRefs": [
        "s1"
       ],
       "ProductBrandOffering": [
        {
         "@type": "ProductBrandOffering",

Search 22.11.22: IsJourney change, new indicators for brand attributes | 17 Nov 2022

This release introduces a number of features related to brand attributes, which are services included in a branded fare, such as wifi or a free checked bag.

  • Updates the response behavior for ProductInclusionPreference\Classification, which can be sent in the request to specify that only fares that include the specified brand attributes are returned. Previously, the Search response limited only the base offers to fares that included those specified brand attributes, and returned upsell offers that may or may not include those brand attributes. With this update, the response limits all offers, both base and upsell, to only fares that include the specified brand attributes.

  • When ProductInclusionPreference\Classification is sent, the following new indicators may be returned to detail how each offer matches the requested brand attributes. See the API Search Reference for examples and additional details:

    • In ReferenceList\Brand\BrandAttribute, matchedAttributeInd: Returned as true for any attribute that was requested in ProductInclusionPreference\Classification. Not returned if false.

    • In ProductBrandOptions\ProductBrandOffering:

      • MatchedAttributes: The number of attributes requested in ProductInclusionPreference\Classification that are available for a fare.

      • bestMatchInd: Returned with a value of true when all brand attributes requested in ProductInclusionPreference\Classification are available for a fare. Not returned if false.

In addition, this release adds support for the following:

  • Updates how journey-based and leg-based responses are requested. Instead of the IsJourney header parameter, send the new payload object CustomResponseModifiersAir/SearchRepresentation with the value Leg for a leg-based search or Journey for a journey-based search. If CustomResponseModifiersAir is not sent, the default is a journey-based response. While the IsJourney header parameter remains available for use, it will be deprecated in a future release and customers should update to using SearchRepresentation as soon as feasible.

  • In the Search and Next Leg Search responses, updates the ReferenceListFlight/Flight/operatingCarrier object to return the code of the codeshare operating carrier when one has been filed by the operating carrier. Previously, this object incorrectly returned the code of the operating carrier. The operating carrier name continues to be returned in Flight/operatingCarrierName.

Search API 22.11.21: Remove trailing zeros | 8 Sep 2022

Updates all Search responses to remove trailing zeros in the objects in Price that return amounts; e.g,, 54.00 is now returned as 54 and 121.80 is now 121.8.

Search API 22.11.20: Leg-level preferences, BaggageAllowance updates | 25 Aug 2022

Adds support for the following:

  • Sending the CabinPreference modifier at the leg level. Previously any CabinPreference applied to the entire itinerary. GDS only, not supported for NDC.

  • Updates the GDS leg-based Search and Next Leg Search responses to remove duplicate flight details when the same outbound flight is returned multiple times with different fares in combination with the same inbound flight. GDS only; the duplicate flight details are still returned for NDC.

  • Removes best combinable price data (BestCombinablePrice) from the anchored flight in the Next Leg Search response. The anchored flight is the offer selected from the Search response and sent with the Next Leg Search response; because this offer has already been selected, the best combinable price does not apply to it. Aligns with NDC response, which already did not return BestCombinablePrice for the anchored flight.

  • Updates the baggage allowance information returned in BaggageAllowance into structured fields in the Search response as follows; GDS only, not supported for NDC:

    • Repeats baggage allowance details for each PTC type.

    • For the weight restriction checked baggage allowance (when there are no weight restriction details for the first and second bag):

      • Remove details for SecondCheckedBag and increase quantity of FirstCheckedBag to 2.

      • Move the weight to a structured format and remove the text field.

    • For the weight restriction carry-on baggage allowance (when there are no weight restriction details for the first and second bag), move the weight to a structured format and remove the text field.

"BaggageAllowance": [
{
 "@type": "BaggageAllowanceDetail",
 "passengerTypeCodes": [
  "ADT"
 ],
 "baggageType": "CarryOn",
 "ProductRef": [
  "p18"
 ],
 "BaggageItem": [
  {
   "@type": "BaggageItem",
   "quantity": 2,
   "Measurement": [
    {
     " measurementType ": "Weight",
     "unit": "Kilograms",
     "value": 7
    }
   ],
   "Text": "CHGS MAY APPLY IF BAGS EXCEED TTL WT ALLOWANCE"
  }
 ],
 "SegmentSequenceList": [
  2,
  3
 ]
}

Search API 22.11.19: Request fares by refund and change criteria | 21 Jul 2022

Adds two optional modifiers to the Search request providing the ability to request only fares that meet certain criteria for changes and refunds. The following objects were added to PricingModifiersAir/FareSelection:

  • ChangeOptions: Requests the return of only fares that meet certain change criteria, specified in changeTypes with one of these supported values:

    • Changeable: Return only changeable fares.

    • NonChangeable: Return only nonchangeable fares.

  • RefundOptions: Requests the return of only fares that meet certain refund criteria, specified in refundTypes with one of these supported values:

    • Refundable: Return only fully refundable fares.

    • NonRefundable: Return only nonrefundable fares.

    • PartialRefund: Returns fares that allow for a partial refund, defined as a refund penalty that is 98 percent or less of the fare component amount.

Search 22.11.18: Internal updates | 30 Jun 2022

Internal updates only.

Search 22.11.17: New indicators, additional O&D support, partial Flight Specific Search request | 23 Jun 2022

Adds support for the following:

  • The new returnMostRestrictiveBrandInd modifier, which allows you to choose whether to return information for either the most restrictive brand or the brand on the most significant segment on the itinerary. GDS only, not supported for NDC.

  • Returns in the response the indicator Flight/subjectToGovernmentApproval when an airline has filed in its schedule that availability for a specific flight is subject to government approval. GDS only, not supported for NDC.

  • Adds support for searching up to 6 O&D pairs with the Search, Next Leg Search, and Flight Specific Search APIs. Previously, up to 3 O&D pairs were supported. This affects the number of upsells that can be requested.

  • Enhanced the Flight Specific Search reference payload request to require details for only one leg in the request. Previously, the full itinerary was required in the request to return a response.

  • Returning in the response the new secureFlightPassengerDataRequiredInd indicator to notify when additional passenger data is required for Secure Flight Passenger Data requirements. GDS only, not supported for NDC.

Search 22.11.16: Identifier not returned for journey-based Search without caching | 19 May 2022

With this update, when the offersPerPage setting is not sent with a journey-based Search, the search results are not cached and no transaction identifier is returned. (CatalogProductOfferings/Identifier is not present in the response.) This improves performance time by not caching results, and prevents failures by ensuring that no identifier can subsequently be used to call additional results when none are available.

Search 22.11.15: Internal updates | 21 Apr 2022

Internal updates only.

Search 22.11.14: Multiple updates | 31 Mar 2022

Adds support for the following across Search, Next Leg Search, and Flight Specific Search:

  • Permitted and prohibited class of service modifier. GDS only; not supported for NDC.
  • Returning a URL for a brand image in the response when available, in Brand/ImageURL.
  • Returning the following additional brand attributes, when available, in the new object AdditionalBrandAttribute. An additional attribute is returned only when a brand has that attribute associated with it. Additional brand attributes can be filtered in the request with CustomResponseModifiersAir/BrandAttributeInclusion/AdditionalClassification.
    • ChauffeurTransfer
    • ExtraLegroom
    • InFlightEntertainment
    • LoungeAccess
    • PriorityBaggage
    • PriorityBoarding
    • PriorityCheckIn
    • PrioritySecurity
    • PriorityServices
    • MileageAccrual
    • Upgrades
    • USB

In addition, to better support customers in generating their code from Swagger files, the @type discriminators have been updated as follows in all Search responses:

  • Add @type: “ProductBrandOptions” to ProductBrandOptions

  • Change @type “Brand” to “BrandID” in

    • CatalogProductOffering / Brand

    • ProductBrandOffering / Brand

    • ReferenceListProduct / Product / PassengerFlight / FlightProduct / Brand

  • Change @type “Product” to “ProductID” in ProductBrandOffering / Product

  • Change @type “TermsAndConditionsAir” to “TermsAndConditionsID” in ProductBrandOffering / TermsAndConditions

  • Add @type “FlightSegment” to ReferenceListProduct / Product / FlightSegment

  • Change @type “FlightDetail” to “FlightID” in Product / FlightSegment / Flight

  • Add @type “PassengerFlight” to ReferenceListProduct / Product / PassengerFlight

  • Add @type “FlightProduct” to ReferenceListProduct / Product / PassengerFlight / FlightProduct

  • Add @type “BaggageItem” to TermsAndConditions / BaggageAllowance / BaggageItem

  • Add @type “ValidatingAirline” to TermsAndConditions / ValidatingAirline

  • Add @type “Penalties” to TermsAndConditions / Penalties

Search 22.11.13: Exclude baggage fees indicator | 8 Mar 2022

Adds an excludeBaggageFeesInd indicator supporting the exclusion of baggage fees, carry on fees and embargo information for GDS content from the response. Baggage quantity or weight details are returned instead.

Search 22.11.12: Surcharges, ProductBrandOfferings | 1 Feb 2022

Adds support for:

  • Aligning the Search GDS and NDC response formats to use the same structure for returning offers in ProductBrandOfferings. Instances of CatalogProductOffering with the same fare, carrier, and origin and destination in the GDS Search response are now merged to be returned in a single CatalogProductOffering.

  • Adding surcharge amounts to the price breakdown, and providing a new indicator CustomResponseModifiersAir/excludeSurchargesInd that supports excluding those surcharges from the response. GDS only; surcharges are not returned for NDC content. See the Search API Reference.

  • Minor model update. See Code Changes Summary below.

The following model changes were made with this upgrade.

Search request

  • Add excludeSurchargesInd to CustomResponseModifiersAir

    • Boolean, optional. True excludes surcharge breakdown from PriceDetail

  • Add exactMatchInd to ProductInclusionPreference (not yet supported for use)

    • Boolean, Optional. If true, the attributes requested must be included in the offers

  • Add PreferenceType to ClassOfServicePreference (not yet supported for use)

    • Type: ClassOfServicePreferenceTypeEnum. Preference type, e.g., Permitted

  • Add new ClassOfServicePreferenceTypeEnum:

    • Preferred: The preferred classOfService. Other options may be returned in addition to the preferred class of service.

    • Permitted: The permitted classOfService. Only options with this classOfService will be returned. If no options exist, no options will be returned.

    • Prohibited: The prohibited classOfService. This classOfService will be excluded from the offers.

  • Add RefundOptions to PricingModifiersAir/FareSelection (released in Search 22.11.19 )

    • Optional, no repeat. Refund options that can be applied to the offer request.

    • Add refundTypes to RefundOptions

      • Type: RefundTypes, Required. The refund type(s) requested to be included in the offers:

        • Add RefundTypeEnum, Refundable: Requests refundable fares

        • NonRefundable: Request for non refundable fares

        • PartialRefund: Request for partially refundable fares

      • Add RefundPenaltyRange to RefundOptions (not supported)

        • Optional: The penalty range requested as an amount or percent

          • Minimum: Type: AmountPercent, Optional: The minimum amount or percent that is accepted for a refund penalty

          • Maximum: Type: AmountPercent, Optional: The maximum amount or percent that is accepted for a refund penalty

Search response
  • Add Surcharges to PriceBreakdown_Air (surcharges that apply to this offer)
    • approximateInd: Boolean, if true, surcharge amounts are approximate
    • TotalSurcharges: Monetary amount, up to 4 decimal places
      • Surcharge
        • currencyCode
        • purpose (supported values: Weekend Surcharge, Stopover Charge, Multiple Stopover Charges, Other)
        • decimalPlace
        • value

  • Update PenaltyAppliesTo in Change_Permitted: Make optional, no repeat

  • Update Penalty in Change_Permitted: Make optional. Repeat x2

Search 21.11.11: Internal updates | 17 Dec 2021

Internal updates only.

Search 21.11.10: Standalone fare rules and UA bundles | 11 Nov 2021

Adds support for:

  • Requesting fare rules from the standalone fare rules service after a Search response.
  • United Airlines dynamic bundle fares (DBF) are returned by default for NDC when available. Note that support for booking DBFs is under development and they can be searched and priced but not booked at this time.

Search 21.11.9: NDC search updates | 28 Oct 2021

Adds support for the following for NDC content; these capabilities are already available for GDS:

  • Enhanced Flight Specific Search. With this release, search results can be filtered to a specific product to return all available fares for that product.

  • Requesting only fares with specified brand attributes, using the search modifier ProductInclusionPreference.

Search 21.11.8: Internal updates | 30 Sep 2021

Internal updates only.

Search 21.11.7: CAT16 penalties, brand attribute configuration | 2 Sep 2021

Adds support for the following; see the Search API Reference for details:

  • Updates the definition of the bound flights indicator (boundFlightsInd) to specify which flights in a single or double connection must be sold together.
  • A new excludePenaltiesInd indicator allowing you to set whether to return CAT16 change and cancel penalties in the response for each offer.
  • New attributes arrivalFlightDuration and departureFlightDuration to IntermediateStop in the response.
  • A new modifier BrandAttributeInclusion that returns information about only the requested brand attributes.

Search 21.11.6: Initial customer release | 5 Aug 2021

The initial customer release for Search is 21.11.6. You can find information in the Air Shopping Guide.

Note that follow-on support for Search in other APIs is under development and will be noted in release notes for those APIs when available.

Search v11 is an upgrade from Fare Family Search model v9 with several additional features; a list of code changes follows.

The following model changes were made from Fare Family Search v9 to Search v11.

Search and Next Leg Search request

New IsJourney header supports preference setting for journey-based or leg-based searches.

New optional request, Flight Specific Search, supports returning all branded fares filed for a specific product.

In SearchCriteriaFlight, new object DepartureTimeRange with attributes start and end

In CatalogProductOfferingsRequest, new attribute maxNumberOfUpsellsToReturn

New object SearchControlConsoleChannelID with attributes value and sccType; replaces previous query parameter

PricingModifiersAir object: 

  • New objects SellCity and TicketCity
  • OrganizationIdentifier object replaced with OrganizationInformation
Search and Next Leg Search response

DefaultCurrency object removed. New CurrencyCode object with attributes decimalPlace and value added in Price/Amount.

New objects CombinabiityCode and BestCombinable Price

In BrandAttribute object, Not Offered added to values in @inclusion

In Arrival and Departure objects, new attribute terminal

New attributes added to IntermediateStop object: equipment, arrivalDate, departureDate, arrivalTime, departureTime, arrivalTerminal, departureTerminal, value

In Brand object, new attribute shelfNumbers

TermsAndConditionsAir object:

  • New object PaymentTimeLimit
  • BaggageAllowance object renamed to detail facet BaggageAllowanceDetail
    • BaggageItem/Measurement new attribute measurementType
  • ValidatingCarrier renamed to ValidatingAirline
  • OrganizationIdentifier replaced with OrganizationInformation

  • FlightSegment: Flight object renamed to detail facet FlightDetail

Air Availability

Air Availability 24.11.1: Initial release | 5 Apr 2024

The Air Availability API supports searching by air availability. This new API returns all flights between a specified city pair on the specified day and time and indicates whether seats are available on those flights. Unlike the Search APIs, Air Availability focuses on seat availability by class of service. The response does not return pricing information. GDS only; not supported for NDC.

AirPrice

AirPrice 24.11.43: Internal updates | 9 Jan 2025

Internal updates only.

AirPrice 24.11.42: Internal updates | 12 Dec 2024

Internal updates only.

AirPrice 24.11.41: PCC in header | 21 Nov 2024

Adds the new header field TVP-PCC-CORE to all AirPrice APIs, which supports sending the PCC for authentication instead of the access group.

Adds the following error message to be returned if a user sends more than nine tax codes to be exempted: "TAX EXEMPTION FAILED. A MAXIMUM OF NINE TAXES MAY BE REQUESTED" ; can be returned for both the full and reference payload AirPrice requests.

AirPrice 24.11.39 & .40: Internal updates | 17 Oct & 7 Nov 2024

Internal updates only.

AirPrice 24.11.38.1: RouteHappy flight amenities | 25 Sep 2024

Adds support for requesting and returning additional flight amenities, provided by ATPCO as RouteHappy data. Adds the new indicator includeFlightAmenitiesInd to CustomResponseModifiersAir in the AirPrice reference and full payload requests. Send with true to return RouteHappy flight amenities. When requested, the response lists available amenities in the new ReferenceListAmenity object. For each flight, a new amenityRefs object in Product\FlightSegment lists ids for the amenities on that flight, which cross-reference to ids in ReferenceListAmenity\Amenity\id. Several categories of amenities may be returned, including beverages, food, wi-fi, entertainment, and power.

AirPrice 24.11.38: Structured fare rule update | 21 Sep 2024

As part of implementing fare rule categories CAT-31 (Voluntary Changes) and CAT-33 (Voluntary Refund), updates the structure of the StructuredFareRules object in the Fare Rules response. Instead of a displaying all fare rule categories under a single @type with the value StructuredFareRules, the response now repeats "@type": "StructuredFareRules" for each fare rule category. In addition, for Cat-31 & Cat-33 rules, when a penalty amount may vary based differences the time or day from the originally scheduled flight, such variances are now returned. GDS only; structured fare rules are not supported for NDC.

AirPrice 24.11.37: Manual fare adjustment, model upgrade | 22 Aug 2024

Introduces the pricing modifier ManualFareAdjustment to the AirPrice full and reference payload requests to support adjusting the base fare amount. Fares can be increased or decreased by either an amount or a percentage. GDS only; not supported for NDC.

Upgrades AirPrice to version 11.17 of the OD Model with the following changes:

  • AirPrice request: In PricingModifiersAir, adds ManualFareAdjustment , with @type values ManualFareAdjustmentDiscount and ManualFareAdjustmentIncrease.

  • AirPrice response (these updates are not yet in use and will be deployed with future functionality):

    • In FlightProduct, adds amenityRefs to return string values of cross-references to ReferenceListAmenity for the amenities on that flight.

    • In ReferenceList, adds ReferenceListAmenity to return an array of Amenity instances to detail additional amenities per flight. Amenity includes:

      • id

      • Category

      • Text (key value pairs value and language)

AirPrice 24.11.36: NDC upsells at price, filed currency | 18 Jul 2024

Adds support for returning upsells for NDC content by default in the AirPrice full payload response. NDC only; the AirPrice full payload response does not return upsells for GDS content. The AirPrice reference payload response does not return upsells for either GDS or NDC.

In the AirPrice response, adds the object FiledAmount to PriceBreakdown to return the currency in which the base fare has been filed, when the origin currency is not the same as the PCC currency. Previously, the response returned the base fare in only the equivalent currency in the PCC currency. This fare amount continues to be returned in PriceBreakdown/Amount.

AirPrice 24.11.35: Model updates | 12 Jun 2024

Makes the following updates for v11.16 of the ODM model. These updates are not in use yet and will be used with future functionality:

Fare Rules API:

StructuredFareRules:

  • fareClassCode

  • fareTypeCode

  • seasonType

  • oneWayRoundTripRestriction

  • routingNumber

  • generalRuleDoesNotApplyInd

  • Location1GeographicSpecification

  • Location2GeographicSpecification

ErrorDetail:

  • Category

AirPrice 24.11.34: Structured fare rule updates | 22 May 2024

Makes the following updates to the Fare Rules API. These changes support ATPCO's change from filing changes and cancellation penalties under CAT-16 (Penalties) for structured fare rules and moving them to the new fare rule categories CAT-31 (Voluntary Changes) and CAT-33 (Voluntary Refunds). GDS only; not supported for NDC.

  • Fare Rule request: Adds the following supported values to the fareRuleCategories query parameter:

    • VoluntaryRefunds

    • VoluntaryChanges

  • Fare Rule response: In the Penalties object, the object PenaltySourceCode, which includes: 

    • codeContext: Returned with the value ATPCO.

    • value: Returned with the value 31 or 33.

AirPrice 24.11.33: Fare Display updates, error handling updates | 25 Apr 2024

Expands support for the Fare Display API to search for fare rule text for up to three preferred carriers, and a specific fare basis code. GDS only; not supported for NDC.

Implements the following as part of a multi-phase update to JSON API error handling:

  • For any communication error with NDC content, the AirPrice and Fare Rule APIs now return the HTTP StatusCode 200 and SourceCode 2599 in the Result/Error object. This object also returns SourceID with carrier code for the NDC airline.

  • As part of a multi-phase update to JSON API error handling, the SourceDescription object is no longer returned in in ErrorDetail for all Price and Fare Rule APIs; this applies to both GDS and NDC content.

AirPrice 24.11.32.1: Fare Display updates | 17 Apr 2024

Adds the optional modifiers departureDate, returnDate, and carrier to the Fare Display request.

AirPrice 24.11.32.1: Fare Display API | 10 Apr 2024

Adds the new Fare Display API to return the fare rule text based on the origin and destination location. This request does not require a preceding Search or AirPrice request. It can be used as part of the Add Product booking workflow to check fare rule text for an itinerary.. GDS only; not supported for NDC.

AirPrice 24.11.32: Internal updates | 27 Mar 2024

Internal updates only.

AirPrice 24.11.31: Split ticketing, tax exempt pricing modifier | 21 Feb 2024

Adds the TaxExemption pricing modifier to the PricingModifiersAir object in the AirPrice full and reference payload full and reference payload requests to mark specific taxes as tax exempt. TaxExemption can mark all taxes as exempt, or can send a list of either or both country codes or tax codes to mark as exempt. TaxExemption supports up to nine specific values for countries, or for tax codes, or for countries and tax codes combined. When TaxExemption is sent, for any exempt tax, the response returns the indicator exemptInd as true and returns the tax value as 0. GDS only; not supported for NDC.

Adds support for using the AirPrice Reference Payload request to price split ticketing itineraries from a preceding Search response. As explained in the Air Shopping Guide, split ticketing allows you to book a roundtrip ticket by sending two separate pricing solutions in one booking request. In other words, a split ticket has two separate one-way reservations instead of a single round-trip reservation. Adds the new indicator includeSplitPaymentInd to the AirPrice reference payload request; set to true when pricing split ticketing offers. Also supported for Standalone Fare Rules. Note the following:

  • Available for PCCs specifically provisioned for split ticketing Search functionality.

  • Supported only in the reference payload.

  • Supported only for round trip itineraries.

  • Available only in the Search, AirPrice, and Fare Rules APIs. Split ticket itineraries cannot yet be booked or ticketed.

AirPrice 24.11.30 New objects | 1 Feb 2024

Adds the following new objects to the full and reference payload responses in PassengerFlight/FlightProduct; GDS only; not returned for NDC:

  • ticketDesignator: Ticket designator code.

  • fareTypeCode: Fare type code identifying whether the fare is bundled or unbundled.

Adds the following new objects to the full and reference payload responses in ReferenceListBrand/Brand/BrandAttribute; returned whenever filed by the carrier:

  • groupCode

  • subGroupCode

  • subCode

    ...
          "BrandAttribute": [
                     {
                          "@type": "BrandAttribute",
                          "classification": "Rebooking",
                          "inclusion": "Chargeable",
                          "groupCode": "BF",
                          "subGroupCode": "VC",
                          "subCode": "06I"
                      }, 
    ...

AirPrice 23.11.29: Return only fares for a specific account code | 13 Dec 2023

Adds support for a new indicator, accountCodeFaresOnlyInd, to limit the fares priced in the response to only fares filed for that account code. Previously supported only in the Search request. Send OrganizationIdentifier/accountCodeFaresOnlyInd set to true, along with one or more account codes in OrganizationIdentifier/value. If sending multiple account codes send each instance with accountCodeFaresOnlyInd set to true. Supported in both the full and reference payload requests; not supported in Standalone Price. GDS only; not supported for NDC.

AirPrice 23.11.28: New pricing modifiers | 15 Nov 2023

Adds support for the following optional objects in both the reference and full payload pricing requests:

  • BrandAttributeInclusion: Send to return information about only the specified brand attributes. Fares may include other attributes but information about those attributes is not returned.

  • The indicator excludeUnbundledFaresInd: True/false Boolean to support requesting or suppressing the return of unbundled fares. GDS only, not supported for NDC.

  • Two new pricing modifiers for PCCs (pseudo city code; a travel provider's identification code for the JSON APIs, provisioned from Travelport) in PricingModifiersAir, one for ticketing and another for faring; both are GDS only:

    • TicketingPCC: Use to send a PCC to use for ticketing and override the default PCC associated with your account. GDS only; not supported for NDC.

    • PricingPCC: Use to send a PCC for which a selective access or code group agreement exists between that PCC and the PCC associated with your account. Also send fareType with a value of PrivateFaresOnly.

AirPrice 23.11.27.1: Update to private fare handling | 11 Oct 2023

To resolve the error message NO FARES AVAILABLE FOR REQUESTED CABIN when customers send PricingModifiersAir/FareSelection/fareType set to PrivateFaresOnly and an account code in PricingModifiersAir/OrganizationInformation/OrganizationIdentifier, AirPrice no longer validates the account code in this scenario. Instead, AirPrice returns any private fares available for that market and a booking code for the customer's PCC. Previously, AirPrice returned the error message when no specific fare had been filed for that account code.

AirPrice 23.11.27: Inventory check for connecting flights | 11 Oct 2023

Adds support for performing a book and ignore inventory check for connecting flights. In the reference payload, send recheckInventory=true to cause AirPrice to perform the check for any connecting flights, as returned in the preceding Search response with a value of true in FlightSegment/boundFlightsInd. In the full payload, send both recheckInventory=true along with SpecificFlightCriteria/boundFlightsInd=true for any flight segment with a connecting flight.

AirPrice 23.11.26: Internal updates | 27 Sep 2023

Internal updates only.

AirPrice 23.11.25: reCheckInventoryInd indicator, NDC structured fare rules | 6 Sep 2023

Adds support for the following:

  • A new, optional indicator in the AirPrice request, reCheckInventoryInd, supported in both the reference and full payload AirPrice requests. Send with a value of true to confirm that all segments have adequate availability for the requested number of passengers in the requested cabin/class of service. This indicator causes AirPrice to book the seats and then release them. If any or all segments are not bookable, AirPrice returns an error message and the dates and city pairs of the segments that are not bookable, per the following example. This indicator can help reduce sell failures at booking by alerting of insufficient availability. GDS only; not supported for NDC.

The air segments are not bookable -*UNABLE - FLIGHT NOT FOUND IN VENDOR SYSTEM* | *UNABLE - FLIGHT NOT FOUND IN VENDOR SYSTEM* | \nFJ 0102T 17AUG2023SYDAKL | \nFJ 0958T 17AUG2023AKLNAN"

  • Returning structured fare rules for NDC after pricing with a Standalone Fare Rules request. When no fare rules are available, the response returns the warning No FareRule data found. Previously supported only for GDS.

AirPrice 23.11.23: Internal updates | 12 Jul 2023

Internal updates only.

AirPrice 23.11.22: New informational indicators in response | 29 Jun 2023

In the AirPrice response, adds the two following indicators regarding secure flight / government approval messaging:

  • SecureFlightPassengerDataInd in TermsAndConditions. Returned as true when an airline supports the Transportation Security Administration's Secure Flight Passenger Data program (SFPD). Not returned if false. GDS only; not supported for NDC.

  • SubjectToGovernmentApproval in Flight. Returned as true when provided by the airline, usually in the case of new international airline service when the route may require the government to approve the specific airline and flight operation. Not returned if false. Also supported in the Search and AirReservation responses. GDS only; not supported for NDC.

AirPrice 23.11.21: Internal updates | 1 June 2023

Internal updates only.

AirPrice 23.11.20: Internal updates | 10 Apr 2023

Internal updates only.

AirPrice 23.11.19.1: Additional fare options for NDC | 30 Mar 2023

With this update, for price requests following a Next Leg Search on an NDC itinerary, AirPrice returns additional fare options that offer additional inclusions and may be higher than the priced itinerary. This supports additional flight responses and fare combinability for NDC, providing upsell opportunities to the agency and allowing customers to select flights at different price points.

Additional flights are returned as a combinable offer from the NDC carrier. For example, a carrier may offer a Premium Economy cabin fare for the return leg that can be combined at a higher fare with the economy cabin fare on the outbound leg. Additional fare options are returned by default when available, as returned by the carrier. GDS pricing continues to return the flight requested for pricing and any other flights available for the same fare.

AirPrice 23.11.19: New brand attributes | 16 Mar 2023

Adds support for returning the additional values of PersonalItem, PremiumSeat, and LieFlatSeat in BrandAttribute/classification in the AirPrice response, when branded fares are requested and these attributes are returned by the carrier.

AirPrice 23.11.18: Internal | 19 Jan 2023

Internal updates only.

AirPrice 22.11.17.1: Error message update | 16 Nov 2022

Updates the error message for the fare rule response for NDC when no fare rules exist. Returns a 200 error with the message "No Fare Rule Available". Note that most NDC carriers do not support fare rules.

AirPrice 22.11.17: Sell and ticket city, remove trailing zeros, Spanish resident fares | 15 Dec 2022

Adds support for the following:

  • Sell city pricing modifier, which overrides the sell city of the requester to specify an alternate sale location and return pricing based on that location. GDS only; not supported for NDC. Previously available only in the Search API.

  • Local citizen fares for residents of Spain and associated islands. Requested with the new TravelerGeographicLocation object. GDS only; not supported for NDC. Previously available only in the Search API.

  • In the response, removing the trailing zeros in objects that return amounts; e.g,, 54.00 is now returned as 54; 121.80 is now 121.8.

  • In the response, moving baggage details into TermsAndConditionsFull/BaggageAllowance, per the example excerpt below.

                                
                "TermsAndConditionsFull": [
                    {
                        "@type": "TermsAndConditionsFullAir",
                        "ExpiryDate": "2022-10-30T23:59:00Z",
                        "BaggageAllowance": [
                            {
                                "@type": "BaggageAllowanceDetail",
                                "url": "http://VIEWTRIP.TRAVELPORT.COM/BAGGAGEPOLICY/UX",
                                "passengerTypeCodes": [
                                    "ADT"
                                ],
                                "baggageType": "FirstCheckedBag",
                                "ProductRef": [
                                    "p0"
                                ],
                                "BaggageItem": [
                                    {
                                        "@type": "BaggageItem",
                                        "quantity": 1,
                                        "BaggageFee": {
                                            "code": "EUR",
                                            "approximateInd": true,
                                            "value": 30
                                        },
                                        "Text": "UPTO50LB/23KG AND UPTO62LI/158LCM"
                                    }

Price API 22.11.16: BIN for GDS, FareGuaranteePolicy, ValidatingCarrier | 8 Sep 2022

Adds support for:

  • Retuning the validating/plating carrier in the price response, in TermsAndConditionsFull/ValidatingAirline.

  • Returning the fare guarantee policy in the price response, when returned by the airline, in TermsAndConditionsFull/FareGuaranteePolicy. GDS only; not returned by NDC carriers.

  • Sending the credit card BIN number in the GDS price request to return OB fees (carrier ticketing fees) in the response. Sent in PaymentCriteria/IssuerIdentificationNumber. Previously, sending the BIN number was supported only for NDC.

AirPrice API 22.11.15: Full payload request for NDC carriers | 28 Jul 2022

Adds support for the full payload price request for NDC content on specific carriers only; see the NDC Guide for details. Previously, only the reference payload price request was supported for NDC.

AirPrice 22.11.14: Trace and transaction IDs for Full Brand Pricing | 23 Jun 2022

Adds support for separate trace and transaction IDs to the Full Brand Pricing request (API deprecated Dec 2023). These assist in troubleshooting and can help customers who use both the JSON APIs and the SOAP/XML API track transactions across those APIs.

AirPrice API 22.11.13: Remove recheckInventory query parameter | 19 May 2022

The recheckInventory query parameter is no longer needed in either the full or reference request and is ignored if sent. With this update AirPrice always checks the available inventory for each carrier.

AirPrice API 22.11.12.1: ProductIdentifier no longer required | 13 May 2022

With this release the product identifier is no longer required in the AirPrice reference payload request. This change was made to address an issue in which multi-city pricing was failing for select carriers.

AirPrice 22.11.12: Fare calculation ladder, @type updates | 31 Mar 2022

Resolves several defects and adds support for the following:

  • In the AirPrice response, returning for each PTC the fare calculation ladder for all public and private fare types filed by an agency or an airline. Returned in the new object PriceBreakdown/FareCalculation object as a string with unlimited bytes. GDS only; not supported for NDC.
  • To support the @type discriminator updates in the Search 22.11.14 release above, the characters ID were removed from the Standalone Fare Rule API response FareRuleListResponse/FareRuleID, changing it from FareRuleID to FareRule.

AirPrice 22.11.11: Internal updates | 8 Mar 2022

Internal updates only.

AirPrice 22.11.10: AvailabilitySourceCode, PaymentTimeLimit, DBF support | 1 Feb 2022

Adds support for the following:

  • Pricing support for United Airlines dynamic bundle fares (DBF), which are returned by default in NDC Search content when available. Note that support for booking DBFs is under development and they can be searched and priced but not booked at this time.
  • Updates the definition of the bound flights indicator (boundFlightsInd) to specify which flights in a single or double connection must be sold together.
  • Minor model updates to the response:
    • Adds AvailabilitySourceCode to ProductAir/FlightSegment/Flight in the response. GDS only.
    • Moves PaymentTimeLimit (the last date to ticket an offer) from TermsandConditionsFull/ExpiryDate to TermsandConditionsFull. This object is returned for both GDS and NDC and is not populated when this information is not provided by the airline.
  • Enhanced error messaging to return user-friendly, standardized error and warning codes and messages.

AirPrice 21.11.9: Trace and transaction IDs, NTD commission | 11 Nov 2021

Adds support for:

  • Returning a new Commission object in PriceBreakdown for any fare with net ticket data (NTD). GDS only; not supported for NDC, which does not support net fares.
  • 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.
  • Resolves a defect to allow pricing by brand tier from a v11 search.

AirPrice 21.11.8.1: Defect fix | 14 Oct 2021

Resolved a defect to provide fare rules information in the NDC Price v11 response.

AirPrice 21.11.8: Internal updates | 14 Oct 2021

Internal updates only.

AirPrice 21.11.7: Search support, net ticket data, standalone fare rules | 16 Sep 2021

Adds support for the following:

  • A new standalone fare rules service that can be called at any point during the workflow to get the fare rules for that specific service. Note that support for calling standalone fare rules in other APIs is still under development.
  • Pricing offers from the Search v11 API.
  • Returning net ticket data for fares that have a private fare component. Returned in the new attributes carCode and valueCode in ProductAir/PassengerFlight/FlightProduct. The air search request must send the private fare code. GDS only.

AirPrice 21.11.6: Internal updates | 8 Jul 2021

Internal updates only.

AirPrice 21.11.5: Fare Family pricing support | 27 May 2021

Adds support for pricing Fare Family Search combinable round-trip offers. (Fare Family Search was deprecated March 2022.)

AirPrice 21.11.4: Internal updates | 13 May 2021

Continues building support for ancillaries for later release.

AirPrice 21.11.3: Internal updates | 15 Apr 2021

Internal updates only.

AirPrice 21.11.1: Model 11 upgrade | 4 Feb 2021

Updates to ODM model 10 v11 and begins building support for ancillaries for later release. Code changes summary below.

The following model changes were made with this upgrade.

AirPrice request

PassengerCriteria

  • Removed customerloyalty (entity)
  • Added customerLoyalty (list)
AirPrice response

OfferQueryBuildFromCatalogOfferings object

Added FareRuleEnum attribute

OfferQueryBuildFromProducts object

Added FareRuleEnum attribute

TermsAndConditionsAir object

Added FareRuleInfo attribute

TermsAndConditionsFullAir object

Added FareRuleInfo attribute

Brand

No 2024 Brand releases.

Brand 23.11.4: ATPCO brand code | 15 Nov 2023

Adds the ATPCO brand code to the Brand object in the Search, Next Leg Search, and Flight Specific Search responses, returning the new object code in ReferenceListBrand/Brand/code.

Brand 23.11.3: Internal updates | 27 Sep 2023

Internal updates only.

Brand 23.11.2: Brand subattributes | 1 Nov 2023

Adds the following three new Brand subattributes to the BrandAttribute object in the Search, Next Leg Search, and Flight Specific Search responses, returned for both GDS and NDC whenever they are provided by the carrier.

  • groupCode

  • subGroupCode

  • subCode

    ...
          "BrandAttribute": [
                       {
                           "@type": "BrandAttribute",
                           "classification": "SeatAssignment",
                           "inclusion": "Chargeable",
                           "groupCode": "BF",
                           "subGroupCode": "SE",
                           "subCode": "050"
                       }, 
    ...

Brand 23.11.1: New brand attributes | 27 Jun 2023

Adds three new brand attributes: PersonalItem, PremiumSeat, and LieFlatSeat. Returned in the response for Search, Next Leg Search, Flight Specific Search, AirPrice, and other JSON APIs that return brand attributes whenever a brand has these attributes associated with it.

Ancillaries

Ancillaries 24.11.34 | 7 Jan 2025

Adds support for Ancillary Shop after AirPrice and outside a workbench for GDS, allowing ancillary shopping before marking the reservation. (For NDC, Ancillary Shop after AirPrice is already supported for paid baggage but with a different payload; see Ancillary Shop.) Note that the ancillary shop request must be repeated within a subsequent workbench before any ancillary can be booked. In other words, an ancillary returned in the post-price Ancillary Shop request cannot be booked from that shop response.

Ancillaries 24.11.33: Support multi-offers | 12 Dec 2024

Adds support for sending ancillary shop and book requests for an existing multi-offer booking, Not supported in the initial booking workflow. Send one ancillary book request per offer, using a workflow of Initiate Workbench > Ancillary Shop > Ancillary Book for offer 1 > Ancillary Book for offer 2 > Commit Workbench.. The ancillary book requests can be sent in any order: first and second offer, or second and first. GDS only; multi-offers not supported for NDC.

Ancillaries 24.11.32: Seat map and book for multi-offers, seat modify | 12 Nov 2024

Adds support for sending seat map and book requests for an existing multi-offer booking. Not supported in the initial booking workflow. Send one seat book request per offer, using a workflow of Initiate Workbench > Seat Map > Seat Book for offer 1 > Seat Book for offer 2 > Commit Workbench. The seat book requests can be sent in any order: first and second offer, or second and first. GDS only; multi-offers not supported for NDC.

Adds support for sending the existing Seat Map and Seat Book requests to modify a booked seat and hold the existing seat assignment until the new seat book request is successful at commit. Otherwise, current functionality allows a seat assignment to be canceled, committed, and rebooked, but the seat assignment is lost if the seat book is not successful at commit. GDS only; not supported for NDC.

Supported in the initial booking workflow only for free seats; supported for existing reservations for both free and paid seats. Not supported for changing a paid seat to a free seat, or modifying a seat when the current workbench contains any other seat book request. You must add payment and issue tickets at commit; you cannot hold the booking with the modified seats.

Ancillaries 24.11.31: Prohibit seat booking for INF without seat | 17 October 2024

Adds support to prohibit by default booking a seat for an infant that is specified as without a seat. If an infant PTC that by definition doesn't include a seat assignment is sent in a seat book request, Seat Book displays the error message "PASSENGER TYPE CODE CANNOT CONTAIN INFANT". GDS only; not supported for NDC.

Implements fixes to align with standard JSON API error handling.

Ancillaries 24.11.30: Non-baggage ancillaries | 21 Sep 2024

Adds support for booking non-baggage paid ancillaries, such as pets, meals, lounge access, or wifi, with the existing Ancillary Book request.

Adds support for canceling NDC baggage with Ancillary Cancel. Previously, paid baggage could be canceled only for GDS.

Ancillaries 24.11.29: Error handing | 22 Aug 2024

As part of error handling updates, suppresses the SourceDescription object in Ancillary responses.

Ancillaries 24.11.28: Standalone Seat Map API | 18 Jul 2024

Adds a new Standalone Seat Map API to send flight criteria including a booking code to return a view-only seat map. Standalone Seat Map does not send any identifiers for a previously searched or priced flight. It is instead a full payload request and can be sent on its own, either within or outside of a workbench session.

Ancillaries 24.11.27: Cancel ancillary baggage | 12 Jun 2024

Adds support for canceling ancillary bags with the Ancillary Cancel request. Supported only for an existing reservation in a post-booking workbench. GDS only; not supported for NDC.

Ancillaries 24.11.26: Internal updates | 22 May 2024

Internal updates only.

Ancillaries 24.11.25: Internal | 24 Mar 2024

Internal updates only.

Ancillaries 24.11.24: Paid seat support for DL & UA; cached seat maps after Search | 27 Mar 2024

Adds paid seat booking support in GDS for Delta (DL) and United (UA).

Adds support for caching seat map results after a Search request so that the request does not need to be repeated in a subsequent booking workbench. GDS only; not supported for NDC. Seat map results after Price are not cached and so any seat map request after pricing must be repeated in a subsequent booking workbench.

Resolves a defect in which only paid seats were shown in a reservation retrieve for a ticketed GDS itinerary that included both paid and free seats. Both free and paid seats are now returned.

Ancillaries 24.11.23: Seat maps with frequent traveler, PCC in header| 1 Feb 2024

For a traveler added to the workbench with frequent traveler details, the seat map request now supports sending that frequent traveler information and returning accurate availability based on that frequent traveler number, if applicable. Any benefits for that frequent traveler number are not reflected in the response.

Adds the new header field TVP-PCC-CORE to all ancillaries and seats APIs. TVP-PCC-CORE supports sending the PCC for authentication as an alternative to sending the access group.

Ancillaries 23.11.22: Remove unbookable seats when no interline agreement | 29 Nov 2023

Adds a check for an interline agreement between carriers before returning seat maps for multi-segment flight offers. Any seats that are not bookable because there is no interline agreement between the airlines are not returned in the seat map response. This prevents failures when issuing the EMD for such seats.

Ancillaries 23.11.21: Internal updates | 11 Oct 2023

Internal updates only.

Ancillaries 23.11.20: Internal updates | 27 Sep 2023

Internal updates only.

Ancillaries 23.11.19: ARNK segments | 6 Sep 2023

Adds support for booking seats or other ancillaries on a booking with ARNK (arrival unknown) segments; ARNK segments are ignored and ancillary booking is allowed on the other segments. GDS only; not supported for NDC.

Ancillaries 23.11.18: Response structure change for free seats and cancel seats | 27 Jul 2023

This release updates the Seat Book response for booking free seats for GDS. Previously the response returned only a transaction identifier, and a reservation retrieve was required to verify successful booking. This release aligns the free seat response with the paid seat response, which already returned booked seat details. GDS only; not supported for the NDC response, which still returns a transaction identifier instead of details.

For Seat Cancel, the response for GDS has been updated to return full details of the canceled seat offer. Previously the response returned only a transaction identifier, and a reservation retrieve was required to verify successful cancellation. This release aligns the GDS response with the NDC response, which already returned canceled seat details.

Ancillaries 23.11.17: Internal updates | 6 Jul 2023

Internal updates only.

Ancillaries 23.11.16: Internal updates | 1 June 2023

Internal updates only.

Ancillaries 23.11.14: Model updates | 10 Apr 2023

Adds the AncillaryAirBaggage object to the Ancillary Shop response to return additional baggage information such as allowed weight and dimensions. GDS only; already supported for NDC.

Updates the type values for the following objects for paid seats in the seat book response; this also updates the commit and reservation retrieve responses. GDS only; already returned with these types for NDC.

  • Product/Ancillary: @typeAncillaryAirSeat and @type AncillaryAirBaggage

  • Confirmation/OfferStatus: @type OfferStatusAncillary

Ancillaries 23.11.13: Add CatalogOffering/Identifier to GDS seat map response | 22 Mar 2023

Adds the Identifier object to the CatalogOffering in the GDS seat map response to normalize the GDS response with the NDC response. 

"CatalogOffering": [
              {
                  "@type": "CatalogOffering",
                  "id": "ancillaryID_1_0_1",
                  "Identifier": {
                      "authority": "Travelport",
                      "value": "9e1e12d1-973c-420f-ae3a-27ec7144310a"
                    },

Ancillaries 23.11.12: Add more ancillaries to existing booking | 26 Jan 2023

Adds support for adding ancillary baggage to an existing booking that already has ancillaries. Released for GDS, already supported for NDC.

Ancillaries 22.11.11: Internal updates | 16 Nov 2022

Internal updates only.

Ancillaries 22.11.10: Seats and baggage in booking workflow; free seats updates | 20 Oct 2022

Adds support for shopping and booking free seats and paid baggage for GDS in the initial booking workflow when creating the reservation. Previously, these ancillaries for GDS could be added only to an existing reservation. Support for adding paid seats in the initial booking workflow remains pending.

Populates the TermsAndConditionsFull and Price objects for free seat offers. This aligns the responses for free and paid seats; these objects are already populated for paid seats. These updates apply to the responses for reservation retrieve and for commit workbench for both new and existing reservations. Note that price details are not populated in the commit response for free seat or paid seats. Applies to GDS only. See Reservation Retrieve for a full example.

                                
TermsAndConditionsFull: 
    "TermsAndConditionsFull": [
                   {
                       "@type": "TermsAndConditionsFullAncillary",
                       "ApplicationLimit": {
                           "value": "PassengerSegment"
                      }
                  }
              ]
Price with 0 for free seats:
              "Price": {
                  "@type": "PriceDetail",
                  "CurrencyCode": {
                      "value": "AUD"
                },
                  "Base": 0,
                 "TotalPrice": 0
             }
ReceiptConfirmation: 
{
             "@type": "ReceiptConfirmation",
              "OfferRef": [
                  "seatOffer_Flight_01_1"
             ],
             "Confirmation": {
                 "@type": "ConfirmationHold",
                 "OfferStatus": {
                    "@type": "OfferStatusAncillary",
                    "StatusAncillary": [
                        {
                            "value": "Confirmed"
                        }
                    ]
                }
            }
        }

Ancillaries 22.11.9: Pre-ET ancillary NDC support, TravelerProduct updates | 25 Aug 2022

Adds support for booking specific NDC paid ancillaries on carriers Qantas (QF) and United (UA) as part of the initial booking workflow. Previously, paid ancillaries could be added only to an existing reservation, not during booking. NDC only; support for GDS paid ancillaries during booking is pending.

Namespace updates affecting Ancillaries and Seats were also part of this release. Previously, in certain API responses, TravelerProduct was returned twice, once in Reservation and again in TermsAndConditionsFull. Because some customers experienced issues with this, these responses have been updated to return TravelerProduct only once. The following model namespace updates were made in the ancillary book response to implement this change:

  • The PriceBreakdown object was added, including a traveler reference to identify the passenger to which it applies. 

    • "PriceBreakdown": [
                        {
                            "@type": "PriceBreakdownAncillaryAir",
                            "Amount": {
                                "@type": "Amount",
                                "Taxes": {
                                    "@type": "TaxesDetail",
                                    "Tax": [
                                        {
                                            "taxCode": "UO",
                                            "value": 2.27
                                        }
                                    ]
                                }
                            },
                            "TravelerIdentifierRef": {
                                "name": "-FIRST ADTMIDDLE MR",
                                "passengerTypeCode": "ADT",
                                "id": "travelerRefId_1",
                                "value": "-TRAVELER SR"
                            }
                        }
                    ]
                }

  • The ApplicationLimit object was added to TermsAndConditionsFull.

    "TermsAndConditionsFull": [
                    {
                        "@type": "TermsAndConditionsFullAncillary",
                        "ApplicationLimit": {
                            "start": "1",
                            "end": "1",
                            "value": "PassengerSegment"
                        }
                    }
]

For both Ancillaries and Seats, the following changes were made in the responses for workbench commit, create post-reservation workbench, and reservation retrieve:

  • TravelerProduct was removed from TermsAndConditionsFull and is now returned only in Reservation.

    "TravelerProduct": [
                {
                    "@type": "TravelerProduct",
                    "OfferRef": "seatOffer_Flight_01_3",
                    "ProductRef": "product_seat_Flight_01_3",
                    "ConfirmationStatusEnum": "Confirmed"
                }
],

  • The ApplicationLimit object was added to TermsAndConditionsFull. See example above.

Ancillaries 22.11.8: Trace and transaction IDs | 23 Jun 2022

Adds support for separate trace and transaction IDs to Ancillary shop, price, and book. These assist in troubleshooting and can help customers who use both the JSON APIs and the SOAP/XML API track transactions across those APIs.

Ancillaries 22.11.7: Pre-ET ancillary support | 19 May 2022

Adds support for ancillary shop, price, and book in the initial booking workflow when creating the reservation. Supported only for NDC carrier Singapore Airlines for paid bags at this time. Before this update, ancillaries could be added only to an existing reservation after booking.

Ancillaries 22.11.6: Internal updates | 31 Mar 2022

Internal updates only.

Ancillaries 22.11.5: Internal updates | 8 Mar 2022

Internal updates only.

Ancillaries 22.11.4: Multiple paid seat booking sessions| 1 Feb 2022

Adds support for:

  • Booking paid seats in multiple workbench sessions, such as for an additional passenger or an additional leg of the trip. GDS only; not supported for NDC.
  • Enhanced error messaging to return user-friendly, standardized error and warning codes and messages.

Ancillaries 21.11.3: Initial customer release | 02 Dec 2021

Initial customer release of shopping and booking for ancillaries for an existing reservation. At this time supported ancillaries include paid seats for GDS and NDC. Ancillary pricing and paid baggage are supported for NDC only. In addition, GDS EMD display and void support is also available.

AirReservation API

AirReservation 24.11.50 | 7 Jan 2025

Introduces the pricing modifier ManualFareAdjustment to the Add Offer full and reference payload requests to support adjusting the base fare amount. Fares can be increased or decreased by either an amount or a percentage. ManualFareAdjustment has already been deployed in the Search and AirPrice APIs. GDS only; not supported for NDC.

AirReservation 24.11.49 Add/edit minimum secure flight docs with TravelerUpdatableItems | 12 Dec 2024

Adds support for using TravelerUpdate and TravelerUpdatableItems to edit or add minimum secure flight information in either the initial booking workflow or for an existing reservation. Previously, minimum secure flight details in the initial booking workbench could be sent only in the Add Traveler payload.

AirReservation 24.11.48.2: Delete FOP pre-commit, host profile move during initial booking | 12 Nov 2024

Adds a new DEL endpoint to delete a form of payment (FOP) in the initial booking workbench. This allows a new FOP to be added in the same workbench and committed. Previously, FOP could only be added.

Adds support for sending the Host Profile Move request in the initial booking workflow. Previously, Host Profile Move could be sent only after the booking was created. With this change, any pre-commit workbench retrieve returns the moved profile details.

AirReservation 24.11.48: Additional hotel details in retrieve, PCC in header | 7 Nov 2024

In the Reservation Retrieve response, for bookings that include hotel content, returns additional objects in ProductHospitality (TravelerContact, PropertyAddress, Telephone, Email) and in TermsAndConditions (AcceptedCreditCard, CustomerLoyalty).

Adds the new header field TVP-PCC-CORE to all book and ticket APIs. TVP-PCC-CORE supports sending the PCC for authentication as an alternative to sending the access group.

AirReservation 24.11.47: Structured fare rules for NDC, SSR deletion fix | 17 October 2024

Adds support for returning structured fare rules for NDC in the Reservation Retrieve response. Supported for only the Penalties category.

Resolves an issue with modifying traveler documents in which the previous travel document (DOC SSR) was not deleted.

AirReservation 24.11.37.8: Multiple offers, add GDS or NDC air to hotel/car booking | October 2024

This release (released out of sequence by number above) was deployed to support adding air to a booking that already has one or more hotel and/or car offers. Supported for both GDS and NDC. See the Booking Guide for Air, Hotel, and Car for workflow details.

The release also added support for booking and retrieving reservations with multiple air offers; these features are GDS only:

  • In either the initial booking workflow, or for an existing reservation, send one or more Add Offer reference payload requests to add multiple GDS air offers in a single booking. Previously, only the Add Offer full payload request supported multiple Add Offer requests.

  • Retrieve reservations with multiple GDS air offers. This change updates the Reservation Retrieve response by adding TravelerRefs to Price/PriceBreakdown to identify the traveler associated with a specific PriceBreakdown object, as shown in each of the two instances of PriceBreakdown in the example excerpt below.

Your PCC must be provisioned for multi-offers; contact your Travelport representative if necessary.

   ...
                 "Price": {
                        "@type": "PriceDetail",
                        "id": "PriceDetail_1",
                        "CurrencyCode": {
                            "value": "AUD"
                        },
                        "Base": 3134,
                        "TotalTaxes": 1394.72,
                        "TotalFees": 0,
                        "TotalPrice": 4528.72,
                        "PriceBreakdown": [
                            {
                                "@type": "PriceBreakdownAir",
                                "quantity": 1,
                                "requestedPassengerType": "ADT",
                                "Amount": {
                                    "@type": "Amount",
                                    "CurrencyCode": {
                                        "decimalPlace": 2,
                                        "value": "GBP"
                                    },
                                    "Base": 818
                                },
                                "TravelerRefs": [
                                    "travelerRefId_1"
                                ]
                            },
                            {
                                "@type": "PriceBreakdownAir",
                                "quantity": 1,
                                "requestedPassengerType": "ADT",
                                "Amount": {
                                    "@type": "Amount",
                                    "currencySource": "Charged",
                                    "approximateInd": true,
                                    "CurrencyCode": {
                                        "decimalPlace": 2,
                                        "value": "AUD"
                                    },
                                    "Base": 1567,
                                    "Taxes": {
                                        "@type": "TaxesDetail",
                                        "TotalTaxes": 697.36,
                                        "Tax": [...]
                                    },
                                    "Total": 2264.36
                                },
                                "FiledAmount": {
                                    "currencyCode": "GBP",
                                    "decimalPlace": 2,
                                    "value": 818
                                },
                                "TravelerRefs": [
                                    "travelerRefId_1"
                                ],
                                "FareCalculation": "LON QF SYD 994.45LKOGB NUC994.45END ROE0.822564"
                            },

  ...

AirReservation 24.11.46.2: RouteHappy flight amenities | 25 Sep 2024

Adds the query parameter includeFlightAmenitiesInd to Reservation Retrieve to request and return additional flight amenities, provided by ATPCO as RouteHappy data. When requested, the response lists available amenities in the new ReferenceListAmenity object. For each flight, a new amenityRefs object in Offer\Product\FlightSegment lists ids for the amenities on that flight, which cross-reference to ids in ReferenceListAmenity\Amenity\id. Several categories of amenities may be returned, including beverages, food, wi-fi, entertainment, and power.

AirReservation 24.11.46: Spanish residency fares, birthdate & gender update | 21 Sep 2024

Adds the TravelerGeographicLocation object to the Add Offer full payload request to support booking Spanish residency fares. For the Add Offer reference payload request, if Spanish residency fares are requested and returned in a previous Search or AirPrice request, those fares can be booked.

In the Traveler Updatable Items and Traveler Update requests, adds support for modifying a traveler's gender and/or birthdate, which updates the Minimum Secure Flight details (DOCS SSR) for that traveler. This data can be edited in the TravelDocument/birthDate and TravelDocument/Gender objects.

AirReservation 24.11.45.1: Retrieve MCO number for exchanged tickets | 23 Aug 2024

Updates the Reservation Retrieve response to return the MCO number for any exchanged ticket that has an MCO associated with it. An MCO (miscellaneous change order) is created for any exchanged ticket that has residual value remaining after the exchange. The MCO number is returned in an instance of Document with the new @type value DocumentMCO. GDS only, not returned for NDC exchanged tickets.

AirReservation 24.11.45: agentNonRefundableInd for cash FOP | 22 Aug 2024

In the Add Form of Payment (FOP) request, for cash form of payment only, adds new indicator agentNonRefundableInd and a FreeText object for an optional description. Send with a value of true to indicate the payment is non-refundable; do not send if false. No change to the Add FOP response. The workbench commit and Reservation Retrieve responses return the agentNonRefundableInd indicator with a value of true. GDS only; not supported for NDC or for ticketless carriers.

AirReservation 24.11.44: Pay in installments, structured fare rules, NDC ticket display API | 18 Jul 2024

Adds the ExtendedPayment object to the Add Form of Payment request. Used to request payment in installments with a credit card. Also supports the Pagos Parcelados program for Brazil. When ExtendedPayment is sent, the Add Form of Payment and Reservation Retrieve responses return an ExtendedPayment object with those details. GDS only; not supported for NDC.

Adds the NDC Ticket Retrieve API to retrieve an NDC ticket. Previously, only GDS tickets could be retrieved in the JSON APIs, using the GDS Ticket Retrieve API.

Adds support for returning structured fare rules in the Reservation Retrieve by sending the new query parameter fareRuleType with the value Structured. Optionally, you can also request only specific categories of structured fare rules by also sending the fareRuleCategories parameter with the category names to return.

Adds the SpecialService object to the Reservation Retrieve response to return details about special service requirements. Returned only for the SSR BFFF.

AirReservation 24.11.43.5: Book NDC upsells from price | 24 Jul 2024

For the Add Offer reference payload request, adds support for adding an upsell offer for NDC content in a preceding AirPrice full payload response. NDC only; the AirPrice full payload response does not return upsells for GDS content. The AirPrice reference payload response does not return upsells for either GDS or NDC.

AirReservation 24.11.43: Modify name remarks, PricingPCC & TicketingPCC | 12 Jun 2024

Adds the objects PricingPCC and TicketingPCC to the Add Offer full and reference payload requests in PricingModifersAir. These objects allow users to override the faring or ticketing PCC and are already supported in the Search and Price requests.GDS only; pricing modifiers are not supported for NDC in any request.

Adds support for adding, modifying, and deleting name remarks. Adds the TravelerUpdatableItemComments object to the Updatable Items response and the Traveler Update request. GDS only; not supported for NDC.

AirReservation 24.11.42: Internal updates | 22 May 2024

Internal updates only.

AirReservation 24.11.41: Host Profile Move PCC, Fare Rule fix, SourceDescription | 25 Apr 2024

Adds the optional ProfilePCC object to the Host Profile Move API. Use ProfilePCC to specify the PCC associated with the profile to move when the profile's PCC differs from the PCC in the JSON API booking workbench.

Adds the enum PassportCard to TravelDocument/docType in the Add Traveler request. GDS only; not supported for NDC.

As part of a multi-phase update to JSON API error handling, the SourceDescription object is no longer returned in ErrorDetail for all AirReservation and AirTicketing APIs; this applies to both GDS and NDC content.

AirReservation 24.11.40: Custom rules, additional infant PTCs | 27 Mar 2024

Adds several new APIs to support custom booking rules associated with a PCC. See the Custom Rules Guide for details.

Adds support for the following additional infant PTCs:

  • CNF: Convention Passenger Infant without a Seat

  • CNI: Infant without a seat accompanied by a companion

  • DNF: Disabled Infant without a seat

  • ENF: Emigrant infant without a seat

  • FBI: Numerous family 1 discount infant without a seat

  • FGI: Numerous family 2 discount infant without a seat

  • FIP: Frequent Flyer Infant without a seat - Preferred

  • FNF: Family plan infant without a seat

  • GIF: Group Inclusive Tour Infant without a seat

  • GRI: Group Infant without a seat

  • ICF: Incentive certificates Infant without a seat

  • INR: Infant without a seat Resident

  • LIF: Laborer/worker infant without a seat

  • MIF: Missionary Infant without a seat

  • MNF: Military Infant without a seat

  • NBI: No bag Infant without a seat

  • PEI: Premium economy Infant without a seat

  • SNF: Staff Infant without a seat

  • TNF: Frequent flyer Infant without a seat

  • WBI: Web accompanied Infant without a seat

  • ZEI: ZED employee Infant without a seat

AirReservation 24.11.39.2.1 | 7 March 2024

Adds a new Host Profile Move request to copy traveler profile information already stored in the Travelport system into the JSON API booking workflow so that this data does not need to be re-sent.

AirReservation 24.11.39: ReceivedFrom at workbench commit, tour and surface segments | 21 Feb 2024

Adds an optional payload to the workbench commit to send a ReceivedFrom object. This allows online travel agencies (OTAs) and agents using the Deem platform to send a receive field at reservation creation or update. GDS only; not supported for NDC.

Adds the CustomAuxiliarySegment object to the Reservation object in the Reservation Retrieve response to return any auxiliary segments on a booking. Also adds AuxiliaryDisplaySequence to ReservationDisplaySequence to return the sequence of any auxiliary segments. Auxiliary segments can include air taxi, cars, hotels, surface transportation, and tours. TUR (tour) or SUR (surface) segments are commonly used for rail content, but they can be used for other ground transportation such as taxis, surface transportation and tours. This content cannot be booked in the JSON APIs but is returned in the reservation retrieve when booked through another Travelport platform or an external provider.

AirReservation 24.11.38: Multiple offers with Add Offer, CustomerLoyalty caching | 1 Feb 2024

Add multiple offers with Add Offer reference payload (previously supported only for full payload request).

For NDC only, adds support for caching an invalid number frequent traveler number if an invalid number is sent in the Add Traveler request. Although the response returns the warning message M INVALID FQTV NAME OR NUMBER - {carrier code}, the JSON APIs cache and continue to pass the invalid number to prevent a potential booking failure. With this change, if CustomerLoyalty is sent for NDC in the Search request, it must also be sent in the AirPrice request and the Add Traveler request. Because some NDC carriers validate frequent traveler data through the workflow, failing to send the same CustomerLoyalty details may cause a booking failure at workbench commit.

AirReservation 23.11.37: Internal updates | 13 Dec 2023

Internal updates only.

AirReservation 23.11.36: APIs for custom rules and travel agency address | 29 Nov 2023

Adds support for the following new APIs that can be sent in the initial booking workflow or for an existing reservation:

  • The Travel Agency Address API, which adds, updates, or deletes a travel agency address. The reservation retrieve for a booking returns any travel agency address associated with that booking.

  • The Custom Rule API, which adds the name of a custom rule to a booking. These custom rules are created in a rules booking engine used by your agency. At commit, the booking is compared to the conditions in any rules that have been added to the booking. If any conditions are not met, an error message is returned and the changes in the workbench are not committed. The workbench session is maintained so that the conditions required by the attached rule can be fixed in the booking. You can attach up to three custom rules to a booking. The rules can be associated with your PCC or a PCC that your PCC has an agreement with.

AirReservation 23.11.35: Traveler name remarks | 19 Oct 2023

Adds the Traveler/Comments object to the Add Traveler request payload to support sending optional, freeform traveler name remarks, which can be used to send a unique identifier for each traveler.

AirReservation 23.11.34: Filed fare updates & MIR for NDC | 27 Sep 2023

Adds support for the following on NDC:

  • Adds support to generate a MIR (management information report) for ticket issuance, ticket exchanges, and ticket voids for NDC in the same format as currently exists for GDS ticket issuance and exchanges.

  • Updates handling of filed fare details so that if the price changes between the time of booking and ticketing, the passive booking record reflects the updated price at ticketing.

  • Updates handling of filed fare details so that if there is any change in the itinerary (date change, time change, routing change, etc.) and the airline exchanges the original ticket for a new ticket, the filed fare for the original ticket is canceled and replaced with the filed fare for the exchanged ticket. This ensures the exchange is handed and reported per ARC/BSP standards and that the same information is sent to the MIR and the back office system. (In the BSP market, when the original ticket is exchanged for a new ticket, the fare is collected either as a NO ADC or an ADC. In the ARC(US) market, the fare is created with the total values which includes base fare, taxes and total fare.)

All of the above features can be configured on or off in the configuration file settings for your PCC (pseudo city code, provisioned from Travelport). Contact your Travelport representative for assistance with this setting if needed.

AirReservation 23.11.33: Travel agency corporate ID, updates to remarks| 6 Sep 2023

Adds support for the following:

  • Several updates to remarks; for full details see the Remarks and Service Requests Guide:

    • Deleting several types of remarks from the booking workbench for both GDS and NDC, either during an initial booking or for an existing reservation.

    • Adds NDC support for several types of remarks.

    • Updates the ReservationCommentList and Accounting request payloads and the return of these remarks in the Reservation Retrieve response. By default, AirReservation now uses these updated payloads and responses. However, AirReservation can use the previous payloads and responses if set in your configuration settings with Travelport; contact your Travelport representative for assistance.

AirReservation 23.11.32: Update traveler details on shell booking, unmask card numbers | 23 Aug 2023

Adds support for the following:

  • In the Reservation Retrieve response, returning all digits of the credit card number instead of masking all but the final four digits in FormOfPayment/PaymentCard/CardNumber/Plaintext.

  • Updating a shell booking with any traveler details that can be added or deleted with the Traveler Updateable Items request.

AirReservation 23.11.31 & 31.1: Retrieve and update ticketing time limit | 27 Jul 2023

This release adds support for retrieving, updating, and deleting the ticketing date on an existing booking. GDS only; not supported for NDC.

  • Adds the notificationDate object to the existing Reservation Retrieve response to return the ticketing time limit by default if the booking has one. No changes to the request are required to return the date.

  • Adds support to update or delete the ticketing time limit on existing booking by sending a Workbench Commit payload with Notification/Date. Send either the updated/new date to update or add, or with the value 1000-01-01 to delete the existing ticketing time limit date.

AirReservation 23.11.31.1 was an internal release.

AirReservation 23.11.30: NDC schedule change message, Notepad remarks | 12 Jul 2023

Adds support for the following:

  • Updates the Reservation Retrieve response to return notepad remarks without qualifiers.

  • Internal updates to support booking search content with the new object ProductBrandOffering/Identifier that was added in Search 23.11.31 leg-based search responses when both GDS and NDC content is requested.

  • For NDC only, updates the Reservation Retrieve response to return the message NDC CONTENT HAS CHANGED in ReservationComment when a schedule change has occurred on the NDC itinerary. (For GDS, a value in OfferStatus/StatusAir/code of either TK or UN indicates the flight has schedule change information.)

AirReservation 23.11.29: Multiple booking & remarks updates; return hotel and car content, NDC schedule changes | 05 July 2023

This release adds a number of features to AirReservation as follows.

Accept involuntary schedule changes for NDC

Adds support for NDC for the indicator scheduleChangeAcceptedInd to accept involuntary schedule changes. Send scheduleChangeAcceptedInd in a workbench commit message payload to accept NDC schedule changes when an airline has modified a flight. To check whether a schedule has been modified, send a standard Reservation Retrieve request; the message NDC CONTENT HAS CHANGED (23.11.30 and later) is returned if a flight schedule has changed. To accept the schedule change, send a workbench commit request with scheduleChangeAcceptedInd set to true. You do not need to create a workbench session first.

Currently there are defects associated with accepting involuntary schedule changes for NDC; these will be resolved in upcoming releases; until then you may receive error messages.
Return hotel and car content

Updates the existing Reservation Retrieve and Post-Commit Workbench responses to return by default any hotel or car segments along with air for any booking that includes hotel or car reservations. The hotel and/or car segments must have been reserved with the JSON Hotel or JSON Car (pending) APIs or from a terminal program. Supported for both GDS and NDC air bookings. At this time the only support for this content is to retrieve it. Support for modifying or servicing these bookings is planned for future releases. For full details see the Booking Guide for Air, Hotel, & Car.

Update retention segments

See the links below and Retention Segments for details:

  • Adds support for returning the autoDeleteDate by default in the Reservation Retrieve for any booking that has a retention segment. Adds the Reservation/autoDeleteDate and ReservationDisplaySequence/autoDeleteDateSequence objects to the existing Reservation Retrieve, Workbench Commit, and Post-Commit Workbench.

  • Adds support for modifying or deleting the purge date for an existing retention segment by sending the autoDeleteDate query parameter when committing the workbench in a post-commit session. 

{
              "ReservationResponse": {

                             "@type": "ReservationResponse",
                             "Reservation": {
                                           "@type": "Reservation",
                                           "autoDeleteDate": "2023-12-10",
                                           "ReservationDisplaySequence": {
                                                          "@type": "ReservationDisplaySequence",
                                                          "autoDeleteDateSequence": 4
                                           }
                             },...
Retrieve, update, and delete ticketing time limit on existing booking

This release adds support for retrieving, updating, and deleting the ticketing date on an existing booking. GDS only; not supported for NDC.

  • Adds the notificationDate object to the existing Reservation Retrieve response to return the ticketing time limit by default if the booking has one. No changes to the request are required to return the date. 

... "ReservationResponse": {
        "@type": "ReservationResponse",
        "Reservation": {
            "@type": "Reservation",
             "notificationDate": "2023-07-11",
            "Identifier": {
                "authority": "Travelport",
                "value": "b62190ce-7580-44f9-8ad2-ea8bd617814f"
            },...

  • Adds support to update or delete ticketing time limit on existing booking by sending a Workbench Commit payload with Notification/Date with either the updated/new date or the value 1000-01-01 to delete the existing ticketing time limit date. 

{
 "ReservationQueryCommitReservation": {
  "@type": "ReservationQueryCommitReservation",
  "Notification": [
   {
    "@type": "Notification",
    "QueueNumber": [
     {
      "value": 10
     }
    ],
    "Date": "1000-01-01"
   }
  ]
 }
}
Return same day flights as two products

For an itinerary with outbound and inbound flights occurring on the same day, the Reservation Retrieve response has been updated to return the outbound flights as one product and the inbound flights as a separate product. This supports any subsequent change to one segment of the itinerary. Previously, all segments were returned as one product.

Reservation shell updates

See Create Shell Booking in Case of Booking Failure for full details:

  • Support for adding an offer, form of payment (FOP), and payment information to a shell booking in order to ticket it.

  • Support for adding and deleting several types of remarks to a shell booking even if it does not yet contain an offer:

Remarks updates

Several updates to remarks; see the Remarks & Service Requests Guide for full details. This release updates the payloads and responses for notepad, vendor, associated, unassociated, and historical comments. AirReservation can return either these updated payloads, or the previous payloads, depending on your configuration file settings. Contact your Travelport representative for assistance with this setting.

Add IntermediateStop details

Updated the existing Reservation Retrieve and Post-Commit Workbench responses to return the following objects in the IntermediateStop object: duration, arrivalDate, departureDate, arrivalTime, departureTime.

Minor model version updates

Updates the ODM model version to latest model version 11.10.1. Minor changes only, all of which are noted in the feature list above.

AirReservation 23.11.28: Internal | 27 Apr 2023

Internal updates and defect fixes only.

AirReservation 23.11.27: Internal updates | 10 Apr 2023

Internal updates only.

AirReservation 23.11.26: Standalone pricing for unpriced products| 16 Feb 2023

Adds a new Standalone Price request that prices any unpriced products in the workbench, which occurs when Add Product is used to add flight details during the initial booking flow and skip the Search and AirPrice requests that usually initiate the JSON APIs workflow. Standalone Price is an optional request that can be sent in either the booking or ticketing flows, or in a separate workbench session. Current known issues are noted in the Standalone Price API Reference.

AirReservation 23.11.25: TaxExemption pricing modifier, Add Product booking flow, scheduleChangeAcceptedInd indicator | 26 Jan 2023

Adds support for the following:

  • Adds to the Add Offer full payload the new pricing modifier TaxExemption, which can exempt all taxes on the itinerary or only specific taxes by country list and tax codes. The reservation retrieve and workbench create responses return Tax/exemptInd with a value of true when applicable, and exempted taxes are shown with a value of 0. Must be added as part of the initial booking workflow; cannot be specified for an existing reservation. GDS only; not supported for NDC.

{
  "OfferQueryBuildFromProducts": {
    "@type": "OfferQueryBuildFromProducts",
    "BuildFromProductsRequest": {
      "@type": "BuildFromProductsRequestAir",
      "PricingModifiersAir": {
        "@type": "PricingModifiersAir",
        "TaxExemption": {
          "@type": "TaxExemption",
          "allTaxesExemptInd": true
        }
      },
"PricingModifiersAir": {
        "@type": "PricingModifiersAir",
        "TaxExemption": {
          "@type": "TaxExemption",
          "countries": [
            "AU"
          ],
          "taxCodes": [
            "F1"
          ]
        }
      }
    }
  }
}

  • A new Add Product request supports booking an itinerary without sending price details and without searching or pricing using the JSON APIs. This new full payload request is best suited for corporate customers who frequently travel the same itinerary and do not need or want to check price or alternative options. The request sends flight and class of service data as sourced from outside the JSON APIs. The request takes place as part of the usual booking workflow instead of the Add Offer step: Initiate workbench, Add Product, Add Traveler, Workbench commit. GDS only; not supported for NDC.

  • In the workbench commit request, a new indicator scheduleChangeAcceptedInd that allows customers to accept schedule changes when an airline has modified their flight. To check whether a flight schedule has been modified, send a standard Reservation Retrieve request: a value in OfferStatus/StatusAir/code of either TK or UN indicates the flight has schedule change information. To accept the schedule change, send a workbench commit request with scheduleChangeAcceptedInd set to true. You do not need to create a workbench session first. GDS only; not supported for NDC (implemented for NDC with 23.11.29 above).

  • Updates all book and retrieve services to ODM model version 11.8 to support upcoming functionality in the JSON APIs. No customer-facing changes at this time.

{
 "ReservationQueryCommitReservation": {
  "@type": "ReservationQueryCommitReservation",
  "scheduleChangeAcceptedInd": true
 }
}

AirReservation 22.11.24: Baggage details, flight/fare update notification | 15 Dec 2022

Adds support for the following:

  • A new viewBaggageDetailInd query parameter in the Reservation Retrieve request: Send with a value of true to return additional baggage details in the response in TermsAndConditionsFull/BaggageAllowance. Default is false. GDS only; not supported for NDC.

  • For NDC reservations, an update to ensure that carrier reservation details are also updated when traveler passport details are modified.

  • After the reservation workbench commit, returning a notification message per the examples below if the flight time or fare has changed since the offer was added; GDS only; not supported for NDC:

Price increase example: "The Total Price has been increased from 17272.68 USD to 18272.0 USD"

Price decrease example: "The Total Price has been decreased from 665.7 USD to 620.8 USD"

Flight time change example: "The Departure Date and/or Time has changed from 2023-01-19/16:35:00 to 2023-01-23/18:35:00 for KL 1243 from AMS to CDG"

AirReservation 22.11.23: Unused ticket as FOP, add and retrieve service fee details | 16 Nov 2022

Adds support for the following:

  • Applying an unused ticket as form of payment for a separate booking. NDC only, supported only for AA NDC. Not supported for GDS.

  • Returning the service fee information from the reservation in the reservation retrieve. This service fee information is stored in the remarks (associated and unassociated itinerary remarks.

  • Minor model upgrade to version 11.7 to support upcoming functionality. No customer-facing changes at this time.

AirReservation 22.11.22: Reservation shell for failed booking | 20 Oct 2022

Adds support for the following:

  • Creating a reservation shell that contains traveler details when a booking fails due to inability to either add the offer or quote a fare. This allows an agency to contact the customer offline through their call center and complete the booking as necessary. Note that for the reservation shell to be created, the autoDeleteDate query parameter must be sent at the workbench commit step.

  • For NDC only, sending the account code/corporate ID number at workbench commit, if that number was sent as a pricing modifier in OrganizationInformation//OrganizationIdentifier in the Search request. This retains the account code/corporate ID number without having to enter it in any additional step after Search. The account code/corporate ID number is returned in the workbench commit and reservation retrieve responses. NDC only; not supported for GDS.

AirReservation 22.11.21: Internal updates | 29 Sep 2022

Internal updates only.

AirReservation 22.11.20: PaymentTimeLimit, Short fare rules, additional indicators | 8 Sep 2022

Adds support for the following:

  • Added an optional message payload to the booking workbench commit request to place the reservation on a queue.

  • In the booking commit and the reservation retrieve responses, returning by default the offer expiration date and time in TermsAndConditionsFull/ExpireDate, and the last date and time to ticket an offer in TermsAndConditionsFull/PaymentTimeLimit

  • Returning short fare rules for NDC with a Standalone Fare Rules request for an existing reservation. Previously, requesting short fare rules for NDC was supported after the Search and AirPrice responses but not for an existing reservation. This update brings parity to requesting short text fare rules for NDC and GDS.

  • In the reservation retrieve response, returning the following indicators. Both are GDS only, not supported for NDC.

    • secureFlightPassengerDataRequiredInd: Returned in the TermsAndConditionsFull object when an airline has filed in its schedule that availability for a specific flight is subject to government approval.

    • subjectToGovernmentApprovalInd: Returned in the Flight object when additional passenger data is required for Secure Flight Passenger Data requirements.

AirReservation 22.11.19: Minor updates | 25 Aug 2022

Updates the following responses to align with Swagger formats:

  • Adds @type to the responses for the Primary Contact and OSI comment response.

  • In the reservation retrieve and book commit responses, moves traveler product information for paid seats and baggage to Reservation/TravelerProduct from Reservation/Offer/TermsAndConditions/TravelerProduct.

AirReservation 22.11.18: AvailabilitySourceCode | 28 Jul 2022

Adds the AvailabilitySourceCode object to Product/FlightSegment/Flight in the commit response. GDS only, not supported for NDC.

AirReservation 22.11.17: Internal updates | 30 Jun 2022

Internal updates only.

AirReservation 22.11.16: Fare rules, EMDs in reservation retrieve, NDC seat cancel | 23 Jun 2022

Adds support for the following:

  • A standalone fare rules request for an existing reservation. Previously, you could request standalone fare rules only after the Search or AirPrice response. GDS only; not supported for NDC.

  • Canceling seats for NDC on an existing booking. Previously, seat cancel for an existing booking was supported only for GDS.

  • Returning EMDs in the reservation retrieve for any booking with EMDs, in an instance of Document with @type DocumentEMD. GDS only; not supported for NDC.

  • Normalizes the decimal place across currencies in the reservation retrieve to return consistent amounts in the filed amount and equivalent fares.

  • Resolves an issue that caused all booking session data to be lost when a seat error occurred at commit; now, the error is returned and you may either correct the issue or modify the seat, and continue with the booking session with no data loss.

AirReservation 22.11.15: Add FQTV to reservation for GDS | 19 May 2022

Adds support for adding a frequent traveler number (FQTV) to an existing reservation for GDS through the Updatable Items request. Previously, updating FQTV on an existing reservation was supported only for NDC.

Updated the Ancillary Book response for seats to change the @type of OfferListResponse/OfferID from OfferIdentifier to OffierId.

Added extension to the Telephone object in the Add Traveler payload to support adding an extension for a phone number. GDS only; not supported for NDC.

AirReservation 22.11.14.4: DOB mandatory for child PTCs | 19 May 2022

Updates date of birth details to be mandatory in Traveler/birthDate when adding travelers with any child PTC, including CHD and CNN.

AirReservation 22.11.14.3: Special services remarks update | 21 Apr 2022

In the request payload for adding special services remarks, updated the object SpecialServiceListRequest/SpecialServiceID to be either SpecialServiceID or SpecialService. Either object name is supported.

AirReservation 22.11.14: Fare calculation ladder, reservation sync | 31 Mar 2022

Adds support for the following:

  • In the Reservation Retrieve response, returning for each PTC the fare calculation ladder for all public and private fare types filed by an agency or an airline. Returned in the new object PriceBreakdown/FareCalculation object as a string with unlimited bytes. GDS only; not supported for NDC.
  • For NDC, syncing the reservation with the NDC carrier reservation (or passive PNR) if the passenger phone number or email address is updated.

AirReservation 22.11.13: India GST SSR | 8 Mar 2022

Adds support to send Goods and Services Tax (GST) details for travel within and from India to create applicable GST SSRs. Send in the Add Offer request in OrganizationInformation/GSTRegistrationNumber.

AirReservation 22.11.12: Add brand tier segment to reservation | 1 Feb 2022

Adds support for:

  • Storing segment information with the brand tier number to the reservation so this information is available in the reservation retrieve.
  • Minor model update.
  • Improved error messaging.

AirReservation 21.11.11: Internal updates | 17 Dec 2021

Internal updates only.

AirReservation 21.11.10: Search booking support | 11 Nov 2021

Adds support for booking an itinerary from the Search v11 API.

AirReservation 21.11.9: Net ticket data | 30 Sep 2021

Adds support for returning additional net ticket data (NTD) in the Reservation Retrieve for any fare that has a private fare component. GDS only.

AirReservation 21.11.8: Net ticket data, reservation modify | 19 Sep 2021

Adds support for the following:

  • Adds support for returning specific net ticket data (NTD) in the Reservation Retrieve for any fare that has a private fare component. Returned in the new attributes carCode and valueCode in ProductAir/PassengerFlight/FlightProduct. GDS only.
  • Adding CTCE, CTCM, and CTCR SSRs in the traveler primary contact for NDC (previously supported for GDS), and to add or delete this information for an existing reservation (GDS and NDC).
  • Modifying a reservation by adding and deleting a free meal SSR for both GDS and NDC.

AirReservation 21.11.7: Minimum secure flight | 5 Aug 2021

Adds support for adding minimum secure flight information to the SSR DOCS shared with carriers.

AirReservation 21.11.6: Support for booking from Search | 27 Jul 2021

Adds support for booking an itinerary from the Search API. Note that at this time only GDS booking is supported; support for NDC booking will be added in a future release.

AirReservation 21.11.5: Special meal request and traveler document modify | 8 Jul 2021

Adds support for:

  • Sending SSR special meal requests, on specific NDC carriers only.
  • Currently, traveler documents can be added only when creating a reservation, by sending traveler remarks for SSR DOCA (Address), DOCO (visa, redress number, known traveler), and DOCS (passport). This release adds support for modifying and deleting traveler documents on an existing reservation (SSR DOCS, DOCO, and DOCA for GDS, and SSR DOCS for NDC).

AirReservation 21.11.4: Passenger name change | 15 Jun 2021

Adds support for changes to passenger name.

AirReservation 21.11.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.

  • Reservation and retrieve responses have been enhanced to provide more meaningful error messaging and HTTP status codes.

  • Modify a reservation by adding, updating, or deleting frequent traveler information for all or any passengers on that reservation. NDC only.

  • Fixes a defect that was causing booking failures due to cached data.

AirReservation 21.11.2: Minor updates | 20 Mar 2021

Adds the following update:

  • When a reservation is imported and contains multiple travelers grouped under a single surname, AirReservation indexes those names and creates individual traveler records for each traveler. There is no change in the Reservation Retrieve response.

AirReservation 21.11.1: Model 11 upgrade | 4 Feb 2021

Updates to ODM model 10 v11. Code changes summary below.

The following model changes were made with this upgrade.

Add Traveler request

Traveler (object)

  • Renamed the dob attribute renamed to birthDate.
Add Traveler response
  • Change to start and end brackets after Traveler object. Now inclusive of @type, TravelerIdentifier, Identifier, and value facets.
Add SSR Primary Contact response
  • Instead of returning a 204 No Content response, the response now returns a blank PrimaryContactResponse object.
Add OSI Reservation Comments and General Remarks request and response
  1. In the request, the ReservationCommentRequest object was renamed to ReservationCommentListRequest.
  2. Instead of returning a 204 No Content response, the responses now return an empty ReservationCommentResponse object when blank, or with an identifier when an identifier is returned.
Add Special Service request and response
  • Instead of returning a 204 No Content response, the response now returns a blank ReservationCommentResponse object.

Measurement (object)

  • When a Measurement object is sent or returned, the Measurement type attribute is renamed to measurementType.
Commit workbench response

Price (object)

  • The object CurrencyCode (min/max 3-byte currency code value) was added to the Amount and Taxes/Tax objects.

AirTicketing

Starting with 24.11.x releases, ticketing functionality was included in AirReservation releases.

AirTicketing 23.11.32: Internal updates | 12 Jul 2023

Internal updates only.

AirTicketing 23.11.31: Internal updates | 5 Jul 2023

Internal updates only.

AirTicketing 23.11.30: Reservation divide for same last name | 27 Apr 2023

Resolves an issue in which reservation divide for travelers with the same surname/last name did not work correctly. With this update, travelers with the same surname can be correctly split from one booking onto separate bookings.

AirTicketing 23.11.29: Internal updates | 10 Apr 2023

Internal updates only.

AirTicketing 23.11.27-28: Internal updates | 23 & 30 Mar 2023

Internal updates only to support upcoming functionality.

AirTicketing 23.11.26: Reservation retrieve by ticket number | 26 Jan 2023

Adds the identifierType query parameter to the Reservation Retrieve GET request to support retrieving reservation details by ticket number. Previously, the request could send only the record locator, which is still supported. GDS only; not supported for NDC.

AirTicketing 22.11.25: Traveler-specific commission, multiple offers on reservation | 15 Dec 2022

Adds support for the following:

  • Adding a traveler-specific commission as either an amount or percentage: Send the traveler identifier in the Document Overrides request. GDS only, not supported only for NDC.

  • Combining multiple one-way offers into a booking by repeating the Add Offer step as needed. While there is no specific limit on the number of offers that can be combined, a reservation cannot have more than 16 flight segments. Adds support for GDS, previously supported only for NDC.

AirTicketing 22.11.24: Order divide, retain remarks after migration | 16 Nov 2022

Adds support for the following:

  • Divide a reservation with multiple travelers into separate itineraries. This provides flexibility and avoids the need to cancel a multi-traveler booking if traveler needs change.

  • Retaining remarks when a reservation is migrated to the JSON APIs from previous systems including Worldspan (1P) and Apollo (1V). Retaining these remarks allows customers to complete the follow-up manual exchanges and refunds and to access fare details and retrieve the ticket using the ticket number of the migrated reservation.

AirTicketing 22.11.23: Internal updates | 20 Oct 2022

Internal updates only.

AirTicketing 22.11.22: New indicators | 29 Sep 2022

Adds support in the Ticket Retrieve response for returning indicators for tax exempt, inclusive tour (IT) and bulk ticket (BT), in the new indicators exemptInd, iTFareInd, and bTFareInd.

AirTicketing 22.11.21: Brand attributes in Reservation Retrieve | 8 Sep 2022

Adds a new query parameter to the reservation retrieve request to support requesting brand attributes. If requested, brand attributes are returned in the response in Offer/Product/PassengerFlight/FlightProduct/Brand. GDS only; not supported for NDC.

AirTicketing 22.11.20: Internal updates | 25 Aug 2022

Internal updates only.

AirTicketing 22.11.19: Group connection details | 21 Jul 2022

Adds the connectionInd attribute to the ticket retrieve response to indicate that a leg of the itinerary has connecting flights.

AirTicketing 22.11.18: Extended ticket void period | 23 Jun 2022

Adds support for taking into account tickets issued past midnight and on weekends and holidays in determining the allowable ticket void period. Supported only for ARC users, not BSP. Ticket Void is GDS only.

AirTicketing 22.11.17: Internal | 19 May 2022

Internal updates only.

AirTicketing 22.11.16: Multiple GDS offers | 21 Apr 2022

Adds support for repeating the add offer step to add multiple GDS offers.

AirTicketing 22.11.15: Multiple FOP, reservation retrieve updates | 31 Mar 2022

Adds support for the following:

  • In the Reservation Retrieve response, details for tickets that have been exchanged or refunded.
  • In the Reservation Retrieve response, details related to VAT taxes on a change fee and residual value.
  • Support for using multiple forms of payment when one is a non-standard card or cash. When sending a non-standard credit card, send inhibitPaymentCardAuthorizationInd with a value of true in the Add Form Of Payment request.

AirTicketing 22.11.14: Internal updates | 8 Mar 2022

Internal updates only.

AirTicketing 22.11.13: Trace and transaction IDs | 1 Feb 2022

Adds 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.

AirTicketing 21.11.12: EMD issuance | 2 Dec 2021

Adds support for issuing an EMD for select paid ancillaries.

AirTicketing 21.11.11: Defect fixes | 11 Nov 2021

Resolves two minor booking defects.

AirTicketing 21.11.10: Internal updates | 28 Oct 2021

Internal updates only.

AirTicketing 21.11.9:  Document information (DOCI) | 14 Oct 2021

This release adds support for:

  • Adding the document information (DOCI) accounting remarks as notepad remarks. GDS only. These remarks are returned in a Retrieve reservation response.

  • Retrieving only the document information (DOCI) accounting remarks using Retrieve reservation. Both NDC and GDS.

AirTicketing 21.11.8: EMD display and void | 19 Sep 2021

Adds support for EMD display and void for GDS.

AirTicketing 21.11.7.1: Defect fixes | 28 Aug 2021

Resolves a defect that returned an error during ticketing when the traveler surname exceeded 16 characters and another defect causing ticketing commit issues for certain customers.

AirTicketing 21.11.7: Internal updates | 19 Aug 2021

Internal updates only.

AirTicketing 21.11.6: Defect fixes | 5 Aug 2021

Defect fix for issues with canceling a reservation.

AirTicketing 21.11.5: Internal updates | 8 Jul 2021

Internal updates only.

AirTicketing 21.11.4: SSR FOID and NDC | 15 Jun 2021

Adds support for the following:

  • Sending SSR form of ID (FOID) to carriers that require it for ticketing.
  • Booking paid seats, only for NDC and only specific carriers as listed in the Seats Guide. (GDS paid seats are supported in 21.11.12 and later.)
  • Canceling a ticket and retaining the segments (NDC only).

AirTicketing 21.11.3: Add offer to existing/expired reservation | 27 Apr 2021

Adds support for adding an offer to an existing reservation, such as when the previously added offer has expired and can no longer be booked. The step for adding an offer to an existing reservation is the same as when creating a reservation. GDS only.

AirTicketing 21.11.2: Defect fixes | 3 Apr 2021

Defect fixes:

  • Value field is not required with DocumentOverrides/TourCodes with tour type of Bulk Tour or Inclusive Tour.
  • Corrected tax currency in Ticket Display

AirTicketing 21.11.1: Model 11 upgrade, new remarks | 4 Feb 2021

Updates to ODM model 10 v11. Code changes summary below.

Other changes include:

  • Replaced back office remarks with document override and accounting remarks, for GDS only. Back office remarks are not supported in v11 and later.
  • Adds the optional detailViewInd query parameter to the reservation retrieve request. Sending detailViewInd set to true retrieves any document override and accounting remarks that were added to the reservation.

The following model changes were made with this upgrade.

Commit Response

Document object

  1. Renamed @type attribute value to DocumentTicket from Document for ticket issuance; DocumentTicketExchange for an exchanged ticket.

  2. Renamed TravelerRef object to TravelerIdentifierRef.
  3. Added Amount and Total objects for the total fare for that traveler.
Display Ticket Response

TicketID object

  • Renamed @type attribute value to TicketSummary from TicketDetail.

FormOfPayment object

  1. Renamed @type values FormOfPaymentCash to Cash, FormOfPaymentPaymentCard to Paymentcard, and FormOfPaymentInvoice to Invoice.
  2. Removed expireDate, approvalCode and CardCode.

TicketSegment object

  1. Renamed to TicketSegment from FlightSegment.
  2. Renamed Status @type ProviderStatus to only Status.
  3. Moved ClassOfService and FareBasisCode objects to TicketSegment from FlightProduct.
  4. Moved and renamed from TermsAndConditionsFull/ BaggageAllowance/BaggageItem to TicketSummary/TicketBaggage.

TicketPrice object

  1. New object TicketPrice.
  2. Removed PriceBreakdown/TicketPrice/PriceBreakdown and moved all attributes (Amount, CurrencyCode, tax, Taxcode and value) into TicketPrice.

Seats

Starting with 24.11.x releases, Seats functionality was included in Ancillaries releases.

Seats 23.11.15: Seat Maps after Search | 27 Apr 2023

Adds a new request to retrieve seat maps after any search response, allowing customers to view seat availability and fare details earlier in the workflow. This reference request passes identifiers from a preceding Search, Next Leg Search, or Flight Specific Search response. Previously seat maps could not be requested until after pricing or after establishing a booking workbench. GDS only; not supported for NDC.

Seats 22.11.11: Remove trailing zeros | 8 Sep 2022

Updates the seat map response to remove trailing zeros in the objects in Price that return amounts; e.g,, 54.00 is now returned as 54.

See the Ancillaries 22.11.9 release notes for namespace updates that affected both Ancillaries and Seats.

Seats 22.11.10: Sort seat map by segment sequence | 25 Aug 2022

Updates the sorting of the GDS seat map response to sort by segment sequence number instead of flight number. NDC responses are already sorted by segment sequence number.

In addition, this release modified TravelerProduct in the response to any workbench commit, create post-reservation workbench, and reservation retrieve for a reservation with seats; see the Ancillaries 22.11.9 release notes for details.

Seats 22.11.9: Cancel seats from workbench | 21 Apr 2022

Adds support for canceling seats in the workbench. New seats can then be selected in the same workbench session if desired.

Seats 22.11.8: Internal updates | 8 Mar 2022

Internal updates only.

Seats 22.11.7: Seat map after price | 1 Feb 2022

Adds support for a seat availability request after pricing. Previously, seat availability could not be requested until the booking workflow session. GDS only; not supported for NDC.

Seats 21.11.6: Internal updates | 16 Dec 2021

Internal updates only.

Seats 21.11.5: Seat map NDC update | 02 Dec 2021

Updates the seat map request to support sending multiple segments in a single request for NDC. Previously, requesting seat maps for multiple segments was supported only for GDS.

Seats 21.11.4: Seat book endpoint update | 16 Sep 2021

Updates the seat booking endpoint for GDS free seats, NDC free seats, and NDC paid seats to align with the ancillary endpoint used to book GDS paid seats. With this release, all four types of seats (GDS and NDC both free and paid) use the same resource.

Seats 21.11.3: Internal updates | 8 Jul 2021

Internal updates only.

Seats 21.11.2: GDS seat data update | 29 Jun 2021

Adds the following data to the GDS Seat Map response that was previously returned only in the NDC response:

  • Price value of 0.00 for free seats
  • The brand name seat assignment for free seats
  • Extra flight details (airport, date, time)
  • Layout of aircraft

Updated the Seat Book request for NDC to require the objects CatalogOfferingIdentifier and TravelerIdentifierRef, which aligns with the GDS request.

Seats 21.11.1: Model 11 upgrade, request seats by offer or product | 15 Apr 2021

Updates to ODM model 10 v11. Code changes summary below.

Seats v11 adds support for any of three types of seat map requests:

  • all flights within an offer
  • all flights within a product
  • a single flight or multiple flights within an offer or product

The following model changes were made with this upgrade.

Seat Map request

Adds OfferIdentifier, Productidentifier, and SegmentSequenceList objects.

Seat Map response
  • Updated Traveler object name to TravelerIdentifierRef.
  • The defaultCurrency object was removed.
  • The object CurrencyCode (min/max 3-byte currency code value) was added to the Price and Amount objects.
Seat Book request

  • Updated TravelerIdentifier object name to TravelerIdentifierRef.

Seat Book response
  • Updated Traveler object name to TravelerIdentifierRef.

Exchange APIs

The Exchange APIs support only GDS, not NDC content. See the Exchange, Refund, and Void Guide for NDC options.

Eligibility API

Exchange Eligibility 24.11.28: Error handling for multi-offer bookings | 21 Aug 2024

Adds the following error message when a ticket with multiple offers is sent to Eligibility using the Locator query parameter: MULTI OFFER EXISTS - USE ELIGIBILITY BY TICKET WORKFLOW. The Ticket query parameter should be used instead.

Eligibility 24.11.27: Internal updates | 19 Jun 2024

Internal updates only.

Exchange Eligibility 24.11.26: Updated error message | 17 Apr 2024

Updates the error message returned when a ticket has already been exchanged is sent in an Eligibility request to Tickets that have been previously exchanged are not currently supported for exchange processing.

Eligibility 24.11.25: Internal updates | 20 Mar 2024

Internal updates only.

Eligibility 24.11.24: Error message update | 13 March 2024

Adds an error message to be returned when a booking is presented for eligibility that has the same PTC types priced separately, such as when passengers are booked using different filed fares or fare basis codes (FBCs). This scenario is not supported and returns the error message MULTIPLE FARE CONSTRUCTION EXIST - divide the PNR.

Exchange Eligibility 24.11.23: Support numeric PTCs | 28 Feb 2024

Adds support for checking eligibility of tickets with PTCs that have a numeric component, e.g., SRC65, YTH17.

Exchange Eligibility 24.11.22: PCC in header | 1 Feb 2024

Adds support for the header field TVP-PCC-CORE to send the PCC instead of the access group.

Exchange Eligibility 23.11.21: Error message for previously exchanged ticket | 13 Dec 2023

Adds an error message when a ticket number for a ticket that has previously been exchanged is sent: Tickets that have been previously exchanged are not currently supported for exchange processing.

Exchange Eligibility 23.11.20: Internal updates | 15 Nov 2023

Internal updates only.

Exchange Eligibility 23.11.19: Internal updates | 7 Sep 2023

Internal updates only.

Exchange Eligibility 23.11.18: Internal | 24 Aug 2023

Internal updates only, including an update to a minor model version.

Exchange Eligibility 23.11.17: Internal updates | 12 Jul 2023

Internal updates only.

Exchange Eligibility 23.11.15 & 16: Error messaging compliance | 6 Jul 2023

Continued integration work on returning the standard JSON API error messages.

Exchange Eligibility 23.11.14: Support for open tickets without PNRs | 22 Mar 2023

Adds support for checking exchange eligibility by ticket for tickets that are open but the reservation record no longer exists.

Exchange Eligibility 23.11.13: Minor model updates | 23 Feb 2023

Updates Eligibility to ODM model version 11.8 to support upcoming functionality. No customer-facing changes at this time.

Exchange Eligibility 22.11.11: Internal updates | 15 Dec 2022

Internal updates only.

Exchange Eligibility 22.11.10: Internal updates | 16 Nov 2022

Internal updates only.

Exchange Eligibility 22.11.9: ARNK segments | 1 Sep 2022

Adds support for checking eligibility for a reservation with ARNK (arrival unknown) segments.

Exchange Eligibility 22.11.8: Messaging for multiple reissue ticket | 18 Jun 2022

The Exchange APIs do not support exchanging tickets that have already been reissued. This release adds the following error message with StatusCode 200 when Eligibility is checked for a previously exchanged ticket: "Tickets that have been previously exchanged are not currently supported for Exchange processing".

Exchange Eligibility 22.11.7: Updates | 31 Mar 2022

Adds support for the following:

  • Standardized error messaging with other Air APIs, returning errors in Result/Error.

  • Updated error messaging about split/multiple tickets, which Eligibility does not support. Eligibility now returns the message "Records with multiple tickets for a traveler are not currently supported."

  • To align with other Swagger updates, removing the characters ID in TicketChangeEligibilityListResponse/TicketChangeEligibilityID, changing the object name to TicketChangeEligibility.

Exchange Eligibility 22.11.6: Conjunctive ticket numbers | 1 Feb 2022

Adds support for returning conjunctive ticket numbers in the Eligibility response. Conjunctive ticket numbers are returned in TicketChangeEligibilityID/Identifier/value and have a hyphenated format as follows:

 "value": "0163768864791-792"

Exchange Eligibility 21.11.5: Internal updates | 2 Dec 2021

Internal updates only.

Eligibility 21.11.4: Internal updates | 28 Oct 2021

Internal updates only.

Exchange Eligibility 21.11.3: Passenger-level eligibility | 16 Sep 2021

Updates the Eligibility response to return eligibility details at the passenger level instead of the PTC level.

Eligibility 21.11.2: Currencies other than two decimal places | 28 Jun 2021

Resolves several defects. Adds support for currencies that have 0, 1, and 3 decimal places. Previously, only currencies with 2 decimal places were supported.

Eligibility 21.11.1: Model 11 upgrade | 18 Feb 2021

Updates to ODM model 10 v11. Code changes summary below.

The following model changes were made with this upgrade.

Eligibility response

Penalty (object)

  1. The Penalty object has changed to an array.

Amount (object):

  1. The attribute minorUnit was added to the Amount object.

Exchange Search

Exchange Search 24.11.32: Internal updates | 3 Oct 2024

Internal updates only.

Exchange Search 24.11.31: Multi-offer exchanges | 21 Aug 2024

Adds support for exchanging tickets with multiple offers. The exchange for each offer must take place in its own workbench session. For example, if exchanging a ticket with one offer for each leg of a round-trip itinerary, use two workbench sessions to exchange. The workflow for each exchange is the same as usual.

Exchange Search 24.11.30: Internal updates | 19 Jun 2024

Internal updates only.

Exchange Search 24.11.29: Return original ticket price | 17 Apr 2024

In the Exchange Search response, adds the new object ReferenceList with @type ReferenceListExchangedPrice to return price details by PTC for the original ticket price.

Exchange Search 24.11.28: Internal updates | 20 Mar 2024

Internal updates only.

Exchange Search 24.11.27: Internal updates | 13 Mar 2024

Internal updates only.

Exchange Search 24.11.26: Error message for separate FBCs | 28 Feb 2024

Adds an error message to be returned when a booking is presented for exchange that has the same PTC types priced separately, such as when passengers are booked using different filed fares or fare basis codes (FBCs). This scenario is not supported and returns the error message MULTIPLE FARE CONSTRUCTION EXIST - divide the PNR.

Exchange Search 24.11.25: PTC handling, PCC in header | 1 Feb 2024

Adds support for processing and showing PTCs that include an age. For example, if the booking has a PTC of SRC65, previously it was shown as SRC; with this update, it is shown in full as SRC65.

Adds the new header field TVP-PCC-CORE, which supports sending the PCC for authentication as an alternative to sending the access group.

Exchange Search 23.11.24: Error message for previously exchanged ticket | 13 Dec 2023

Adds an error message when a ticket number for a ticket that has previously been exchanged is sent: Tickets that have been previously exchanged are not currently supported for exchange processing.

Exchange Search 23.11.23: Cabin preferences | 15 Nov 2023

Adds support for searching with a cabin type and preference at either the leg or itinerary level. This supports automated exchanges when the customer wants to change cabin with their ticket exchange.

Exchange Search 23.11.22.1: Calculated Fares modifier | 20 Sep 2023

Adds the pricing modifier CalculatedFareAdjustment to PricingModifiersAir. Allows customers who have airline calculated fares to increase or decrease those fares during exchanges. The @type value for CalculatedFareAdjustment specifies whether to increase or decrease the fare as follows. Use with the AmountPercent object to specify the amount or percentage.

  • @type CalculatedFareAdjustmentDiscount discounts the fare.

  • @type CalculatedFareAdjustmentIncrease increases the fare.

Exchange Search 23.11.22: Return only fares for specified account code | 7 Sep 2023

Adds support for a new indicator, accountCodeFaresOnlyInd, to limit the fares returned to only fares filed for that account code. Send OrganizationIdentifier/accountCodeFaresOnlyInd set to true, along with one or more account codes in OrganizationIdentifier/value. If sending multiple account codes send each instance with accountCodeFaresOnlyInd set to true. If not sent the default is false.

Exchange Search 23.11.21: PricingPCC modifier | 24 Aug 2023

Adds support for the new pricing modifier PricingPCC. Send PricingModifiersAirChange/PricingPCC along with fareType set to PrivateFaresOnly to send a PCC for which a selective access or code group agreement exists between that PCC and the PCC associated with your account. (PCC is the pseudo city code; a travel provider's identification code for the JSON APIs, provisioned from Travelport.)

 ...
 "PricingModifiersAirChange": {
    "@type": "PricingModifiersAirChange",
    "FareSelection": {
     "@type": "FareSelectionDetail",
     "fareType": "PrivateFaresOnly"
    },
    "PricingPCC": "DU7"
   }, 
   ...

Exchange Search 23.11.20: Internal updates | 13 Jul 2023

Internal updates only.

Exchange Search 23.11.19: Return rate of exchange | 6 Jul 2023

Adds a new object, CurrencyRateConversion, to the Exchange Search response to return the conversion rate when the POS (point of sale) and flight originating country are different. CurrencyRateConversion is not returned when the POS and originating country are the same.

"CurrencyRateConversion": [
            {
                "@type": "CurrencyRateConversion",
                "SourceCurrency": {
                    "value": "GBP"
                },
                "TargetCurrency": {
                    "value": "AUD"
                },
                "ConversionRate": {
                    "rateAsOf": "2023-05-03T06:49:00Z",
                    "value": 1.833236
                }
            }
        ]

Exchange Search 23.11.17 & 18: Internal updates | 5 Apr 2023

Internal updates only.

Exchange Search 23.11.16: Minor model updates | 23 Feb 2023

Updates Exchange Search to ODM model version 11.8 to support upcoming functionality. No customer-facing changes at this time.

Exchange Search 22.11.14: Internal updates | 15 Dec 2022

Internal updates only.

Exchange Search 22.11.13: Error message update, AvailabilitySourceCode | 19 Nov 2022

Adds support for:

  • Updated error message when Exchange Search is requested for any ticket with unconfirmed segments to "Records with unconfirmed segments are not currently supported for Exchange Search processing."

  • In the response, populating the AvailabilitySourceCode object in ProductAir/FlightSegment/Flight ; see the Search API Reference for possible values and definitions.

Exchange Search 22.11.12 | 29 Sep 2022

Internal updates only.

Exchange Search 22.11.11: Additional response data | 1 Sep 2022

Adds support for the following additional data in the Exchange Search response:

  • Returning the cabin type, in PassengerFlight/FlightProduct/cabin.

  • The duration of any connection, in Product/FlightSegment/connectionDuration.

  • The total travel duration for a product (one leg of the itinerary), in Product/totalDuration.

Exchange Search 22.11.10: PaymentTimeLimit, additional offers | 18 Jun 2022

Adds support for the following:

  • Returning the last date and time to ticket in the TermsAndConditions/PaymentTimeLimit object in the Exchange Search response. This is the date and time until which an offer is valid and can be issued or exchanged.

  • Increasing the number of offers returned from 14 to 25.

Exchange Search 22.11.9: Updates | 31 Mar 2022

Adds support for the following:

  • ARNK (arrival unknown) segments for an itinerary with two O&D and ARNK segments. Not supported for open jaw itineraries.

  • Adding intermediate stop details to the Exchange Search response in ReferenceListFlight/IntermediateStop.

  • Standardized error messaging with other Air APIs, returning errors in Result/Error.

  • Updated error messaging about split/multiple tickets, which Search does not support. Search now returns the message "Records with multiple tickets for a traveler are not currently supported."

  • New indicator changeFeeIssuedSeparatelyInd, returned In the Exchange Search response, when a refund will be returned along with a change fee.

  • In the Exchange Search response, returning for each PTC the fare calculation ladder for all public and private fare types filed by an agency or an airline. Returned in the new object PriceBreakdown/FareCalculation as a string with unlimited bytes.

In addition, to align with Swagger changes in other releases made to better support customers in generating code from Swagger files, the @type discriminators have been updated to the following values:

  • CatalogOfferingModifyTvp @type updated to CatalogOfferingModify
  • Flight @type updated to FlightID
  • Brand @type updated to BrandID
These updated values are not yet shown in all examples across the online help.

Exchange Search 22.11.8: Error messaging, past date and fare type in response | 1 Feb 2022

Adds support for:

  • Validation for reservations with previously exchanged tickets and new error message "Tickets that have been previously exchanged are not currently supported for Exchange Search processing."

  • Minor model update with following changes:

    • New object CatalogOffering/ProductOptions/Product/PassengerFlight/FlightProduct/fareType in response to return the fare type for that flight. Possible values are AirlinePrivateFare, AgencyPrivateFare, NetFare, PublicFare.

    • New object CatalogOffering/PastDate in the response; PostDate lists segment IDs that have already been flown, allowing those segments to be hidden from the response if desired.

{
    "PastDate": [
        "s1",
        "s2"
    ]

Exchange Search 21.11.7: Internal updates | 2 Dec 2021

Internal updates only.

Exchange Search 21.11.6: VAT for change fees | 28 Oct 2021

Adds support for returning VAT information for a change fee in the Exchange Search response.

Exchange Search 21.11.5: Fare type and net ticket data| 30 Sep 2021

Adds support for:

  • Specify fare type in the request.

  • Returning net ticket data for fares that have a private fare component. Returned in the new attributes carCode and valueCode in ProductOptions/PassengerFlight/FlightProduct. The request must send the private fare code. GDS only.

Exchange Search 21.11.4: Internal updates | 16 Sep 2021

Internal updates only.

Exchange Search 21.11.3: Support for multiple O&D, interline, and open jaw itineraries | 28 Jun 2021

Expands search capabilities by adding support for multiple origin and destination / circle trips, interline tickets, and open jaw. Also included the following:

  • Addition of the ChangeFeeCollectionMethod object to the TermsAndConditions/FulfillmentMethod object, which updates the display of any change fee that is to be collected through a tax.
  • Hiding private fares in the exchange search response until they are fully supported to prevent errors at booking.

Exchange Search 21.11.2: Flight type, account code, and exclude unbundled fares | 3 Apr 2021

Adds support for the following:

  • Specifying the type of flights to return.
  • Sending up to 5 account/contract codes in the request if they are required for agency or airline private fares.
  • Specifying whether to exclude unbundled fares in the response.
  • Supporting double connections in the original ticket and returning double connections in the response as options.

Exchange Search 21.11.1: Model 11 upgrade | 18 Feb 2021

Updates to ODM model X v11. Code changes summary below.

Other features:

  • Support for specifying PTC in the Exchange Search request in the PassengerCriteria object. This allows the PTC to be changed for a passenger; for example, if a passenger age has changed from child (CNN) to adult (ADT).
  • In the PassengerCriteria object, support for the optional indicator specifiedPassengerTypeCodeOnlyInd to specify a PTC for which a fare should be returned. Note if no fares are available for that PTC an error message is returned.
  • In the Exchange Search response, the new object TermsAndConditions/Fulfillment Method specifies how any refundable balance will be handled.

Known defects include:

  • Reservations containing a child PTC specified only with date of birth are considered as adult by the system during the exchange process. In order to process it as a child PTC, reservations should use PTC as CNN or C05 (PTC with age component).

The following model changes were made in the Exchange Search API with this upgrade from model v10:

Exchange Search request

CatalogOfferingsQueryAirChange object

  1. The CatalogOfferingsAirChangeRequest object was added as a wrapper object for all remaining objects.
  2. In CatalogOfferingsAirChangeRequest, the PassengerCriteria object was added:
    1. Optional
    2. @type PassengerCriteriaAirChange.
    3. Key value pairs are age and passengerTypeCode.
    4. Includes TravelerIdentifierRef object with id attribute.
    5. Optional specifiedPassengerTypeCodeOnlyInd indicator.

SearchCriteriaFlightChange object

  • The SearchCriteriaFlightChange object was renamed to SearchCriteriaFlight.
Exchange Search response

TermsAndConditions object

  1. The FulfillmentMethod object was added.
  2. FulfillmentMethod includes RefundMethod object:
    1. Includes value attribute.
    2. Supported values are RefundOriginalFOP, EMD, MCO, Unknown.

CatalogOfferingsAirChangeResponse object:

  • DefaultCurrency object removed.

Price/PriceBreakdown/Amount object:

  • Fees structure changed.

TermsAndConditions/BaggageAllowance/BaggageItem object:

  • ValidatingAirlines object added. Contains ValidatingAirlines object to specify the validating airlines.

PriceDifference/ModifyPrice object:

  • The PriceDifference object was renamed to ModifyPrice.
  • The currencyCode object was added to ModifyPrice:
    • Key value pairs decimalPlace and value.

TicketSegment object:

  • The TicketSegment object was renamed to ManualFareSegment.

PassengerFacilityChargeBreakdown object:

  • PassengerFacilityChargeBreakdown renamed to PassengerTaxBreakdown

Exchange Ticketing

As of Feb 2023 Add Payment has become a mandatory step in the GDS exchange workflow.

Exchange Ticketing 24.11.26: Add/delete remarks during exchanges | 12 Dec 2024

Adds support for adding or deleting reservation remarks during the exchange process. These remarks are sent in the Reservation Comments payload and include vendor, OSI, itinerary, notepad, historical, accounting, and DOCI remarks. Remarks can be added or delete for both issuing tickets or holding the booking at workbench commit. See the Remarks and Service Requests Guide for endpoints and payload details.

Exchange Ticketing 24.11.25.3: Stored fare modifiers | 3 Dec 2024

Adds support for saving any pricing modifiers used in searching for an exchanged itinerary. These modifiers are stored as part of the filed fare. They are not returned in the JSON API response but can be accessed as historical notepad remarks through a terminal program such as Smartpoint Desktop.

Exchange Ticketing 24.11.23: Multi-offer exchanges, extended offer history | 22 Aug 2024

Adds support for exchanging tickets with multiple offers. The exchange for each offer must take place in its own workbench session. For example, if exchanging a ticket with one offer for each leg of a round-trip itinerary, use two workbench sessions to exchange. The workflow for each exchange is the same as usual.

Adds support for storing extended offer history, which may be pricing or a historical filed fare, whenever an exchange is completed. This extended offer history is not returned in the JSON API response but can be accessed as historical notepad remarks through a terminal program such as Smartpoint Desktop.

Exchange Ticketing 24.11.20: Apply ticket designator change by PTC | 1 Feb 2024

Adds support during ticket exchanges for adding or modifying a ticket designator for an individual PTC. Previously, any change in the ticket designator was applied to all travelers on the itinerary.

Exchange Ticketing 23.11.19: Internal updates | 13 Dec 2023

Internal updates only.

Exchange Ticketing 23.11.18: Internal updates | 15 Nov 2023

Internal updates only.

Exchange Ticketing 23.11.17: Return previously issued ticket number | 11 Oct 2023

Adds support for the following:

  • Updates the Ticket Retrieve response to returns the previously issued ticket number and issuing agency details when a ticket has been exchanged. The new object PreviousIssue returns the ticket number, issuing city, issue date, and IATA agency code.

Exchange Ticketing 23.11.16: Return VAT tax details | 6 Sep 2023

Updates the Exchange Ticketing commit response to include VAT tax handling on a change fee and note whether the tax is included in the change fee.

 ...                        "Amount": {
                                "@type": "Amount",
                                "Base": 90.00,
                                "Taxes": {
                                    "@type": "TaxesDetail",
                                    "TotalTaxes": 9.00,
                                    "Tax": [
                                        {
                                            "currencyCode": "AUD",
                                            "taxCode": "UO",
                                            "description": "VAT on Change Fee",
                                            "decimalPlace": 2,
                                            "value": 9.00
                                        }
                                    ]
                                },
                                "Total": 99.00
						},...

Exchange Ticketing 23.11.15: Ticket designator, create MCO in pay later flow | 5 Jul 2023

Adds support for the following:

  • A new TicketDesignator object in the Document Overrides request to allow ARC and BSP Canada API customers to add or modify a ticket designator during the exchange flow. The ticket designator applies to all travelers on the reservation.

  • When there is a residual balance to an MCO (miscellaneous change order) during the exchange process, the pay later flow is updated to create but not yet issue the MCO at commit. (The pay later flow creates a reservation for the new itinerary but does not yet issue the ticket.) This allows customers display, modify, and issue their own MCO outside of the JSON APIs if desired. If the reservation is subsequently ticketed in Exchange Ticketing, the MCO is issued as usual at commit. There is no change to the pay now flow, in which the reservation is made, the ticket issued, and the MCO issued in the same session.

Exchange Ticketing 23.11.14: Update for carrier IB | 5 Apr 2023

Modifies response for carrier Iberia (IB), which no longer allows a refund fulfillment to EMD, when a ticket is presented for exchange and has an applicable residual balance. In this case, in both the Exchange Search and Exchange Ticketing commit response, the refund method is returned with a value of Unknown per below:

"FulfillmentMethod": [
                                {
                                    "@type": "FulfillmentMethod",
                                    "RefundMethod": {
                                        "value": "Unknown" ...

Exchange Ticketing 23.11.13: Additional EMD details, payLaterInd required | 26 Jan 2023

Adds support for the following:

  • In the ticket exchange commit response, adds the new object EMDDescription to the Document object. In addition, Document/type is returned with a value of either DocumentEMD for open EMDs or DocumentEMDRefund for refunded EMDs. 

     			{
                            "@type": "DocumentEMDRefund",
                            "Number": "1252901089719",
                            "TravelerIdentifierRef": {
                                "name": "ROGELIO VAZQUEZ",
                                "passengerTypeCode": "ADT",
                                "id": "travelerRefId_1",
                                "value": "d658dc8b-bca3-48a0-87cc-07c99842f022"
                            },
                            "Amount": {
                                "@type": "Amount",
                                "Total": 649.0
                            },
                            "EMDDescription": {
                                "value": "REFUNDABLE"
                            }
                        }

  • Updates the workbench commit request to require the payLaterInd indicator in the endpoint, which specifies specify whether to hold the booking (true) or issue tickets now (false). Previously, this indicator was optional and defaulted to false if not sent.

  • Previously, Exchange Ticketing returned an error and did not proceed with the exchange when the ChangeFeeCollectionMethod was Unknown. With this update, Exchange Ticketing completes the exchange and defaults the change fee to a tax with tax code CP. No message is returned.

Exchange Ticketing 22.11.12: EMD endorsements, error updates | 16 Nov 2022

Adds support for the following:

  • Adding endorsements to an EMD. Use the new object Restrictions/DocumentType in the Document Overrides request.

  • If any segments requested with the Add/Modify Offer request are waitlisted, the response returns an error and does not update the reservation. Previously, the reservation would be updated with the waitlisted segment, which would cause a failure at commit if the segments sold out between the Add/Modify Offer request and the commit. The error message returned is INVENTORY IS NO LONGER AVAILABLE.

  • Returning an error instead of a warning when an error that does not prevent ticketing occurs at the commit step. The text of the message itself has not changed.

Exchange Ticketing 22.11.11: Error messaging | 20 Oct 2022

Integrates with the common error handler used for most other JSON APIs so that standard error messages are returned for Exchange Ticketing.

Ticketing Exchange 22.11.10: Forfeit residual amounts for ARC | 25 Aug 2022

Adds support for ARC customers to forfeit residual amounts in exchanges. Previously, this was available only to BSP customers. Functionality is the same.

Exchange Ticketing 22.11.9: FOP for fees, DocumentValue parameter | 9 Jun 2022

Adds support for the following; see the Exchange, Refund, and Void Guide:

  • Referencing a form of payment (FOP) in the Add Payment request for the change fee being applied to an EMD: After adding the FOP, add the Fees object to the Add Payment payload to apply the referenced FOP to that fee.

  • The optional new query parameter DocumentValue, which can be used to request that a refundable balance EMD be automatically refunded after ticket issuance.

  • New Document @type values in the commit response: 

    • The previous (exchanged) tickets are returned with Document @type DocumentTicketExchange.

    • The newly issued tickets are returned with Document @type DocumentTicket.

    • If an EMD is issued during the exchange, such as for a change fee or a residual balance, the commit response returns Document @type DocumentEMD with the EMD number and the amount.

Exchange Ticketing 22.11.8: Payment updates | 21 Apr 2022

Adds support for the following:

  • Adding an alternate form of payment (FOP) when issuing tickets later. In previous versions, alternate FOP was supported only for ticket/s issued at workbench commit.

  • Specifying in the Document Overrides remark request how to collect VAT tax on a change fee.

  • Returning more accurate currency details when the travel originates from a different country than the ticketing country.

Exchange Ticketing 22.11.7: Issue now or later parameter, waive change fees | 1 Feb 2022

Adds support for the following; see the Exchange, Refund, and Void Guide for details:

  • Applying commission to base fare, change fee, or both, in a document override remark. Previously a commission applied only to the base fare.

  • Exchanging an itinerary with conjunctive tickets.

  • Adding multiple forms of payment during exchange.

  • Waiving a change fee.

  • Forfeiting residual fare/taxes collected on prior ticket.

  • A new query parameter, payLaterInd, indicating whether to issue the new ticket/s now or later.

Exchange Ticketing 21.11.6: Commission on change fee | 2 Dec 2021

Adds the ApplyTo object to Commissions in document override remarks. ApplyTo allows you to apply an instance of Commissions/Commission to either the change fee (send with a value of Fee) or the base fare (send with a value of Base). ApplyTo is supported only in document overrides sent as part of Exchange Ticketing.

Exchange Ticketing 21.11.5.2: Defect fix | 19 Oct 2021

  • Resolved a defect where the session token from the modify offer was not working.

  • Resolved a defect where AddOffer occasionally returned an error when deleting segments.

Exchange Ticketing 21.11.5: Net ticket data | 30 Sep 2021

Added support for:

  • Exchange of tickets that include net, selling, and private fares is now supported. However, if the original ticket has an IT/BT and if those flights were canceled and no flights from the original ticket were flown, then the reservation is empty and the original tickets with private fares cannot be exchanged.

  • Partially flown ticket exchange is now fully supported.

Exchange Ticketing 21.11.4: Internal updates | 8 Jul 2021

Internal updates only.

Exchange Ticketing 21.11.3 | 28 Jun 2021

Initial customer release of the Exchange Ticketing functionality. This release completes the end-to-end exchange functionality with support for:

  • Modifying the existing offer on a ticketed reservation for any of the scenarios documented in Supported Exchange Options.
  • A Pay Now flow, in which the reservation is modified and the ticket/s reissued in one session.
  • A Pay Later flow, in which the reservation is modified in one session, and payment made and tickets reissued in a subsequent session.