AirPrice Full Payload API Reference

OfferQueryBuildFromProducts

Top level object.

Includes BuildFromProductsRequest and FareRuleType.

MaxNumberOfUpsellsToReturn

Number. Supports values from 0 to 99 inclusive. Send to request upsell offers along with pricing for the requested class of service or cabin, returned in ascending price order. An upsell is the next highest fare in a different brand or cabin than requested. NDC only; not supported for GDS.

Upsells are returned as follows:

• Upsells not requested: Only the requested offer is returned.

• One upsell requested: The lowest priced offer in the requested class of service or cabin plus one upsell offer are returned.

• Two upsells requested (and so on for x upsells requested): The lowest priced offer in the requested class of service or cabin plus two upsell offers are returned.

lowFareFinderInd

Boolean. Provides pricing flexibility around class of service. If not sent, or sent with false, the response returns fares only in the requested class of service. Supported values:

• true: Returns the lowest fares available in any class of service available, which may not be the same as the requested class. Note that if lowFareFinderInd=true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted.
  
• false: Provides fares for only the specified class of service. Default.

returnBrandedFaresInd

Boolean. Use to request the return of branded fares, which by default are not returned for the AirPrice Full Payload request. See Branded Fares and Attributes in the Air Pricing Guide. Supported values:

• true: Returns branded fares.
• false: Does not return branded fares. Default.

validateInventoryInd

Boolean. Sets whether to validate inventory in the requested class of service. Supported values:

• true: Checks for availability for the requested number of passengers in the requested class of service at the time of the price request. If there are fewer seats than requested passengers available in that class of service, AirPrice does not return any offers and instead returns an error message that the booking class or preference is not available. This reduces failures at the Add Offer and Workbench Commit steps.
• false: Checks only for general seat availability on the flight, not a specific class of service. AirPrice may return upsell offers with no availability in the requested class of service. Default.

reCheckInventoryInd

Boolean. Sets whether to validate inventory on the first flight in the itinerary in the requested class of service by booking and then releasing seats. Supported values:

• true: Checks for availability by booking and then releasing seats for the requested number of passengers in the requested class of service. If any or all segments are not bookable, AirPrice returns a message that the air segment/s are not bookable along with 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.
• false: Checks only for general seat availability on the flight, not a specific class of service. Default.

Show Example error response for non-bookable segments

{
 "OfferListResponse": {
  "@type": "OfferListResponse",
  "transactionId": "04ec9290-06da-4eb6-bb3c-b09563cabd96",
  "Result": {
   "@type": "Result",
   "Error": [
    {
     "@type": "ErrorDetail",
     "StatusCode": 200,
     "Message": "BOOKING CLASS/PREFERENCE NOT AVAIL CHECK AVAILABILITY"
    }
   ]
  },
  "Identifier": {
   "value": "04ec9290-06da-4eb6-bb3c-b09563cabd96_PC"
  }
 }
}

FareRuleType

Returns fare rules in the price response. Use not recommended; send the Fare Rules request instead.

BuildFromProductsRequest

Top level object.

Includes PricingModifiersAir, PassengerCriteria, and ProductCriteriaAir.

PricingModifiersAir

Optional pricing modifiers. See the PricingModifiersAir table below.

PassengerCriteria

Array. Defines the type of passenger/s on the itinerary.

Send one PassengerCriteria for each passenger type code (PTC). AirPrice supports up to nine total passengers across all PTCs.

May include optional CustomerLoyalty.

passengerTypeCode

String. The passenger type code for the passengers on the itinerary. Common PTCs are:

• ADT: adult
• CHD: child of unknown age (see Notes on PTC and age below)
• CNN: child when age is known
• INF: infant without a seat
• INS: infant with a seat
• UNN: unaccompanied child

See Downloads to download a full list of PTCs.

number

Number. The number of passengers with this PTC. Default is 1.

age

Number. The age of the passenger.

specifiedPassengerTypeCodeOnlyInd

Boolean. AirPrice returns pricing only for the specified PTC. This indicator sets behavior if no offers for that PTC are available:

• true: If no fares are available for the specified PTC, returns an error message that there is no valid fare.
• false: If no fares are available for the specified PTC, returns fares for the default ADT (adult) PTC instead.

CustomerLoyalty

Optional object for sending customer loyalty information, such as for a frequent flyer program.

TravelerGeographicLocation

value

String. IATA code specifying the location relevant to the local citizen//local resident fare.

travelerGeographicLocationType

String. The type of location where the local fare is valid. Supported values are 

• Country
• City
• State/Province

PaymentCriteria

Optional object to send the BIN of the credit card to be used for payment. Sending the BIN returns OB fees in the response, which are ticketing and form of payment (FOP) fees, including credit card fees. Returned in an instance of Price/PriceBreakdown/Fees/Fee with a feeCode of OB.

