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

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.