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, returned in ascending price order. NDC only; not supported for GDS.

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.
• false: Provides fares for only the specified class of service. Default.

returnBrandedFaresInd

Return brand attributes for branded fares. See Brand Pricing in the Air Pricing Guide.

Supported values:

• true: Returns brand attributes.
• false: Does not return brand attributes. Default.

validateInventoryInd

Boolean. Set to true to verify availability for the requested number of passengers in a specific class of service at the time of the price request. If sent with false or not sent, AirPrice may return upsell offers with no availability in the requested class of service. If there are fewer seats than requested passengers available in that class of service, AirPrice does not return any offers and instead returns the error message BOOKING CLASS/PREFERENCE NOT AVAIL CHECK AVAILABILITY. This reduces failures at the Add Offer and Workbench Commit steps.

Supported in both the reference and full payload responses. GDS only; not supported for NDC, as NDC carriers already validate inventory at pricing.

Supported values:

• true: Checks for availability in the requested class of service.
• false: Checks only for general seat availability on the flight, not a specific class of service. Default.

reCheckInventoryInd

Boolean. Set to true to verify availability for the requested number of passengers in a specific class of service at the time of the price request. This indicator causes AirPrice to book the seats and then release them. If any or all segments are not bookable, AirPrice returns the message The air segments 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.

Supported only in the full payload request.

Supported values:

• true: Books and then releases the requested number of seats in the requested class of service.
• 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"
  }
 }
}

Other errors may be returned:

• 0 AVAIL/WL CLOSED

• UNABLE - CLASS DOES NOT EXIST FOR THIS FLIGHT

• UNABLE - FLIGHT NOT FOUND IN VENDOR SYSTEM

• FLIGHT NOT FOUND - CHECK AVAILABILITY

FareRuleType

Returns fare rules in the price response. Use not recommended; send the Standalone 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).

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 the error "NO VALID FARE FOR INPUT CRITERIA".
• false: If no fares are available for the specified PTC, returns fares for the default ADT (adult) PTC.

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. 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, 6 to 8 byte number. Send 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 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="2024-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

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.

AvailabilitySourceCode

Recommended to send in the full payload request.

Supported values and definitions for AvailabilitySourceCode 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

boundFlightsInd

Boolean. To cause AirPrice to perform a sell/ignore availability check on connecting flight/s as well as the initial flight on a leg, when sending reCheckInventoryInd=trueper above, also send boundFlightsInd=true for any flight segment that has a connecting flight. (Note that recommended best practice is to use validateInventoryInd instead of reCheckInventoryInd.)

Show Example with boundFlightsInd

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

• reCheckInventoryInd=true

• boundFlightsInd=true for the first flight segment on the outbound/departure leg

• boundFlightsInd=true for the first flight segment on the inbound/return leg

Both segments have a segmentSequence value of 0and connect to another flight segment.

{
 "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 the 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. If that class is not available, the response does not return any offers.
• Preferred: Searches for the specified class or classes, but will return lower classes if the specified class is not available.
• PreferredWithUpgrade: Searches for the specified class or classes, and will return 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

Object. Sends additional modifiers.

May include BrandAttributeInclusion.

excludeUnbundledFaresInd

Boolean. Sets whether to return unbundled fares:

• true Does not return unbundled fares in the response.

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

includeFlightAmenitiesInd

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

• true: Includes amenities in the response if available.

• false or not sent: Amenities not returned in response.

If requested, amenities are returned in ReferenceListAmenity.

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. The specified brand attributes returned may be included, chargeable, or not offered.

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. Send as true when pricing a split ticketing itinerary. which includes two one-way offers.

The AirPrice request must send offers that are identified in the Search response with CombinabilityCode j0; the value j0 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 the error message Split Pricing functionality not supported for this combination.

currencyCode

String. Send the currency type to return if you want to override the default currency specified with your PCC.

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

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.

Note that the response returns pricing in the local currency for the specified sell city, not the currency for which your PCC is provisioned.

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.

Note that the response returns pricing in the local currency for the specified ticket city, not the currency for which your PCC is provisioned.

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. (PCC is the pseudo city code; a travel provider's identification code for the JSON APIs, provisioned from Travelport.)

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 immediately below) return results as follows:

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

• PricingPCC sent and PrivateFaresOnly not requested: 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, private fares (if available) are returned for the requesting and providing PCC.

• PricingPCC sent and PrivateFaresOnly is requested: If a selective access or group agreement exists but does not allow private fares access, or if no agreement exists, 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 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 or PTCs to be increased or decreased. This increases or decreases the fare for all passengers with the 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 either increase (when sent in @type ManualFareAdjustmentIncrease) or decrease (when sent in @type ManualFareAdjustmentDiscount) the base fare by 20.5%.

AmountPercentAmount

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

Amount: Send the 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 either increase (when sent in @type ManualFareAdjustmentIncrease) or decrease (when sent in @type ManualFareAdjustmentDiscount) the base fare by $14.75.

FareSelection

fareType

String. Supported values:

• PublicFaresOnly
• PrivateFaresOnly
• PublicAndPrivateFares (default value)
• NetFaresOnly (Net fares are returned if available even if not requested. Not supported for NDC.)
• AllFares: Returns public and private fare offers and net fare offers in one request.

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 the default validating carrier.

FareSelectionDetail

Object to request fares with specific restrictions.

The response does not currently return any indicators about these conditions.

prohibitAdvancePurchaseFaresInd

prohibitMaxStayFaresInd

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

prohibitMinStayFaresInd

refundableOnlyInd

OrganizationInformation

Object.

Includes OrganizationIdentifier.

OrganizationIdentifier

Array. Send one or more account codes to return negotiated fares for your PCC.

The response returns an instance of TermsAndConditions/OrganizationInformation/OrganizationIdentifier for each account code sent.

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. Optional indicator to limit the fares returned to only fares filed for that account code. Send set to true, along with one or more account codes in OrganizationIdentifier/value per above. If sending multiple account codes, send each instance with accountCodeFaresOnlyInd set to true. If not sent the default is false.

• 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 message: accountCodeFaresOnlyInd set to true requires an account code to be specified in the request.

Note the following when also requesting private fares (FareSelection/fareType=PrivateFaresOnly):

• PrivateFaresOnly and account code: Private fare is returned.

• PrivateFaresOnly and account code and accountCodeFaresOnlyInd=true: Private fare specific to that account code is returned if available. If no account fare exists an error message is returned.

Note the following when also requesting net fares (FareSelection/fareType=NetFaresOnly):

• NetFaresOnly along with Account code: Net Fare will be returned

• NetFaresOnly and account code and accountCodeFaresOnlyInd=true: Any net fare specific to that account code is returned if available. If no account fare exists an error message is returned.

TaxExemption

Marks as tax exempt either all taxes, only specific tax codes, or all taxes in specific countries.

Send either allTaxesExemptInd orthe key value pairs countries and taxCodes per below.

TaxExemption supports up to nine values for countries, or nine values for taxCodes, or up to nine values in countries and taxCodes combined.

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

countries

Array. One or more two-letter alphanumeric codes for the countries in which the taxCodes sent are tax exempt.

taxCodes

Array. One or more two-letter alphanumeric tax codes to mark as exempt.