v1

latestOpenAPI 3.0.02026-08-061029011.1 MB
Searches

Air Availability

Air Availability returns scheduled flights between a specified city pair on a specified day and time and indicates whether seats are available on those flights. Air Availability is a full payload request that focuses on seat availability by class of service. It does not return pricing information. GDS only; not supported for NDC.

post/air/search/airAvailability

Headers

TraceIdstring
Example:TraceID_123456789

Identifier used to correlate Air API invocations across a multi-call business flows.

XAUTH_TRAVELPORT_ACCESSGROUPstring
Example:19Y88702-C27A-4E5D-829A-89D7016688B1

Identifies the Travelport access group with which the caller is associated

travelportPlusSessionIdentifierstring
Example:49f58f5f-c443-43b4-9f5d-be405fd00a01

travelportPlusSessionIdentifier used to maintain an established agency session

TVP-PCC-Corestring
Example:DU7_1G

Allows user to pass PCC instead of Access Group ID

Request body

@typestring required

Discriminator class CatalogProductOfferingsQueryRequest only

Example request

{
  "@type": "CatalogProductOfferingsQueryRequest",
  "CatalogProductOfferingsRequest": {
    "@type": "CatalogProductOfferingsRequestAir",
    "SearchControlConsoleChannelID": {
      "value": "IBM",
      "sccType": "999"
    },
    "offersPerPage": 45,
    "contentSourceList": [
      "NDC"
    ],
    "maxNumberOfUpsellsToReturn": 3,
    "numberOfDownsellsToReturn": 2,
    "sortBy": "Price-LowToHigh",
    "PassengerCriteria": [
      {
        "@type": "PassengerCriteria",
        "number": 1,
        "age": 26,
        "passengerTypeCode": "ADT",
        "birthDate": "2020-01-16",
        "id": "passengercriteria_001",
        "CustomerLoyalty": [
          {
            "value": "132456",
            "id": "Loyalty_1",
            "priority": 2,
            "programId": "HY",
            "programName": "Frontier-EarlyReturns",
            "supplierType": "Hotel",
            "supplier": "UA",
            "tier": "Silver",
            "shareWithSupplier": [
              "[\"AF\",\"KL\"]"
            ],
            "cardHolderName": "John Smith",
            "validatedInd": true,
            "prefix": "Dr",
            "given": "John",
            "middle": "Wilkinson",
            "surname": "Smith"
          }
        ],
        "TravelerGeographicLocation": {
          "value": "PMI",
          "travelerGeographicLocationType": "City",
          "generalLargeFamilyResidentDiscountInd": true,
          "specialLargeFamilyResidentDiscountInd": true
        },
        "specifiedPassengerTypeCodeOnlyInd": true
      }
    ],
    "SearchCriteriaFlight": [
      {
        "daysBeforeDeparture": 1,
        "daysAfterDeparture": 2,
        "departureTime": "07:00:00",
        "arrivalTime": "09:15:00",
        "From": {
          "value": "MEX",
          "cityOrAirport": "City or Airport",
          "radius": 50,
          "radiusMeasurement": "Kilometers"
        },
        "To": {
          "value": "MEX",
          "cityOrAirport": "City or Airport",
          "radius": 50,
          "radiusMeasurement": "Kilometers"
        },
        "AdditionalFrom": [
          {
            "value": "LGW",
            "cityOrAirport": "City or Airport"
          }
        ],
        "AdditionalTo": [
          {
            "value": "LGW",
            "cityOrAirport": "City or Airport"
          }
        ],
        "DepartureTimeRange": {
          "start": "06:15:00",
          "end": "09:15:00"
        },
        "ArrivalTimeRange": {
          "start": "06:15:00",
          "end": "09:15:00"
        }
      }
    ],
    "SearchModifiersAir": {
      "@type": "SearchModifiersAir",
      "excludeGround": "Train",
      "CarrierPreference": [
        {
          "@type": "CarrierPreference",
          "preferenceType": "Preferred",
          "carriers": [
            "BA"
          ],
          "legSequence": [
            1,
            2
          ]
        }
      ],
      "CabinPreference": [
        {
          "@type": "CabinPreference",
          "preferenceType": "Preferred",
          "cabins": [
            "Economy"
          ],
          "legSequence": [
            1,
            2
          ]
        }
      ],
      "ClassOfServicePreference": [
        {
          "@type": "ClassOfServicePreference",
          "legSequence": [
            1,
            2
          ],
          "ClassesOfService": [
            "F"
          ],
          "PreferenceType": "Preferred"
        }
      ],
      "ProductInclusionPreference": [
        {
          "@type": "ProductInclusionPreference",
          "legSequence": [
            1,
            2
          ],
          "Classification": [
            "CheckedBag"
          ],
          "AdditionalClassification": [
            "PremiumDrinks"
          ],
          "exactMatchInd": true,
          "bestMatchInd": true
        }
      ],
      "ConnectionPreferences": [
        {
          "legSequence": [
            1,
            2,
            4
          ],
          "maxConnectionDuration": "PT3H45M",
          "maxOvernightDuration": "PT6H30M",
          "preferenceType": "Permitted",
          "cityOrAirport": "City or Airport",
          "FlightType": {
            "@type": "FlightType",
            "connectionType": "StopDirect",
            "excludeInterlineConnectionsInd": true
          }
        }
      ],
      "prohibitChangeOfAirportInd": true
    },
    "PaymentCriteria": {
      "@type": "PaymentCriteria",
      "IssuerIdentificationNumber": "123456",
      "PaymentCardCode": "VI",
      "DocumentNumber": [
        {
          "value": "1259900123456",
          "documentIssuer": "BA",
          "documentType": "Ticket",
          "passengerTypeCode": "ADT"
        }
      ],
      "FlightPass": [
        {
          "@type": "FlightPass",
          "accountNumber": "0140851633093",
          "supplier": "AC",
          "Description": [
            "FlightPass"
          ],
          "TravelerIdentifierRef": [
            {
              "uris": [
                "google.com"
              ]
            }
          ]
        }
      ],
      "agencyAccountInd": true,
      "bspInd": true,
      "cashInd": true,
      "invoiceInd": true
    },
    "PricingModifiersAir": {
      "@type": "PricingModifiersAir",
      "currencyCode": "GBP",
      "FareSelection": {
        "@type": "FareSelection",
        "fareType": "PrivateFaresOnly",
        "RefundOptions": {
          "@type": "RefundOptions",
          "refundTypes": [
            "Refundable"
          ],
          "RefundPenaltyRange": {
            "@type": "RefundPenaltyRange",
            "Minimum": {
              "@type": "AmountPercentAmount",
              "application": "Full"
            },
            "Maximum": {
              "@type": "AmountPercentAmount",
              "application": "Full"
            }
          }
        },
        "ChangeOptions": {
          "@type": "ChangeOptions",
          "changeTypes": [
            "Changeable"
          ],
          "ChangePenaltyRange": {
            "@type": "ChangePenaltyRange",
            "Minimum": {
              "@type": "AmountPercentAmount",
              "application": "Full"
            },
            "Maximum": {
              "@type": "AmountPercentAmount",
              "application": "Full"
            }
          }
        },
        "FareQualifier": [
          {
            "value": "Consolidator"
          }
        ],
        "FareQualiferString": [
          "Tour"
        ]
      },
      "OrganizationInformation": {
        "@type": "OrganizationInformation",
        "OrganizationIdentifier": [
          {
            "value": "JBD123456",
            "supplier": "AA",
            "organizationCodeType": "Account",
            "segmentSequenceList": [
              1,
              2,
              3
            ],
            "productRef": [
              "product_1"
            ],
            "accountCodeFaresOnlyInd": true
          }
        ],
        "GSTRegistrationNumber": [
          {
            "value": "07AAGFF2194N1Z1",
            "telephone": "222-222-222",
            "address": "1122 sample trail, CO, USA, 21232",
            "country": "IND",
            "companyName": "Adecco",
            "email": "sample@adecco.com"
          }
        ]
      },
      "TaxExemption": {
        "@type": "TaxExemption",
        "countries": [
          "GB",
          "MX"
        ],
        "taxCodes": [
          "US"
        ],
        "allTaxesExemptInd": true
      },
      "PromotionalCode": [
        {
          "value": "CDFRT",
          "supplierCode": "AA"
        }
      ],
      "SellCity": "NYC",
      "TicketCity": "NYC",
      "PricingPCC": "0Bx3",
      "MultiPricingAgency": [
        "[\"0XS4\",\"0YBZ\",\"J80K\"]"
      ],
      "TicketingPCC": "0XS4",
      "CalculatedFareAdjustment": {
        "@type": "CalculatedFareAdjustmentDiscount"
      },
      "ManualFareAdjustment": [
        {
          "@type": "ManualFareAdjustmentIncrease",
          "passengerTypeCodes": [
            "ADT",
            "CHD"
          ]
        }
      ],
      "BrandPreference": [
        {
          "@type": "BrandPreference",
          "brandTier": 1,
          "legSequence": [
            1,
            2
          ]
        }
      ],
      "splitPaymentOfferings": 25
    },
    "CustomResponseModifiersAir": {
      "@type": "CustomResponseModifiersAir",
      "BrandAttributeInclusion": [
        {
          "@type": "BrandAttributeInclusion",
          "legSequence": [
            1,
            2
          ],
          "Classification": [
            "CarryOn"
          ]
        }
      ],
      "SearchRepresentation": "Leg",
      "excludePenaltiesInd": true,
      "excludeBaggageFeesInd": true,
      "includeFareCalculationInd": true,
      "excludeSurchargesInd": true,
      "excludeUnbundledFaresInd": true,
      "includeCO2EmissionsDataInd": true,
      "includeFlightAmenitiesInd": true,
      "includeUniversalProductAttributesInd": true,
      "includeBundledAncillariesInd": true
    },
    "SearchType": "MetaSearch",
    "inhibitBrandContentInd": true,
    "detailViewInd": true,
    "excludeMixedBrandsInd": true
  }
}