Includes IssuerIdentificationNumber.

IssuerIdentificationNumber

String, The BIN of the credit card to be used for payment.

ProductCriteriaAir

Top level object for itinerary details.

Includes SpecificFlightCriteria and CabinPreference.

SpecificFlightCriteria

Array. Each instance sends details for each flight (aka segment) on the itinerary to price.

carrier

String. IATA code of airline carrier for flight.

flightNumber

String. Flight number assigned by airline.

departureDate

String. Departure date of flight in YYYY-MM-DD format (e.g., departureDate="2026-12-06")

departureTime

String. Departure time of flight. HH:MM:SS (24-hour) format (e.g., departureTime="18:00").

arrivalDate

String. Arrival date of flight in YYYY-MM-DD format.

arrivalTime

String. Arrival time of flight in HH:MM:SS (24-hour) format.

from

String. IATA airport code of departure.

to

String. IATA airport code of arrival.

cabin

String. Cabin class to price.

classOfService

String. Class of service to price.

brandTier

String. The brand tier to price, if brand tier pricing is desired.

segmentSequence

Sequence of this segment on the leg, starting with 0 for the first segment on the leg. A segment is one flight with the same flight number.

ContentSource

String. Send with either GDS for GDS content or NDC for NDC content.

AvailabilitySourceCode

Recommended to send in the full payload request.

Supported values and definitions for AvailabilitySourceCode:

• 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

boundFlightsInd

Boolean. Sets whether to validate inventory on a connecting flight in the requested class of service by booking and then releasing seats. Supported values:

• true: Send for the leading segment/s on a leg with connecting flight/s to also check availability on the connecting flight/s by booking and releasing seats in the requested class of service on those flight/s. For example, if a leg has two connections, send boundFlightsInd for the first two of the three flights. Must also send reCheckInventoryInd=true per above. If any or all segments are not bookable, AirPrice returns a message that the air segment/s are not bookable and the dates and city pairs of the segments that are not bookable.

• false: Checks only for general seat availability on any connecting flight, not a specific class of service. Default.

Show Example with boundFlightsInd

The following example request is for a round trip itinerary with connecting flights both ways. It sends the following:

• reCheckInventoryInd=true

• boundFlightsInd=true for the first flight segment (segmentSequence=0) on both the outbound/departure leg and the inbound/return leg

{
 "OfferQueryBuildFromProducts": {
  "lowFareFinderInd": "false",
  "returnBrandedFaresInd": "false",
  "reCheckInventoryInd": true,
  "validateInventoryInd": "true",
  "BuildFromProductsRequest": {
   "@type": "BuildFromProductsRequestAir",
   "PassengerCriteria": [
    {
     "passengerTypeCode": "ADT",
     "number": 1,
     "age": 24
    }
   ],
   "ProductCriteriaAir": [
    {
     "SpecificFlightCriteria": [
      {
       "@type": "SpecificFlightCriteria",
       "carrier": "FJ",
       "flightNumber": "910",
       "departureDate": "2023-10-16",
       "departureTime": "13:45:00",
       "arrivalDate": "2023-10-16",
       "arrivalTime": "19:25:00",
       "from": "SYD",
       "to": "NAN",
       "cabin": "Economy",
       "classOfService": "V",
       "segmentSequence": "0",
       "boundFlightsInd": true
      },
      {
       "@type": "SpecificFlightCriteria",
       "carrier": "FJ",
       "flightNumber": "810",
       "departureDate": "2023-10-16",
       "departureTime": "21:40:00",
       "arrivalDate": "2023-10-16",
       "arrivalTime": "12:55:00",
       "from": "NAN",
       "to": "LAX",
       "cabin": "Economy",
       "classOfService": "V",
       "segmentSequence": "1"
      }
     ]
    },
    {
     "SpecificFlightCriteria": [
      {
       "@type": "SpecificFlightCriteria",
       "carrier": "FJ",
       "flightNumber": "811",
       "departureDate": "2023-10-21",
       "departureTime": "23:55:00",
       "arrivalDate": "2023-10-23",
       "arrivalTime": "05:45:00",
       "from": "LAX",
       "to": "NAN",
       "cabin": "Economy",
       "classOfService": "T",
       "segmentSequence": "0",
       "boundFlightsInd": true
      },
      {
       "@type": "SpecificFlightCriteria",
       "carrier": "FJ",
       "flightNumber": "911",
       "departureDate": "2023-10-26",
       "departureTime": "09:00:00",
       "arrivalDate": "2023-10-26",
       "arrivalTime": "11:45:00",
       "from": "NAN",
       "to": "SYD",
       "cabin": "Economy",
       "classOfService": "T",
       "segmentSequence": "1"
      }
     ]
    }
   ]
  },
  "FareRuleType": "null"
 }
}

