API Information

Response Format
JSON
Method/Endpoint
POST /v1.9.7/shop/altairports/flights/
Current Version
1.9.7
Target Audience
TN
Environment
Production
Documentation
Go to the Alternate Airport Shop documentation

What's New

  • Bargain Finder Max service has been enhanced to enable more flexibility within the request and return additional information in the response as follows: •Agency Retailer – allows you to create selling levels for your authorized Category 35 negotiated fares or adjust the selling level of any fare in compliance with the agencies carrier agreements. - Applies to limited release customers only.

New Features

In the Request

Required

Parameter: SellingLevelRules/@Ignore

Type: Boolean

Description: If ignore set to “true,” adjustment SellingLevelRules will be ignored. To use this element, the ORGFQD EPR keyword is required.

Sample Value:

"SellingLevels": { "SellingLevelRules": { "Ignore": true } }
Parameter: ShowFareAmounts

Type: Complex

Description: The ShowFareAmounts element defines which FareLevel should be returned in the response. When the ShowFareAmounts element is defined, only one of its attributes can be defined, either Original or Adjusted. At least one is required.

Sample Value:

N/A
Parameter: RetailerRule/@Code

Type: String (restriction: maximum length 20 characters)

Description: This attribute is used to provide the code(s) of retailer rules that should be matched by returned fares.

Sample Value:

"RetailerRule": [{ "Code": "MBRKERRQ" }, { "Code": "MBRKERRQNET" }]

Optional

Parameter: SellingLevels

Type: Complex

Description: Element controlling Mark Up Any Fare functionality. When SellingLevels element is defined, one of its sub-elements must be provided, either SellingLevelRules or ShowFareAmounts.

Sample Value:

N/A
Parameter: ShowFareAmounts/@Original

Type: Boolean

Description: When ShowFareAmounts/@Original is set to “true,” the original fare amount will be returned in the total fare amount, and additional MarkUp information will be returned in the SellingFareData element. To use this attribute, the ORGFQD EPR keyword is required.

Sample Value:

"SellingLevels": { "ShowFareAmounts": { "Original": true } }
Parameter: ShowFareAmounts/@Adjusted

Type: Boolean

Description: When ShowFareAmounts/@Adjusted is set to “true,” the selling fare level amount and total adjusted fare amount will be returned. To use this attribute, the AGYRET EPR keyword is required.

Sample Value:

"SellingLevels": { "ShowFareAmounts": { "Adjusted": true } }
Parameter: RetailerRules

Type: Complex

Description: Provides the capability to request fares matching the specified retailer rules.

Sample Value:

N/A
Parameter: RetailerRules/@Force

Type: Boolean

Description: If RetailerRules/@Force is set to “true,” only fares with a matched Business Rule containing the specified Retailer Rule Qualifier will be returned.

Sample Value:

N/A

In the Response

Required

Parameter: SellingFareData/@LayerTypeName

Type: String

Description: Indicates that the returned fare level is the adjusted selling fare, meaning that the agency retailer markup was applied

Sample Value:

"SellingFareDataList": { "SellingFareData": [{ "LayerTypeName": "ADS", "HandlingMarkupSummary": [{ "TypeCode": "J", "Description": "ADJT AMT", "MonetaryAmountValue": 21.00 }] }] }
Parameter: HandlingMarkupSummary/@TypeCode

Type: String (restricted to one character)

Description: HandlingMarkupSummary/@TypeCode defines the Agency Retailer markup type. Valid values are: • M − Embedded Mark Up • J − Adjusted Selling • H − Handling Fee • G − GST Taxes

Sample Value:

"SellingFareDataList": { "SellingFareData": [{ "LayerTypeName": "ADS", "HandlingMarkupSummary": [{ "TypeCode": "J", "Description": "ADJT AMT", "MonetaryAmountValue": 21.00 }] }] }
Parameter: HandlingMarkupSummary/@Description

Type: String (restriction: maximum 10 characters)

Description: HandlingMarkupSummary/@Description is a description of the selling fare data.

Sample Value:

"SellingFareDataList": { "SellingFareData": [{ "LayerTypeName": "ADS", "HandlingMarkupSummary": [{ "TypeCode": "J", "Description": "ADJT AMT", "MonetaryAmountValue": 21.00 }] }] }
Parameter: HandlingMarkupSummary/@MonetaryAmountValue

Type: Decimal (up to three fractional digits)

Description: HandlingMarkupSummary/@MonetaryAmountValue is the Agency Retailer markup amount in the equivalent currency.

Sample Value:

"SellingFareDataList": { "SellingFareData": [{ "LayerTypeName": "ADS", "HandlingMarkupSummary": [{ "TypeCode": "J", "Description": "ADJT AMT", "MonetaryAmountValue": 21.00 }] }] }
Parameter: FareRetailerRule/@TransactionType

Type: String

Description: FareRetailerRule/@TransactionType specifies the general or adjusted selling level.

