The type of ancillary. Can be F - flight-related, or P - prepaid.
Example
P
OptionalbaggageId?: number
Description
Baggage ID number.
Example
1
carrier: string
Description
The carrier name of the traveler's journey.
Example
AA
code: string
Description
The code of the carrier of the traveler's journey.
Example
SU1
OptionaldepartureDate?: string
Description
The date of the departure. The format is YYYY-MM-DD.
Example
2020-03-20
Optionaldescription?: string
Description
Text description of the ancillary's fee details.
Example
PREPAIDBAGGAGE 23KG
Optionaldescription1?: string
Description
Ancillary Fee description line 1 from ATPCO filing. Baggage description line 1 information.
Example
UPTO50POUNDS/23KILOGRAMS
Optionaldescription2?: string
Description
Ancillary Fee description line 2 from ATPCO filing. Baggage description line 2 information.
Example
UPTO80LINEARINCHES/203LINEARCENTIMETERS
destination: string
Description
Destination airport code.
Example
LHR
endSegment: number
Description
End travel segment.
Example
1
OptionalfirstOccurrence?: number
Description
First occurrence for which the baggage charge applies. Returned only for new ATPCO processing of baggage charges.
Example
1
OptionallastOccurrence?: number
Description
Last occurrence for which the baggage charge applies. If last occurrence is not returned, baggage option has no limit of pieces that can be sold. Returned only for new ATPCO processing of baggage charges. Note - for new baggage charges processing If FirstOccurrence and LastOccurrence is not returned, then this baggage option should not be sold, because for airline it means it is overweight.
Baggage text information for charges.The first line of the charge type's description.
Example
UPTO50POUNDS/23KILOGRAMS
Optionaldescription2?: string
Description
Baggage text information for charges.The second line of the charge type's description.
Example
UPTO81LINEARINCHES/208LINEARCENTIMETERS
OptionalequivalentAmount?: number
Description
Baggage charge equivalent amount information.
Example
79
OptionalequivalentCurrency?: string
Description
Baggage charge equivalent currency information.
Example
USD
OptionalfirstPiece?: number
Description
First of baggage pieces for which the specified charge information applies to.
Example
1
id: number
Description
Baggage Charge ID.
Example
1
OptionallastPiece?: number
Description
Last of baggage pieces for which the specified charge information applies to.
Example
2
OptionalnoChargeNotAvailable?: string
Description
Returned in the response whenever charges are unavailable when requesting baggage information. It might contain one of listed description: X - service not available, F - no charge for service (free) and an EMD is not issued to reflect the free service, E - no charge for service (free) and an EMD is issued to reflect the free service, G - no charge for service (free), booking is not required and an EMD is not issued to reflect the free service, H - no charge for service (free), booking is not required and an EMD is issued to reflect the free service.
The Low Fare Search Request message requests price itinerary options for flights between specific city pairs on specific dates for specific numbers and types of passengers. The optional request information can include - Time / Time Window - Connecting cities. - Client Preferences (airlines, cabin, flight types, etc.) The Low Fare Search request contains similar information to a Low Fare Search entry on an airline CRS or GDS.
OptionalAvailableFlightsOnly?: boolean
Description
Indicator for whether to consider the availability of the corresponding booking codes. true(default) - Returns fares considering the availability of the corresponding booking codes. false - Returns fares without regard to the availability of the corresponding booking codes.
Specify maximum allowed distance from specified airport.
OptionalAllowBorderCross?: boolean
Description
Parameter set from default to true. In addition to AlternateAirportMileage it enables to cross a given country border if an alternative Airport is in the range of requested mileage radius. Note- Allow to return alternate airports from other countries. Default value is true. AllowBorderCross configuration set at AlternateAirportMileage overrides values of the same parameter set at leg level.
Example
true
Number: string
Description
Mileage radius range to searchfor alternate airports.
Diversity parameters control how we should itineraries be selected based not necessarily on cheapest price, but also on other criteria that guarantee a diverse response.
Carrier preference (dimension) in diversity bucket.
OptionalDefault?: {Options:string}
Description
Indicates any carrier code not specified on "Override" element.
Options: string
Description
Number or percentage of options.
Example
5
OptionalOnlineIndicator?: boolean
Description
Allows the User to decide if Carrier Diversity should be applied to online versus interline itineraries.
Default
false
Example
true
OptionalOverride?: {Code:string;Options:string}[]
Description
Specifies exact carrier code for diversity bucket.
Weight: number
Description
Allows the User to define how much the Carrier dimension should affect the score of an itinerary in Diversity Swapper. The range of allowed values is an integer between 0 and 10.
Provides the capability to prefer itineraries that are unique if it comes to the operating flights. This is done by penalizing itineraries with duplicated operating flights.
OptionalPreferredCarrier?: {Code:string}[]
Description
Allows the User to define Preferred Validating Carrier Codes.
Weight: number
Description
Allows the User to define how much the Operating Duplicate dimension should affect the score of an itinerary in Diversity Swapper.The range of allowed values is an integer between 0 and 10.
Example
1
OptionalPriceWeight?: number
Description
This defines how important price options are, on a scale of 0 to 10.
Default
10
Example
10
OptionalStopsNumber?: {Weight:number}
Description
Provides the capability to prefer itineraries consisting non-stop flights over connecting ones. This dimension penalize itineraries consisting of direct and connecting flights.
Weight: number
Description
Defines how much the Stops Number dimension should affect the score of an itinerary in Diversity Swapper. The range of allowed values is an integer between 0 and 10.
Provides the capability to define preferred options distribution among different time ranges. Itineraries departing and/or arriving in the Time of Day range with bigger number/percentage of options specified be preferred over the others.
Exactly one attribute, either Direction or Leg must be provided.
Weight: number
Description
Allows the User to define how much the Time of Day dimension should affect the score of an itinerary in Diversity Swapper. The range of allowed values is an integer between 0 and 10.
Example
1
OptionalTravelTime?: {Weight:number}
Description
Allows you to prefer itineraries with shorter duration over the other ones.
Weight: number
Description
Allows the User to define how much the Travel Time dimension should affect the score of an itinerary in Diversity Swapper.
Activates the AirStreaming functionality, which allows you to receive a chunked response. The MaxItinsPerChunk attribute is set individually by customers and configures the maximum number of itineraries per one chunk. This feature requires some development work on the customers side; therefore, more information is available in a dedicated Developer Administration Guide. The same document describes two available types of AirStreaming. Functionality is available in XML over the REST Endpoints. Applies to BargainFinderMax, Alternate Airport Shop, and Alternate Dates services.
MaxItinsPerChunk: number
Description
Atributte is set individually by the customers and configures what is the maximum amount of itineraries per one chunk in the below example the value is set to max. 10 Itineraries per chunk.
Example
10
Method: "Services"|"WholeResponse"
Description
There are 2 types of streaming available, therefore the Method of AirStreaming is equal either to "Services" or "WholeResponse".
Example
Services @enum {string}
OptionalCompressResponse?: {Value?:boolean}
Description
Indicator for whether the response should be compressed.
OptionalValue?: boolean
Description
A value of "true" returns the response payload in a Base64 encoded GZIP format. For instructions on how to decode and unzip the response, see the Response design document.
This allows you to specify what to do if the same journey is returned from ATPCO and NDC channels. By default, the cheaper will stay. In the case of a tie, the previously described solution will be in place. With this attribute, you can indicate show me everything, combine ATPCO and NDC fares as additional fares, regardless of whether they are the same price. You can use this for a single NDC fare or multiple, the same for APTCO, both single and multiple. NDC Applicable.
Value: boolean
Description
Combine solutions from different services/sources as additional fares.
Example
true
OptionalRequestType?: {Name?:string}
Description
Identifier of the type of request.
OptionalName?: string
Description
Type of request. It specifies the number of options returned for one-way, round-trip, single/double open jaw, and multi-destination trips with less than three legs. For complex,multi-destination, and circle trips with three or more legs, the number of options returned depends only the customer tier and with some exceptions. Name="50ITINS" Returns 50 itineraries in the response. The action code in the SOAP header must be set to BargainFinderMaxRQ.Name="100ITINS" Returns 100 itineraries. The action code in the SOAP header must be set to BargainFinderMaxRQ. Name="200ITINS" Returns 200 itineraries. The action code in the SOAP header must be set to BargainFinderMaxRQ. If a Request Type other than the ones listed above is used, the response is "No Availability". Using a Request Type name for a tier to which you are not subscribed alsoreturns a "No Availability" response.
MultiTicket allows you to request the lowest fare for an itinerary by considering two one-way flight combinations to be issued in two separate tickets. This will reduce the number of queries (single call versus multiple) by enabling you to request both one-way (OW) and round-trip (RT) solutions for the same itinerary simplifying the process.
OptionalDisplayPolicy?: "SOW"|"GOW2RT"|"SCHS"
Description
Display Option Policy, takes values - SOW - Show OneWays separately - first show standard RT output, then show OW for 1st and 2nd legs separately. Customer receives Round Trip and OneWays (outbound and inbound) solutions for the same request. OneWay solutions will be presented as 2 separate sections (OneWay Outbound and OneWay Inbound) and not as combination of two OneWay solutions combined into one round trip itinerary. Customer will be able to build the RT solution by choosing the most applicable, comfortable and cheapest OneWay solutions. SCHS - Group OneWays, match to RoundTrip and show cheaper solution. Customer receives cheapest solutions between Round Trip and 2 OneWay solution for the same request. OW solutions will be presented as combination of separate one way tickets into one round trip Itinerary.
Example
SOW @enum {string}
OptionalRequestedOneWays?: number
Description
Allow to set requested number of OneWays in MultiTicket processing.
ATPCO RH content (Flight Amenities UTA, UPA). Control over which Rich Content elements should be returned in the response. Available for consumption based on approval and activation only. Please refer to your account manager for information.
OptionalFlightAmenities?: boolean
Description
FlightAmenities parameter allows to specify if a list of available flight amenities such as Seat Comfort, WiFi, Power etc. should be included in the response.
Default
false
Example
true
OptionalLanguage?: string
Description
Language(optional) (Default = English) allows specifying the desired language translations for Universal Ticketing and Product Attributes. If the language is not specified, it defaults to EN. If the translations are not available in provided language or the provided language code is incorrect, it defaults to EN.
Example
EN
OptionalSeatInfo?: boolean
Description
SeatInfo(optional) supports to return Seat Type and Seat Pitch information about what is included in the offer regarding seat type and seat pitch.
Default
false
Example
true
OptionalUniversalProductAttributes?: boolean
Description
UniversalProductAttributes(optional) parameter allows to return ATPCO Route Happy Universal Product Attributes content in the response.
Default
false
Example
true
OptionalUniversalTicketingAttributes?: boolean
Description
UniversalTicketingAttributes(optional) parameter allows to return ATPCO Route Happy Universal Ticket Attributes content in the response.
Allows you to exclude non-branded fares in the shopping response. When the PreferLevel is set to Preferred," this means Use non-branded fares. If this is single filter (no other preferred elements), the meaning is Use ONLY non-branded fares. If other preferred filters are also used, the meaning is Use non-branded fares or fares with given (in filters) brands. When the PreferLevel is set to Unacceptable," this means Do not use non-branded fares. If this is single filter (no other unacceptable elements), the meaning is Use ONLY branded fares skip all non-branded. If other unacceptable filters are also used, the meaning is Use only branded fares excluding fares matching given (in filters) brands.
PreferLevel: "Unacceptable"|"Preferred"
Description
Preference level for all combinations inside one element.
Example
Preferred @enum {string}
OptionalItinParityBrandlessLeg?: boolean
Description
Parameter to Allow for Brand-less Leg Solutions when Itinerary parity is requested.
Parameter to choose the Fall Back Mode when brand Itinerary parity cannot be met (Lowest single Brand or Leg Parity).
Example
LegParity @enum {string}
OptionalMultipleBrandedFares?: boolean
Description
Return multiple brand options per itin. NDC Applicable.
Example
true
OptionalParityMode?: "Leg"|"Itin"
Description
Parameter to control the Brand Parity calculation logic preference (Leg Parity or Itinerary Parity). When specifying the ParityMode="Itin" at the request level without specifying the ItinParityFallbackMode, then the default (BFS) single lowest brand will be applied and single branded options returned.
Example
Itin @enum {string}
OptionalParityModeForLowest?: "None"|"Leg"|"Itin"
Description
Parameter which gives the ability to apply parity mode for the main/primary fare. Possible Values: Leg or Itinerary. If set, given parity mode will be forced on the cheapest branded fare solution. If not specified, no parity (None) is forced on the cheapest branded fare solution. NOTE: It"s designed to work with MultipleBrandedFares feature only.
Example
Leg @enum {string}
OptionalReturnBrandAncillaries?: boolean
Description
Parameter to request brand attributes, allows Sabre agencies to return additional brand attributes in the response it returns the structured data filed in table 166. Brand attributes is a feature within the Branded fares capabilities and will be returned with single and multiple branded fares request.
Example
true
OptionalSingleBrandedFare?: boolean
Description
Return single brand option per itin.
Example
true
OptionalUpsellLimit?: number
Description
Parameter to Limit of the Number of Upsell solutions to be returned.
Restricts fares that can be returned in the response. If you use this element, you must provide all children.
OptionalMinMaxStay?: {Ind:boolean}
Description
Indicator for whether to include fares that have a min/max stay requirement. Valid values are:true or 1 Includes fares with a min/max stay requirement in the response. false or 0 Do not include fares with a min/max stay requirement in the response. Note This is negation of the XS qualifier.
Ind: boolean
Description
Indicator for whether the fare can contain a Minimum Maximum Stay restriction. If the value is "true", the response can contain fares that have a min/max stay restriction. If the value is "false", no fares that include a min/max stay requirement will be included in the response.
Example
true
OptionalRefundPenalty?: {Ind:boolean}
Description
Indicator for whether to include fares that have a refund penalty. Note This is negation of the XS qualifier.
Ind: boolean
Description
Indicator for whether the fare can contain a refund penalty. If the value is "true", the response can contain fares that have a refund penalty. If the value is "false", no fares that include a refund penalty requirement will be included in the response.
Example
true
OptionalResTicketing?: {Ind:boolean}
Description
Indicator for whether to include fares that have a reservation/ticketing requirement.
Ind: boolean
Description
Indicator for whether the fare can contain a ticketing policy. If the value is "true", the response can contain fares that have a reservation/ticketing requirement. If the value is "false", no fares that include a reservation/ticketing requirement will be included in the response.
Returns the fares available for the specified point of sale. These fares will be priced in the currency of the specified point of sale. This allows you to override the point of origin country and validate applicable fare restrictions to selling a fare in the requested country. The currency is overridden by PriceRequestInformation@CurrencyCode.
Indicator for whether to enable the ancillary fees. Enable="true" Enable ancillary fees. Enable="false" Do not enable ancillary fees.
Example
true
OptionalSummary?: boolean
Description
Indicator for whether this is a summary request. Summary="true" Indicates the request is a summary request. Summary="false" Indicates the request is not a summary request.
This element allows user to get baggage information.
OptionalCarryOnInfo?: boolean
Description
Show Carry-on baggage info in response - available on Main Fare.
Example
true
OptionalDescription?: boolean
Description
Indicates whether baggage text information should be returned. If set to "true" - baggage text information returned in response (if applicable). If "false" baggage text information is not returned in response. If RequestType="N", "Description" parameter will be ignored.
Default
false
Example
true
OptionalFreeCarryOn?: boolean
Description
Freilter solution by availability with Free Carry-On baggage - available on Main Fare, Main Fare Leg, Flex Fares, Flex Fares Leg.
Example
true
OptionalFreePieceRequired?: boolean
Description
Free baggage piece is required on the whole journey.
Example
true
OptionalRequestedPieces?: number
Format: int16
Description
Number of baggage pieces requested.
Example
4
OptionalRequestType?: "C"|"A"|"N"
Description
Specifies baggage information type. "A" - allowance only; "C" - allowance and charges; "N" - no baggage information.
Preferred cabin(s) to be used in a search for this leg level (if SegmentType is O) or segment (if SegmentType is X). The cabin type you specify in this element will override the cabin type specified at the request level for this leg/segment. If you do not specify a cabin type at both the leg/segment level and request level, the default cabin is Economy.
OptionalETicketDesired?: boolean
Description
Indicator for whether to include e-ticketable flights in the response. Valid values are "true or "false". If set to "true", return only flights that are e-ticketable, when set to "false" return only flights that are non e-ticketable.
Preferred flight characteristics to be used in a search.
OptionalMaxConnections?: number|boolean
Description
Maximum number of connections requested in each leg. Itineraries with more connections than the specified value will not be returned. NDC Applicable.
Example
1
OptionalHybrid?: boolean
Description
If set to "true", returned shopping results will contain hybrid carriers content, if available on the market.
Default
true
Example
true
OptionalLookForAlternatives?: boolean
Description
Indicator to specify to return alternative options or the lowest fare in the response. If false no alternative solutions will be returned in response.
Default
true
Example
true
OptionalMaxStopsQuantity?: number
Description
Indicates the max number of stops requested in each leg. Itineraries with more stops than the specified value will not be returned. MaxStopsQuantity should not be used with "FlightTypePref@MaxConnections"option or other way around. NDC Applicable.
Example
2
OptionalSpanishFamilyDiscount?: {Level:1|2}
Description
Spanish Large Family Discount processing options.
Level: 1|2
Format: int16
Description
Spanish Large Family Discount Level. Valid values are 1 or 2. Spanish Large Family Discount Level 1 - 5 % of the base fare. Spanish Large Family Discount Level 2 - 10% of the base fare.
Guarantees that a lower cabin class will not be applied within a single shopping option, depending on the chosen mode.
Mode: "All"|"Main"|"None"
Description
Guarantees that lower cabin class won't be applied within single shopping option depending on the chosen mode. All - Apply Avoid Cabin Downgrade logic on the entire itinerary. Main - Apply Avoid Cabin Downgrade logic on the main flight of every leg. None - Disable Avoid Cabin Downgrade logic (default value).
Ability to filter out codeshare flights. The option is available with two attributes ExcludeCodeshare removes codeshare flights. The same Marketing/Operating (base flights), can be combined with KeepOnlines to also return the online flights that are codeshare, for more diversity.
Defines how the options in the response should be distributed between certain departure time of day ranges. All defined TimeOfDayRanges must cover the whole day, and the sum of all Percentages must equal 100.
Forces Dynamic Schedules Finder (DSF) to return schedules only for carriers bookable in the Sabre system.
OptionalEnabled?: boolean
Description
Force DSF to return schedules only for carriers bookable by Sabre.
Example
true
OptionalExcludeVendorPref?: {Code?:string}[]
Description
Codes for the carrier(s) to exclude from the search.
OptionalExemptAllTaxes?: {Value:boolean}
Description
Exempts all taxes (/TE).
Value: boolean
Description
Indicator for whether to exempt all taxes and include applicable fees and passenger facility charges (PFCs). Cannot combine ExemptAllTaxes with ExemptAllTaxesAndFees, Taxes, and ExemptTax.
Example
true
OptionalExemptAllTaxesAndFees?: {Value:boolean}
Description
Exempts all taxes and fees (/TN).
Value: boolean
Description
Indicator for whether to exempt all taxes and fees and include applicable passenger facility charges (PFCs). Cannot combine ExemptAllTaxesAndFees with ExemptAllTaxes, Taxes, and ExemptTax.
Example
true
OptionalExemptTax?: {TaxCode:string}[]
Description
Exempts the specified tax(es) (/TE). You cannot combine ExemptTax with ExemptAllTaxesAndFees, ExemptAllTaxes, and Taxes.
Change minimum and maximum connect time per connection in long connection schedules if Long Connect Time logic is enabled. Valid values are less than 1440 minutes (24 hours).
OptionalEnable?: boolean
Description
Enable long connection schedules.
Example
true
OptionalMax?: number
Format: int16
Description
Maximum connect time in minutes per connection in long connection schedules, default is 1439.
Example
1200
OptionalMin?: number
Format: int16
Description
Minimum connect time in minutes per connection in long connection schedules, default is 780.
Example
780
OptionalNumberOfSolutions?: string
Description
Specify the desired number of solutions to be returned in the response either in percentage or a number.
Allows you to exclude all the Low Cost Carriers from shopping via request. You can use this element instead of listing each Low Cost Carrier as unacceptable via the VendorPref element. Note When you use LowCostCarriersProcessing, no Low Cost Carriers options will be returned even if the low-cost carrier is specified as the preferred carrier at the IncludeVendorPref or VendorPref level.
Frequent Flyer status information. NDC Applicable.
OptionalMaxNumberOfUpsells?: {Value:number}
Description
Allows you to display additional upsells for the journeys. The system cannot request upsells explicitly; the system can only do something with them if provided by the carrier. By default, the system does a low fare search, so only the lowest fare is presented. With this element, you can tell the system if the carrier returns upsells, return them as additional fares, but no more than X.
Value: number
Format: int16
Description
Indicates maximum number of NDC upsells per itinerary.
Example
1
OptionalMultipleBrandedFares?: {Value:boolean}
Description
Indicates whether NDC upsells are allowed.
Value: boolean
Description
Indicates whether NDC upsells are allowed.
Example
true
OptionalParityMode?: {Mode:"Leg"|"Itin"}
Description
Parity mode for the PriceClasses.
Mode: "Leg"|"Itin"
Description
Parity mode for the PriceClasses.
Example
Leg @enum {string}
OptionalQualifier?: {Name:string;Value:string}[]
Description
General qualifiers.
OptionalShowOneWays?: {Value:boolean}
Description
Show One Ways indicator.
Value: boolean
Description
For carriers supporting Brand Based Shopping (returning two lists of one ways instead of round trip) display the one ways (do not combine those into round trips).
Example
true
OptionalSingleBrandedFare?: {Value:boolean}
Description
Indicator for whether price class information is displayed.
Value: boolean
Description
Indicates whether price class information is displayed.
Example
true
OptionalNumTrips?: {Number?:number}
Description
Number of itineraries returned.
OptionalNumber?: number
Format: int16
Description
Default 9, minimum 1.
Default
9
Example
19
OptionalOnlineIndicator?: {Ind?:boolean}
Description
OnlineIndicator and InterlineIndicator are mutually exclusive. One of the two is required.
OptionalInd?: boolean
Description
A value of "true" returns only online itineraries.
Example
true
OptionalPreferNDCSourceOnTie?: {Value:boolean}
Description
Select content from the New Distribution Capability (NDC) Content Source in case of identical offers.
Value: boolean
Description
Select content from NDC Content Source in case of identical offers.
Allows you to request fares matching the specified retailer rules.
OptionalForce?: boolean
Description
If set to true, only one Retailer Rule Code can be specified in the request. Only fares with a matched Business Rule containing the specified Retailer Rule Qualifier will be returned.
Optional seat comfort seats filter. This allows a more modernized way to display relevant offers from the same or different airlines for easy comparison to travelers.
Element controlling Mark Up Any Fare functionality. When the SellingLevels element is defined, one of its sub-elements must be provided, either SellingLevelRules or ShowFareAmounts.
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.
OptionalAdjusted?: boolean
Description
When set to "true" selling fare level amount and total adjusted fare amount will be returned.To use this attribute AGYRET EPR keyword is required.
Example
true
OptionalOriginal?: boolean
Description
When set to "true", original fare amount will be returned in total fare amount, and additional MarkUp information will be returned in "SellingFareData" element. To use this attribute ORGFQD EPR keyword is required.
Example
true
OptionalSettlementMethod?: string
Description
Overrides settlement method. This element provides users with ability to override the default settlement method selected (based on Agency POS or settlement method hierarchy). Invalid settlement method will return an error "INVALID SETTLEMENT METHOD" or "INVALID SETTLEMENT METHOD FOR POINT OF SALE". Supported codes for settlement method BSP, ARC, TCH, GEN (Generic TAT), RUT (Russian TAT), PRT (Philippines TAT), SAT (SATA), KRY (Killroy).
Type of trip. Value="OneWay" One-way trip. Value="Return" (default) Round-trip. Value="Circle" Circle trip. Value="OpenJaw" Open jaw trip. Value="Other" Complex trip.
Allows you to override local settlement method validation and Interline Electronic Ticketing agreements.
OptionalCarrier?: {Code:string}[]
Description
Carrier code information.
OptionalCountry?: {Code:string}[]
Description
Country code information.
IETValidation: {Ind:boolean}
Description
IETValidation allows you to disable Electronic Ticketing agreements validation or specify in which points of sale and for which carriers Electronic Ticketing agreements should be checked. If set to "true," the IET agreement will be validated for the listed countries.
Ind: boolean
Description
Set to "false" disables interline electronic ticket (IET) agreement validation for validating carriers. Set to "true" along with SettlementValidation set to "false" and at least one Country Code specified will trigger the responses with no settlement validation performed on Validating Carriers returned but with IET validation performed in the specified countries. Set to "true" along with SettlementValidation set to "true" will trigger the response with settlement validation and IET check performed in specified country.
Example
true
SettlementValidation: {Ind:boolean}
Description
The SettlementValidation parameter allows you to override the local settlement plan check. Note When SettlementValidation/@Ind is set to false, it disables the settlement method validation in the local point of sale. When SettlementValidation/@Ind is set to true, it validates the settlement method in the local POS. If specified along with Carrier Code, the settlement validation will be disabled.
Ind: boolean
Description
Set to "false" disables settlement method validation for local Point Of Sale. Set to "true" enables settlement method validation for specified country code.
Indicates how the current itinerary is priced. Valid values are L Look for the lowest fare (default). M Look in the requested RBD and requested pricing qualifiers. B Perform both L and M searches, and return both fares.
OptionalAlwaysCheckAvailability?: boolean
Description
Check availability for repriced itin.
Example
true
OptionalValue?: "L"|"M"|"B"
Description
Define how the current itinerary is priced.
Example
L @enum {string}
OptionalXOFares?: {Value:boolean}
Description
Indicator for whether to return only fares with a passenger type the same as the passenger type specified in the request.
Value: boolean
Description
Indicator for whether to return only fares with a passenger type the same as the passenger type specified in the request. Value="true" Returns only fares with a passenger type the same as the passenger type specified in the request. Value="false" (default) Uses standard Bargain Finder Max logic.
Example
true
OptionalValidInterlineTicket?: boolean
Description
If present, will validate options on base of interline ticketing agreement. ValidInterlineTicket="true" Return only options with valid interline ticketing agreement. ValidInterlineTicket="false" Return both options with and without valid interline ticketing agreement. Mark each option whether it has interline ticketing agreement or not.
Indicates whether online or interline carrier selection logic should be applied for the specified carrier type. One instance per carrier type is allowed.
Indicates if the service is free (F), not offered (N), chargeable (C), or displayed but not offered (D). The service is displayed but not offered for the brand.
Example
C
commercialName: string
Description
Textual description of the service within the brand.
Example
1CABINBAGUPTO 8KG
id: number
Description
The unique ID of the Brand Feature.
Example
210
serviceGroup: string
Description
The code used to specify the group of ancillaries of the service.
Example
BF
serviceType: string
Description
Service codes. Posible values Z- Branded Fares, F-Flight related, T- ticket related ancillary, A- Allowance, P- Prepaid.
Example
P
subCode: string
Description
Three-character alphanumeric code that is filed in the S5 record. This can be an industry sub-code or a carrier-defined sub-code.
Example
04D
vendor: string
Description
The code used to represent the vendor, or the data provider from where it was taking the information.
Marketing brand name for a specified group of fares within a Brand Program.
Example
AmericanAirlines
code: string
Description
Shortcode representing each brand (usually two characters).
Example
XX
OptionalpriceClassDescriptionRef?: number
Description
Price class description.
Example
1
OptionalprogramCode?: string
Description
The code of the Brand program that is returned from the branding service.
Example
DOMBE
OptionalprogramDescription?: string
Description
The description of the program. A program is a set of fare brands with a point of sale and origin and destination that is designed to be marketed with services desirable to customers.
This describes the best available entertainment in a given cabin. These elements are later referenced from FlightAmenities.
Optionalcost?: "free"|"paid"
Description
Indicates whether there is a charge for entertainment. It can be free or paid.
Example
free @enum {string}
Optionalexists?: boolean
Description
Indicates whether entertainment is available on the flight in the cabin.
Example
false
id: number
Description
The number of Entertainment returned.
Example
1
Optionaltype?: string
Description
Indicates the best entertainment type available. It can be livetv, loop, none, on-demand, overhead, pre-download, pre-download seatback, streaming, tablet.
Marketing brand name for a specified group of fares within a Brand Program.
Example
AmericanAirlines
code: string
Description
Shortcode representing each brand (usually two characters).
Example
XX
OptionalpriceClassDescriptionRef?: number
Description
Price class description.
Example
1
OptionalprogramCode?: string
Description
The code of the Brand program that is returned from the branding service.
Example
DOMBE
OptionalprogramDescription?: string
Description
The description of the program. A program is a set of fare brands with a point of sale and origin and destination that is designed to be marketed with services desirable to customers.
Standards baggage hints for a specific passenger type.
OptionaldivideByParty?: boolean
Description
Divide party T/F indicates if different passenger types are booked in different inventories.
Example
true
OptionaleTicketable?: boolean
Description
If true, this fare type can be used with an eTicket.
Example
true
OptionalgoverningCarriers?: string
Description
The names of the governing carriers for the fare.
Example
OSLH
OptionallastTicketDate?: string
Description
Last date to ticket. Specifies deadline date to purchase the ticket for this fare.
Example
2020-10-12
OptionallastTicketTime?: string
Description
Last time to ticket. specifies deadline time to purchase the ticket for this fare.
Example
20:19
OptionalmandatoryInd?: boolean
Description
Mandatory indicator at the Fare level. Applicable for ATPCO and NDC content. If set to "true" indicates mandatory Offer Items that can't be removed from the Offer. Mandatory Offer Items transition into Order Items. If not present or "false", the Offer item is optional.
Example
true
OptionalofferItemId?: string
Description
Unique identifier for this Offer item instance. Offer item is a priceable chunk of services.
Reissue Indicator. If true, the item can be reissued.
Example
true
OptionalreissueText?: string
Description
Detailed text on the ticket reissue.
Example
ABCD
OptionalserviceId?: string
Description
Uniquely Identifies a Service within the context of one message. A service is a feature/service included in a given flight. NDC Service Id.
Example
do3385fr4jsvz1el50-2-1-1
OptionalsimultaneousReservation?: boolean
Description
Simultaneous reservation flag indicates if the fare requires simultaneous reservations/ticketing.
Example
true
OptionalspanishFamilyDiscount?: string
Description
Spanish Discount indicator with values of A, B, C where A indicates Spanish Large Family discount only. B indicates Spanish Large Family discount + Spanish Islander discount. C indicates Spanish Islander discount only.
Air Extras total summary amount (currency for AirExtras is in Currency).
Example
1
OptionalbaseFareAmount?: number
Description
Base fare amount.
Example
1250
OptionalbaseFareCurrency?: string
Description
Base fare currency code.
Example
EUR
OptionalbookingFeeAmount?: number
Description
Booking fee. Returned only if non-zero value.
Example
1
OptionalconstructionAmount?: number
Description
Construction total amount.
Example
1725.34
OptionalconstructionCurrency?: string
Description
Construction currency code.
Example
NUC
OptionalcreditCardFeeAmount?: number
Description
Credit card fee. Returned only if non-zero value.
Example
1
currency: string
Description
Tax currency code.
Example
EUR
OptionaleffectivePriceDeviation?: number
Description
Effective Price Deviation.
Example
1
OptionalequivalentAmount?: number
Description
Equivalent (including taxes etc.) amount.
Example
1250
OptionalequivalentCurrency?: string
Description
Equivalent currency code.
Example
EUR
OptionalserviceFeeAmount?: number
Description
Service Fee Amount.
Example
1
OptionalserviceFeeTax?: number
Description
Service Fee Tax.
Example
1
totalPrice: number
Description
Total price for all passenger types.
Example
1806.62
OptionaltotalPriceWithAirExtras?: number
Description
Total price with Air Extras (currency for TotalPriceWithAirExtras is in Currency).
Example
1
totalTaxAmount: number
Description
Total taxes.
Example
1
OptionaltotalTtypeObFee?: number
Description
Total T-type OB Fee for all passenger types.
Example
1
OptionalvalidatingCarrierCode?: string
Description
Validating Carrier Code.The unique code used to identify the validating carrier of the journey.
Example
UA
OptionalvalidatingCarriers?: {ref:number}[]
Description
Validating Carrier information.
Optionalvita?: boolean
Description
Validate Interline Ticketing Agreement - indicates whether the itin has VITA indicator or not. If true, the itinerary has a Validate Interline Ticketing Agreement (VITA).
The one based number of the flight subsegment the referred amenity applies to. Subsegment is a portion of flight separated by a hiddenmstop. This attribute is omitted for flights without hidden stops.
Indicates what type of itineraries is contained in this itinerary group. If this attribute is missing, it denotes "normal" itineraries. Apart from normal itineraries, this attribute can name one of the following types:"branded", "oneWay", "departed", "soldOut", "legMissed" No other value shall appear in this attribute at this time. Other values may be allowed in the future.
FlightAmenities are presented in an indexed way that can easily be associated with flight components. List of all Flight Amenities of different types that are available on any of the returned flights. They are later referenced from other elements.
Indicates what type of itineraries is contained in this itinerary group. If this attribute is missing, it denotes "normal" itineraries. Apart from normal itineraries, this attribute can name one of the following types:"branded", "oneWay", "departed", "soldOut", "legMissed" No other value shall appear in this attribute at this time. Other values may be allowed in the future.
A message indicating that no schecules/no availabilities were found for the given market x date query. Typically you would expect either one message or a non-empty list of itineraries. It is possible though that you can get more than one message or a message + itinerary list in case where this itinerary group merges the result from two services (e.r. two JR's).
Severity may assume one of the following values. Info, Warning, Error, Diagnostic, Header. Warning message will be returned if depricated version of respense is used - "This response\version is deprecated and will be decommissioned once two newer versions are released".
Example
Info
OptionalshortCode?: string
Description
Short Code returned.
Example
123A
Optionaltext?: string
Description
Short text. Depending on the length of the message, its proper content may appear either in this attribute or in the element body.
Travel Destination Location - for example, air uses the IATA 3 letter code.
OptionalLocationCode?: string
Description
Three-character airport code for the arrival location. Location identifying code. Required unless AirportsGroup or AllAirports is specified. Cannot appear with AirportsGroup nor AllAirports.
Example
FRA
OptionalLocationType?: string
Description
Location type for specified LocationCode. A - for airport; C - for city. If "LocationType" not specified it defaults to city.
Travel Origin Location - for example, air uses the IATA 3 letter code.
OptionalLocationCode?: string
Description
Three-character airport code for the departure location. Location identifying code. Required unless AirportsGroup or AllAirports is specified. Cannot appear with AirportsGroup nor AllAirports.
Example
OSL
OptionalLocationType?: string
Description
Location type for specified LocationCode. A - for airport; C - for city. If LocationType not specified it defaults to city.
Additional elements and attributes to be included if required, per Trading Partner Agreement (TPA).One, and only one of following keys has to be present.
Allows you to exclude non-branded fares in the shopping response. When the PreferLevel is set to Preferred, this means Use non-branded fares. If this is single filter (no other preferred elements), the meaning is Use ONLY non-branded fares. If other preferred filters are also used, the meaning is Use non-branded fares or fares with given (in filters) brands. When the PreferLevel is set to Unacceptable, this means Do not use non-branded fares. If this is single filter (no other unacceptable elements), the meaning is Use ONLY branded fares skip all non-branded. If other unacceptable filters are also used, the meaning is Use only branded fares excluding fares matching given (in filters) brands.
PreferLevel: "Unacceptable"|"Preferred"
Description
Used to specify a preference level for something that is or will be requested.
Specifies cabin type for leg or segment. Cabin="P" or Cabin="PremiumFirst" is a Premium First class cabin.Cabin="F" or Cabin="First" is a First class cabin. Cabin="J" or Cabin="PremiumBusiness" is a Premium Business class cabin. Cabin="C" or Cabin="Business" is a Business class cabin. Cabin="S" or Cabin="PremiumEconomy" is a Premium Economy class cabin. Cabin="Y" or Cabin="Economy" is a Economy class cabin.
Example
Y @enum {string}
OptionalPreferLevel?: "Preferred"
Description
Indicator for whether the cabin is preferred. PreferLevel="Preferred" can occur a maximum of 3 times in the current sequence, however only the last entry will be considered as valid one and the previous two will be ignored.
Sister destination mileage informaton to search for alternate airports for the destination in this leg/segment.
OptionalAllowBorderCross?: boolean
Description
Parameter set from default to true. In addition to SisterDestinationMileage, it enables to cross a given country border if an alternative Airport is in the range of mileage radius. Note - Allow to return alternate airports from other countries. Default value is true. AllowBorderCross configuration set at AlternateAirportMileage overrides values of the same parameter set at leg level. Note - Allow to return alternate airports from other countries. Default value is true. AllowBorderCross configuration set at AlternateAirportMileage overrides values of the same parameter set at leg level.
Example
true
Number: number
Description
The maximum allowed number of miles from desired airport.
Mileage radius from the origin the system can search for alternate cities.
OptionalAllowBorderCross?: boolean
Description
Parameter set from default to true. In addition to SisterOriginMileage it enables to cross a given country border if an alternative Airport is in the range of requested mileage radius. Note - Allow to return alternate airports from other countries. Default value is true. AllowBorderCross configuration set at AlternateAirportMileage overrides values of the same parameter set at leg level.
Example
true
Number: number
Description
Mileage radius range to search for alternate airports for the origin in this leg/segment.
Extension of the Stopover section. Indicates the amount of nights between connections. It is possible to indicate min and max timeframes (hours). The information is related to the stay at the stopover point.
Allows you to exclude non-branded fares in the shopping response. When the PreferLevel is set to Preferred, this means Use non-branded fares. If this is single filter (no other preferred elements), the meaning is Use ONLY non-branded fares. If other preferred filters are also used, the meaning is Use non-branded fares or fares with given (in filters) brands. When the PreferLevel is set to Unacceptable, this means Do not use non-branded fares. If this is single filter (no other unacceptable elements), the meaning is Use ONLY branded fares skip all non-branded. If other unacceptable filters are also used, the meaning is Use only branded fares excluding fares matching given (in filters) brands.
PreferLevel: "Unacceptable"|"Preferred"
Description
Used to specify a preference level for something that is or will be requested.
Preferred cabin(s) to be used in a search for this leg level (if SegmentType is O) or segment (if SegmentType is X). The cabin type you specify in this element will override the cabin type specified at the request level for this leg/segment. If you do not specify a cabin type at both the leg/segment level and request level, the default cabin is Economy.
Specifies cabin type for leg or segment. Cabin="P" or Cabin="PremiumFirst" is a Premium First class cabin.Cabin="F" or Cabin="First" is a First class cabin. Cabin="J" or Cabin="PremiumBusiness" is a Premium Business class cabin. Cabin="C" or Cabin="Business" is a Business class cabin. Cabin="S" or Cabin="PremiumEconomy" is a Premium Economy class cabin. Cabin="Y" or Cabin="Economy" is a Economy class cabin.
Example
Y @enum {string}
OptionalPreferLevel?: "Preferred"
Description
Indicator for whether the cabin is preferred. PreferLevel="Preferred" can occur a maximum of 3 times in the current sequence, however only the last entry will be considered as valid one and the previous two will be ignored.
Parameter set from default to true. In addition to SisterDestinationMileage, it enables to cross a given country border if an alternative Airport is in the range of mileage radius. Note - Allow to return alternate airports from other countries. Default value is true. AllowBorderCross configuration set at AlternateAirportMileage overrides values of the same parameter set at leg level. Note - Allow to return alternate airports from other countries. Default value is true. AllowBorderCross configuration set at AlternateAirportMileage overrides values of the same parameter set at leg level.
Example
true
Number: number
Description
The maximum allowed number of miles from desired airport.
Parameter set from default to true. In addition to SisterOriginMileage it enables to cross a given country border if an alternative Airport is in the range of requested mileage radius. Note - Allow to return alternate airports from other countries. Default value is true. AllowBorderCross configuration set at AlternateAirportMileage overrides values of the same parameter set at leg level.
Example
true
Number: number
Description
Mileage radius range to search for alternate airports for the origin in this leg/segment.
Extension of the Stopover section. Indicates the amount of nights between connections. It is possible to indicate min and max timeframes (hours). The information is related to the stay at the stopover point.
An identifier of the entity making the request (e.g. ATA/IATA/ID number, Electronic Reservation Service Provider (ERSP), Association of British Travel Agents (ABTA)).
OptionalCompanyName?: {Code?:string}
Description
Identifies the company that is associated with the UniqueID.
OptionalCode?: string
Description
A company code used to identify a specific company.
Example
TN
ID: string
Description
A unique ID assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
Example
1
Type: string
Description
A reference to the type of object defined by the UniqueID element. Refer to OTA Code List Unique ID Type (UIT).
Additional elements and attributes to be included if required, per Trading Partner Agreement (TPA).One, and only one of following keys has to be present.
Specify maximum allowed distance from specified airport.
OptionalAllowBorderCross?: boolean
Description
Parameter set from default to true. In addition to AlternateAirportMileage it enables to cross a given country border if an alternative Airport is in the range of requested mileage radius. Note- Allow to return alternate airports from other countries. Default value is true. AllowBorderCross configuration set at AlternateAirportMileage overrides values of the same parameter set at leg level.
Example
true
Number: string
Description
Mileage radius range to searchfor alternate airports.
Diversity parameters control how we should itineraries be selected based not necessarily on cheapest price, but also on other criteria that guarantee a diverse response.
Carrier preference (dimension) in diversity bucket.
OptionalDefault?: {Options:string}
Description
Indicates any carrier code not specified on "Override" element.
Options: string
Description
Number or percentage of options.
Example
5
OptionalOnlineIndicator?: boolean
Description
Allows the User to decide if Carrier Diversity should be applied to online versus interline itineraries.
Default
false
Example
true
OptionalOverride?: {Code:string;Options:string}[]
Description
Specifies exact carrier code for diversity bucket.
Weight: number
Description
Allows the User to define how much the Carrier dimension should affect the score of an itinerary in Diversity Swapper. The range of allowed values is an integer between 0 and 10.
Provides the capability to prefer itineraries that are unique if it comes to the operating flights. This is done by penalizing itineraries with duplicated operating flights.
OptionalPreferredCarrier?: {Code:string}[]
Description
Allows the User to define Preferred Validating Carrier Codes.
Weight: number
Description
Allows the User to define how much the Operating Duplicate dimension should affect the score of an itinerary in Diversity Swapper.The range of allowed values is an integer between 0 and 10.
Example
1
OptionalPriceWeight?: number
Description
This defines how important price options are, on a scale of 0 to 10.
Default
10
Example
10
OptionalStopsNumber?: {Weight:number}
Description
Provides the capability to prefer itineraries consisting non-stop flights over connecting ones. This dimension penalize itineraries consisting of direct and connecting flights.
Weight: number
Description
Defines how much the Stops Number dimension should affect the score of an itinerary in Diversity Swapper. The range of allowed values is an integer between 0 and 10.
Provides the capability to define preferred options distribution among different time ranges. Itineraries departing and/or arriving in the Time of Day range with bigger number/percentage of options specified be preferred over the others.
Exactly one attribute, either Direction or Leg must be provided.
Weight: number
Description
Allows the User to define how much the Time of Day dimension should affect the score of an itinerary in Diversity Swapper. The range of allowed values is an integer between 0 and 10.
Example
1
OptionalTravelTime?: {Weight:number}
Description
Allows you to prefer itineraries with shorter duration over the other ones.
Weight: number
Description
Allows the User to define how much the Travel Time dimension should affect the score of an itinerary in Diversity Swapper.
Activates the AirStreaming functionality, which allows you to receive a chunked response. The MaxItinsPerChunk attribute is set individually by customers and configures the maximum number of itineraries per one chunk. This feature requires some development work on the customers side; therefore, more information is available in a dedicated Developer Administration Guide. The same document describes two available types of AirStreaming. Functionality is available in XML over the REST Endpoints. Applies to BargainFinderMax, Alternate Airport Shop, and Alternate Dates services.
MaxItinsPerChunk: number
Description
Atributte is set individually by the customers and configures what is the maximum amount of itineraries per one chunk in the below example the value is set to max. 10 Itineraries per chunk.
Example
10
Method: "Services"|"WholeResponse"
Description
There are 2 types of streaming available, therefore the Method of AirStreaming is equal either to "Services" or "WholeResponse".
Example
Services @enum {string}
OptionalCompressResponse?: {Value?:boolean}
Description
Indicator for whether the response should be compressed.
OptionalValue?: boolean
Description
A value of "true" returns the response payload in a Base64 encoded GZIP format. For instructions on how to decode and unzip the response, see the Response design document.
This allows you to specify what to do if the same journey is returned from ATPCO and NDC channels. By default, the cheaper will stay. In the case of a tie, the previously described solution will be in place. With this attribute, you can indicate show me everything, combine ATPCO and NDC fares as additional fares, regardless of whether they are the same price. You can use this for a single NDC fare or multiple, the same for APTCO, both single and multiple. NDC Applicable.
Value: boolean
Description
Combine solutions from different services/sources as additional fares.
Example
true
OptionalRequestType?: {Name?:string}
Description
Identifier of the type of request.
OptionalName?: string
Description
Type of request. It specifies the number of options returned for one-way, round-trip, single/double open jaw, and multi-destination trips with less than three legs. For complex,multi-destination, and circle trips with three or more legs, the number of options returned depends only the customer tier and with some exceptions. Name="50ITINS" Returns 50 itineraries in the response. The action code in the SOAP header must be set to BargainFinderMaxRQ.Name="100ITINS" Returns 100 itineraries. The action code in the SOAP header must be set to BargainFinderMaxRQ. Name="200ITINS" Returns 200 itineraries. The action code in the SOAP header must be set to BargainFinderMaxRQ. If a Request Type other than the ones listed above is used, the response is "No Availability". Using a Request Type name for a tier to which you are not subscribed alsoreturns a "No Availability" response.
MultiTicket allows you to request the lowest fare for an itinerary by considering two one-way flight combinations to be issued in two separate tickets. This will reduce the number of queries (single call versus multiple) by enabling you to request both one-way (OW) and round-trip (RT) solutions for the same itinerary simplifying the process.
OptionalDisplayPolicy?: "SOW"|"GOW2RT"|"SCHS"
Description
Display Option Policy, takes values - SOW - Show OneWays separately - first show standard RT output, then show OW for 1st and 2nd legs separately. Customer receives Round Trip and OneWays (outbound and inbound) solutions for the same request. OneWay solutions will be presented as 2 separate sections (OneWay Outbound and OneWay Inbound) and not as combination of two OneWay solutions combined into one round trip itinerary. Customer will be able to build the RT solution by choosing the most applicable, comfortable and cheapest OneWay solutions. SCHS - Group OneWays, match to RoundTrip and show cheaper solution. Customer receives cheapest solutions between Round Trip and 2 OneWay solution for the same request. OW solutions will be presented as combination of separate one way tickets into one round trip Itinerary.
Example
SOW @enum {string}
OptionalRequestedOneWays?: number
Description
Allow to set requested number of OneWays in MultiTicket processing.
ATPCO RH content (Flight Amenities UTA, UPA). Control over which Rich Content elements should be returned in the response. Available for consumption based on approval and activation only. Please refer to your account manager for information.
OptionalFlightAmenities?: boolean
Description
FlightAmenities parameter allows to specify if a list of available flight amenities such as Seat Comfort, WiFi, Power etc. should be included in the response.
Default
false
Example
true
OptionalLanguage?: string
Description
Language(optional) (Default = English) allows specifying the desired language translations for Universal Ticketing and Product Attributes. If the language is not specified, it defaults to EN. If the translations are not available in provided language or the provided language code is incorrect, it defaults to EN.
Example
EN
OptionalSeatInfo?: boolean
Description
SeatInfo(optional) supports to return Seat Type and Seat Pitch information about what is included in the offer regarding seat type and seat pitch.
Default
false
Example
true
OptionalUniversalProductAttributes?: boolean
Description
UniversalProductAttributes(optional) parameter allows to return ATPCO Route Happy Universal Product Attributes content in the response.
Default
false
Example
true
OptionalUniversalTicketingAttributes?: boolean
Description
UniversalTicketingAttributes(optional) parameter allows to return ATPCO Route Happy Universal Ticket Attributes content in the response.
Specify maximum allowed distance from specified airport.
OptionalAllowBorderCross?: boolean
Description
Parameter set from default to true. In addition to AlternateAirportMileage it enables to cross a given country border if an alternative Airport is in the range of requested mileage radius. Note- Allow to return alternate airports from other countries. Default value is true. AllowBorderCross configuration set at AlternateAirportMileage overrides values of the same parameter set at leg level.
Example
true
Number: string
Description
Mileage radius range to searchfor alternate airports.
Carrier preference (dimension) in diversity bucket.
OptionalDefault?: {Options:string}
Description
Indicates any carrier code not specified on "Override" element.
Options: string
Description
Number or percentage of options.
Example
5
OptionalOnlineIndicator?: boolean
Description
Allows the User to decide if Carrier Diversity should be applied to online versus interline itineraries.
Default
false
Example
true
OptionalOverride?: {Code:string;Options:string}[]
Description
Specifies exact carrier code for diversity bucket.
Weight: number
Description
Allows the User to define how much the Carrier dimension should affect the score of an itinerary in Diversity Swapper. The range of allowed values is an integer between 0 and 10.
Provides the capability to prefer itineraries that are unique if it comes to the operating flights. This is done by penalizing itineraries with duplicated operating flights.
OptionalPreferredCarrier?: {Code:string}[]
Description
Allows the User to define Preferred Validating Carrier Codes.
Weight: number
Description
Allows the User to define how much the Operating Duplicate dimension should affect the score of an itinerary in Diversity Swapper.The range of allowed values is an integer between 0 and 10.
Example
1
OptionalPriceWeight?: number
Description
This defines how important price options are, on a scale of 0 to 10.
Default
10
Example
10
OptionalStopsNumber?: {Weight:number}
Description
Provides the capability to prefer itineraries consisting non-stop flights over connecting ones. This dimension penalize itineraries consisting of direct and connecting flights.
Weight: number
Description
Defines how much the Stops Number dimension should affect the score of an itinerary in Diversity Swapper. The range of allowed values is an integer between 0 and 10.
Provides the capability to define preferred options distribution among different time ranges. Itineraries departing and/or arriving in the Time of Day range with bigger number/percentage of options specified be preferred over the others.
Exactly one attribute, either Direction or Leg must be provided.
Weight: number
Description
Allows the User to define how much the Time of Day dimension should affect the score of an itinerary in Diversity Swapper. The range of allowed values is an integer between 0 and 10.
Example
1
OptionalTravelTime?: {Weight:number}
Description
Allows you to prefer itineraries with shorter duration over the other ones.
Weight: number
Description
Allows the User to define how much the Travel Time dimension should affect the score of an itinerary in Diversity Swapper.
Carrier preference (dimension) in diversity bucket.
OptionalDefault?: {Options:string}
Description
Indicates any carrier code not specified on "Override" element.
Options: string
Description
Number or percentage of options.
Example
5
OptionalOnlineIndicator?: boolean
Description
Allows the User to decide if Carrier Diversity should be applied to online versus interline itineraries.
Default
false
Example
true
OptionalOverride?: {Code:string;Options:string}[]
Description
Specifies exact carrier code for diversity bucket.
Weight: number
Description
Allows the User to define how much the Carrier dimension should affect the score of an itinerary in Diversity Swapper. The range of allowed values is an integer between 0 and 10.
Provides the capability to prefer itineraries that are unique if it comes to the operating flights. This is done by penalizing itineraries with duplicated operating flights.
OptionalPreferredCarrier?: {Code:string}[]
Description
Allows the User to define Preferred Validating Carrier Codes.
Weight: number
Description
Allows the User to define how much the Operating Duplicate dimension should affect the score of an itinerary in Diversity Swapper.The range of allowed values is an integer between 0 and 10.
Example
1
OptionalPriceWeight?: number
Description
This defines how important price options are, on a scale of 0 to 10.
Default
10
Example
10
OptionalStopsNumber?: {Weight:number}
Description
Provides the capability to prefer itineraries consisting non-stop flights over connecting ones. This dimension penalize itineraries consisting of direct and connecting flights.
Weight: number
Description
Defines how much the Stops Number dimension should affect the score of an itinerary in Diversity Swapper. The range of allowed values is an integer between 0 and 10.
Provides the capability to define preferred options distribution among different time ranges. Itineraries departing and/or arriving in the Time of Day range with bigger number/percentage of options specified be preferred over the others.
Exactly one attribute, either Direction or Leg must be provided.
Weight: number
Description
Allows the User to define how much the Time of Day dimension should affect the score of an itinerary in Diversity Swapper. The range of allowed values is an integer between 0 and 10.
Example
1
OptionalTravelTime?: {Weight:number}
Description
Allows you to prefer itineraries with shorter duration over the other ones.
Weight: number
Description
Allows the User to define how much the Travel Time dimension should affect the score of an itinerary in Diversity Swapper.
Indicates any carrier code not specified on "Override" element.
Options: string
Description
Number or percentage of options.
Example
5
OptionalOnlineIndicator?: boolean
Description
Allows the User to decide if Carrier Diversity should be applied to online versus interline itineraries.
Default
false
Example
true
OptionalOverride?: {Code:string;Options:string}[]
Description
Specifies exact carrier code for diversity bucket.
Weight: number
Description
Allows the User to define how much the Carrier dimension should affect the score of an itinerary in Diversity Swapper. The range of allowed values is an integer between 0 and 10.
Allows the User to define Preferred Validating Carrier Codes.
Weight: number
Description
Allows the User to define how much the Operating Duplicate dimension should affect the score of an itinerary in Diversity Swapper.The range of allowed values is an integer between 0 and 10.
Defines how much the Stops Number dimension should affect the score of an itinerary in Diversity Swapper. The range of allowed values is an integer between 0 and 10.
Exactly one attribute, either Direction or Leg must be provided.
Weight: number
Description
Allows the User to define how much the Time of Day dimension should affect the score of an itinerary in Diversity Swapper. The range of allowed values is an integer between 0 and 10.
Activates the AirStreaming functionality, which allows you to receive a chunked response. The MaxItinsPerChunk attribute is set individually by customers and configures the maximum number of itineraries per one chunk. This feature requires some development work on the customers side; therefore, more information is available in a dedicated Developer Administration Guide. The same document describes two available types of AirStreaming. Functionality is available in XML over the REST Endpoints. Applies to BargainFinderMax, Alternate Airport Shop, and Alternate Dates services.
MaxItinsPerChunk: number
Description
Atributte is set individually by the customers and configures what is the maximum amount of itineraries per one chunk in the below example the value is set to max. 10 Itineraries per chunk.
Example
10
Method: "Services"|"WholeResponse"
Description
There are 2 types of streaming available, therefore the Method of AirStreaming is equal either to "Services" or "WholeResponse".
Example
Services @enum {string}
OptionalCompressResponse?: {Value?:boolean}
Description
Indicator for whether the response should be compressed.
OptionalValue?: boolean
Description
A value of "true" returns the response payload in a Base64 encoded GZIP format. For instructions on how to decode and unzip the response, see the Response design document.
This allows you to specify what to do if the same journey is returned from ATPCO and NDC channels. By default, the cheaper will stay. In the case of a tie, the previously described solution will be in place. With this attribute, you can indicate show me everything, combine ATPCO and NDC fares as additional fares, regardless of whether they are the same price. You can use this for a single NDC fare or multiple, the same for APTCO, both single and multiple. NDC Applicable.
Value: boolean
Description
Combine solutions from different services/sources as additional fares.
Example
true
OptionalRequestType?: {Name?:string}
Description
Identifier of the type of request.
OptionalName?: string
Description
Type of request. It specifies the number of options returned for one-way, round-trip, single/double open jaw, and multi-destination trips with less than three legs. For complex,multi-destination, and circle trips with three or more legs, the number of options returned depends only the customer tier and with some exceptions. Name="50ITINS" Returns 50 itineraries in the response. The action code in the SOAP header must be set to BargainFinderMaxRQ.Name="100ITINS" Returns 100 itineraries. The action code in the SOAP header must be set to BargainFinderMaxRQ. Name="200ITINS" Returns 200 itineraries. The action code in the SOAP header must be set to BargainFinderMaxRQ. If a Request Type other than the ones listed above is used, the response is "No Availability". Using a Request Type name for a tier to which you are not subscribed alsoreturns a "No Availability" response.
Atributte is set individually by the customers and configures what is the maximum amount of itineraries per one chunk in the below example the value is set to max. 10 Itineraries per chunk.
Example
10
Method: "Services"|"WholeResponse"
Description
There are 2 types of streaming available, therefore the Method of AirStreaming is equal either to "Services" or "WholeResponse".
A value of "true" returns the response payload in a Base64 encoded GZIP format. For instructions on how to decode and unzip the response, see the Response design document.
Type of request. It specifies the number of options returned for one-way, round-trip, single/double open jaw, and multi-destination trips with less than three legs. For complex,multi-destination, and circle trips with three or more legs, the number of options returned depends only the customer tier and with some exceptions. Name="50ITINS" Returns 50 itineraries in the response. The action code in the SOAP header must be set to BargainFinderMaxRQ.Name="100ITINS" Returns 100 itineraries. The action code in the SOAP header must be set to BargainFinderMaxRQ. Name="200ITINS" Returns 200 itineraries. The action code in the SOAP header must be set to BargainFinderMaxRQ. If a Request Type other than the ones listed above is used, the response is "No Availability". Using a Request Type name for a tier to which you are not subscribed alsoreturns a "No Availability" response.
Display Option Policy, takes values - SOW - Show OneWays separately - first show standard RT output, then show OW for 1st and 2nd legs separately. Customer receives Round Trip and OneWays (outbound and inbound) solutions for the same request. OneWay solutions will be presented as 2 separate sections (OneWay Outbound and OneWay Inbound) and not as combination of two OneWay solutions combined into one round trip itinerary. Customer will be able to build the RT solution by choosing the most applicable, comfortable and cheapest OneWay solutions. SCHS - Group OneWays, match to RoundTrip and show cheaper solution. Customer receives cheapest solutions between Round Trip and 2 OneWay solution for the same request. OW solutions will be presented as combination of separate one way tickets into one round trip Itinerary.
Example
SOW @enum {string}
OptionalRequestedOneWays?: number
Description
Allow to set requested number of OneWays in MultiTicket processing.
Control over which Rich Content elements should be returned in response.
OptionalFlightAmenities?: boolean
Description
FlightAmenities parameter allows to specify if a list of available flight amenities such as Seat Comfort, WiFi, Power etc. should be included in the response.
Default
false
Example
true
OptionalLanguage?: string
Description
Language(optional) (Default = English) allows specifying the desired language translations for Universal Ticketing and Product Attributes. If the language is not specified, it defaults to EN. If the translations are not available in provided language or the provided language code is incorrect, it defaults to EN.
Example
EN
OptionalSeatInfo?: boolean
Description
SeatInfo(optional) supports to return Seat Type and Seat Pitch information about what is included in the offer regarding seat type and seat pitch.
Default
false
Example
true
OptionalUniversalProductAttributes?: boolean
Description
UniversalProductAttributes(optional) parameter allows to return ATPCO Route Happy Universal Product Attributes content in the response.
Default
false
Example
true
OptionalUniversalTicketingAttributes?: boolean
Description
UniversalTicketingAttributes(optional) parameter allows to return ATPCO Route Happy Universal Ticket Attributes content in the response.
Allows you to exclude non-branded fares in the shopping response. When the PreferLevel is set to Preferred," this means Use non-branded fares. If this is single filter (no other preferred elements), the meaning is Use ONLY non-branded fares. If other preferred filters are also used, the meaning is Use non-branded fares or fares with given (in filters) brands. When the PreferLevel is set to Unacceptable," this means Do not use non-branded fares. If this is single filter (no other unacceptable elements), the meaning is Use ONLY branded fares skip all non-branded. If other unacceptable filters are also used, the meaning is Use only branded fares excluding fares matching given (in filters) brands.
PreferLevel: "Unacceptable"|"Preferred"
Description
Preference level for all combinations inside one element.
Example
Preferred @enum {string}
OptionalItinParityBrandlessLeg?: boolean
Description
Parameter to Allow for Brand-less Leg Solutions when Itinerary parity is requested.
Parameter to choose the Fall Back Mode when brand Itinerary parity cannot be met (Lowest single Brand or Leg Parity).
Example
LegParity @enum {string}
OptionalMultipleBrandedFares?: boolean
Description
Return multiple brand options per itin. NDC Applicable.
Example
true
OptionalParityMode?: "Leg"|"Itin"
Description
Parameter to control the Brand Parity calculation logic preference (Leg Parity or Itinerary Parity). When specifying the ParityMode="Itin" at the request level without specifying the ItinParityFallbackMode, then the default (BFS) single lowest brand will be applied and single branded options returned.
Example
Itin @enum {string}
OptionalParityModeForLowest?: "None"|"Leg"|"Itin"
Description
Parameter which gives the ability to apply parity mode for the main/primary fare. Possible Values: Leg or Itinerary. If set, given parity mode will be forced on the cheapest branded fare solution. If not specified, no parity (None) is forced on the cheapest branded fare solution. NOTE: It"s designed to work with MultipleBrandedFares feature only.
Example
Leg @enum {string}
OptionalReturnBrandAncillaries?: boolean
Description
Parameter to request brand attributes, allows Sabre agencies to return additional brand attributes in the response it returns the structured data filed in table 166. Brand attributes is a feature within the Branded fares capabilities and will be returned with single and multiple branded fares request.
Example
true
OptionalSingleBrandedFare?: boolean
Description
Return single brand option per itin.
Example
true
OptionalUpsellLimit?: number
Description
Parameter to Limit of the Number of Upsell solutions to be returned.
Restricts fares that can be returned in the response. If you use this element, you must provide all children.
OptionalMinMaxStay?: {Ind:boolean}
Description
Indicator for whether to include fares that have a min/max stay requirement. Valid values are:true or 1 Includes fares with a min/max stay requirement in the response. false or 0 Do not include fares with a min/max stay requirement in the response. Note This is negation of the XS qualifier.
Ind: boolean
Description
Indicator for whether the fare can contain a Minimum Maximum Stay restriction. If the value is "true", the response can contain fares that have a min/max stay restriction. If the value is "false", no fares that include a min/max stay requirement will be included in the response.
Example
true
OptionalRefundPenalty?: {Ind:boolean}
Description
Indicator for whether to include fares that have a refund penalty. Note This is negation of the XS qualifier.
Ind: boolean
Description
Indicator for whether the fare can contain a refund penalty. If the value is "true", the response can contain fares that have a refund penalty. If the value is "false", no fares that include a refund penalty requirement will be included in the response.
Example
true
OptionalResTicketing?: {Ind:boolean}
Description
Indicator for whether to include fares that have a reservation/ticketing requirement.
Ind: boolean
Description
Indicator for whether the fare can contain a ticketing policy. If the value is "true", the response can contain fares that have a reservation/ticketing requirement. If the value is "false", no fares that include a reservation/ticketing requirement will be included in the response.
Returns the fares available for the specified point of sale. These fares will be priced in the currency of the specified point of sale. This allows you to override the point of origin country and validate applicable fare restrictions to selling a fare in the requested country. The currency is overridden by PriceRequestInformation@CurrencyCode.
Indicates relation between conditions. Match="All" Indicates that all penalty conditions must be match by returned fare. Match="Any" Indicates that at least one penalty must by match by returned fare. Match="Info" Indicates that penalty information must be returned in the response.
Identifies whether penalties associated with voluntary changes should be included in the search results.
OptionalMatch?: "All"|"Any"|"Info"
Description
Indicates relation between conditions. Match="All" Indicates that all penalty conditions must be match by returned fare. Match="Any" Indicates that at least one penalty must by match by returned fare. Match="Info" Indicates that penalty information must be returned in the response.
Allows you to exclude non-branded fares in the shopping response. When the PreferLevel is set to Preferred," this means Use non-branded fares. If this is single filter (no other preferred elements), the meaning is Use ONLY non-branded fares. If other preferred filters are also used, the meaning is Use non-branded fares or fares with given (in filters) brands. When the PreferLevel is set to Unacceptable," this means Do not use non-branded fares. If this is single filter (no other unacceptable elements), the meaning is Use ONLY branded fares skip all non-branded. If other unacceptable filters are also used, the meaning is Use only branded fares excluding fares matching given (in filters) brands.
PreferLevel: "Unacceptable"|"Preferred"
Description
Preference level for all combinations inside one element.
Example
Preferred @enum {string}
OptionalItinParityBrandlessLeg?: boolean
Description
Parameter to Allow for Brand-less Leg Solutions when Itinerary parity is requested.
Parameter to choose the Fall Back Mode when brand Itinerary parity cannot be met (Lowest single Brand or Leg Parity).
Example
LegParity @enum {string}
OptionalMultipleBrandedFares?: boolean
Description
Return multiple brand options per itin. NDC Applicable.
Example
true
OptionalParityMode?: "Leg"|"Itin"
Description
Parameter to control the Brand Parity calculation logic preference (Leg Parity or Itinerary Parity). When specifying the ParityMode="Itin" at the request level without specifying the ItinParityFallbackMode, then the default (BFS) single lowest brand will be applied and single branded options returned.
Example
Itin @enum {string}
OptionalParityModeForLowest?: "None"|"Leg"|"Itin"
Description
Parameter which gives the ability to apply parity mode for the main/primary fare. Possible Values: Leg or Itinerary. If set, given parity mode will be forced on the cheapest branded fare solution. If not specified, no parity (None) is forced on the cheapest branded fare solution. NOTE: It"s designed to work with MultipleBrandedFares feature only.
Example
Leg @enum {string}
OptionalReturnBrandAncillaries?: boolean
Description
Parameter to request brand attributes, allows Sabre agencies to return additional brand attributes in the response it returns the structured data filed in table 166. Brand attributes is a feature within the Branded fares capabilities and will be returned with single and multiple branded fares request.
Example
true
OptionalSingleBrandedFare?: boolean
Description
Return single brand option per itin.
Example
true
OptionalUpsellLimit?: number
Description
Parameter to Limit of the Number of Upsell solutions to be returned.
Restricts fares that can be returned in the response. If you use this element, you must provide all children.
OptionalMinMaxStay?: {Ind:boolean}
Description
Indicator for whether to include fares that have a min/max stay requirement. Valid values are:true or 1 Includes fares with a min/max stay requirement in the response. false or 0 Do not include fares with a min/max stay requirement in the response. Note This is negation of the XS qualifier.
Ind: boolean
Description
Indicator for whether the fare can contain a Minimum Maximum Stay restriction. If the value is "true", the response can contain fares that have a min/max stay restriction. If the value is "false", no fares that include a min/max stay requirement will be included in the response.
Example
true
OptionalRefundPenalty?: {Ind:boolean}
Description
Indicator for whether to include fares that have a refund penalty. Note This is negation of the XS qualifier.
Ind: boolean
Description
Indicator for whether the fare can contain a refund penalty. If the value is "true", the response can contain fares that have a refund penalty. If the value is "false", no fares that include a refund penalty requirement will be included in the response.
Example
true
OptionalResTicketing?: {Ind:boolean}
Description
Indicator for whether to include fares that have a reservation/ticketing requirement.
Ind: boolean
Description
Indicator for whether the fare can contain a ticketing policy. If the value is "true", the response can contain fares that have a reservation/ticketing requirement. If the value is "false", no fares that include a reservation/ticketing requirement will be included in the response.
Returns the fares available for the specified point of sale. These fares will be priced in the currency of the specified point of sale. This allows you to override the point of origin country and validate applicable fare restrictions to selling a fare in the requested country. The currency is overridden by PriceRequestInformation@CurrencyCode.
Additional elements and attributes to be included if required, per Trading Partner Agreement (TPA).One, and only one of following keys has to be present: [].
Allows you to exclude non-branded fares in the shopping response. When the PreferLevel is set to Preferred," this means Use non-branded fares. If this is single filter (no other preferred elements), the meaning is Use ONLY non-branded fares. If other preferred filters are also used, the meaning is Use non-branded fares or fares with given (in filters) brands. When the PreferLevel is set to Unacceptable," this means Do not use non-branded fares. If this is single filter (no other unacceptable elements), the meaning is Use ONLY branded fares skip all non-branded. If other unacceptable filters are also used, the meaning is Use only branded fares excluding fares matching given (in filters) brands.
PreferLevel: "Unacceptable"|"Preferred"
Description
Preference level for all combinations inside one element.
Example
Preferred @enum {string}
OptionalItinParityBrandlessLeg?: boolean
Description
Parameter to Allow for Brand-less Leg Solutions when Itinerary parity is requested.
Parameter to choose the Fall Back Mode when brand Itinerary parity cannot be met (Lowest single Brand or Leg Parity).
Example
LegParity @enum {string}
OptionalMultipleBrandedFares?: boolean
Description
Return multiple brand options per itin. NDC Applicable.
Example
true
OptionalParityMode?: "Leg"|"Itin"
Description
Parameter to control the Brand Parity calculation logic preference (Leg Parity or Itinerary Parity). When specifying the ParityMode="Itin" at the request level without specifying the ItinParityFallbackMode, then the default (BFS) single lowest brand will be applied and single branded options returned.
Example
Itin @enum {string}
OptionalParityModeForLowest?: "None"|"Leg"|"Itin"
Description
Parameter which gives the ability to apply parity mode for the main/primary fare. Possible Values: Leg or Itinerary. If set, given parity mode will be forced on the cheapest branded fare solution. If not specified, no parity (None) is forced on the cheapest branded fare solution. NOTE: It"s designed to work with MultipleBrandedFares feature only.
Example
Leg @enum {string}
OptionalReturnBrandAncillaries?: boolean
Description
Parameter to request brand attributes, allows Sabre agencies to return additional brand attributes in the response it returns the structured data filed in table 166. Brand attributes is a feature within the Branded fares capabilities and will be returned with single and multiple branded fares request.
Example
true
OptionalSingleBrandedFare?: boolean
Description
Return single brand option per itin.
Example
true
OptionalUpsellLimit?: number
Description
Parameter to Limit of the Number of Upsell solutions to be returned.
Restricts fares that can be returned in the response. If you use this element, you must provide all children.
OptionalMinMaxStay?: {Ind:boolean}
Description
Indicator for whether to include fares that have a min/max stay requirement. Valid values are:true or 1 Includes fares with a min/max stay requirement in the response. false or 0 Do not include fares with a min/max stay requirement in the response. Note This is negation of the XS qualifier.
Ind: boolean
Description
Indicator for whether the fare can contain a Minimum Maximum Stay restriction. If the value is "true", the response can contain fares that have a min/max stay restriction. If the value is "false", no fares that include a min/max stay requirement will be included in the response.
Example
true
OptionalRefundPenalty?: {Ind:boolean}
Description
Indicator for whether to include fares that have a refund penalty. Note This is negation of the XS qualifier.
Ind: boolean
Description
Indicator for whether the fare can contain a refund penalty. If the value is "true", the response can contain fares that have a refund penalty. If the value is "false", no fares that include a refund penalty requirement will be included in the response.
Example
true
OptionalResTicketing?: {Ind:boolean}
Description
Indicator for whether to include fares that have a reservation/ticketing requirement.
Ind: boolean
Description
Indicator for whether the fare can contain a ticketing policy. If the value is "true", the response can contain fares that have a reservation/ticketing requirement. If the value is "false", no fares that include a reservation/ticketing requirement will be included in the response.
Returns the fares available for the specified point of sale. These fares will be priced in the currency of the specified point of sale. This allows you to override the point of origin country and validate applicable fare restrictions to selling a fare in the requested country. The currency is overridden by PriceRequestInformation@CurrencyCode.
Allows you to exclude non-branded fares in the shopping response. When the PreferLevel is set to Preferred," this means Use non-branded fares. If this is single filter (no other preferred elements), the meaning is Use ONLY non-branded fares. If other preferred filters are also used, the meaning is Use non-branded fares or fares with given (in filters) brands. When the PreferLevel is set to Unacceptable," this means Do not use non-branded fares. If this is single filter (no other unacceptable elements), the meaning is Use ONLY branded fares skip all non-branded. If other unacceptable filters are also used, the meaning is Use only branded fares excluding fares matching given (in filters) brands.
PreferLevel: "Unacceptable"|"Preferred"
Description
Preference level for all combinations inside one element.
Example
Preferred @enum {string}
OptionalItinParityBrandlessLeg?: boolean
Description
Parameter to Allow for Brand-less Leg Solutions when Itinerary parity is requested.
Parameter to choose the Fall Back Mode when brand Itinerary parity cannot be met (Lowest single Brand or Leg Parity).
Example
LegParity @enum {string}
OptionalMultipleBrandedFares?: boolean
Description
Return multiple brand options per itin. NDC Applicable.
Example
true
OptionalParityMode?: "Leg"|"Itin"
Description
Parameter to control the Brand Parity calculation logic preference (Leg Parity or Itinerary Parity). When specifying the ParityMode="Itin" at the request level without specifying the ItinParityFallbackMode, then the default (BFS) single lowest brand will be applied and single branded options returned.
Example
Itin @enum {string}
OptionalParityModeForLowest?: "None"|"Leg"|"Itin"
Description
Parameter which gives the ability to apply parity mode for the main/primary fare. Possible Values: Leg or Itinerary. If set, given parity mode will be forced on the cheapest branded fare solution. If not specified, no parity (None) is forced on the cheapest branded fare solution. NOTE: It"s designed to work with MultipleBrandedFares feature only.
Example
Leg @enum {string}
OptionalReturnBrandAncillaries?: boolean
Description
Parameter to request brand attributes, allows Sabre agencies to return additional brand attributes in the response it returns the structured data filed in table 166. Brand attributes is a feature within the Branded fares capabilities and will be returned with single and multiple branded fares request.
Example
true
OptionalSingleBrandedFare?: boolean
Description
Return single brand option per itin.
Example
true
OptionalUpsellLimit?: number
Description
Parameter to Limit of the Number of Upsell solutions to be returned.
Allows you to exclude non-branded fares in the shopping response. When the PreferLevel is set to Preferred," this means Use non-branded fares. If this is single filter (no other preferred elements), the meaning is Use ONLY non-branded fares. If other preferred filters are also used, the meaning is Use non-branded fares or fares with given (in filters) brands. When the PreferLevel is set to Unacceptable," this means Do not use non-branded fares. If this is single filter (no other unacceptable elements), the meaning is Use ONLY branded fares skip all non-branded. If other unacceptable filters are also used, the meaning is Use only branded fares excluding fares matching given (in filters) brands.
PreferLevel: "Unacceptable"|"Preferred"
Description
Preference level for all combinations inside one element.
This element restricts fares which can be returned in response. If a customer passes this element, all its children should be specified.
OptionalMinMaxStay?: {Ind:boolean}
Description
Indicator for whether to include fares that have a min/max stay requirement. Valid values are:true or 1 Includes fares with a min/max stay requirement in the response. false or 0 Do not include fares with a min/max stay requirement in the response. Note This is negation of the XS qualifier.
Ind: boolean
Description
Indicator for whether the fare can contain a Minimum Maximum Stay restriction. If the value is "true", the response can contain fares that have a min/max stay restriction. If the value is "false", no fares that include a min/max stay requirement will be included in the response.
Example
true
OptionalRefundPenalty?: {Ind:boolean}
Description
Indicator for whether to include fares that have a refund penalty. Note This is negation of the XS qualifier.
Ind: boolean
Description
Indicator for whether the fare can contain a refund penalty. If the value is "true", the response can contain fares that have a refund penalty. If the value is "false", no fares that include a refund penalty requirement will be included in the response.
Example
true
OptionalResTicketing?: {Ind:boolean}
Description
Indicator for whether to include fares that have a reservation/ticketing requirement.
Ind: boolean
Description
Indicator for whether the fare can contain a ticketing policy. If the value is "true", the response can contain fares that have a reservation/ticketing requirement. If the value is "false", no fares that include a reservation/ticketing requirement will be included in the response.
If set to true, fares that have a min/max stay can be included in the responses. If set to false, then no fares that include a min/max stay requirement will be included in the response.
Ind: boolean
Description
Indicator for whether the fare can contain a Minimum Maximum Stay restriction. If the value is "true", the response can contain fares that have a min/max stay restriction. If the value is "false", no fares that include a min/max stay requirement will be included in the response.
If set to true, fares that have a refund penalty can be included in the responses. If set to false, then no fares that include a refund penalty requirement will be included in the response.
Ind: boolean
Description
Indicator for whether the fare can contain a refund penalty. If the value is "true", the response can contain fares that have a refund penalty. If the value is "false", no fares that include a refund penalty requirement will be included in the response.
If set to true, fares that have a reservation/ticketing can be included in the responses. If set to false, then no fares that include reservation/ticketing requirement will be included in the response.
Ind: boolean
Description
Indicator for whether the fare can contain a ticketing policy. If the value is "true", the response can contain fares that have a reservation/ticketing requirement. If the value is "false", no fares that include a reservation/ticketing requirement will be included in the response.
Will return the fares available for specified point of sale and priced in this point of sale currency. Currency is overriden by PriceRequestInformation@CurrencyCode.
Indicator for whether to enable the ancillary fees. Enable="true" Enable ancillary fees. Enable="false" Do not enable ancillary fees.
Example
true
OptionalSummary?: boolean
Description
Indicator for whether this is a summary request. Summary="true" Indicates the request is a summary request. Summary="false" Indicates the request is not a summary request.
This element allows user to get baggage information.
OptionalCarryOnInfo?: boolean
Description
Show Carry-on baggage info in response - available on Main Fare.
Example
true
OptionalDescription?: boolean
Description
Indicates whether baggage text information should be returned. If set to "true" - baggage text information returned in response (if applicable). If "false" baggage text information is not returned in response. If RequestType="N", "Description" parameter will be ignored.
Default
false
Example
true
OptionalFreeCarryOn?: boolean
Description
Freilter solution by availability with Free Carry-On baggage - available on Main Fare, Main Fare Leg, Flex Fares, Flex Fares Leg.
Example
true
OptionalFreePieceRequired?: boolean
Description
Free baggage piece is required on the whole journey.
Example
true
OptionalRequestedPieces?: number
Format: int16
Description
Number of baggage pieces requested.
Example
4
OptionalRequestType?: "C"|"A"|"N"
Description
Specifies baggage information type. "A" - allowance only; "C" - allowance and charges; "N" - no baggage information.
Preferred cabin(s) to be used in a search for this leg level (if SegmentType is O) or segment (if SegmentType is X). The cabin type you specify in this element will override the cabin type specified at the request level for this leg/segment. If you do not specify a cabin type at both the leg/segment level and request level, the default cabin is Economy.
OptionalETicketDesired?: boolean
Description
Indicator for whether to include e-ticketable flights in the response. Valid values are "true or "false". If set to "true", return only flights that are e-ticketable, when set to "false" return only flights that are non e-ticketable.
Preferred flight characteristics to be used in a search.
OptionalMaxConnections?: number|boolean
Description
Maximum number of connections requested in each leg. Itineraries with more connections than the specified value will not be returned. NDC Applicable.
Example
1
OptionalHybrid?: boolean
Description
If set to "true", returned shopping results will contain hybrid carriers content, if available on the market.
Default
true
Example
true
OptionalLookForAlternatives?: boolean
Description
Indicator to specify to return alternative options or the lowest fare in the response. If false no alternative solutions will be returned in response.
Default
true
Example
true
OptionalMaxStopsQuantity?: number
Description
Indicates the max number of stops requested in each leg. Itineraries with more stops than the specified value will not be returned. MaxStopsQuantity should not be used with "FlightTypePref@MaxConnections"option or other way around. NDC Applicable.
Example
2
OptionalSpanishFamilyDiscount?: {Level:1|2}
Description
Spanish Large Family Discount processing options.
Level: 1|2
Format: int16
Description
Spanish Large Family Discount Level. Valid values are 1 or 2. Spanish Large Family Discount Level 1 - 5 % of the base fare. Spanish Large Family Discount Level 2 - 10% of the base fare.
Guarantees that a lower cabin class will not be applied within a single shopping option, depending on the chosen mode.
Mode: "All"|"Main"|"None"
Description
Guarantees that lower cabin class won't be applied within single shopping option depending on the chosen mode. All - Apply Avoid Cabin Downgrade logic on the entire itinerary. Main - Apply Avoid Cabin Downgrade logic on the main flight of every leg. None - Disable Avoid Cabin Downgrade logic (default value).
Ability to filter out codeshare flights. The option is available with two attributes ExcludeCodeshare removes codeshare flights. The same Marketing/Operating (base flights), can be combined with KeepOnlines to also return the online flights that are codeshare, for more diversity.
Defines how the options in the response should be distributed between certain departure time of day ranges. All defined TimeOfDayRanges must cover the whole day, and the sum of all Percentages must equal 100.
Forces Dynamic Schedules Finder (DSF) to return schedules only for carriers bookable in the Sabre system.
OptionalEnabled?: boolean
Description
Force DSF to return schedules only for carriers bookable by Sabre.
Example
true
OptionalExcludeVendorPref?: {Code?:string}[]
Description
Codes for the carrier(s) to exclude from the search.
OptionalExemptAllTaxes?: {Value:boolean}
Description
Exempts all taxes (/TE).
Value: boolean
Description
Indicator for whether to exempt all taxes and include applicable fees and passenger facility charges (PFCs). Cannot combine ExemptAllTaxes with ExemptAllTaxesAndFees, Taxes, and ExemptTax.
Example
true
OptionalExemptAllTaxesAndFees?: {Value:boolean}
Description
Exempts all taxes and fees (/TN).
Value: boolean
Description
Indicator for whether to exempt all taxes and fees and include applicable passenger facility charges (PFCs). Cannot combine ExemptAllTaxesAndFees with ExemptAllTaxes, Taxes, and ExemptTax.
Example
true
OptionalExemptTax?: {TaxCode:string}[]
Description
Exempts the specified tax(es) (/TE). You cannot combine ExemptTax with ExemptAllTaxesAndFees, ExemptAllTaxes, and Taxes.
Change minimum and maximum connect time per connection in long connection schedules if Long Connect Time logic is enabled. Valid values are less than 1440 minutes (24 hours).
OptionalEnable?: boolean
Description
Enable long connection schedules.
Example
true
OptionalMax?: number
Format: int16
Description
Maximum connect time in minutes per connection in long connection schedules, default is 1439.
Example
1200
OptionalMin?: number
Format: int16
Description
Minimum connect time in minutes per connection in long connection schedules, default is 780.
Example
780
OptionalNumberOfSolutions?: string
Description
Specify the desired number of solutions to be returned in the response either in percentage or a number.
Allows you to exclude all the Low Cost Carriers from shopping via request. You can use this element instead of listing each Low Cost Carrier as unacceptable via the VendorPref element. Note When you use LowCostCarriersProcessing, no Low Cost Carriers options will be returned even if the low-cost carrier is specified as the preferred carrier at the IncludeVendorPref or VendorPref level.
Frequent Flyer status information. NDC Applicable.
OptionalMaxNumberOfUpsells?: {Value:number}
Description
Allows you to display additional upsells for the journeys. The system cannot request upsells explicitly; the system can only do something with them if provided by the carrier. By default, the system does a low fare search, so only the lowest fare is presented. With this element, you can tell the system if the carrier returns upsells, return them as additional fares, but no more than X.
Value: number
Format: int16
Description
Indicates maximum number of NDC upsells per itinerary.
Example
1
OptionalMultipleBrandedFares?: {Value:boolean}
Description
Indicates whether NDC upsells are allowed.
Value: boolean
Description
Indicates whether NDC upsells are allowed.
Example
true
OptionalParityMode?: {Mode:"Leg"|"Itin"}
Description
Parity mode for the PriceClasses.
Mode: "Leg"|"Itin"
Description
Parity mode for the PriceClasses.
Example
Leg @enum {string}
OptionalQualifier?: {Name:string;Value:string}[]
Description
General qualifiers.
OptionalShowOneWays?: {Value:boolean}
Description
Show One Ways indicator.
Value: boolean
Description
For carriers supporting Brand Based Shopping (returning two lists of one ways instead of round trip) display the one ways (do not combine those into round trips).
Example
true
OptionalSingleBrandedFare?: {Value:boolean}
Description
Indicator for whether price class information is displayed.
Value: boolean
Description
Indicates whether price class information is displayed.
Example
true
OptionalNumTrips?: {Number?:number}
Description
Number of itineraries returned.
OptionalNumber?: number
Format: int16
Description
Default 9, minimum 1.
Default
9
Example
19
OptionalOnlineIndicator?: {Ind?:boolean}
Description
OnlineIndicator and InterlineIndicator are mutually exclusive. One of the two is required.
OptionalInd?: boolean
Description
A value of "true" returns only online itineraries.
Example
true
OptionalPreferNDCSourceOnTie?: {Value:boolean}
Description
Select content from the New Distribution Capability (NDC) Content Source in case of identical offers.
Value: boolean
Description
Select content from NDC Content Source in case of identical offers.
Allows you to request fares matching the specified retailer rules.
OptionalForce?: boolean
Description
If set to true, only one Retailer Rule Code can be specified in the request. Only fares with a matched Business Rule containing the specified Retailer Rule Qualifier will be returned.
Optional seat comfort seats filter. This allows a more modernized way to display relevant offers from the same or different airlines for easy comparison to travelers.
Element controlling Mark Up Any Fare functionality. When the SellingLevels element is defined, one of its sub-elements must be provided, either SellingLevelRules or ShowFareAmounts.
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.
OptionalAdjusted?: boolean
Description
When set to "true" selling fare level amount and total adjusted fare amount will be returned.To use this attribute AGYRET EPR keyword is required.
Example
true
OptionalOriginal?: boolean
Description
When set to "true", original fare amount will be returned in total fare amount, and additional MarkUp information will be returned in "SellingFareData" element. To use this attribute ORGFQD EPR keyword is required.
Example
true
OptionalSettlementMethod?: string
Description
Overrides settlement method. This element provides users with ability to override the default settlement method selected (based on Agency POS or settlement method hierarchy). Invalid settlement method will return an error "INVALID SETTLEMENT METHOD" or "INVALID SETTLEMENT METHOD FOR POINT OF SALE". Supported codes for settlement method BSP, ARC, TCH, GEN (Generic TAT), RUT (Russian TAT), PRT (Philippines TAT), SAT (SATA), KRY (Killroy).
Type of trip. Value="OneWay" One-way trip. Value="Return" (default) Round-trip. Value="Circle" Circle trip. Value="OpenJaw" Open jaw trip. Value="Other" Complex trip.
Allows you to override local settlement method validation and Interline Electronic Ticketing agreements.
OptionalCarrier?: {Code:string}[]
Description
Carrier code information.
OptionalCountry?: {Code:string}[]
Description
Country code information.
IETValidation: {Ind:boolean}
Description
IETValidation allows you to disable Electronic Ticketing agreements validation or specify in which points of sale and for which carriers Electronic Ticketing agreements should be checked. If set to "true," the IET agreement will be validated for the listed countries.
Ind: boolean
Description
Set to "false" disables interline electronic ticket (IET) agreement validation for validating carriers. Set to "true" along with SettlementValidation set to "false" and at least one Country Code specified will trigger the responses with no settlement validation performed on Validating Carriers returned but with IET validation performed in the specified countries. Set to "true" along with SettlementValidation set to "true" will trigger the response with settlement validation and IET check performed in specified country.
Example
true
SettlementValidation: {Ind:boolean}
Description
The SettlementValidation parameter allows you to override the local settlement plan check. Note When SettlementValidation/@Ind is set to false, it disables the settlement method validation in the local point of sale. When SettlementValidation/@Ind is set to true, it validates the settlement method in the local POS. If specified along with Carrier Code, the settlement validation will be disabled.
Ind: boolean
Description
Set to "false" disables settlement method validation for local Point Of Sale. Set to "true" enables settlement method validation for specified country code.
Indicates how the current itinerary is priced. Valid values are L Look for the lowest fare (default). M Look in the requested RBD and requested pricing qualifiers. B Perform both L and M searches, and return both fares.
OptionalAlwaysCheckAvailability?: boolean
Description
Check availability for repriced itin.
Example
true
OptionalValue?: "L"|"M"|"B"
Description
Define how the current itinerary is priced.
Example
L @enum {string}
OptionalXOFares?: {Value:boolean}
Description
Indicator for whether to return only fares with a passenger type the same as the passenger type specified in the request.
Value: boolean
Description
Indicator for whether to return only fares with a passenger type the same as the passenger type specified in the request. Value="true" Returns only fares with a passenger type the same as the passenger type specified in the request. Value="false" (default) Uses standard Bargain Finder Max logic.
Example
true
OptionalValidInterlineTicket?: boolean
Description
If present, will validate options on base of interline ticketing agreement. ValidInterlineTicket="true" Return only options with valid interline ticketing agreement. ValidInterlineTicket="false" Return both options with and without valid interline ticketing agreement. Mark each option whether it has interline ticketing agreement or not.
Indicates whether online or interline carrier selection logic should be applied for the specified carrier type. One instance per carrier type is allowed.
Indicator for whether to enable the ancillary fees. Enable="true" Enable ancillary fees. Enable="false" Do not enable ancillary fees.
Example
true
OptionalSummary?: boolean
Description
Indicator for whether this is a summary request. Summary="true" Indicates the request is a summary request. Summary="false" Indicates the request is not a summary request.
This element allows user to get baggage information.
OptionalCarryOnInfo?: boolean
Description
Show Carry-on baggage info in response - available on Main Fare.
Example
true
OptionalDescription?: boolean
Description
Indicates whether baggage text information should be returned. If set to "true" - baggage text information returned in response (if applicable). If "false" baggage text information is not returned in response. If RequestType="N", "Description" parameter will be ignored.
Default
false
Example
true
OptionalFreeCarryOn?: boolean
Description
Freilter solution by availability with Free Carry-On baggage - available on Main Fare, Main Fare Leg, Flex Fares, Flex Fares Leg.
Example
true
OptionalFreePieceRequired?: boolean
Description
Free baggage piece is required on the whole journey.
Example
true
OptionalRequestedPieces?: number
Format: int16
Description
Number of baggage pieces requested.
Example
4
OptionalRequestType?: "C"|"A"|"N"
Description
Specifies baggage information type. "A" - allowance only; "C" - allowance and charges; "N" - no baggage information.
Spanish Large Family Discount Level. Valid values are 1 or 2. Spanish Large Family Discount Level 1 - 5 % of the base fare. Spanish Large Family Discount Level 2 - 10% of the base fare.
Additional elements and attributes to be included if required, per Trading Partner Agreement (TPA).One, and only one of following keys has to be present.
Guarantees that a lower cabin class will not be applied within a single shopping option, depending on the chosen mode.
Mode: "All"|"Main"|"None"
Description
Guarantees that lower cabin class won't be applied within single shopping option depending on the chosen mode. All - Apply Avoid Cabin Downgrade logic on the entire itinerary. Main - Apply Avoid Cabin Downgrade logic on the main flight of every leg. None - Disable Avoid Cabin Downgrade logic (default value).
Ability to filter out codeshare flights. The option is available with two attributes ExcludeCodeshare removes codeshare flights. The same Marketing/Operating (base flights), can be combined with KeepOnlines to also return the online flights that are codeshare, for more diversity.
Defines how the options in the response should be distributed between certain departure time of day ranges. All defined TimeOfDayRanges must cover the whole day, and the sum of all Percentages must equal 100.
Forces Dynamic Schedules Finder (DSF) to return schedules only for carriers bookable in the Sabre system.
OptionalEnabled?: boolean
Description
Force DSF to return schedules only for carriers bookable by Sabre.
Example
true
OptionalExcludeVendorPref?: {Code?:string}[]
Description
Codes for the carrier(s) to exclude from the search.
OptionalExemptAllTaxes?: {Value:boolean}
Description
Exempts all taxes (/TE).
Value: boolean
Description
Indicator for whether to exempt all taxes and include applicable fees and passenger facility charges (PFCs). Cannot combine ExemptAllTaxes with ExemptAllTaxesAndFees, Taxes, and ExemptTax.
Example
true
OptionalExemptAllTaxesAndFees?: {Value:boolean}
Description
Exempts all taxes and fees (/TN).
Value: boolean
Description
Indicator for whether to exempt all taxes and fees and include applicable passenger facility charges (PFCs). Cannot combine ExemptAllTaxesAndFees with ExemptAllTaxes, Taxes, and ExemptTax.
Example
true
OptionalExemptTax?: {TaxCode:string}[]
Description
Exempts the specified tax(es) (/TE). You cannot combine ExemptTax with ExemptAllTaxesAndFees, ExemptAllTaxes, and Taxes.
Change minimum and maximum connect time per connection in long connection schedules if Long Connect Time logic is enabled. Valid values are less than 1440 minutes (24 hours).
OptionalEnable?: boolean
Description
Enable long connection schedules.
Example
true
OptionalMax?: number
Format: int16
Description
Maximum connect time in minutes per connection in long connection schedules, default is 1439.
Example
1200
OptionalMin?: number
Format: int16
Description
Minimum connect time in minutes per connection in long connection schedules, default is 780.
Example
780
OptionalNumberOfSolutions?: string
Description
Specify the desired number of solutions to be returned in the response either in percentage or a number.
Allows you to exclude all the Low Cost Carriers from shopping via request. You can use this element instead of listing each Low Cost Carrier as unacceptable via the VendorPref element. Note When you use LowCostCarriersProcessing, no Low Cost Carriers options will be returned even if the low-cost carrier is specified as the preferred carrier at the IncludeVendorPref or VendorPref level.
Frequent Flyer status information. NDC Applicable.
OptionalMaxNumberOfUpsells?: {Value:number}
Description
Allows you to display additional upsells for the journeys. The system cannot request upsells explicitly; the system can only do something with them if provided by the carrier. By default, the system does a low fare search, so only the lowest fare is presented. With this element, you can tell the system if the carrier returns upsells, return them as additional fares, but no more than X.
Value: number
Format: int16
Description
Indicates maximum number of NDC upsells per itinerary.
Example
1
OptionalMultipleBrandedFares?: {Value:boolean}
Description
Indicates whether NDC upsells are allowed.
Value: boolean
Description
Indicates whether NDC upsells are allowed.
Example
true
OptionalParityMode?: {Mode:"Leg"|"Itin"}
Description
Parity mode for the PriceClasses.
Mode: "Leg"|"Itin"
Description
Parity mode for the PriceClasses.
Example
Leg @enum {string}
OptionalQualifier?: {Name:string;Value:string}[]
Description
General qualifiers.
OptionalShowOneWays?: {Value:boolean}
Description
Show One Ways indicator.
Value: boolean
Description
For carriers supporting Brand Based Shopping (returning two lists of one ways instead of round trip) display the one ways (do not combine those into round trips).
Example
true
OptionalSingleBrandedFare?: {Value:boolean}
Description
Indicator for whether price class information is displayed.
Value: boolean
Description
Indicates whether price class information is displayed.
Example
true
OptionalNumTrips?: {Number?:number}
Description
Number of itineraries returned.
OptionalNumber?: number
Format: int16
Description
Default 9, minimum 1.
Default
9
Example
19
OptionalOnlineIndicator?: {Ind?:boolean}
Description
OnlineIndicator and InterlineIndicator are mutually exclusive. One of the two is required.
OptionalInd?: boolean
Description
A value of "true" returns only online itineraries.
Example
true
OptionalPreferNDCSourceOnTie?: {Value:boolean}
Description
Select content from the New Distribution Capability (NDC) Content Source in case of identical offers.
Value: boolean
Description
Select content from NDC Content Source in case of identical offers.
Allows you to request fares matching the specified retailer rules.
OptionalForce?: boolean
Description
If set to true, only one Retailer Rule Code can be specified in the request. Only fares with a matched Business Rule containing the specified Retailer Rule Qualifier will be returned.
Optional seat comfort seats filter. This allows a more modernized way to display relevant offers from the same or different airlines for easy comparison to travelers.
Element controlling Mark Up Any Fare functionality. When the SellingLevels element is defined, one of its sub-elements must be provided, either SellingLevelRules or ShowFareAmounts.
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.
OptionalAdjusted?: boolean
Description
When set to "true" selling fare level amount and total adjusted fare amount will be returned.To use this attribute AGYRET EPR keyword is required.
Example
true
OptionalOriginal?: boolean
Description
When set to "true", original fare amount will be returned in total fare amount, and additional MarkUp information will be returned in "SellingFareData" element. To use this attribute ORGFQD EPR keyword is required.
Example
true
OptionalSettlementMethod?: string
Description
Overrides settlement method. This element provides users with ability to override the default settlement method selected (based on Agency POS or settlement method hierarchy). Invalid settlement method will return an error "INVALID SETTLEMENT METHOD" or "INVALID SETTLEMENT METHOD FOR POINT OF SALE". Supported codes for settlement method BSP, ARC, TCH, GEN (Generic TAT), RUT (Russian TAT), PRT (Philippines TAT), SAT (SATA), KRY (Killroy).
Type of trip. Value="OneWay" One-way trip. Value="Return" (default) Round-trip. Value="Circle" Circle trip. Value="OpenJaw" Open jaw trip. Value="Other" Complex trip.
Allows you to override local settlement method validation and Interline Electronic Ticketing agreements.
OptionalCarrier?: {Code:string}[]
Description
Carrier code information.
OptionalCountry?: {Code:string}[]
Description
Country code information.
IETValidation: {Ind:boolean}
Description
IETValidation allows you to disable Electronic Ticketing agreements validation or specify in which points of sale and for which carriers Electronic Ticketing agreements should be checked. If set to "true," the IET agreement will be validated for the listed countries.
Ind: boolean
Description
Set to "false" disables interline electronic ticket (IET) agreement validation for validating carriers. Set to "true" along with SettlementValidation set to "false" and at least one Country Code specified will trigger the responses with no settlement validation performed on Validating Carriers returned but with IET validation performed in the specified countries. Set to "true" along with SettlementValidation set to "true" will trigger the response with settlement validation and IET check performed in specified country.
Example
true
SettlementValidation: {Ind:boolean}
Description
The SettlementValidation parameter allows you to override the local settlement plan check. Note When SettlementValidation/@Ind is set to false, it disables the settlement method validation in the local point of sale. When SettlementValidation/@Ind is set to true, it validates the settlement method in the local POS. If specified along with Carrier Code, the settlement validation will be disabled.
Ind: boolean
Description
Set to "false" disables settlement method validation for local Point Of Sale. Set to "true" enables settlement method validation for specified country code.
Indicates how the current itinerary is priced. Valid values are L Look for the lowest fare (default). M Look in the requested RBD and requested pricing qualifiers. B Perform both L and M searches, and return both fares.
OptionalAlwaysCheckAvailability?: boolean
Description
Check availability for repriced itin.
Example
true
OptionalValue?: "L"|"M"|"B"
Description
Define how the current itinerary is priced.
Example
L @enum {string}
OptionalXOFares?: {Value:boolean}
Description
Indicator for whether to return only fares with a passenger type the same as the passenger type specified in the request.
Value: boolean
Description
Indicator for whether to return only fares with a passenger type the same as the passenger type specified in the request. Value="true" Returns only fares with a passenger type the same as the passenger type specified in the request. Value="false" (default) Uses standard Bargain Finder Max logic.
Guarantees that lower cabin class won't be applied within single shopping option depending on the chosen mode. All - Apply Avoid Cabin Downgrade logic on the entire itinerary. Main - Apply Avoid Cabin Downgrade logic on the main flight of every leg. None - Disable Avoid Cabin Downgrade logic (default value).
Defines how the options in the response should be distributed between certain departure time of day ranges. All defined TimeOfDayRanges must cover the whole day, and the sum of all Percentages must equal 100.
Defines how the options in the response should be distributed between certain departure time of day ranges. All defined TimeOfDayRanges need to cover the whole day and the sum of all Percentages needs to equal 100.
Indicator for whether to exempt all taxes and include applicable fees and passenger facility charges (PFCs). Cannot combine ExemptAllTaxes with ExemptAllTaxesAndFees, Taxes, and ExemptTax.
Indicator for whether to exempt all taxes and fees and include applicable passenger facility charges (PFCs). Cannot combine ExemptAllTaxesAndFees with ExemptAllTaxes, Taxes, and ExemptTax.
Guarantees that lower cabin class won't be applied within single shopping option depending on the chosen mode. All - Apply Avoid Cabin Downgrade logic on the entire itinerary. Main - Apply Avoid Cabin Downgrade logic on the main flight of every leg. None - Disable Avoid Cabin Downgrade logic (default\value).
Allows you to exclude non-branded fares in the shopping response. When the PreferLevel is set to Preferred," this means Use non-branded fares. If this is single filter (no other preferred elements), the meaning is CUse ONLY non-branded fares. If other preferred filters are also used, the meaning is Use non-branded fares or fares with given (in filters) brands. When the PreferLevel is set to Unacceptable," this means Do not use non-branded fares. If this is single filter (no other unacceptable elements), the meaning is Use ONLY branded fares skip all non-branded. If other unacceptable filters are also used, the meaning is Use only branded fares excluding fares matching given (in filters) brands.
PreferLevel: "Unacceptable"|"Preferred"
Description
Preference level.
Example
Preferred @enum {string}
OptionalItinParityBrandlessLeg?: boolean
Description
Allow brandless legs in multiple brands upsell solutions.
Fallback mode for Multiple Branded Fares with Itin parity, when no itin parity solutions found.
Example
LegParity @enum {string}
OptionalMultipleBrandedFares?: boolean
Description
Return multiple brand options per itin.
Example
true
OptionalParityMode?: "Leg"|"Itin"
Description
Multiple Branded Fares parity mode.
Example
Leg @enum {string}
OptionalParityModeForLowest?: "None"|"Leg"|"Itin"
Description
If set, given parity mode will be forced on the cheapest branded fare solution. If not specified, no parity (None) is forced on the cheapest branded fare solution. It's designed to work with MultipleBrandedFares feature only.
Example
Leg @enum {string}
OptionalSingleBrandedFare?: boolean
Description
Return single brand option per itin.
Example
true
OptionalUpsellLimit?: number
Description
Indicates maximum number of requested branded upsells.
Allows you to exclude non-branded fares in the shopping response. When the PreferLevel is set to Preferred," this means Use non-branded fares. If this is single filter (no other preferred elements), the meaning is CUse ONLY non-branded fares. If other preferred filters are also used, the meaning is Use non-branded fares or fares with given (in filters) brands. When the PreferLevel is set to Unacceptable," this means Do not use non-branded fares. If this is single filter (no other unacceptable elements), the meaning is Use ONLY branded fares skip all non-branded. If other unacceptable filters are also used, the meaning is Use only branded fares excluding fares matching given (in filters) brands.
Set to "true" guarantees that all segments within single shopping option belong to the requested cabin. When KeepSameCabin Enabled = "true" is used in conjunction with JumpCabinLogic Disabled ="true", KeepSameCabin overrides JumpCabin parameter.
Allows you to exclude non-branded fares in the shopping response. When the PreferLevel is set to Preferred," this means Use non-branded fares. If this is single filter (no other preferred elements), the meaning is Use ONLY non-branded fares. If other preferred filters are also used, the meaning is Use non-branded fares or fares with given (in filters) brands. When the PreferLevel is set to Unacceptable," this means Do not use non-branded fares. If this is single filter (no other unacceptable elements), the meaning is Use ONLY branded fares skip all non-branded. If other unacceptable filters are also used, the meaning is Use only branded fares excluding fares matching given (in filters) brands.
If set to true, fares that have a min/max stay can be included in the responses. If set to false, then no fares that include a min/max stay requirement will be included in the response. This is negation of XS qualifier.
If set to true then returned fares need to match AcccountCode/CorpID specified in Fare Group definition on all fare components.
Ind: boolean
Description
If set to true then returned fares need to match AcccountCode/CorpID specified in Fare Group definition on all fare components. Applicable only if account code or corporate id provided in the request.
If set to true, fares that have a refund penalty can be included in the responses. If set to false, then no fares that include a refund penalty requirement will be included in the response. This is negation of XP qualifier.
If set to true, fares that have a reservation/ticketing can be included in the responses. If set to false, then no fares that include reservation/ticketing requirement will be included in the response. This is negation of XA qualifier.
Identifies whether penalties associated with voluntary changes should be included in the search results.
OptionalMatch?: "All"|"Any"|"Info"
Description
Indicates relation between conditions. Match="All" Indicates that all penalty conditions must be match by returned fare. Match="Any" Indicates that at least one penalty must by match by returned fare. Match="Info" Indicates that penalty information must be returned in the response.
Change minimum and maximum connect time per connection in long connection schedules, specify number or percentage of requested solutions if Long Connect Time logic is enabled. Time values should be less than 1440 minutes (24 hours). If percentage is specified, % symbol should be added after the number, otherwise exact number of solutions should be provided.
OptionalEnable?: boolean
Description
Enable long connection schedules.
Example
true
OptionalMax?: number
Format: int16
Description
Maximum connect time in minutes per connection in long connection schedules, default is 1439.
Example
1200
OptionalMin?: number
Format: int16
Description
Minimum connect time in minutes per connection in long connection schedules, default is 780.
Example
780
OptionalNumberOfSolutions?: string
Description
Specify the desired number of solutions to be returned in the response either in percentage or a number.
Frequent Flyer status information. NDC Applicable.
OptionalMaxNumberOfUpsells?: {Value:number}
Description
Allows you to display additional upsells for the journeys. The system cannot request upsells explicitly; the system can only do something with them if provided by the carrier. By default, the system does a low fare search, so only the lowest fare is presented. With this element, you can tell the system if the carrier returns upsells, return them as additional fares, but no more than X.
Value: number
Format: int16
Description
Indicates maximum number of NDC upsells per itinerary.
Example
1
OptionalMultipleBrandedFares?: {Value:boolean}
Description
Indicates whether NDC upsells are allowed.
Value: boolean
Description
Indicates whether NDC upsells are allowed.
Example
true
OptionalParityMode?: {Mode:"Leg"|"Itin"}
Description
Parity mode for the PriceClasses.
Mode: "Leg"|"Itin"
Description
Parity mode for the PriceClasses.
Example
Leg @enum {string}
OptionalQualifier?: {Name:string;Value:string}[]
Description
General qualifiers.
OptionalShowOneWays?: {Value:boolean}
Description
Show One Ways indicator.
Value: boolean
Description
For carriers supporting Brand Based Shopping (returning two lists of one ways instead of round trip) display the one ways (do not combine those into round trips).
Example
true
OptionalSingleBrandedFare?: {Value:boolean}
Description
Indicator for whether price class information is displayed.
Value: boolean
Description
Indicates whether price class information is displayed.
For carriers supporting Brand Based Shopping (returning two lists of one ways instead of round trip) display the one ways (do not combine those into round trips).
If set to true, only one Retailer Rule Code can be specified in the request. Only fares with a matched Business Rule containing the specified Retailer Rule Qualifier will be returned.
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.
OptionalAdjusted?: boolean
Description
When set to "true" selling fare level amount and total adjusted fare amount will be returned.To use this attribute AGYRET EPR keyword is required.
Example
true
OptionalOriginal?: boolean
Description
When set to "true", original fare amount will be returned in total fare amount, and additional MarkUp information will be returned in "SellingFareData" element. To use this attribute ORGFQD EPR keyword is required.
When set to "true" selling fare level amount and total adjusted fare amount will be returned.To use this attribute AGYRET EPR keyword is required.
Example
true
OptionalOriginal?: boolean
Description
When set to "true", original fare amount will be returned in total fare amount, and additional MarkUp information will be returned in "SellingFareData" element. To use this attribute ORGFQD EPR keyword is required.
Type of trip. Value="OneWay" One-way trip. Value="Return" (default) Round-trip. Value="Circle" Circle trip. Value="OpenJaw" Open jaw trip. Value="Other" Complex trip.
Presence of any of ["Carrier", "Country"] make ["IETValidation","SettlementValidation"] required.
OptionalCarrier?: {Code:string}[]
Description
Carrier code information.
OptionalCountry?: {Code:string}[]
Description
Country code information.
IETValidation: {Ind:boolean}
Description
IETValidation allows you to disable Electronic Ticketing agreements validation or specify in which points of sale and for which carriers Electronic Ticketing agreements should be checked. If set to "true," the IET agreement will be validated for the listed countries.
Ind: boolean
Description
Set to "false" disables interline electronic ticket (IET) agreement validation for validating carriers. Set to "true" along with SettlementValidation set to "false" and at least one Country Code specified will trigger the responses with no settlement validation performed on Validating Carriers returned but with IET validation performed in the specified countries. Set to "true" along with SettlementValidation set to "true" will trigger the response with settlement validation and IET check performed in specified country.
Example
true
SettlementValidation: {Ind:boolean}
Description
The SettlementValidation parameter allows you to override the local settlement plan check. Note When SettlementValidation/@Ind is set to false, it disables the settlement method validation in the local point of sale. When SettlementValidation/@Ind is set to true, it validates the settlement method in the local POS. If specified along with Carrier Code, the settlement validation will be disabled.
Ind: boolean
Description
Set to "false" disables settlement method validation for local Point Of Sale. Set to "true" enables settlement method validation for specified country code.
Set to "false" disables interline electronic ticket (IET) agreement validation for validating carriers. Set to "true" along with SettlementValidation set to "false" and at least one Country Code specified will trigger the responses with no settlement validation performed on Validating Carriers returned but with IET validation performed in the specified countries. Set to "true" along with SettlementValidation set to "true" will trigger the response with settlement validation and IET check performed in specified country.
Set to "false" disables settlement method validation for local Point Of Sale. Set to "true" enables settlement method validation for specified country code.
Indicator for whether to return only fares with a passenger type the same as the passenger type specified in the request. Value="true" Returns only fares with a passenger type the same as the passenger type specified in the request. Value="false" (default) Uses standard Bargain Finder Max logic.
If set to 'true', indicates mandatory Offer Items which cannot be removed from the Offer. Mandatory Offer Items transition into Order Items. If not present or 'false', the Offer item is optional.
Indicator for whether to return the content of ATPCO Routehappy Universal Product Attributes in the response. Note: Universal Product Attributes (UPAs) provide targeted messaging and visual content that showcases airline products and services, for example, media, photos, videos, graphics, and captions.
Indicator for whether to return the content of ATPCO Routehappy Universal Ticket Attributes in the response. Note: Universal Ticket Attributes (UTAs) provide standardized, easy to integrate fare benefits and restrictions and can be composed of refundability, changes, baggage, carry-on allowance, seat selection, and priority boarding attributes.
If set to 'true', indicates mandatory Offer Items which cannot be removed from the Offer. Mandatory Offer Items transition into Order Items. If not present or 'false', the Offer item is optional.
Indicator for whether to return the content of ATPCO Routehappy Universal Product Attributes in the response. Note: Universal Product Attributes (UPAs) provide targeted messaging and visual content that showcases airline products and services, for example, media, photos, videos, graphics, and captions.
Indicator for whether to return the content of ATPCO Routehappy Universal Ticket Attributes in the response. Note: Universal Ticket Attributes (UTAs) provide standardized, easy to integrate fare benefits and restrictions and can be composed of refundability, changes, baggage, carry-on allowance, seat selection, and priority boarding attributes.
Indicator for whether the fare is changeable or non-changeable.
Example
true
OptionalconditionsApply?: boolean
Description
If present, the fare is Refundable/Changeable in general, but there are some restrictions to this general rule. Check the fare rule details for conditions.
Example
true
Optionalcurrency?: string
Description
Penalty Charge Currency.
Example
USD
Optionalrefundable?: boolean
Description
Indicator for whether the fare is refundable or non-refundable.
Example
true
Optionaltype?: string
Description
Fare yype information.
Example
Refund
Photo: {ref:number}
ref: number
Description
Reference to universal product attribute photo item from the photo list.
Inform that minimum one of the legs included in the itinerary option contain brand(s). "Revalidated" (optional). Indicator to identify the fare for the revalidated itinerary. if set to "true" this means the itinerary has been repriced in WPNI verification flow.
Standards baggage hints for a specific passenger type.
OptionaldivideByParty?: boolean
Description
Divide party T/F indicates if different passenger types are booked in different inventories.
Example
true
OptionaleTicketable?: boolean
Description
If true, this fare type can be used with an eTicket.
Example
true
OptionalgoverningCarriers?: string
Description
The names of the governing carriers for the fare.
Example
OSLH
OptionallastTicketDate?: string
Description
Last date to ticket. Specifies deadline date to purchase the ticket for this fare.
Example
2020-10-12
OptionallastTicketTime?: string
Description
Last time to ticket. specifies deadline time to purchase the ticket for this fare.
Example
20:19
OptionalmandatoryInd?: boolean
Description
Mandatory indicator at the Fare level. Applicable for ATPCO and NDC content. If set to "true" indicates mandatory Offer Items that can't be removed from the Offer. Mandatory Offer Items transition into Order Items. If not present or "false", the Offer item is optional.
Example
true
OptionalofferItemId?: string
Description
Unique identifier for this Offer item instance. Offer item is a priceable chunk of services.
Reissue Indicator. If true, the item can be reissued.
Example
true
OptionalreissueText?: string
Description
Detailed text on the ticket reissue.
Example
ABCD
OptionalserviceId?: string
Description
Uniquely Identifies a Service within the context of one message. A service is a feature/service included in a given flight. NDC Service Id.
Example
do3385fr4jsvz1el50-2-1-1
OptionalsimultaneousReservation?: boolean
Description
Simultaneous reservation flag indicates if the fare requires simultaneous reservations/ticketing.
Example
true
OptionalspanishFamilyDiscount?: string
Description
Spanish Discount indicator with values of A, B, C where A indicates Spanish Large Family discount only. B indicates Spanish Large Family discount + Spanish Islander discount. C indicates Spanish Islander discount only.
Air Extras total summary amount (currency for AirExtras is in Currency).
Example
1
OptionalbaseFareAmount?: number
Description
Base fare amount.
Example
1250
OptionalbaseFareCurrency?: string
Description
Base fare currency code.
Example
EUR
OptionalbookingFeeAmount?: number
Description
Booking fee. Returned only if non-zero value.
Example
1
OptionalconstructionAmount?: number
Description
Construction total amount.
Example
1725.34
OptionalconstructionCurrency?: string
Description
Construction currency code.
Example
NUC
OptionalcreditCardFeeAmount?: number
Description
Credit card fee. Returned only if non-zero value.
Example
1
currency: string
Description
Tax currency code.
Example
EUR
OptionaleffectivePriceDeviation?: number
Description
Effective Price Deviation.
Example
1
OptionalequivalentAmount?: number
Description
Equivalent (including taxes etc.) amount.
Example
1250
OptionalequivalentCurrency?: string
Description
Equivalent currency code.
Example
EUR
OptionalserviceFeeAmount?: number
Description
Service Fee Amount.
Example
1
OptionalserviceFeeTax?: number
Description
Service Fee Tax.
Example
1
totalPrice: number
Description
Total price for all passenger types.
Example
1806.62
OptionaltotalPriceWithAirExtras?: number
Description
Total price with Air Extras (currency for TotalPriceWithAirExtras is in Currency).
Example
1
totalTaxAmount: number
Description
Total taxes.
Example
1
OptionaltotalTtypeObFee?: number
Description
Total T-type OB Fee for all passenger types.
Example
1
OptionalvalidatingCarrierCode?: string
Description
Validating Carrier Code.The unique code used to identify the validating carrier of the journey.
Example
UA
OptionalvalidatingCarriers?: {ref:number}[]
Description
Validating Carrier information.
Optionalvita?: boolean
Description
Validate Interline Ticketing Agreement - indicates whether the itin has VITA indicator or not. If true, the itinerary has a Validate Interline Ticketing Agreement (VITA).
Example
true
OptionalflexibleFare?: number
Description
If the fare is an additional flexible fare, this is the fare group ID.
Indicator for whether to return the content of ATPCO Routehappy Universal Product Attributes in the response. Note: Universal Product Attributes (UPAs) provide targeted messaging and visual content that showcases airline products and services, for example, media, photos, videos, graphics, and captions.
Indicator for whether to return the content of ATPCO Routehappy Universal Ticket Attributes in the response. Note: Universal Ticket Attributes (UTAs) provide standardized, easy to integrate fare benefits and restrictions and can be composed of refundability, changes, baggage, carry-on allowance, seat selection, and priority boarding attributes.
Inform that minimum one of the legs included in the itinerary option contain brand(s). "Revalidated" (optional). Indicator to identify the fare for the revalidated itinerary. if set to "true" this means the itinerary has been repriced in WPNI verification flow.
Standards baggage hints for a specific passenger type.
OptionaldivideByParty?: boolean
Description
Divide party T/F indicates if different passenger types are booked in different inventories.
Example
true
OptionaleTicketable?: boolean
Description
If true, this fare type can be used with an eTicket.
Example
true
OptionalgoverningCarriers?: string
Description
The names of the governing carriers for the fare.
Example
OSLH
OptionallastTicketDate?: string
Description
Last date to ticket. Specifies deadline date to purchase the ticket for this fare.
Example
2020-10-12
OptionallastTicketTime?: string
Description
Last time to ticket. specifies deadline time to purchase the ticket for this fare.
Example
20:19
OptionalmandatoryInd?: boolean
Description
Mandatory indicator at the Fare level. Applicable for ATPCO and NDC content. If set to "true" indicates mandatory Offer Items that can't be removed from the Offer. Mandatory Offer Items transition into Order Items. If not present or "false", the Offer item is optional.
Example
true
OptionalofferItemId?: string
Description
Unique identifier for this Offer item instance. Offer item is a priceable chunk of services.
Reissue Indicator. If true, the item can be reissued.
Example
true
OptionalreissueText?: string
Description
Detailed text on the ticket reissue.
Example
ABCD
OptionalserviceId?: string
Description
Uniquely Identifies a Service within the context of one message. A service is a feature/service included in a given flight. NDC Service Id.
Example
do3385fr4jsvz1el50-2-1-1
OptionalsimultaneousReservation?: boolean
Description
Simultaneous reservation flag indicates if the fare requires simultaneous reservations/ticketing.
Example
true
OptionalspanishFamilyDiscount?: string
Description
Spanish Discount indicator with values of A, B, C where A indicates Spanish Large Family discount only. B indicates Spanish Large Family discount + Spanish Islander discount. C indicates Spanish Islander discount only.
Air Extras total summary amount (currency for AirExtras is in Currency).
Example
1
OptionalbaseFareAmount?: number
Description
Base fare amount.
Example
1250
OptionalbaseFareCurrency?: string
Description
Base fare currency code.
Example
EUR
OptionalbookingFeeAmount?: number
Description
Booking fee. Returned only if non-zero value.
Example
1
OptionalconstructionAmount?: number
Description
Construction total amount.
Example
1725.34
OptionalconstructionCurrency?: string
Description
Construction currency code.
Example
NUC
OptionalcreditCardFeeAmount?: number
Description
Credit card fee. Returned only if non-zero value.
Example
1
currency: string
Description
Tax currency code.
Example
EUR
OptionaleffectivePriceDeviation?: number
Description
Effective Price Deviation.
Example
1
OptionalequivalentAmount?: number
Description
Equivalent (including taxes etc.) amount.
Example
1250
OptionalequivalentCurrency?: string
Description
Equivalent currency code.
Example
EUR
OptionalserviceFeeAmount?: number
Description
Service Fee Amount.
Example
1
OptionalserviceFeeTax?: number
Description
Service Fee Tax.
Example
1
totalPrice: number
Description
Total price for all passenger types.
Example
1806.62
OptionaltotalPriceWithAirExtras?: number
Description
Total price with Air Extras (currency for TotalPriceWithAirExtras is in Currency).
Example
1
totalTaxAmount: number
Description
Total taxes.
Example
1
OptionaltotalTtypeObFee?: number
Description
Total T-type OB Fee for all passenger types.
Example
1
OptionalvalidatingCarrierCode?: string
Description
Validating Carrier Code.The unique code used to identify the validating carrier of the journey.
Example
UA
OptionalvalidatingCarriers?: {ref:number}[]
Description
Validating Carrier information.
Optionalvita?: boolean
Description
Validate Interline Ticketing Agreement - indicates whether the itin has VITA indicator or not. If true, the itinerary has a Validate Interline Ticketing Agreement (VITA).
Example
true
OptionalflexibleFare?: number
Description
If the fare is an additional flexible fare, this is the fare group ID.
Description of universal ticketing attribute item.
Optionalapplication?: string
Description
Indicates if the service is free (F), not offered (N), chargeable (C), or displayed but not offered (D).
Example
F
assessment: string
Description
Indicate an assessment for a UTA Category. Assessment may contain the values: benefit, fee, restriction, or neutral. Not being returned by baggage processing. Returned for penalties only if CAT31/33 information is not found.
Example
ABC1
categoryId: string
Description
UTA Category type. The current UTA Categories are Advance Change, Boarding Priority, Cancellation, Carry-on Allowance, Checked Bag Allowance, Check-in Priority, Lounge Access, Same-Day Change, Seat Selection, and Upgrade Eligibility.
Example
Cancellation
OptionalcommercialName?: string
Description
Textual description of the service within the brand. Returned for penalties only if CAT31/33 inforamtion is not found.
Example
ABC1
descriptions: string
Description
Full-text description of the feature. Contain more extensive text that details the content to the flight shopper. Example: "2 free checked bags per passenger". *NOTE: Headline, Description, SmallIconUrl, and LargeIconUrl values are Base64 coded(this is due to the complexity and multiple special characters used across the available languages translations).
Example
ABC1
OptionalgroupCode?: string
Description
UTA Group code. The service group type. Example: BG - Baggage, GT - Ground Transportation, LG - Lounge Access, SA - Pre-reserved seat assignments, TS - Travel Services, UP - Upgrades.
Example
BG
headline: string
Description
Short text describing the feature. Example: "2 free" *NOTE: Headline, Description, SmallIconUrl, and LargeIconUrl values are Base64 coded(this is due to the complexity and multiple special characters used across the available languages translations).
Example
2free
id: number
Description
Reference Id.
Example
1
largeIconUrl: string
Description
The URL provides the small icon (84 x 84 pixels) applicable for the UTA Category. Icons are generic and included in each UTA as a pointer URL. Users can choose whether to utilize them for display. *NOTE: Headline, Description, SmallIconUrl, and LargeIconUrl values are Base64 coded(this is due to the complexity and multiple special characters used across the available languages translations).
Example
ABC1
smallIconUrl: string
Description
The URL provides the small icon (42 x 42 pixels) applicable for the UTA Category. Icons are generic and included in each UTA as a pointer URL. Users can choose whether to utilize them for display. *NOTE: Headline, Description, SmallIconUrl, and LargeIconUrl values are Base64 coded(this is due to the complexity and multiple special characters used across the available languages translations).
Example
ABC1
OptionalsubCode?: string
Description
Three-character alphanumeric code, an industry sub-code, or a carrier-defined sub-code. List of standard ATPCO subcodes examples: 0CC, 0CD, 0CE, 0CF, 0CG, 0CH, 0CI, 0CJ, 0CK, 0EN.
Example
0CD
UPA: {ref:number}
ref: number
Description
Reference to universal product attribute item from the list.
Example
1
UPACategoryDescType: {id:number;name:string}
Description
Description of universal product attribute category.
Indicates the country for which SettlementMethod and IET validation were checked. "Country" appears in response only if in request both, SettlementValidation Indand IETValidation Ind are set to "true".
Description
Baggage Allowance ID number.
Example