AirSearch API Reference

Optional

Optional

Optional

Includes CatalogOfferings and ReferenceList objects.

AirSearch 20.9.2 and later include the transactionId and traceId key value pairs, intended for to be used for tracking and troubleshooting when necessary. See Transaction and Trace IDs for details.

• transactionId: A unique system-generated transaction ID. No custom value is sent in the request.
• traceId: If a custom value is sent in the TraceId field of the header of the AirSearch request, AirSearch returns that custom value here in traceId. If no value is sent, traceID is not returned.

Top level object for all offers.

Includes Identifier, DefaultCurrency, and CatalogOffering objects.

Includes the following key value pair:

value: Provides the transaction identifier, which is required for any subsequent GET requests to retrieve additional offers (see Pagination Options for more information) as well as subsequent requests for AirPrice and other APIs.

Includes the following key value pair:

code: The currency in which all results in the response are displayed. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport.

To change the default currency for an individual response, see Optional Pricing Modifiers.

An individual offer, which is all flight options valid at one price point under the same terms and conditions. One instance of CatalogOffering is returned for each offer.

Includes the following key value pair:

id: Unique number for each CatalogOffering in the response. Note:

• For GDS content, the CatalogOffering id value is letter ‘o’ + unique numeric value, as in o0.0.
• For NDC content, the CatalogOffering id value is the two letter NDC carrier code + unique numeric value, as in QF1.

Includes the ProductOptions, Price, and TermsAndConditions objects. For NDC content only, it also includes an Identifier object.

CatalogOfferings includes an Identifier object only if the offer contains NDC content. Includes the following key value pairs:

authority: NDC carrier of the offering

id: Unique identifier for that CatalogOffering.

AncillaryOffering is returned for NDC offers on United Airlines (UA) only when air ancillary bundles are available. The AirSearch response returns air ancillary bundles (air fare and ancillaries together) at the product level, allowing you to select an ancillary bundle for each leg of a flight. Send an AirSearch request to return NDC content, and UA bundles are returned in the AncillaryOffering object by default when available. Supported on model v9 only. Not returned for GDS or other NDC carriers.

See Example AncillaryOffering response excerpt

The description for ancillary bundles returns multiple items in Ancillary/Description/value per the example below.

          "id": "ancillaryOffering_2",
          "ProductOptions": [
            {
              "@type": "ProductOptions",
              "sequence": 1,
              "Product": [
                {
                  "@type": "ProductAncillary",
                  "id": "pa1",
                  "Quantity": "1",
                  "Ancillary": {
                    "@type": "Ancillary",
                    "quantity": 1,
                    "Description": [
                      {
                        "code": "A",
                        "subCode": "B14",
                        "value": "Economy Plus, Extra Bag"
                      }
                    ]
                  }
                }
              ]
            }
          ],

Lists all Products that make up one leg of the itinerary (origin and destination (O&D) pair). Every CatalogOffering for a one-way search returns one instance of ProductOptions, while every CatalogOffering for a round-trip search returns two instances of ProductOptions.

For round-trip and multi-city itineraries, each instance of ProductOptions includes a sequence key value pair to indicate its order in the itinerary (example below). Each sequence starts with 1. ProductOptions sequence numbers for one-way itineraries, if present, are always 1.