Sample Value:

"FareRetailerRule": [{ "TransactionType": "General", "Code": "MBRKERRQNET" }, { "TransactionType": "AdjustedSellingLevel", "Code": "MBRKERRQ" }]
Parameter: FareRetailerRule/@Code

Type: String

Description: FareRetailerRule/@Code returns the matched Agency Retailer rule code.

Sample Value:

"FareRetailerRule": [{ "TransactionType": "General", "Code": "MBRKERRQNET" }, { "TransactionType": "AdjustedSellingLevel", "Code": "MBRKERRQ" }]

Optional

Parameter: HandlingMarkupDetail

Type: Complex

Description: Provides information about handling markup details if applicable on the fare component level.

Sample Value:

N/A
Parameter: HandlingMarkupDetail/@MarkupHandlingFeeAppID

Type: String

Description: HandlingMarkupDetail/@MarkupHandlingFeeAppID is a markup handling fee application ID.

Sample Value:

"HandlingMarkupDetail": [{ "MarkupHandlingFeeAppID": "AJ", "FareAmountAfterMarkup": 207.50, "MarkupAmount": 19.00, "AmountCurrency": "EUR", "MarkupRuleSourcePCC": "A1D0", "MarkupRuleItemNumber": 7794 }]
Parameter: HandlingMarkupDetail/@MarkupTypeCode

Type: String

Description:

Sample Value:

"HandlingMarkupDetail": [{ "MarkupHandlingFeeAppID": "AJ", "FareAmountAfterMarkup": 207.50, "MarkupAmount": 19.00, "AmountCurrency": "EUR", "MarkupRuleSourcePCC": "A1D0", "MarkupRuleItemNumber": 7794 }]
Parameter: HandlingMarkupDetail/@FareAmountAfterMarkup

Type: Decimal

Description: HandlingMarkupDetail/@FareAmountAfterMarkup is the fare amount after the applied markup.

Sample Value:

"HandlingMarkupDetail": [{ "MarkupHandlingFeeAppID": "AJ", "FareAmountAfterMarkup": 207.50, "MarkupAmount": 19.00, "AmountCurrency": "EUR", "MarkupRuleSourcePCC": "A1D0", "MarkupRuleItemNumber": 7794 }]
Parameter: HandlingMarkupDetail/@MarkupAmount

Type: Decimal

Description: HandlingMarkupDetail/@MarkupAmount is the amount of the applied markup.

Sample Value:

"HandlingMarkupDetail": [{ "MarkupHandlingFeeAppID": "AJ", "FareAmountAfterMarkup": 207.50, "MarkupAmount": 19.00, "AmountCurrency": "EUR", "MarkupRuleSourcePCC": "A1D0", "MarkupRuleItemNumber": 7794 }]
Parameter: HandlingMarkupDetail/@AmountCurrency

Type: String

Description: HandlingMarkupDetail/@AmountCurrency is the currency of a given markup amount.

Sample Value:

"HandlingMarkupDetail": [{ "MarkupHandlingFeeAppID": "AJ", "FareAmountAfterMarkup": 207.50, "MarkupAmount": 19.00, "AmountCurrency": "EUR", "MarkupRuleSourcePCC": "A1D0", "MarkupRuleItemNumber": 7794 }]
Parameter: HandlingMarkupDetail/@MarkupRuleSourcePCC

Type: String (restriction: minimum three maximum four characters)

Description: HandlingMarkupDetail/@MarkupRuleSourcePCC is code of PCC who crated given markup rule.

Sample Value:

"HandlingMarkupDetail": [{ "MarkupHandlingFeeAppID": "AJ", "FareAmountAfterMarkup": 207.50, "MarkupAmount": 19.00, "AmountCurrency": "EUR", "MarkupRuleSourcePCC": "A1D0", "MarkupRuleItemNumber": 7794 }]
Parameter: HandlingMarkupDetail/@MarkupRuleItemNumber

Type: Unsigned Long

Description: HandlingMarkupDetail/@MarkupRuleItemNumber is a number identifying a markup rule item.

Sample Value:

"HandlingMarkupDetail": [{ "MarkupHandlingFeeAppID": "AJ", "FareAmountAfterMarkup": 207.50, "MarkupAmount": 19.00, "AmountCurrency": "EUR", "MarkupRuleSourcePCC": "A1D0", "MarkupRuleItemNumber": 7794 }]
Parameter: SellingFareDataList

Type: Complex

Description: Agency retailer MarkUp information if applicable.

Sample Value:

N/A
Parameter: HandlingMarkupSummary

Type: Complex

Description: This is a summary information about the Agency Retailer MarkUp amount, markUp type, and MarkUp description.

Sample Value:

N/A
Parameter: FareRetailerRule

Type: Complex

Description: Matched general retailer rule code or adjusted selling level retailer rule code.

Sample Value:

N/A