Response

OK - Successful Response - 200

Example response

{
  "CatalogProductOfferingsResponse": {
    "@type": "response",
    "transactionId": "49f58f5f-c443-43b4-9f5d-be405fd00a01",
    "traceId": "TraceID_123456",
    "Result": {
      "@type": "Result",
      "status": "Complete",
      "Error": [
        {
          "@type": "ErrorDetail",
          "StatusCode": 200,
          "Message": "No flights found.",
          "NameValuePair": [
            {
              "value": "Sunday",
              "id": "6",
              "name": "Day1"
            }
          ]
        }
      ],
      "Warning": [
        {
          "@type": "WarningDetail",
          "StatusCode": 200,
          "Message": "Customer Loyalty could not be applied.",
          "NameValuePair": [
            {
              "value": "Sunday",
              "id": "6",
              "name": "Day1"
            }
          ]
        }
      ]
    },
    "Identifier": {
      "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
      "authority": "TVPT"
    },
    "NextSteps": {
      "id": "5",
      "NextStep": [
        {
          "value": "www.resourcelocation.com",
          "id": "2",
          "action": "cancel",
          "description": "remove offer from the order"
        }
      ]
    },
    "ReferenceList": [
      {
        "@type": "ReferenceListFlight"
      }
    ],
    "CurrencyRateConversion": [
      {
        "SourceCurrency": {
          "value": "USD",
          "codeAuthority": "ISO 4217",
          "decimalPlace": 4,
          "decimalAuthority": "ISO 4217"
        },
        "TargetCurrency": {
          "value": "USD",
          "codeAuthority": "ISO 4217",
          "decimalPlace": 4,
          "decimalAuthority": "ISO 4217"
        },
        "ConversionRate": {
          "rateAuthority": "ISO 4217",
          "rateAsOf": "2026-08-07T12:12:00Z"
        }
      }
    ],
    "Pagination": {
      "@type": "Pagination",
      "page": 1,
      "pageSize": 20,
      "totalPages": 5,
      "totalItems": 100
    }
  }
}
All 102 operations