CabinPreference

Array. Requests a fare based on cabin class. Only one cabin preference type is allowed per request, but there is no limit to the number of cabins that can be sent.

type

String. The type of cabin preference. Supported values are (no default):

• Permitted: Searches for ONLY the specified class or classes, and returns no offers if that class is not available.
• Preferred: Searches for the specified class or classes, and returns lower classes if the specified class is not available.
• PreferredWithUpgrade: Searches for the specified class or classes, and returns higher classes if the specified class is not available.

cabins

String. A space-delimited list of cabins. Supported values are (no default):

• Economy
• PremiumEconomy
• Business
• First
• PremiumFirst

CustomResponseModifiersAir

Sends additional modifiers.

May include BrandAttributeInclusion.

excludeUnbundledFaresInd

Boolean. Sets whether to return unbundled fares:

• true: Does not return unbundled fares.

• false: Returns unbundled and bundled fares as available. Default.

includeFlightAmenitiesInd

Boolean. Indicator to return flight amenities from ATPCO RouteHappy data:

• true: Returns flight amenities from ATPCO RouteHappy if available.

• false: Does not return ATPCO RouteHappy amenities.

If requested, amenities are returned in ReferenceListAmenity.

excludePenaltiesInd

Boolean. Indicator to set whether to return change and cancel penalties:

• true: Does not return penalties in the response.

• false or not sent: Returns penalties in the response. Default.

If requested, change and cancel penalties are returned in TermsAndConditionsFullAir.

BrandAttributeInclusion

Object. Supports returning only information about the brand attributes specified in Classification below and does not return any other brand attributes for those fares.

Classification

String. Send one or more of the following values to return information about only the specified attributes. Fares may include other attributes but information about them is not returned. Supported values:

• CarryOn
• Refund
• Meals
• Rebooking
• CheckedBag
• SeatAssignment
• WiFi

May include AdditionalClassification.

PricingModifiersAir

Object for optional journey modifiers.

includeSplitPaymentInd

Boolean for split ticketing.

• true: Send when pricing a split ticketing itinerary, defined as two one-way offers.

• false: Default. The itinerary is not for split ticketing.

For split ticketing, the AirPrice request must send offers that are identified in the Search response with CombinabilityCode j0, which identifies those offers as one-way outbound and one-way inbound split ticketing offers. A combination of j0 and any non-j0 value offer returns an error message that split pricing is not supported

currencyCode

String. Send the currency type to return if you want to override the default currency of your PCC Pseudo city code. A travel provider's identification code for the JSON APIs, provisioned from Travelport. Used to determine access and other settings in the JSON APIs for your company..

For a list of currency codes, see the Universal API Reference Data file linked from Downloads.

SellCity

String. The IATA location code for the city. Overrides the sell city of the requester to specify an alternate sale location and return pricing based on that location. The response returns pricing in the local currency for the specified sell city instead of your PCC's default currency.

TicketCity

String. The IATA location code for the city. Overrides the ticketing city of the requester to specify an alternate ticket location and return pricing based on that location. The response returns pricing in the local currency for the specified ticket city instead of your PCC's default currency.

TicketingPCC

String, 2-10 characters supported. Overrides the ticketing PCC associated with your account to specify an alternate PCC and return pricing based on that PCC.

PricingPCC

String, 2-10 characters supported. Use to send a faring PCC for which a selective access or code group agreement exists between that PCC and the PCC associated with your account. The following combinations of PricingPCC and FareSelection/fareType=PrivateFaresOnly (see below) return results as follows:

• PricingPCC sent and PrivateFaresOnly not requested: If a selective access or group agreement exists, both public and any available private fares are returned for the requesting and providing PCC. If no selective access or group agreement exists, only public fares are returned.

• PricingPCC sent and PrivateFaresOnly is requested: If a selective access or group agreement exists that allows private fare access, only available private fares are returned for the requesting and providing PCC. If no agreement exists, or if an agreement exists but does not allow private fares access, an error is returned.

ManualFareAdjustment

Send to manually adjust the base fare amount on all fares for a specific PTC. You can increase or decrease the base fare per these @type values by either an amount or a percentage:

• Send with @type value ManualFareAdjustmentDiscount to decrease the base fare.

• Send with @type value ManualFareAdjustmentIncrease to increase the fare.

Show Example excerpt

The following PricingModifiersAir excerpt sends one instance of ManualFareAdjustment that discounts the ADT fare by 20%, and another instance that increases the CHD fare by the amount of 50.

 ...
  "PricingModifiersAir": {
    "@type": "PricingModifiersAir",
    "SellCity": "NYC",
    "TicketCity": "SFO",
    "ManualFareAdjustment": [
     {
      "@type": "ManualFareAdjustmentDiscount",
      "passengerTypeCodes": [
       "ADT"
      ],
      "AmountPercent": {
       "@type": "AmountPercentPercent",
       "Percent": 20
      }
     },
     {
      "@type": "ManualFareAdjustmentIncrease",
      "passengerTypeCodes": [
       "CHD"
      ],
      "AmountPercent": {
       "@type": "AmountPercentAmount",
       "Amount": {
        "value": 50
       }
      }
     }
    ]
   },