"ProductOptions": [
    {
       "@type": "ProductOptions",
       "sequence": 1,

Includes ProductAir object.

Each Product lists one complete set of flight options for that segment of the itinerary. Multiple instances of Product (in this case with type ProductAir) may be returned in each ProductOptions object. Includes the following key value pairs:

• totalDuration: Total time length of the segment in hours (H) and minutes (M)

• id: ProductAir id.

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

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

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

• Quantity: Number of seats available for that Product. Not returned for NDC.

  If the Product has connecting flights, Quantity returns the lowest number available. For example, if the first flight has 9 seats in Y class and the connecting flight has 4 seats in Y class, Quantity returns a value of 4.

Includes FlightSegment and PassengerFlight objects.

Lists the flight or connecting flights that make up that Product. A FlightSegment with a direct flight returns one instance of Flight while a FlightSegment with connecting flights returns one instance of Flight object for each flight on the leg. Includes the following key value pairs:

• sequence: The place of this segment within the leg, e.g., 1 for the first segment and 2 for the second.
• connectionDuration: Length of any connection, if applicable, in hours (H) and minutes (M). Not returned for NDC.

• boundFlightsInd: The bound flights indicator boundFlightsInd is a Boolean variable indicating segments are married/bound. When returned with a value of true, the flight segments are polled together and usually share the same fare basis code and class of service. The indicator is returned as true for all leading segments on one leg of the flight, and not returned for the last segment of the bound flight leg journey, indicating where the bound flights end. For example, if an O&D pair has 3 flight segments, boundFlightsInd is returned for the first two segments on that leg. If the segments are not bound, boundFlightsInd is false and not returned. Not returned for NDC. With AirSearch 21.9.11 and later, and Fare Family Search 21.9.10 and later, the definition of boundFlightsInd was updated to specify which flights in a single or double connection must be sold together, which results in fewer booking failures. Previously, boundFlightsInd specified which flights in a single or double connection are polled together, which in some instances can cause booking failures.

  With AirSearch 21.9.11 and later, the definition of boundFlightsInd was updated to specify which flights in a single or double connection must be sold together, which results in fewer booking failures. Previously, boundFlightsInd specified which flights in a single or double connection are polled together, which in some instances can cause booking failures.

Includes the Flight object to reference flight details.

Provides a FlightRef value for the flight, which references ReferenceList/Flight/id (see below), which consolidates flight details (carrier, distance, flight number, and arrival and departure details) from all CatalogOfferings.

• For GDS, FlightRef is formatted as the letter ‘s’+ unique numeric value, as in s1.
• For NDC, FlightRef is formatted as the two letter NDC carrier code + s+ unique numeric value, as in QFs1.

Returns PTC details and class/brand information for each PTC requested. If multiple PTCs were requested, multiple instance of Passenger Flight are returned. Includes the folllowing key value pairs:

• passengerQuantity: Number of passengers in that PTC from the request.
• passengerTypeCode: The PTC code.

Includes the FlightProduct object.

Provides the following key value pairs:

• segmentSequence: Order of the corresponding flight in the sequence.
• classOfService: Class of service code.
• cabin: Cabin class.
• fareBasisCode: Fare basis code for the flight.
• fareType: Indicates the fare type. Possible values are AirlinePrivateFare, AgencyPrivateFare, PublicFare, or NetFare (net fares are not supported for NDC).

Includes the Brand object if branded fares were requested.

Returned only if returnBrandedFaresInd is set to true in the AirSearch request. Response differs by detail and summary response.

The summary response returns FlightProduct/Brand with all brand information in the following:

• name: The brand name.
• tier: The brand tier. Not returned for NDC.
• Identifier object:
  • value key value pair: The brand id from the supplier.
  • authority key value pair: Always contains the value Travelport.

The detail response returns FlightProduct/Brand returns with only the BrandRef key value pair, which is an internal identifier to the expanded brand information in ReferenceListBrand.

Price as follows, inclusive of all passengers across all PTCs for that CatalogOffering.

• Base: The base fare before taxes and fees.
• TotalTaxes: Sum of all taxes for the fare.
• TotalFees: Sum of all fees for the fare.
• TotalPrice: Total fare including base fare, taxes and fees, inclusive of all passengers.

If a detail response was requested, includes the PriceBreakdown object listed next.

Returned in Price if a detail view was requested.

Key value pairs:

• quantity: Number of passengers in that PTC.
• requestedPTC: The PTC.
• currencyCode: The currency code of the price. Returned only for NDC.

Includes the Amount object, and may include Commission object.

Returned in Price/PriceBreakdown if a detail view was requested.

Only for NDC, Amount returns the currencyCode with currency code of the price.

Includes the Base, Taxes, Fees, and Total objects.

Returned if a detail view was requested.

Base fare for one passenger of that PTC type.

Returned if a detail view was requested.

Includes TotalTaxes and Tax objects.

Returned if a detail view was requested.

Sum total of all taxes for that PTC.

Returned if a detail view was requested. Includes the following key value pairs:

• taxCode: Code for that tax.
• value: Amount of that tax.

• description: A text description of the tax code. Returned only for NDC.

Returned if a detail view was requested.

Provides breakdown of fees, if applicable. Includes TotalFees object to return sum of any fees for that PTC. May include Fees object to break down individual fees.

Returned if a detail view was requested.

Provides additional information on fees, if applicable. Includes the key value pairs:

• feeCode: The code for the fee, such as OB for OB fees.
• description: Any description for that fee code.
• text: The amount of the fee.

Returned if a detail view was requested.

Total of base fare and all taxes for that PTC.

Provides any terms and conditions applicable to all flights in that CatalogOffering.

• validatingCarrier: The carrier on which the ticket is issued.
• ExpiryDate: Last date and time to ticket.

Includes BaggageAllowance object. If a loyalty number was sent, includes CustomerLoyaltyCredit object. For NDC only, includes a FareRuleInfo object.

Returned only in the detail view when the faring agency and the ticketing agency are different. Includes the following key value pairs:

• Code: The PCC of the ticketing agency.
• ProductRef: The ids of the products available for ticketing only by the ticketing agency.
• SegmentSequenceList: Segment sequences if applicable.

Returned only for NDC. Includes the following key value pairs:

• flightRefs: A reference to the flight id to which the fare rule applies.
• ruleNumber: A number for the fare rule.

Returned only if the CustomerLoyalty object was sent in the request (currently supported only for NDC), CustomerLoyaltyCredit returns the information sent in the request and other details including the miles earned for this flight.

Includes the ProductRef, CustomerLoyalty, Earned, and Status objects.

    "CustomerLoyaltyCredit": [
        {
           "ProductRef": "QFp0",
           "CustomerLoyalty": {
                 "supplier": "QF",
                 "tier": "Bronze",
                 "cardHolderName": "JORDAN LOYTEST",
                 "value": "1295036"
            },
             "Earned": "10400",
             "Status": "180"
       }
      ]
     }
    },

