Standalone Price API Reference

OfferQueryBuildFromShoppingCartProducts

Top level object.

Includes PricingModifiersAir and ProductIdentifier.

PricingModifiersAir

Optional pricing modifiers. See table below.

ProductIdentifier

Reference details for the products to price.

Includes Identifier.

id

Text. Custom user-assigned id of choice.

PricingModifiersAir

Object for optional journey modifiers.

includeSplitPaymentInd

AirPrice 24.11.31 and later, reference payload In the JSON APIs, an API call that sends identifers referring to a previous response for the itinerary to be shopped, priced, added, etc. instead of full itinerary details. only. GDS only, not supported for NDC.

Boolean. Send as true when pricing a split ticketing itinerary The entire trip on a booking, including all flights on all legs. Also called a journey.. which includes two one-way An itinerary with a single destination; e.g., LHR > CDG. 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 In the JSON Search APIs, an offer is a product available at a specific price under a set of terms and conditions. An offer includes the flight or connecting flights for one leg of the itinerary, plus a service level that includes the cabin class and any fare codes that may apply. At booking, the selected offer from the Search response - including the flight/s, service level, price, terms and conditions, and brand if applicable - is converted into a single Offer object that is subsequently returned for that booking. returns the error message Split Pricing functionality not supported for this combination.

Split ticketing is available only for customers specifically provisioned for split ticketing. Split ticketing returns one-way outbound and one-way inbound fares in addition to round-trip An itinerary in which travel goes to a single destination and returns to the origin. E.g., LHR > CDG and CDG > LHR. offers. Split ticket offers are identified with a CombinabilityCode of j0. If your account is not configured for split ticketing, sending includeSplitPaymentInd in the Search response returns a response without split ticket offers and the warning message User is not authorized for Split Ticketing Shop. Please contact support. GDS only, not supported for NDC.

currencyCode

String. Send the currency type to return if you want to override the default currency specified with 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 Tools.

SellCity

String. The IATA International Air Transportation Association, an organization that standardizes rules, regulations and fare construction principles for the international travel industry. 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 Special air fares negotiated by agencies. Private fares may use account names, account codes, contract codes, or corporate IDs. (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 Passenger Type Code, used to categorize travelers. The most common PTCs are adult (ADT), child (CNN), and infant (INF). You can request a maximum of 9 passengers in one Search request.. 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 Net fares, also called consolidator fares or bulk fares, are any negotiated price between an airline and a consolidator or agency. Send your account or corporate code in the search request to receive net fares in the response. GDS only; NDC carriers do not generally offer net fares. 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 An airline. 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.