...

passengerTypeCodes

Send the PTC/s to be increased or decreased. This increases or decreases the fare for all passengers with that PTC/s.

AmountPercentPercent

Send to adjust the base fare for the specified PTC/s by the percentage sent in Percent as follows:

Percent: Send percentage of the base fare to be decreased or increased, up to two decimal places. For example, the value 20.5 would increase the base fare by 20.5% when sent in @type ManualFareAdjustmentIncrease, or decrease the base fare by 20.5% when sent in @type ManualFareAdjustmentDiscount .

AmountPercentAmount

Send to adjust the base fare for the specified PTC/s by the amount sent in Amount as follows:

Amount: Send amount value to either increase or decrease the base fare, up to two decimal places. For example, the value 14.75 for a base fare in the currency USD would increase the base fare by $14.75 when sent in @type ManualFareAdjustmentIncrease, or decrease the base fare by $14.75 when sent in @type ManualFareAdjustmentDiscount.

FareSelection

fareType

String. Supported values:

• PublicFaresOnly
• PrivateFaresOnly
• PublicAndPrivateFares (default)
• NetFaresOnly (Net fares are returned for GDS if available even if not requested. NDC does not support net fares.)
• AllFares: Returns public and private fare offers and net fare offers.

The response identifies the type of fare returned for each Product in PassengerFlight/FlightProduct @fareType. Possible values in the response are AirlinePrivateFare, AgencyPrivateFare, NetFare, or PublicFare.

Includes FareSelectionDetail.

validatingCarrier

IATA code for a carrier to override any default validating carrier.

FareSelectionDetail

Request fares with specific restrictions. The response does not return any indicators about these conditions.

prohibitAdvancePurchaseFaresInd

prohibitMaxStayFaresInd

Boolean. true prevents the return of fares that require a maximum stay. Default is false.

prohibitMinStayFaresInd

Boolean. true prevents the return of fares that require a minimum stay. Default is false.

refundableOnlyInd

Boolean. true prevents the return of fares that are not fully refundable. Default is false.

OrganizationInformation

Use to send account codes for negotiated fares.

Includes OrganizationIdentifier.

OrganizationIdentifier

Array of account codes to return negotiated fares. The response returns an instance of TermsAndConditions/OrganizationInformation/OrganizationIdentifier for each account code sent.

Show Example excerpt to send multiple account codes

"OrganizationIdentifier" : [{
      "value" : "XYZ123",
      "supplier" : "UA",
      "type" : "Account"
    },
    {
      "value" : "ABC123",
      "supplier" : "LH",
      "type" : "Account"
    }]

organizationCodeType

String.

value

String. The account code to apply.

supplier

String. The IATA code for the airline on which the account code is applicable.

accountCodeFaresOnlyInd

Boolean. Sets whether to limit fares returned to only fares filed for an account code.

• true: Limits the fares returned to only fares filed for that account code; must send with one or more account codes in OrganizationIdentifier/value. If sending multiple account codes, send each instance with accountCodeFaresOnlyInd set to true.

• false: Does not limit fares returned to any account code sent. Default.

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

If accountCodeFaresOnlyInd=true is sent and no account code is sent, accountCodeFaresOnlyInd is ignored; the response returns all fares and a warning message that the request must include an account code.

Note the following when also requesting private fares only:

• FareSelection/fareType=PrivateFaresOnly and account code: Private fares are returned.

• FareSelection/fareType=PrivateFaresOnly, accountCodeFaresOnlyInd=true, and account code: Any private fares specific to that account code are returned if available. If no private fares exist for that account code, an error message is returned.

Note the following when also requesting net fares:

• FareSelection/fareType=NetFaresOnly and account code: Net fares are returned.

• FareSelection/fareType=NetFaresOnly, accountCodeFaresOnlyInd=true, and account code: Any net fares specific to that account code are returned if available. If no net fares exist for that account code, an error message is returned.

TaxExemption

Use to exempt some or all taxes. Must include either allTaxesExemptInd orboth countries and taxCodes per below.

If sent, the response returns any exempt taxes with exemptInd=true and value=0.

countries

Array. One or more codes for the countries in which the paired taxCodes sent are tax exempt. Must also send taxCodes object.

Up to nine values total supported for countries, or for taxCodes, or for countries and taxCodes combined.

taxCodes

Array. One or tax codes to mark as exempt in the paired country. Must also send countries object.