Returned only if CustomerLoyalty object was sent. Includes:

• id: The id of the Product object to which the mileage information applies. Note that for NDC content the id is formatted with the two letter NDC carrier code + p + unique numeric value, as in QFp0.

Returned only if CustomerLoyalty object was sent.

Includes the following key value pairs:

• supplier: The customer loyalty card carrier code.
• tier: Loyalty tier name.
• cardHolderName: The customer loyalty card holder name.
• value: The customer loyalty number.

Returned only if CustomerLoyalty object was sent.

The mileage or points that the traveler earns for the Product segment.

Returned only if CustomerLoyalty object was sent.

A numeric value for any status credits.

If provided by the carrier, any baggage information. Includes ProductRef and BaggageItem objects.

The Product id or ids to which any BaggageAllowance applies.

As returned by the carrier, baggage allowance details. May return either of the following key value pairs but not both:

• quantity: Allowed number of pieces of baggage.
• weight: Allowed weight of each baggage item.

If any account codes were sent, OrganizationIdentifier is returned with those codes.

• type: Returns value of Account.
• value: The account code sent.

Consolidates common information across all offers. ReferenceList generally returns one instance each with type ReferenceListFlight, ReferenceListProduct, ReferenceListTermsAndConditions, and ReferenceListBrand. Each type consolidates common information about flights, products, terms and conditions, and brands that match to the identifiers in instances of CatalogOffering.

The ReferenceList object of type ReferenceListFlight provides flight details about all flights in CatalogOfferings, consolidating details for each flight into one object.

Includes multiple Flight objects.

Each flight in CatalogOfferings includes a reference id that matches to a Flight instance in ReferenceListFlight. Each Flight instance provides the following details:

• distance: Distance covered in the journey.
• duration: Time of the flight in hours (H) and minutes (M).
• carrier: Airline carrier.
• number: Flight number.
• equipment: Equipment model. Note that TRN, TRS, and BUS equipment codes indicate ground transportation; see Exclude Ground Transportation in Optional Journey Modifiers above.
• id: id for theFlightRef values in instances of CatalogOffering/ProductOptions/Product/FlightSegment/Flight

Note these differences in id for GDS and NDC content:

• For GDS, the Flight id is formatted as the letter ‘s’+ unique numeric value, as in s1.
• For NDC, the Flight id is formatted as the two letter NDC carrier code + s+ unique numeric value, as in QFs1.

Includes the Departure, Arrival, AvailabilitySourceCode, and IntermediateStop objects.

Returned only in the detailed view to assist in troubleshooting.

Possible values and definitions are as follows:

• A: AVS (availability and schedules)
• B: Travelport cache
• C: AVS
• D: Direct Access
• E: Travelport cache
• F: Travelport cache
• G: Travelport cache
• H: Travelport cache
• I: Travelport cache
• K: Travelport cache
• L: Last seat availability
• M: Unknown source
• O: Travelport cache
• P: Travelport cache
• Q: Travelport cache
• S: Seamless
• T: Travelport cache
• U: Unknown source
• X: Customer Reusing Availability Data from Customer Cache (Data originally obtained from Travelport)
• Y: Customer Reusing Data Obtained from Another System (e.g. another GDS) (Data may be fresh or stored in customer cache)
• Z: Customer sold from e-streamed data stored in customer cache

Provides the location, date, time, and terminal of departure.

Provides the location, date, time, and terminal of arrival.

Returned if the flight has a technical stop but does not incur a change in flight number. Includes the duration key value pair to specify the ground duration of the intermediate stop.

If returnBrandedFaresInd is set to true in the AirSearch request, and detailed view is requested, the response includes a ReferenceList object of type ReferenceListBrand to consolidate brand details and top brand key value pairs about each flight in CatalogOfferings.

Includes Brand.

Returned only in the detail view. See Branded Fares in Search Basics for details.

In ReferenceListBrand, the Brand object consolidates common brand data across the flights in CatalogOfferings. It includes the following key value pairs:

• name key value pair: The brand name.
• tier key value pair: The brand tier.
• id: The internal identifier that matches to the id for the corresponding flight in PassengerFlight/FlightProduct/Brand.

Includes Identifier and BrandAttribute objects.

Brand identifier information:

• value: The brand id from the supplier.
• authority: Always contains the value Travelport.

Returned only in the detail view. See Branded Fares in Search Basics

Contains one or more instances of the following two paired key value pairs:

• classification: The brand key value pair classification. Possible values are:

  • CarryOn

  • CheckedBag

  • Meals

  • Seats (model v6 - AirSearch 20.6.x) or SeatAssignment (model v9 - AirSearch 20.9.1 and later)

  • Rebooking

  • Refund

  • Wifi
• inclusion: Whether the key value pair is included in the price of the fare or is chargeable. Values are either:
  • Included: Attribute is included in the brand at no additional charge.
  • Chargeable: Attribute is available for the brand at a cost.

Includes objects for any warning or error message that is returned.

If returned, may include StatusCode, Message, and Source Code objects.

The HTTP standard response code for the message.

The text of any error message returned.