V2User's Guide
|
V2 User's Guide |
The PricePNRWithLowestFare function provided in the Fare interface displays the lowest possible fare for the booked itinerary, even if it is not available (no availability in the class for which this fare is applicable).
This Fare function is used to perform an informative Best Pricing request on an itinerary, without any PNR (Passenger Name Record).
The LowFareSearch function also known as Value Pricer, is an Amadeus host-based product that searches for available low fares. You can use Value Pricer entries with or without an active PNR. The system returns up to four recommendations, which you can choose from to either create a new booking, or rebook an existing one. Value Pricer processes multi passenger types, and guarantees your seat at booking time. Value Pricer supports domestic and international sectors, interline routings, and one-way, return, circle, and open-jaw trips.
This function is used to display fare notes after Fare Display or after Pricing transactions.
The InformativePricingWithoutPNR function provided in the PoweredFare interface allows pricing an itinerary informatively, without any PNR.
The Airline Ticketing Fees standalone recalculation functionality allows the automated recalculation of the OB Fees of a TST without impacting its Fare Guarantee.
Fare_PricePNRWithBookingClass function provided in the Fares interface gives the possibility to price itineraries in a PNR.
The PricePNRWithLowerFares function provided in the Fare interface is used to display the lowest available fare for a given itinerary.
The QuoteItinary transaction quotes fares for passenger types without existing reservations (PNR). All calculations are based, like for an integrated Fare Quote function, on the data stored in the Fare Quote database.
Quote Itinerary takes into account the full functionality available with the Amadeus cryptic transaction FQP.
DisplayFaresForCityPair allows to receive a list of fares available on a given market by considering certain options.
The ConvertCurrency is a service of the Amadeus Pricing and Shopping Platform (PSP). The functionalitycorresponds to the existing cryptic transaction FQC.
The Commercial Service can be used to:
The usage of the Low Fare Search product is chargeable, for more information pertaining to the tariffs please contact your API Product Manager.
CheckRules must be sent to the fare server after a Fare Display or Pricing mother transaction
DisplayFaresForCityPair might be the first services request in a sequence with follow-up services (e.g. Fare Notes).
Not applicable
The office identification (office profile) that uses the Low Fare Search isvalidated to confirm whether is it permissible to perform this function.Go to the Chapter on Low Fare Search in this guide for more information.
The Retrieve function is used to retrieve and display an active passenger name record(PNR) or to redisplay a PNR during the current user session.
For more information please refer to the PoweredPNR User's Guide
The Low Fare Search function (a.k.a. Value Pricer) provided in the Powered Fares interfaceoffers the ability to search the Amadeus system for available low fares andthe usage of this function is charged, please contact your AmadeusAccount Manager for details.
The PricePNRWithLowestFares function provided in the Fare interface is used to display the lowest possible fare for a given itinerary.
"Lowest possible" means that availability of the different booking classes have not been taken into account when searching for the lowest price. As a result, it might not be possible to rebook the passengers of the PNR in this booking class due to insufficient availability.
The PricePNRWithLowestFares function supports the following operations:
|
The PricePNRWithLowestFares function can't process different discounts and passenger types within a PNR, if the passengers are booked in different classes. |
|
You cannot perform PricePNRWithLowestFares pricing by passenger. If you need to passenger-select to enter discounts, select all passengers. |
|
You may perform PricePNRWithLowestFares on a PNR containing married segments only if the airline allows married segments to be rebooked or cancelled. |
|
Open or passive flight segments are not permitted. |
|
For selected markets, carrier-specific fares will take precedence over fares offered after a PricePNRWithLowerFares entry, when the amounts of the fares are equal. |
|
You cannot apply best buy for an unaccompanied minor, where you have used the um sell command to reserve seats. |
|
You cannot apply best buy for a stretcher passenger, where you have used the st sell command to reserve seats. |
|
You cannot price a non-homogeneous PNR, for instance a PNR where the number of passengers in the PNR is different from the number of seats booked in on of the flight segment of the itinerary |
|
A round or circle trip can contain: no more than twelve flight segments or ten flight segments and two surface segments a maximum of eight fare-break points. A one-way trip can contain: no more than eleven flight segments or nine flight segments and two surface segments. |
Operations that are not supported are:
A PNR should be retrieved to perform the pricing transaction.
Chapter 5 will explain how to build a query
The current PNR is not modified by this operation. The reply is fully structured, i.e. no full-screen text will be returned.
| Message | Description |
| CM00011 - Unable to process | Internal process error |
| CM00005 - Check segment number | A segment with the TATTOO number specified in the paxSegReference is not present in the PNR |
| CM00258 - Function not supported | The functionality requested is not available |
| CM00477 - Invalid format | The data specified in the request is not valid, although the message is correctly defined |
|
|
Examples: Corporate number length is not six digits (overrideInformation/attributeDetails/attributeDescription) |
| CM01908 - Check passenger number | A passenger with the TATTOO number specified in the paxSegReference group is not present in the PNR |
| CM01959 - Need PNR | No PNR exists in the context |
| CM02032 - Invalid corporate code | The number of corporate codes specified in the overrideInformation group is greater than allowed (1corp code) |
| CM02230 - Single selection code only | Different passenger types are specified in the same paxSegReference group. |
| CM03504 - Combination not allowed | The combination of options entered is not permitted |
| CM04701 - Exceeds maximum fare disc codes | More than three cumulative discounts codes are specified |
| CM04725 - Invalid passenger association | Passengers selected in referenceQualifier are not selected in the global paxSegReference. |
| CM04070 - Unable to process + seg name | Process error, usually unrelated to the data in the request. The name of the program where the error occurred is appended to the end of the message. |
| CM06392 - Invalid repetitive option | The same option has been specified twice (or more) for options that are allowed only once. |
| CM09053 - Invalid record locator | The rec locator specified in the pnrLocatorData group does not match the retrieved PNR. |
| CM13301 - Invalid point of sale | The city qualifier in the cityOverride does not correspond to a point of tkt |
| CM12400 - Invalid DIAG format | Empty or blank string specified in DIAG option "attributeDescription" field of overrideInformation ("override information"). |
| CM07785 - Check TRAP format | Empty or blank string specified in TRAP option in "attributeDescription" field of overrideInformation ("override information"). |
| CM02011 - ENTRY NOT AUTHORISED | The request that has been entered is not permitted. This may depend on the office id settings. |
| CM04843 - INF DISCOUNT/SELECTION NOT VALID FOR THIS TRANSACTION |
This option is not valid for Best pricer entries |
| CM1966 - NEED ITINERARY |
This error is returned when no itinerary is present in the PNR |
Specific fees may be added in the query. Fee codes are defined by ATPCO.
The fee amount is applicable for form of payment Fee codes only.
This amount is provided without any decimals.
This example shows a booking code list option.
The following example shows the booking list A,B,C for segment withTattoo number 1 and D,E,F for segment with Tatoo number 2. The list of booking codes cannot exceed 15 per segment
See "Error Messages" section.
This example shows a requesting booking date override. If you do not enter a specific date, the system uses the fare from the current date by default.
See "Error Messages" section.
This example shows a Breakpoint.
See "Error Messages" section.
This example shows a prohibit breakpoint.
See "Error Messages" section.
This example shows a pricing by cabin classes F, C and Y. There is no priority in the query.
| F | FIRST |
| C | CLUB (BUSINESS) |
| Y | ECONOMY |
See "Error Messages" section.
In this example the "+" means any other cabin.
For this example the priority will be given:
See "Error Messages" section.
This example shows a pricing by cabin class, request with the following priority:
See "Error Messages" section.
This option allows overriding the controlling carrier.
Here the parameters:
This example shows requirements No Advance Purchase, No Minimum Stay and penalty limited to 5%.
It is possible to perform the operation fare selection, equivalent to the /R,FS-USD
The exemption of all fees is requested. If you add some fees in the query, these fees won't be exempted.
Airline Ticketing Fees (OB Fees) are calculated for a given Form Of Payment (FOP). If no FOP is specified in the query, the PNR FOP(FP element) will be used by default.
The forms of payment types, associated amounts and bin number in case of credit card are kept in context and reused for consistency checks at issuance time.
Credit Card bin number: this information is optional. However, it is mandatory if the Form of Payment Type is
a credit card. It is composed of the first 6 bin numbers of the credit card.
Form of Payment Amount: This amount is provided without any decimals. This amount is optional. Additionally, there are other constraints:
• For one occurrence of Form Of Payment in query, there are 0 to 1 of them with an amount associated;
• For two occurrences of Form Of Payment in query, there are 1 to 2 of them with an amount associated;
• For three occurrences of Form Of Payment entered as an option in any Pricing query there are 2 (but neither 0, 1 nor 3) of them with an amount associated.
Form of Payment Currency: no currency can be provided in query. The currency is by default the one the Point Of Sale.
Global indicators are allowed.
When a Best Pricer is requested on a PNR with more than one passenger there are situations where the best pricer requires to books passengers in different booking codes.
This option forces not to split the PNR.
This example processes only the lowest available.
See "Error Messages" section.
This example shows a pricing on a past date, 12 May 2004.
See "Error Messages" section.
It is possible to override the point of sale
This is the option without any options.
This option allows to price only the adults in the PNR.
It is possible to select the segments you want to price in a PNR.
Specific fees can be exempted.
This example shows a stopover for segment 2.
See "Error Messages" section.
This example shows all added taxes by country code (AA).
See "Error Messages" section.
This example shows exempt tax type EE.
In the field taxIdenfier you are supposed to choose the code-set EXM, i.e exempt tax. You can specify a tax. If you don’t specify it, all taxes will be exempted.
See "Error Messages" section.
This example shows all taxes withheld by country code.
See "Error Messages" section.
In this example the amount of a tax is added.
In the field taxIdenfier you have to choose the codeset ADT, i.e Add country tax.
In the field taxValueQualifier two code-sets are available: A (Amount) and P (percentage).
See "Error Messages" section.
In the field taxIdenfier you have to choose the codeset ADT, i.e Add country tax.
In the field
taxValueQualifier it is possible to specify P, i.e. percentage.
See "Error Messages" section.
This example shows tax withheld.
See "Error Messages" section.
Tier level override is allowed at segment and passenger level.
This example shows a transfer.
See "Error Messages" section.
This example shows a turnaround point.
See "Error Messages" section.
Pricing by unifare is allowed.
See "Error Messages" section.
Pricing by unifare with corporate code is allowed.
See "Error Messages" section.
This option allows both MIT and MBT.
See "Error Messages" section.
This example shows validating carrier, airline code CO.
Airline Ticketing Fees (OB Fees) are calculated for given Validating Carrier.If no Validating Carrier option is specified in Query, the validating carrier specified in PNR (FV element) will be used by default.The Validating Carrier used at pricing time for OB Fees are kept in context and reused for consistency checks during ticket issuance.
See "Error Messages" section.
If you specify WQ in the field attributeType, you can withhold q surcharges.
This example shows the zapp off option.In order to avoid ambiguities, the REF segment is filled.
See "Error Messages" section.
The InformativeBestPricingWithoutPNR function provided in the Fare interface is used to perform informatively a Best Pricing request on an itinerary, without any PNR context. No pricing record (TST) is created to store the results.
The InformativeBestPricingWithoutPNR function returns the best fare (or list of best fares) for the itinerary and passengers provided in the request.
The rules applicable for a standard Best Pricing operation based on a PNR (Fare_PricePNRWithLowerFares) are also applicable here.
The following list of options is supported. Each one of these options can be applied either alone, or combined with other ones.
Itinerary data must be provided in the request:
If the optional data is not present in the request, the process will automatically call the availability server in order to retrieve the missing information.
If all the optional data is present in the pricing request, no check is performed on this information (the availability server is not called). Thus the consistency and integrity of this data falls under the customer's responsibility.
By default we assume that the class indicated in the pricing request is available. It this is not the case, the service may return an insufficient availability warning. This happens if the cheapest recommendation is for the booking class provided in the query and this booking class is not available.
The customer may specify whether or not he receives information about the availability for the class specified in the query, using the option Check on the original class availability.
If the value of this option is VOA, no assumption on the availability is made and the recommendation returned is always the lowest available.
If the value is NVO, we assume that the class indicated in the pricing request is available, without any check.
For further details, please refer to the explanation provided in section 5.
TLA (TicketLess Access Airline) is not supported.
All the pricing options that are not explicitly specified above are not supported.
In particular the following options are not supported:
None.
Certain information is mandatory in the query (i.e. otherwise, the request will fail):
In messageDetails:
In segmentInformation group, the following data is mandatory:
It is important to specify whether or not two flights are connected. This is optional, but a pricing can be different if this information is not present, e.g. for Slice and Dice process. If the flights are connected, the process may search all the possible SubO&D and these are forwarded to fare quote. So the price will be chosen among all the possible SubO&D of the itinerary. If the flights are not connected, no SubO&D is possible so the process never applies.
passengersGroup is recommended but not mandatory.
If present, the following data is mandatory:
The PSR is conditional. If no PSR is passed in the input, the default PS of the office is used for the pricing.
No PNR is created or modified by this operation. If a PNR already exists, it remains untouched and no pricing record (TST) is created to store the results. The reply is fully structured, i.e. no full-screen text will be returned.
Please note that the last ticketing date is in the field generalIndicators/ productDateTimeDetails / departureDate.
If present, Slice and Dice indicators are entered in the field segmentInformation/specialSegment. It is possible to have:
New data in the response
| Message | Description |
|---|---|
| CM00011 - Unable to process | Processing error, usually unrelated to the data in the request |
| CM00258 - Function not supported | The requested functionality is not available |
| CM00477 - Invalid format |
The data specified in the request is not valid, although the message is correctly defined. Examples: Corporate number length is not 6 digits or is not numeric, Point of sale/ticketing not a city code (3 letters), Date format 25MAY instead of 250507 |
| CM03504 - Combination not allowed | The combination of options is not permitted. |
| CM04701 - Exceeds maximum fare disc codes | More than three cumulative discount codes are specified (should never happen by design). |
| CM04070 - Unable to process + seg name | Process error, usually unrelated to the data in the request. The name of the program where the error occurred is appended to the end of the message. |
| CM06392 - Invalid repetitive option | The same option has been specified twice (or more) for options that are allowed only once. |
| CM13301 - Invalid point of sale | The city qualifier in the POS segment does not correspond to a point of sale/point of tkt codeset (normally this error should not occur). |
| CM21604 - Invalid message details. Be sure to ask for a Non-Integrated Pricing for Non-Booked Segments. | Non Integrated Pricing not selected in messageDetails segment (Action code should be 741.) |
| CM21604 - STL exception occurred. /Unexpected error occurred. | Software Internal Error. |
| CM21604 - XXXX not specified | The mandatory data XXXX was not included in the request. Examples: Booking class missing (segmentInformation), PTC missing (FAR) |
The objective of the Award Search option is to offer to the End User the capability to request for journeys priced in miles, in a context of an Award program.
The request must contain:
By default the process will load fares filed in USD currency, currency override option with a currency different than USD will skip Award solution.
The cabin option allows to search the best fare:
In this example the preferred cabins are:
The code-set FC means First Choice.
The code D in the productDetailsQualifier means: if the first choise (Y in the example) is not available, consider all cabins.
For each flight the requested cabin is the cabin that correponds to the booking code booked in the PNR, for this flight.
In this example the order of preference is:
The code-set are FC for first choice, SC for second choice, an DC default choice. The last code set DC is used when the user enters more than two choices
In this example the preferred cabin are, with the same priority, Economic (Y) and Club / Business (C).
The code-set FC means First Choice.
In the field indicators there are two possible codesets for the availability check:
• VOA: Verify Original class Availability: check on the posting level for the booking class specified in the query is forced. The lowest available is always returned.
• NVO: Not Verify Original class availability. As explained in the chapter "Limitations", no check on the posting level for the booking class specified in the query is performed. So it may return a class that is not available, if the cheapest recommendation is for the booking class provided in the query and this booking class is not available. No warning is sent.
These two code-sets are mutually exclusive.
It is not possible to combine this option with the option Display only the lowest fare.
Connected segments have the same flightTypeDetails and a different itemNumber.
Please be aware that the process Slice and Dice may apply only on connected flights. If the flights are not connected, process Slice and Dice cannot find any subO&D so the process cannot apply.
In the example the first three flights are connected.
For the first flight 1023 we have:
flightTypeDetails = 1
itemNumber = 1
For the second flight 434 we have:
flightTypeDetails = 1
itemNumber = 2
For the second flight 9422 we have:
flightTypeDetails = 1
itemNumber = 3
This option allows to override the controlling carrier. In the example below AF (Air France) represents the identifier of the companyNumberDetails (in the pricingOptionGroup).
See "Error Messages" section.
Currency override is allowed
The corporation Code provided will be included in the query sent to availability to retrieve availability per class.
This option allows the selection of fares eligible to electronic ticketing or paper ticketing.
This option is used to transmit Form of Payment (FOP) information at global request level.
This option is used to transmit Form of Payment (FOP) information at passenger level.
Global indicators (RW, CT) are allowed
It is mandatory to associate an infant to a passenger. In order to do that they must have the same passenger ID and the infant must have the flag 766.
Please notice that a passenger may have associated only one infant.
This kind of association is very important especially for rebooking processes.
CHECK PASSENGER ASSOCIATION may be returned when the association is wrong (for example two infant with the same passenger ID).
It is possible to specify if you want to display:
The example contains the indicator L.
In the query some main information can be specified:
It is important to know that this ID must be in the whole query, even if the passengers are in different groups.
If the passengers ID is not assigned by the user, it will be assigned automatically by the system. The first passenger that compares in the query will be the 1, the second 2 and so on.
The PTC is associated to the group, so all the passenger in a group will have the same PTC.
Here the mapping of the information:
The ID of the group is in the field :pricingGroupLevelGroup - numberOfPax - segmentControlDetails - quantity
The number of passenger is in the field: pricingGroupLevelGroup - numberOfPax - segmentControlDetails - numberOfUnits
The ID of passenger is in the field: pricingGroupLevelGroup - passengersID - travellerDetails - measurementValue
See "Error Messages" section.
This option can be used to request negociated fares.
This option avoids to receive non-homogeneous pricing recommendations that would require a PNR split in case of integrated pricing.
It is possible to handle fees options.
This option allows to force the PTC that has been requested in the query.
See "Error Messages" section.
The following override are allowed:
This option can be used to specify discounts to be taken into account for the pricing of the itinerary.
Discounts (either discount codes or passenger type codes) are specified by passenger category. Therefore the itinerary can be priced with multiple discounts by specifying several passenger categories.
Infant discount are not allowed.
The point of sale override is allowed (LON in the example).
It is possible to specify the PSR in input of the transaction.
This is allowed only if the office profile of the current office has TFU equal to 2 or higher.
It is possible to specify different PTC per bound.
This option allows to exempt either all applicable taxes, or all taxes of a given country, or specific taxes designated by their code.
Ticketing city override is allowed (LON in the example).
The option allows to override the tier level.
validating carrier is allowed
Zap-off option with percentage, amount and/or ticket designator
This option requests the calculation of the ZZ tax, which is a specific tax applied only when the ticketing is done via TCH.
See "Error Messages" section.
The Low Fare Search function provided in the Powered Fares interface offers the ability to search the Amadeus system for available low fares. You can use Low Fare Search entries with or without an active PNR.
Up to four recommendations are returned from which you can create a new booking and or rebook anexisting one. It supports domestic and international sectors; interline routing and one-way,return, circle and open-jaw trips. You not only have the ability to process multi-passengertypes, you are guaranteed the seat at booking time Low Fare Search supports Published fares,Negotiated fares, ATPCO, Private fares, and Interline pricing.
Generally, all best buy and pricing restrictions apply to the Low Fare Search function.
The Low Fare Search function allows for the following supported operations to customize an availability search:
The following options can be used to further customize your query andhave been grouped by common entities for readability purposes:
It is possible to use the following options to narrow down your low fare searches:
Advance purchase: Search for low fares having no advance purchase ('NAP').
Penalty information for cancellation: Search for low fares having no penalty ('NPE').
No Restriction: Search for low fares having no restrictions ('NR').
Refundable fares: Search for low fares that may be refundable ('RF').
These options must be used with a PNR
Each option used to narrow done your Low Fare Search applies either on the segment or on the entire itinerary.The following table gives the rule for each option:
| ?????‚?‚? | Applying to |
|---|
| Options | Segment | Itinerary |
|---|---|---|
| Process Airline | X | X |
| Process Time (1) | X | ?????‚?‚? |
| Process Time Window (1) | X | X |
| Process Default Time Window (1) | X | X |
| Process Flight Category | X | X |
| Process Connect point | X | ?????‚?‚? |
| Process Cabin | ?????‚?‚? | X |
| Process Pricing options (2) | ?????‚?‚? | X |
| Process Passenger Types (2) | ?????‚?‚? | X |
| Process Negotiated Fares (2) | ?????‚?‚? | X |
| Process Private Fares (2) | ?????‚?‚? | X |
| Process Price to Beat (2) | ?????‚?‚? | X |
(1) This option is strictly Low Fare Search function.
(2) These options are strictly Fare related options.
If an option applies on both requested segments and itinerary then the optiongiven at the requested segment level overrides the itinerary option.
If the option is only valid at itinerary level but the End-User has specified itat the segment level the entire entry is rejected with the following message:
"OPTION CANNOT BE APPLIED AT REQUESTED SEGMENT LEVEL"
If the option is only valid at segment level but the End-User has specified itat the itinerary level the entire entry is rejected with the following message:
"OPTION CANNOT BE APPLIED AT ITINERARY LEVEL"
There are a number of restrictions when using the Low Fare Search function, consequently,your request can contain the following fare options:
| Up to six different passenger types that are processed simultaneously. |
| Taxes |
| Ticketing date |
| Override selling/ticketing city |
| Expanded parameters |
Electronic Ticketing (ET) is not yet available in all markets or all carriers,for further details contact your local Amadeus Help Desk for more information, toensure that the Office Profile has beenmodified accordingly and the market SUPPORTS Electronic Ticketing (ET).
Examples:
| Request | Process |
|---|---|
| If no options are entered | System will propose both Electronic and Paper Ticket travel solutions |
| Request Electronic Ticket (ET) only | Electronic Ticket sent |
| Request PaperTicket (PT) only | Paper Ticket sent |
Infants must be associated to Adults when performed a low fare search,hence they travel in the same class as the adult passenger.This means also that infant codes cannot be used within searches independently a check is performed at input time to reinforce this rule.
Infants without seats must be priced in the same class as the non-infantaccompanying passenger: this accompanying passenger can be an adult (ADT),youth (YTH), Military (MIL) and so on.
The time window value varies from 1 to 24 hours. The Time Window option allowsthe End-User to specify an hour range on which the availability search applies.This option can be used in conjunction with the "Time" option.
This option consists in applying, on the different Requested Segments of the Itinerary,the Default Time Window that is specified in the Office Identification (Profile).This option can be used in conjunction with the "Time" option.
The low fare search engine does not support these options:
A security check is performed to determine if the End-User is allowed to accessthe Low Fare Search product or not. This authenticated is made in the officeidentification (office profile) that needs to have the field "LOW FARE SEARCH ALLOWED"set to YES. It should be noted that the default value for this field is NO and thatthe Travel Agents cannot update this field.
If the End-User is not allowed to access the Low Fare Search function upon thetransaction is rejected and the message "OFFICE RESTRICTED" is returned.
Depending on the flavor of the API that is used, each query will follow a givenstructure. The queries for the function operations are clearly explained with dataelement examples in a generic table view that can be adapted to the specific flavorof the API in use.
It is important to note that the examples in each chapter are only illustrationsand are meant to provide the basis for a better understanding on which fieldsare mandatory for basic operation utilisation. It is not a full explanation of everyfield that can be utilised for the operation, but rather a guideline to its use.
Currency Options:
It should be noted that when you use the Fare Selection option,the system response is "VERIFY CURRENCY OPTION".Hence, it should be noted that a warning message will be displayed"THE CONVERSION OPTION AFFECTS THE SALE CURRENCY"
It is possible to request a low fare search from a retrieved PNR and theactive PNR can be redisplayed at any time. The display of the active PNR willinclude all the associated passenger and itinerary information.
Listed here are the options that can be used tofurther customize your Low Fare Search requests:
| Display flight details |
| Display fares notes |
| Display a ticket image |
| Display a booking code |
| Combine entries |
| ?????‚?‚? |
| Book a recommendation |
| Book the selected recommendation |
| Book a recommendation, and store a TST |
| Book the selected recommendations and store a TST |
| ?????‚?‚? |
| Move to the recommendation display |
| Move to the previously selected recommendation |
The following is the minimum input requirements for aone-way trip to perform a Low Fare Search.
When requesting a Low Fare Search the system can return up tofour recommendations and itineraries, which you can choose fromto either create a new booking, or rebook an existing one.The Low Fare Search processes multi passenger types, and guaranteesyour seat at booking time. Low fare searches supports domestic andinternational sectors, interline routings, and one-way, return, circle,and open-jaw trips.
Searches can be customized with a variety of options, such as, Time, Airline,Connecting Point, Flight category and Cabin.
Fare
| Common Name | Data Element Name |
|---|---|
| Total amount for recommendation | TotalPrice |
| Passenger type | Code |
| Penalty message | Text |
| Warning message | Text |
The itinerary information includes such items as:
| Common Name | Data Element Name |
|---|---|
| Flight number | FlightNumber |
| Booking class | ClassOfService |
| Departure date | DepartureDate |
| Departure point | DeparturePoint |
| Arrival point | ArrivalPoint |
| Departure times | DepartureTime |
| Arrival times | ArrivalTime |
| Number of intermediate stops | NumberOfStops |
| Access level | LevelOfAccess |
| Aircraft type | AircraftType |
| Flight duration | EFT |
If the searches are based on flights that are already booked in aPNR - the first fare result displayed is the fare recommendationfor that particular fare, hence that is the price to beat.
The subsequent fare recommendations are in ascending order or equalfares and are applicable to all passengers and corresponding itineraries.
If a search is performed without a PNR the fare recommendations returnedare displayed in ascending order for all the passengers and correspondingitineraries.
An itinerary is a list of a passenger's travel arrangements, it can include flight information and any other information.
You can enter remarks in the PNR and select remark lines from your mini-office profile to be printed on the itinerary. The itinerary can be displayed on your terminal, printed in your office or in a remote office, faxed, or sent by e-mail. A separate itinerary can be issued for each passenger, or a single itinerary (joint) for all passengers in the PNR. The itinerary can include all segments present in the PNR or only selected segments.
If and only if, a translated version exists in the system, you can issue the itinerary in the desired language.
Some offices issue market-specific or airline-specific itineraries instead of the Amadeus default itinerary the format and information printed on those itineraries may differ. The level of information printed on the Amadeus default itinerary varies depending on the type of itinerary.
This example is of a low fare search query for all passenger and their associateditinerary information found in the currently retrieved PNR.
| Fare_LowFareSearch_Query - Data element | Value |
|---|---|
| /MessageAction/Function/ID | 183 |
Follow-up entries are used to select:
From a recommendation display, it is possible to book a recommendationdirectly from the display.Combine follow-up entries to request fare and flight details.
Once you have selected a recommendation, you can request fare details(fare notes, ticket image, booking code) and request flight details.Create a new booking (or rebook an existing one)
It should be noted that if you rebook an existing itinerary the systemautomatically cancels all obsolete segments and segment-associated elements.
The Low Fare Search function fully processes married segment controlfor carriers that support this feature, thus avoiding rejection at booking time.Therefore, when booking the recommended itinerary, Amadeus automatically uses thehighest level of access, including Direct Access Sell (if necessary).As a result, if the booking is successful, you always get real-timeconfirmation of your seat.
| ERROR MESSAGE | CODE | DESCRIPTION |
|---|---|---|
| AIRLINE CANNOT BE AT THE SAME TIME INCLUDED AND EXCLUDED | 9316 | You cannot specify the same airline code in both include and exclude airline options. |
| CANNOT SELECT OR OVERRIDE PART OF A REQUESTED SEGMENT | 9399 | You cannot partially select a requested segment. |
| CHECK COMBINATION: INVALID REPETITIVE OPTION | 6392 | The pricing option is invalid. Ensure that your entry does not contain the same option twice. |
| CHECK TIME WINDOW | 12464 | The time zones overlap. |
| CONNECT POINT INVALID AT ITINERARY LEVEL | 9375 | You can only specify the connecting point option at the segment level. |
| DATE/TIME MUST BE IN CHRONOLOGICAL ORDER | 9391 | When you specify more than one requested segment, you must put the requested dates and times in chronological order |
| EXCEEDS MAXIMUM FARE DISCOUNT CODES | 4745 | You can specify up to six different passenger type codes. |
| INF DISCOUNT/SELECTION NOT VALID FOR THIS TRANSACTION | 4843 | You cannot price infants individually; you must select them with their associated adults. |
| INPUT NOT ALLOWED WITH FDS | 3914 | You cannot combine the passenger type code and the fare discount (FD) element for the same passenger. |
| INVALID - 3 AIRLINE CODES MAXIMUM | 2598 | You can specify up to three airline codes in the include airline and exclude airline options. |
| INVALID AIRLINE CODE | 0817 | The airline code must be a two alphanumeric character code, for example BA for British Airways. To verify the code, enter DNA airline , where airline is the name of the airline company. |
| INVALID AMOUNT | 3811 | The price to beat is invalid because the amount: Is zero Is composed of more than nine digits Contains a decimal placement Contains a currency code |
| INVALID CABIN CODE | 9322 | The cabin code does not exist. Enter F for First, C for Business and Y for Economy. |
| INVALID CATEGORY OPTION | 9369 | The flight category that you specified is incorrect. Enter N for Non-stop, D for Direct, or C for Connecting. |
| INVALID CONNECT POINT OPTION | 9374 | You must specify a city or airport code after the connecting point option. |
| INVALID EXCLUDE AIRLINE OPTION | / | If you specify both the exclude airline and include airline options, you must use the YY code in the include option. You cannot specify the YY code in the exclude airline option. |
| INVALID FORMAT | 0001 | The format that you used is invalid. |
| INVALID NUMBER OF PASSENGERS | 9385 | The number of passenger specified is zero. You must specify between one and nine passengers, excluding infants. |
| INVALID PASSENGER TYPE CODE | 4213 (or 5233) | The passenger type code (PTC) that you have entered is incorrect. |
| INVALID RECOMMENDATION NUMBER | 9396 | The recommendation number in your entry must correspond to the number in the display. |
| INVALID TIME OPTION | 2526 | The option is invalid due to one of the following reasons: The /T is not followed by an A or a D. No time is specified after the /TA or /TD. The /T option is specified more than once for the same requested segment. |
| INVALID TIME WINDOW | 12462 | The time window value must be a number between 1 and 24. |
| MAXIMUM 2 REQUESTED SEGMENTS WITH SAME DATE | 9390 | No more than two requested segments can have the same date. |
| MAXIMUM 4 DIFFERENT CITIES ALLOWED | 9387 | You can specify up to four different cities. |
| NEED AIR SEGMENT (S) | 0376 | If you select informational or ARNK segments, you must also select the air segment. |
| NEED ITINERARY | 1966 | You can only use this entry if an active PNR exists. |
| NEED NAMES | 339 | The PNR does not contain any names. |
| NO ALTERNATE ITINERARY FOUND | 9404 | No other recommendations can be found. |
| NO ITINERARY FOUND FOR REQUESTED SEGMENT BOARD/OFF | 9370 | The city or airport code does not exist, or no itinerary can be found. Board/Off is the origin and destination of the segment that failed. |
| NO RECOMMENDATION FOUND WITH LOWER OR EQUAL PRICE | 9403 | The system cannot find a recommendation that is lower or equal to the price to beat. |
| NON-STOP CANNOT BE REQUESTED WITH CONNECT POINT OPTION | 9325 | Option combination not allowed for the same requested segment. |
| NOT ALLOWED FOR NON-HOMOGENEOUS PNR - USE BOOKSELECTEDFARE | 3493 | You cannot create a TST for a non-homogeneous PNR. |
| NUMBER OF NON-INFANT PTC CANNOT EXCEED NUMBER OF SEATS | 9401 | The number of passenger type codes (PTCs) that need seats (that is, excluding IN and INF) exceeds the number of seats specified. Or The number of PTCs not requiring seats (IN or INF code) exceeds the number of seats specified. Note: Only one infant can be associated to a passenger. |
| NUMBER OF PASSENGERS EXCEEDS NINE | 3388 | The number of passengers, excluding infants, must be between one and nine. |
| NUMBER OF REQUESTED SEGMENTS EXCEEDS SIX | 9386 | You can specify up to six segments, including surface sectors. |
| ONE RECOMMENDATION MUST BE SELECTED PRIOR ENTRY | 9395 | Select a recommendation |
| PARTIAL PASSENGER SELECTION NOT ALLOWED | / | You cannot partially select non-infant passengers. |
| PLEASE SELECT NEW RECOMMENDATION - UNABLE TO BOOK | 9394 | The booking has failed. |
| PNR ITINERARY PRESENT - CHECK FXC FORMAT | 10738 or 9805 | The format is invalid if a PNR exists. |
| PREVIOUS TST EXISTS / SEGMENT OVERLAP | 2058 | A TST does not contain all segments of the PNR, or the segments that you have specified do not match those in the TST. |
| RESTRICTED IN TEMPORARY TICKET MODE | 2123 | You cannot use Low Fare Search in Temporary Ticketing (TY) mode. |
| SAME CITY/AIRPORT CODE CANNOT BE INCLUDED AND EXCLUDED | 9324 | You cannot specify a city code as an exclude connecting point, and an airport associated to that city as an include connecting point. |
| SAME REQUESTED SEGMENT CANNOT BE REPEATED | 9388 | When you specify more than one segment, each origin and destination pair must be unique. |
| SEGMENT ASSOCIATED FDS ARE NOT ALLOWED - PLSE UPDATE | 9398 | You cannot perform Low Fare Search transactions on PNRs that contain segment-associated fare discount (FD) elements. |
| SPECIFY TIME AND TIME WINDOW FOR NEAR DATED REQUESTED SEGMENTS | 9389 | You can specify up to two segments (excluding surface sectors) on the same date. You must specify an arrival time and a time window for the first segment, and a departure time and a time window for the second segment. |
| SPLIT PNR - DIFFERENT BOOKING CODES REQUIRED FOR PASSENGERS | 7440 | The low fares are in different booking classes for different passenger types. Split the PNR to separate the passenger types then re-price each PNR. |
| TIME INVALID AT ITINERARY LEVEL | 9377 | You can only specify the /T option at the segment level. |
| TIME MANDATORY IF TIME WINDOW REQUESTED | 9372 | If you specify the /W option, you must also specify the /T option. |
| TRANSACTION NOT ALLOWED FOR OPEN SEGMENT | 7431 | You cannot perform Low Fare Search transactions on open segments. |
| TRANSACTION NOT ALLOWED FOR STRETCHER OR UM PSGR | 9368 | You cannot use Low Fare Search if segments have been booked using special seat requests, such as ST (stretcher), UM (unaccompanied minor). |
| TRANSACTION NOT ALLOWED ON GROUP PNR | 9397 | You cannot perform Low Fare Search transactions on group PNRs. |
| TRANSACTION NOT ALLOWED ON PASSIVE SEGMENT | / | You cannot perform Low Fare Search transactions on passive or ghost segments. |
| UNABLE LEGALLY PROHIBITED COUNTRY XX SEE GGPROHIB | 7460 | The display for the country XX is restricted. Type GGPROHIB for further information. |
| UNABLE TO FARE - NO INVENTORY FOR FLIGHT REQUESTED | 5436 | No inventory has been found for one of the flights selected. Either the flight does not exist, or it is flagged as departed. (This error may occur only when you perform a PNR-based search.) |
| UNABLE TO PRICE CURRENT PNR | 9402 | The system cannot price the PNR. For example, the fare is no longer applicable when you performed the Low Fare Search transaction. |
| UNABLE TO PRICE CURRENT PNR and NO ALTERNATE ITINERARY FOUND | 9402 or 9404 | The system is unable to price the PNR, and no other recommendations can be found. |
| LOW FARE SEARCH NOT ALLOWED FOR PAST DATE/TIME | 9392 | You cannot search for a fare for an earlier date or time. |
| CONFLICTING OPTIONS USED | 7399 | Error case when Passenger Ticket has a different pricing code than in Corporate |
Request for one adult, one youth requiring 2 seats
ADT
YTH
See the Error Messages section
Request for One Adult, One-Way, from Miami to Paris on the 1st October 2003
See the Error Messages section
One adult, return trip, Miami to Paris on 1st October, returning 10th October
See the Error Messages section
Price to beat of 700 USD
ADT
YTH
INF
See the Error Messages section
Fare in local currency, but convert prices to FRF
ADT
YTH
INF
CUC
FRF
See the Error Messages section
Exempt all taxes
ADT
YTH
INF
See the Error Messages section
Fare for the entire itinerary, only prosing non-stop flights.
N
See the Error Messages section
Fare for the entire itinerary, only propose flights with business (club) class available.
An error message will be given 'Need itinerary', if no itinerary is present before trying to process this query.
See also the Error Messages section
Fare for the entire itinerary, only prosing AF or DL Flights
See the Error Messages section
Propose the same itinerary as the PNR but, seven days earlier
For the same itinerary change the /ItineraryValues/Unit/ValueQualifier,value to DA to opt for 7 days later
See the Error Messages section
Only fares with no penalties attached are requested
ADT
YTH
INF
NPE
See the Error Messages section
Request for two adults, one youth, and an infant (travels with the first adult).Request requires 3 seats
Note: infants do not require a seat
ADT
YTH
INF
See the Error Messages section
Itinerary Level Non-Stop flights only
N
See the Error Messages section
Itinerary level preferred airlines are AF and LH
See the Error Messages section
Price two Nego Corporate Codes
RC
See the Error Messages section
Price only at Passenger Type Code (PTC) requested
ADT
YTH
INF
PTC
See the Error Messages section
PNR segment selection. For the requested segment NCE to ATL,only AF and DL flights are requested
An existing itinerary is required that corresponds to this query.
See the Error Messages section
Propose the same itinerary as the PNR, keeping exactly the same citiesas connect points
Note: It is possible to interchange the Point Value from CTYto APT (airport)
See the Error Messages section
Request for published and negotiated fares
ADT
YTH
INF
RN
RP
See the Error Messages section
PNR segment selection. Propose recommendations for the entire itinerary,however, for the requested segment matchingPNR segments 4 & 5 (NCE to ATL) only propose non-stop flights.
N
See the Error Messages section
Request partial PNR itinerary. Only propose recommendationsmatching the requested segmentdescribed by segments 4 and 5 (NCE to ATL) in the PNR
See the Error Messages section
Request Segments one adult PAX using Unifares
RU
See the Error Messages section
Requested segment level, exclude connections via London for outbound trip only
See the Error Messages section
Requested segment level, Preferred airlines on Frankfurt to Paris only
See the Error Messages section
Requested segment level, only include connections via London for outbound trip only
See the Error Messages section
The paper and electronic ticket surcharge concept is driven from fare datafiled by the airline.
Three new pricing options are available to allow the End User to link the farepriced and the type of Fare required.
| '/PT' FOR PAPER TICKET |
| '/ET' FOR ELETRONIC TICKET |
| '/EP' FOR ELECTRONIC AND PAPER TICKET |
ET RX
See the Error Messages section
Ticketing city override is NYC, selling city override is PAR
ADT
YTH
INF
See the Error Messages section
One adult, same day return trip, arriving in Paris before 10(Time Window +/- 2hours)leaving from Paris after 1800 (Time Window +/- 2 Hours)
See the Error Messages section
Price two Unifare Corporate Names
PT
RC
See the Error Messages section
Price three unifare corporate names/codes plus unifare option
RU
RW
See the Error Messages section
Request withholding Q surcharges
ADT
YTH
INF
WQ
See the Error Messages section
Request for two adults, one youth, requiring 3 seats
ADT
YTH
See the Error Messages section
The CheckRules function is a follow-up transaction that can be used after a pricing or a fare display transaction.
Based on the query it can:
The product number on its own or the product number together with the fare component number (only follow-up after pricing) are to specify in the query.
The following inputs are possible:
Not applicable
Possibility to display info-notes
Office profile security: This transaction can only be used as a subsequent after a pricing or a fare display
Data availability: Not applicable
Successful reply:
If no reject message is generated, the reply can have one of the following forms:
If rejected: an error message is sent back.
There is an example of each type of reply in the operations.
The following rejects occurs when data specified in the request is not valid, although it is compatible with the message definition.
| ERROR MESSAGE | DESCRIPTION |
|---|---|
| CHECK SEQUENCE NUMBER | selected fare component does not exist (ex: 50 fare components are returned after FQD and we ask information about the 51st) |
| VERIFY OPTION | information about a rule that does not exist are requested (In this case, the list of available rules is displayed after the error message) |
A message will have to be defined in case of inconsistent qualifiers in the itemNumber field.
If many items are set in the itemNumber field, one (and one only) has to be a farecomponent (FC qualifier).
Display categories AP and TF after an FQD request
See "Error Messages" section.
Display rule text of a specified category relevant to fare offer
See "Error Messages" section.
Display list of rule categories relevant to fare component 2 of fare offer 2
In this example, 2 elements of ITM are filled:
See "Error Messages" section.
We want to have information on the 3rd recommendation after a pricing request:
See "Error Messages" section.
Request the list of fare components that compose the first recommendation returned by FQP
See "Error Messages" section.
Request the list of available categories of the first fare
See "Error Messages" section.
The InformativePricingWithoutPNR function provided in the PoweredFare interface allows to price informatively an itinerary without any PNR. If a PNR exists, it is neither taken into account nor updated. No pricing record (TST) is created to store the results.
The InformativePricingWithoutPNR function returns the fare corresponding to the itinerary and passengers provided in entry.
The rules applicable for a standard pricing operation based on a PNR are also applicable here.
The following list of options is supported. Each one of these options can be applied either alone, or combined with other ones.
The itinerary data provided in input by the customer may be composed of all necessary elements to perform a pricing request (schedule and availability information). In that case, no call to Inventory is triggered, no check is performed on the corresponding input data, and the consistency and integrity of that data falls under the customer's responsibility.
Best buy through this function is not supported. The itinerary price is computed with the specified booking class.
All the pricing options that are not explicitly specified above are not supported.
In particular following options are not supported:
There is a bunch of information that is absolutely mandatory in the query (i.e. otherwise, the request will fail):
In messageDetails:
In segmentInformation group, following data is mandatory:
In passengersGroup group, following data is mandatory:
Note: Passengers might be grouped by PTC/FD, but it is not absolutely necessary.
No PNR is created nor modified by this operation. If a PNR already exists, it remains untouched and no pricing record (TST) is created to store the results. The reply is fully structured, i.e. no full-screen text will be returned.
| Message | Description |
|---|---|
| CM00011 - Unable to process | Process error - normally it shouldn't be related with data from the request |
| CM00258 - Function not supported | Request a functionality not yet implemented |
| CM00477 - Invalid format | Data specified in the request is not valid, although is OK from the message definition Examples: Corporate number length is not 6 digits or is not digit, Point of sale/ticketing not a city code (3 letters), Date format 25MAY used instead of 250507 |
| CM03504 - Combination not allowed | A not valid combination of options in the pricing query. |
| CM04701 - Exceeds maximum fare disc codes | More than three cumulative discount codes specified (should never happen by design). |
| CM04070 - Unable to process + seg name | Process error - normally it shouldn't be related with data from the request - the name of the program where error occurred is appended at the end of the message. |
| CM06392 - Invalid repetitive option | The same option has been specified twice(or more) for options that are allowed only once. |
| CM13301 - Invalid point of sale | The city qualifier in the POS segment does not correspond to a point of sale/point of tkt codeset (normally this error should not occur). |
| CM21604 - Invalid message details. Be sure to ask for a Non-Integrated Pricing for Non-Booked Segments. | Non Integrated Pricing not selected in messageDetails segment (Action code should be 741.) |
| CM21604 - STL exception occurred. /Unexpected error occurred. | Software Internal Error. |
| CM21604 - XXXX not specified | The mandatory data XXXX has not been specified in the request. Examples: Booking class missing (segmentInformation), PTC missing (FAR) |
The objective of the Award Search option is to offer to the End User the capability to request for journeys priced in miles, in a context of an Award program.
The request must contain:
By default the process will load fares filed in USD currency, currency override option with a currency different than USD will skip Award solution.
See "Error Messages" section.
This option allows the selection of fares eligible to electronic ticketing or paper ticketing.
This option allows the pricing of the provided itinerary using a specific fare basis. The fare basis can be specified at flight level.
It is recommended to associated an infant to a passenger. In order to do that they must have the same passenger ID and the infant must have the flag 766.
Please that a passenger may have associated only one infant.
See "Error Messages" section.
This option can be used to specify discounts to be taken into account for the pricing of the itinerary.
Discounts (either discount codes or passenger type codes) are specified by passenger category. Therefore the itinerary can be priced with multiple discounts by specifying several passenger categories.
Cumulative discounts can also be specified in the request (eg. request a child discount on a military fare).
This option can be used to request negociated fares.
The example below corresponds to a pricing request for a single segment trip from Nice to London for two adults and one child.
This option allows to exempt either all applicable taxes, or all taxes of a given country, or specific taxes designated by their code.
This option requests the calculation of the ZZ tax, which is a specific tax applied only when the ticketing is done via TCH.
See "Error Messages" section.
When the Pricing Context, from which an automated TST has changed between the time of pricing and time of ticketing, the issuance is restricted. The recalculation of the OB Fees for the new context of issuance removes the issuance restriction thanks to the update of the Pricing Context.
The TST number is optional. When not present, the Airline Ticketing Fees standalone recalculation is requested for all TSTs present in the PNR.
The following options can be used for the recalculation of the Fees:
Service requests of the query message must respect the following rule:
=> one pricing request per TST.
If one single passenger has an itinerary with n segments and the pricing has generated x TSTs, then x OB Fees requests are expected.
In case of several passengers in the same PNR, a service request can group all or some of them since passengers of this OB Fee pricing request have:
This feature aims at decreasing the number of requests in case of multi-passengers.
Not applicable
PNR contains:
Each TST contains:
There is only one TST per passenger, covering the same itinerary for all the selected TSTs.
1-Security information:
2-Pricing context = FOP override
(applicable for all passengers)
up to 3 FOP can be provided
3-Pricing Options
4-Fee options encapsulation information
the possible values is OB for OB fees
the possible value is EX for Exempt all automated OB Fees
the possible values are:
the possible values is OB for OB fees
the possible values are:
5-Fare Information
the possible values is 730 for Original issue fare information
the possible values is TST for Transitional Stored Ticket
1-Error Group:
2-Passenger Recommandation
the possible values are:
The possible values are:
3- Service Recommandation (Totals for all TSTs)
the possible values are:
the possible values is 707 for Equivalent conversion currency
the possible values are:
4- Service Recommandation (Total per TST)
the possible value is TST for Transitional Stored Ticket
the possible values is 707 for Equivalent conversion currency
The possible values are:
5- OB fees Breakdown
the possible values is OB for OB Fees
the possible values is EX for All automated fees exempted.
The possible values are the:
the possible values are the:
The possible values are the:
the possible values is OB for OB Fee amount
the possible values is 3 for Literal text
the possible values is COM for Commercial text
RESTRICTED (CM# 20)
INVALID ISSUE IDENTIFIER (CM# 02060)
NEED FORM OF PAYMENT (CM# 00315)
NEED BASE FARE (CM# 12547)
NEED TST(CM# 2102)
MULTI TST/ETKT - REPRICE BY TST/ETKT (CM# 25904)
MULTI TST/ETKT - REPRICE BY TST/ETKT (CM# 25904)
INVALID TST NUMBER (CM# 02075)
RESTRICTED TST (CM# 07347)
TST PRICING CONTEXT MODIFIED : PLEASE REPRICE (CM# 24085 )
PRE-CONDITION:
SCENARIO: Reprice OB Fees with pricing option - FOP override
FOP provided in input will be taken into account, instead of the FOP present in the PNR:
See "Error Messages" section.
PRE-CONDITION:
SCENARIO: Reprice OB Fees with OB Fee option -ADD SPECIFIC OB Fees: R01
See "Error Messages" section.
PRE-CONDITION:
SCENARIO: Reprice OB Fees with OB Fee option - ADD SPECIFIC OB Fees: R01
See "Error Messages" section.
PRE-CONDITION:
SCENARIO: Reprice OB Fees with OB Fee option - EXEMPT ALL OB Fees
See "Error Messages" section.
It is possible to price itineraries using Fare_PricePNRWithBookingClass function.
Pricing can return one or several fare recommendations for the passengers and for the itineraries that are present in the related context.
After calling Fare_PricePNRWithBookingClass function, the system keeps the context for three minutes. This context can be used to create a TST when calling Ticket_CreateTSTFromPricing. I point out that PricePNRWithBookingClass is only informative.
The PNRWithBookingClass function allows for the following supported operation(s):
|
The Fare_PricePNRWithBookingClass cannot process a non homogeneus PNR, i.e. a PNR where the number of passengers is different from the number in party. |
|
You cannot separately price married segment? |
|
For selected markets, carrier-specific fares will take precedence over fares offered after a price with booking class entry, when the amounts of the fares are equal? |
|
A round or circle trip can contain no more than 12 segments and
|
|
A one-way trip can contain no more than 11 segments and
|
A PNR with a name should be retrieved to perform the pricing transaction.
Chapter 5 explains how to use all the options specified in the chapter 1.
Current PNR is not modified by this operation. The reply is fully structured, i.e. no full-screen text will be returned. After receiving the reply user can call Ticket_CreateTSTFromPricing to create the TST.
|
Message |
Description |
|
CM00005 - Check segment number |
A segment with the TATTOO number specified in the paxSegReference is not present in the PNR |
|
CM00011 - Unable to process |
Process error |
|
CM00258 - Function not supported |
Request a functionality not yet implemented |
|
CM00477 - Invalid format |
Data specified in the request is not valid, although is OK from the message definition |
|
CM01908 - Check passenger number |
A passenger with the TATTOO number specified in the paxSegReference group is not present in the PNR |
|
CM01959 - Need PNR |
No PNR exists in the context |
|
CM02032 - Invalid corporate code |
The number of corporate codes specified in the overrideInformation group is greater than allowed (1corp code). |
|
CM02230 - Single selection code only |
Different passenger types specified in the same paxSegReference group. |
|
CM03504 - Combination not allowed |
Use of no combinable options |
|
CM04701 - Exceeds maximum fare disc codes |
More than three cumulative discounts codes specified. |
|
CM04725 - Invalid passenger association |
Passengers selected in referenceQualifier are not selected in the global paxSegReference . |
|
CM04070 - Unable to process + seg name |
Process error - normally it shouldn't be related with data from the request - the name of the program where error occurred is appended at the end of the message. |
|
CM06392 - Invalid repetitive option |
The same option has been specified twice (or more) for options that are allowed only once. |
|
CM09053 - Invalid record locator |
The rec locator specified in the pnrLocatorData group does not match the retrieved PNR. |
|
CM13301 - Invalid point of sale |
The city qualifier in the cityOverride does not correspond to a point of tkt codeset (normally this error should not occur). ??? |
|
CM12400 - Invalid DIAG format |
Empty or blank string specified in DIAG option "attributeDescription" field of overrideInformation ("override information"). |
|
CM07785 - Check TRAP format |
Empty or blank string specified in TRAP option in "attributeDescription" field of overrideInformation ("override information"). |
Specific fees may be added in Query.
Fee codes are defined by ATPCO.
Fee amount:
The Fee amount is applicable for Form Of Payment Fee codes only.
This amount is provided without any decimals.
Equivalent Cryptic Entry: FXX /R,FA-OBFCA*100-OBT01
which means that the two following fees are added:
CM23983 - OPTION NOT AUTHORIZED WITH FOP IN PNR : Reject specific Form of payment fees with FOP.
CM07399 - CONFLICTING OPTIONS USED : if specific fee is both added and exempted
CM02011 - ENTRY NOT AUTHORISED : A Fee code cannot be added
CM00001 - CHECK FORMAT : It is not allowed to enter an amount with an addition of a Ticketing Fee code
CM00001 - CHECK FORMAT : FCA cannot be added in combination with another Form Of Payment fee code
CM00001 - CHECK FORMAT : Three Form Of Payment fee codes must not be added with only one amount
CM00001 - CHECK FORMAT : Three Form Of Payment fee codes must not be added with three amounts
See "Error Messages" section for other errors.
The objective of the Award Search option is to offer to the End User the capability to request for journeys priced in miles, in a context of an Award program.
The request must contain:
By default the process will load fares filed in USD currency, currency override option with a currency different than USD will skip Award solution.
Equivalent Cryptic Entry: FXX /R,U*FBLUE /MAF
CK FORMAT - REFER TO HELP FOR THIS TRANSACTION - The public fare option is not combinable with the Award option.
FORMAT NEEDS CORPORATE CODE - Corporate code associated to Award program code must be specified.
See "Error Messages" section for other errors.
This example shows a booking code override X.
See "Error Messages" section.
This example shows a requesting booking date override.If you do not enter a specific date, the system uses the farefrom the current date by default.
See "Error Messages" section.
This example shows a Breakpoint.In order to avoid ambiguities, the REF segment is filled.
See "Error Messages" section.
This example shows a prohibit breakpoint.In order to avoid ambiguities, the REF segment is filled.
See "Error Messages" section.
Selecting following Positive or Negative Rule Elements:
* Information coded from ATPCO Category 16
Requesting a fare with the "NR", No Restriction, option.
This example shows requirements No Advance Purchase, No Minimum Stay and penalty limited to 5%
See "Error Messages" section.
The exemption of all fees is requested. If you add some fees in the query, these fees won't be exempted.
CM07399 - CONFLICTING OPTIONS USED : if specific fee is both added and exempted
CM02011 - ENTRY NOT AUTHORISED - The option to exempt all fees is deactivated.
See "Error Messages" section for other errors.
Airline Ticketing Fees (OB Fees) are calculated for given Forms Of Payment (FOP).If no FOP option is specified in Query, the PNR FOP(FP element) will be used by default.
The forms of payment types, associated amounts and bin number in case of credit card are kept in context and reused for consistency checks at issuance time.
Credit Card bin number: this information is optional. However, it is mandatory if the Form of Payment Type is Credit Card. It may only occur for Credit Card Types. It is composed of the first 6 bin numbers of the credit card.
Form of Payment Amount: This amount is provided without any decimals.This amount is optional. Additionally, other constraints are:
For three occurrences of Form Of Payment entered in a FP element of the PNR, there are 2 OR 3 (but neither 0 nor 1) of them with an amount associated
Form of Payment Currency: no currency should be provided in query. The currency is by default the one the Point Of Sale.
CM23983 - OPTION NOT AUTHORIZED WITH FOP IN PNR : Reject if FOP in PNR
CM07399 - CONFLICTING OPTIONS USED : Reject if specific Form of payment fee codes are added (ref Add Fees) in same query.
CM00001 - CHECK FORMAT : If the type is not Credit Card, then the bin number is prohibited
CM00001 - CHECK FORMAT : Two or Three FOP must not be provided without any amounts
CM00001 - CHECK FORMAT : If the type is Credit Card, then a bin number of 6 digits is mandatory
CM00001 - CHECK FORMAT : Three FOP must not be provided with three amounts.
CM00001 - CHECK FORMAT : Three FOP must not be provided with only one amount
See "Error Messages" section for other errors.
Global indicator is allowed.
This example shows a open segment.In order to avoid ambiguities, the REF segment is filled.
See "Error Messages" section.
This example specifies the open segment.
See "Error Messages" section.
This example shows a pricing on a past date, 12 May 2004.
See "Error Messages" section.
This example shows a request for Fare informationwhich corresponds to the current booking class of the PNR itinerary.
When we try to price without a retrieved PNR and without specifying a RECLOC in the request.
339 NEED NAME
See also the "Error Messages", section.
This option allows to price only PTC. The difference with the option pricing by PTC is that:
For the option price only PTC, you have to specify PTC in the attributeType.
This is the simplest way to price a PNR
This option allows to price only the adults in the PNR
In order to choose this option, you have to specify FBL in the attributeType and then specify the fare basis you want
TPCBRQ allows to choose different fare basis for different passengers.
In the example, the passengers 1 wants the fare basis Y1 and the passenger 2 wants the fare basis Y8.
You can combine this option with segment selection.
TPCBRQ allows to choose different fare basis for different segments.
In the example, the passengers want the fare basis Y1 for segments 1 and 2 and fare basis Y2 for segment 3.
You can combine this option with passenger selection.
Pricing by PTC is allowed in TPCBRQ.
This option allows you to override the currency of the office.
This option allows to price only the infants in the PNR.
In TPCBRQ you can decide to override print option: ETK for Eletronic Ticket, PAT for Paper Ticket The example shows the first option
This option allows you to have the list of applicable fares.
This option allows you to visualise only the lowest fare.
Specific Fees can be exempted.
CM02011 - ENTRY NOT AUTHORISED : This particular Fee code cannot be exempted.
CM07399 - CONFLICTING OPTIONS USED : if specific fee is both added and exempted.
See "Error Messages" section for other errors.
This example shows a stopover for segment 2.In order to avoid ambiguities, the REF segment is filled.
See "Error Messages" section.
This example shows all added taxes by country code.
See "Error Messages" section.
In the field taxDetails/taxIdenfier you have to choose the code-set EXM, i.e exempt tax.
You can specify a tax. If you do not specify it, all taxes will be exempted.
See "Error Messages" section.
This example shows all taxes withheld by country code.
See "Error Messages" section.
In this example we want to add a tax amount.
In the field taxDetails/taxIdenfier you have to choose the codeset ADT, i.e Add country tax.
In the field taxDetails/taxValueQualifier there are two code-sets:
|
A |
Amount |
|
P |
Percentage |
See "Error Messages" section.
In the field taxDetails/taxIdenfier you have to choose the code-set ADT, i.e Add country tax.
In the field taxDetails/taxValueQualifier we have to choose the code-set P
See "Error Messages" section.
This example shows a transfer. You have to fill the field "flightType" with C. In order to avoid ambiguities, the referenceQualifier element is filled.
See "Error Messages" section.
This example shows a transfer. You have to fill the field "flightType" with PT. In order to avoid ambiguities, the referenceQualifier element is filled.
See "Error Messages" section.
Price one unifare corporate names/codes plus unifare option.
See "Error Messages" section.
Airline Ticketing Fees (OB Fees) are calculated for given Validating Carrier.If no Validating Carrier option is specified in Query, the validating carrier specified in PNR (FV element) will be used by default.The Validating Carrier used at pricing time for OB Fees are kept in context and reused for consistency checks during ticket issuance.
See "Error Messages" section.
This example shows tax withheld.
See "Error Messages" section.
This example shows the zapp off option.In order to avoid ambiguities, the REF segment is filled.
See "Error Messages" section.
The PricePNRWithLowerFares function provided in the Fare interface is used to display the lowest available fare for a given itinerary.
"Lowest available" means that this fare is applicable in a booking class where there are still enough seats available for the passengers of the PNR.
This class might not be the one currently present in the flight segment of the PNR. In this case, rebooking might be necessary.
The PricePNRWithLowerFares function supports the following operations:
| The PricePNRWithLowerFares function can't process different discounts and passenger types within a PNR, if the passengers are booked in different classes. |
| You cannot perform PricePNRWithLowerFares pricing by passenger. If you need to passenger-select to enter discounts, select all passengers. |
| You can perform PricePNRWithLowerFares on a PNR containing married segments only if the airline allows married segments to be rebooked or cancelled. |
| Open or passive flight segments are not permitted. |
| For selected markets, carrier-specific fares will take precedence over fares offered after a PricePNRWithLowerFares entry, when the amounts of the fares are equal. |
| You cannot apply best buy for an unaccompanied minor, where you have used the um sell command to reserve seats. |
| You cannot apply best buy for a stretcher passenger, where you have used the st sell command to reserve seats. |
| You cannot price a non-homogeneous PNR, for instance a PNR where the number of passengers in the PNR is different from the number of seats booked in on of the flight segment of the itinerary |
|
A round or circle trip can contain: no more than twelve flight segments or ten flight segments and two surface segments a maximum of eight fare-break points. A one-way trip can contain: no more than eleven flight segments or nine flight segments and two surface segments. |
Operations that are not supported are:
A PNR should be retrieved to perform the pricing transaction.
Chapter 5 explains how to use all the options specified in the chapter 1.
The current PNR is not modified by this operation. The reply is fully structured, i.e. no full-screen text will be returned.
| Message | Description |
| CM00011 - Unable to process | Internal process error |
| CM00005 - Check segment number | A segment with the TATTOO number specified in the paxSegReference is not present in the PNR |
| CM00258 - Function not supported | The functionality requested is not available |
| CM00477 - Invalid format | Data specified in the request is not valid, although the message is correctly defined |
|
|
Examples: Corporate number length is not six digits (overrideInformation/attributeDetails/attributeDescription) |
| CM01908 - Check passenger number | A passenger with the TATTOO number specified in the paxSegReference group is not present in the PNR |
| CM01959 - Need PNR | No PNR exists in the context |
| CM02032 - Invalid corporate code | The number of corporate codes specified in the overrideInformation group is greater than allowed (1corp code). |
| CM02230 - Single selection code only | Different passenger types are specified in the same paxSegReference group. |
| CM03504 - Combination not allowed | The combination of options is not valid |
| CM04701 - Exceeds maximum fare disc codes | More than three cumulative discounts codes are specified. |
| CM04725 - Invalid passenger association | Passengers selected in referenceQualifier are not selected in the global paxSegReference. |
| CM04070 - Unable to process + seg name | Process error - usually this is not related to data from the request. The name of the program where the error occurred is appended at the end of the message. |
| CM06392 - Invalid repetitive option | The same option has been specified twice (or more) for options that are allowed only once. |
| CM09053 - Invalid record locator | The rec locator specified in the pnrLocatorData group does not match the retrieved PNR. |
| CM13301 - Invalid point of sale | The city qualifier in the cityOverride does not correspond to a point of tkt |
| CM12400 - Invalid DIAG format | Empty or blank string specified in DIAG option "attributeDescription" field of overrideInformation ("override information"). |
| CM07785 - Check TRAP format | Empty or blank string specified in the TRAP option in the "attributeDescription" field of overrideInformation ("override information"). |
| CM02011 - ENTRY NOT AUTHORISED | The entry being performed is not allowed. This may depend on the office id settings. |
| CM04843 - INF DISCOUNT/SELECTION NOT VALID FOR THIS TRANSACTION |
This option is not valid for Best pricer entries |
| CM1966- NEED ITINERARY |
This error is returned when no itinerary is present in the PNR |
Specific fees may be added in the query. Fee codes are defined by ATPCO.
The fee amount is applicable for form of payment Fee codes only.
This amount is provided without any decimals.
In the example two fees are added:
• airline ticketing (OB) fees with subcode FCA (Any format of credit card), applied on an amount of 100 of the currency of the Point Of Sale;
• and airline ticketing (OB) fees with subcode T01.
Equivalent Cryptic Entry: FXX /R,FA-OBFCA*100-OBT01
This example shows a booking code list option.
The following example shows the booking list A,B,C for segment withTattoo number 1 and D,E,F for segment with Tatoo number 2.
This option is designed but not implemented.
See "Error Messages" section.
This example shows a requesting booking date override. If you do not enter a specific date, the system uses the fare from the current date by default.
See "Error Messages" section.
This example shows a Breakpoint.
See "Error Messages" section.
This example shows a prohibit breakpoint.
See "Error Messages" section.
This example shows a pricing by cabin classes F, C and Y. There is no priority in the query.
| F | FIRST |
| C | CLUB (BUSINESS) |
| Y | ECONOMY |
See "Error Messages" section.
In this example the "+" means any other cabin.
For this example the priority will be given:
See "Error Messages" section.
This example shows a pricing by cabin class, request with the following priority:
See "Error Messages" section.
This option allows overriding the controlling carrier.
Here the parameters:
This example shows requirements No Advance Purchase, No Minimum Stay and penalty limited to 5%.
See "Error Messages" section.
It is possible to perform the operation Fare Selection, equivalent to the /R,FS-USD
The exemption of all fees is requested. If you add some fees in the query, these fees won't be exempted.
Airline Ticketing Fees (OB Fees) are calculated for a given Form Of Payment (FOP). If no FOP is specified in the query, the PNR FOP(FP element) will be used by default.
The forms of payment types, associated amounts and bin number in case of credit card are kept in context and reused for consistency checks at issuance time.
Credit Card bin number: this information is optional. However, it is mandatory if the Form of Payment Type is a credit card. It is composed of the first 6 bin numbers of the credit card.
Form of Payment Amount: This amount is provided without any decimals. This amount is optional.
Additionally, there are other constraints:
• For one occurrence of Form Of Payment in query, there are 0 to 1 of them with an amount associated;
• For two occurrences of Form Of Payment in query, there are 1 to 2 of them with an amount associated;
• For three occurrences of Form Of Payment entered as an option in any Pricing query there are 2 (but neither0, 1 nor 3) of them with an amount associated.
Form of Payment Currency: no currency can be provided in query. The currency is by default the one the Point Of Sale.
Global indicator is allowed
When a Best Pricer is requested on a PNR with more than one passenger there are situations where the best pricer requires to books passengers in different booking codes.
This option forces not to split the PNR.
This example processes only the lowest available.
See "Error Messages" section.
This example shows a pricing on a past date, 12 May 2004.
See "Error Messages" section.
It is possible to override the point of sale.
This is the option without any options.
This option allows to price only the adults in the PNR.
This option allows you to have the list of applicable fares.
This option allows you to visualise only the lowest aplicable fares:
It is possible to select the segments you want to price in a PNR.
Specific fees can be exempted.
This example shows a stopover for segment 2.
See "Error Messages" section.
This example shows all added taxes by country code (AA).
See "Error Messages" section.
This example shows exempt tax type EE.
In the field taxIdenfier you are supposed to choose the code-set EXM, i.e exempt tax. You can specify a tax. If you don’t specify it, all taxes will be exempted.
See "Error Messages" section.
This example shows all taxes withheld by country code.
See "Error Messages" section.
In this example the amount of a tax is added.
In the field taxIdenfier you have to choose the codeset ADT, i.e Add country tax.
In the field taxValueQualifier two code-sets are available: A (Amount) and P (percentage).
See "Error Messages" section.
In the field taxIdenfier you have to choose the codeset ADT, i.e Add country tax.
In the field
taxValueQualifier it is possible to specify P, i.e. percentage.
See "Error Messages" section.
This example shows tax withheld.
See "Error Messages" section.
This example shows a transfer.
See "Error Messages" section.
This example shows a turnaround point.
See "Error Messages" section.
This option allows MIT and MBT.
See "Error Messages" section.
Pricing by unifare is allowed.
See "Error Messages" section.
Pricing by unifare with corporate number is allowed.
See "Error Messages" section.
This example shows validating carrier, airline code CO.
Airline Ticketing Fees (OB Fees) are calculated for given Validating Carrier.If no Validating Carrier option is specified in Query, the validating carrier specified in PNR (FV element) will be used by default.The Validating Carrier used at pricing time for OB Fees are kept in context and reused for consistency checks during ticket issuance.
See "Error Messages" section.
If you specify WQ in the field attributeType, you can withhold q surcharges.
This example shows the zapp off option.In order to avoid ambiguities, the REF segment is filled.
See "Error Messages" section.
The QuoteItinary transaction (FQP) quotes fares for passenger types without existing reservations (PNR). Pricing is executed according to the principles of IATA resolutions as well as according to specific user requirements, if industry conform or individual.
The QuoteItinary transaction prices itineraries with specified or open variable data such as dates and reservation booking designators.
The following options can be used:
Possibility for pricing requests of
Possibility to specify flight details
Not included
The number of segments in the itinerary the system can price is limited:
Office profile security
Data availability
All cryptic options of the FQP transaction can be requested with the query of the 1A PSP service informative pricing. The number of different passengers can be up to 6 (similar to cryptic FQP).
By specifying the lowest fare finder option in the query only the cheapest fare construction per passenger is returned.
Functional data in the query:
|
FUNCTIONAL DATA |
Format |
REP |
XML element |
|
MESSAGE FUNCTION 741 : Itinerary pricing |
3an |
|
messageActionDetails/ messageFunctionDetails/ messageFunction |
|
A. PASSENGER INFORMATION |
|
1-9 |
passengerInfoGroup |
|
1.Number of passengers |
1-2n |
|
segmentRepetitionControl/ segmentControlDetails/ numberOfPAx |
|
2.Passengers reference |
|
1-99 |
specificTravellerDetails/ travellerDetails |
|
2.1 Reference |
1-2 n |
|
referenceNumber |
|
3. Passenger type code |
1-3 an |
1 |
passengerTypeGroup/ fareInfo/ valueQualifier |
|
4. Passenger discounts |
1-6 an |
1-3 |
passengerTypeGroup/ fareInfo/ fareTypeGrouping/ discountCode |
|
5. Form of Payment Information |
|
1-9 |
formOfPayment/ formOfPaymentDetails |
|
a. Form of payment |
1-3 an |
|
type |
|
b. Identification code (credit card number, …) |
1-20 an |
|
creditCardNumber |
|
c. Amount to charge on this FOP in currency of sale |
1-12 n |
|
chargedAmount |
|
6. Forced companion fares only (WFC) |
3an |
|
discountAndPenaltyInfo/ discountPenaltyQualifier |
|
|
|
|
|
|
B. OPTIONS |
|
1 |
pricingTktOptionGroup |
|
1. Past travel and validation date |
6 n |
1 |
pricingTicketingDetails/ productDateTimeDetails/ departureDate |
|
2. Expanded parameters |
|
1-9 |
fareQualifierDetails/ discountDetails |
|
a. Expanded parameter (NAP, NDA, NMM, NMN, NMX, NPE, NRF, PTC, AP, DA, MM, MN, MX, PE, RF, NR, EU) |
1-3 an |
|
fareQualifier |
|
b. Expanded parameter flat amount |
1-12an |
|
amount |
|
c. Expanded parameter percentage amount |
1-12an |
|
percentage |
|
3. Point-of-sale override |
3-5 an |
1 |
pricingTicketingDetails/ locationDetails/ pointOfSaleOverrideCity |
|
4. Ticketing City override |
3-5 an |
1 |
pricingTicketingDetails/ otherLocationDetails/ pointOfTicketingOverrideCity |
|
5. IATA rules source override (IAT) |
1-3 an |
1 |
pricingTicketingDetails/ priceTicketDetails/ indicators |
|
6. Non corporate Unifare Details (RP : Public, RU : Unifares) |
1-3 an |
1-2 |
pricingTicketingDetails/ priceTicketDetails/ indicators |
|
7. Validating carrier option |
|
1 |
|
|
1.Validation carrier Qualifier (VC) |
1-3 an |
1 |
pricingTicketingDetails/ priceTicketDetails/ indicators |
|
2.Validation carrier |
2-3 an |
1 |
pricingTicketingDetails/ companyDetails/ marketingCompany |
|
8. Override booking data option (OBD) |
1-3 an |
1 |
pricingTicketingDetails/ priceTicketDetails/ indicators |
|
9. Frequent Flyer process |
|
1 |
|
|
1.Frequent Flyer process qualifier (MFF) |
1-3 an |
1 |
pricingTicketingDetails/ priceTicketDetails/ indicators |
|
2.Frequent Flyer process carrier |
2-3 an |
1 |
pricingTicketingDetails/ companyDetails/ marketingCompany |
|
10. Paper and E-Ticket option E-Ticket only : ET or E Paper Ticket only : PT or P Paper and E-Ticket : EP |
2-3 an |
1 |
pricingTicketingDetails/ priceTicketDetails/ indicators |
|
11. Price and detail Lowest Fare option (LF) |
1-3 an |
1 |
pricingTicketingDetails/ priceTicketDetails/ indicators |
|
|
|
|
|
|
C. CONVERSION AND CURRENCY OPTIONS |
|
1 |
conversionRate/ |
|
1. Price in a foreign currency |
|
1 |
conversionRateDetails |
|
a. Price in foreign currency qualifier (FC) |
1-3 an |
|
conversionType |
|
b. Price in foreign currency code |
3 an |
|
currency |
|
|
|
|
|
|
2. Select fares in a foreign currency |
|
1 |
conversionRateDetails |
|
a.Select fares in a foreign currency qualifier (FS) |
1-3 an |
|
conversionType |
|
b.Select fares in a foreign currency code |
3 an |
|
currency |
|
|
|
|
|
|
3. Manual BSR processing |
|
1 |
conversionRateDetails |
|
a.Manual rate input qualifier (BR) |
1-3 an |
1 |
conversionType |
|
b.Manual rate type USR : User specified rate BSR : Bankers seller rate |
1-3 an |
1 |
rateType |
|
c.Manual rate value |
1-18 n |
1 |
pricingAmount |
|
|
|
|
|
|
D.TAX AND SURCHARGE OPTIONS |
|
20 |
taxOptionsInfoGroup |
|
1.Tax option qualifier E : Tax exemption 700 : Add taxes AC : Add all taxes for specified country WC : Withhold all taxes for specified country W : Withhold all taxes WQ : Withhold Q-Surcharge |
1-3 an |
1 |
taxProcessingInfo/ taxCategory |
|
2.Tax details |
|
1-9 |
taxProcessingInfo/ taxDetails |
|
a. Tax amount or percentage to add |
1-6 an |
|
rate |
|
b. Tax country code |
1-3 an |
|
countryCode |
|
c. Tax type code |
1-3 an |
|
taxTypeCode |
|
d. Tax amount or percentage qualifier |
1-3 an |
|
taxAmountOrPercentageQual |
|
|
|
|
|
|
E. Corporate Unifare Details |
|
1 |
corporateFareInfo/ corporateFareIdentifiers |
|
1. Unifare Qualifier (Unifares : RU) |
1-3 an |
|
fareQualifier |
|
2. Corporate Number/Name |
1-12 an |
1-6 |
identifyNumber |
|
|
|
|
|
|
F. Alternate-Booking Code option |
|
1 |
bookingClassInfoGroup/ productInfo |
|
1.Alternate booking code qualifier (ABC) |
1-3 an |
|
productDetailsQualifier |
|
2.Alternate booking code value |
1-2 an |
1 |
bookingClassDetails/ designator |
|
|
|
|
|
|
G. Fees Information options |
|
1-9 |
feeOptionsEncapInfo/ feeOptionInfoGroup |
|
1.General fee type (OA,OB,OC) OA : Booking fees OB : Ticketing fees OC : Service fees |
1-2an |
|
feeTypeInfo/ carrierFeeDetails/ type |
|
2.Option IN : Include fees EX : Exclude all automated fees |
1-3an |
|
feeTypeInfo/ carrierFeeDetails/ optionInformation |
|
3.VAT percentage to apply to such fees |
|
1 |
rateTaxInfo/ monetaryDetails |
|
a. Percentage |
1-12an |
|
amount |
|
b. Qualifier (VAT) |
1-3an |
|
typeQualifier |
|
4.Fee details |
|
1-99 |
|
|
a. Subtype |
1-3an |
|
feeDetailsInfoGroup/ feeInfo/ dataTypeInformation/ type |
|
b. Option (Include/exclude specific fee) (FEX, FIN) |
1-3an |
|
feeProcessingInfo/ carrierFeeDetails/ type |
|
c. Amount to be charged on this FOP subcode |
|
1 |
associatedAmountsInfo/ monetaryDetails |
|
Qualifier (C) |
1-3an |
|
typeQualifier |
|
value |
1-12an |
|
amount |
|
Currency (default selling currency) |
1-3an |
|
currency |
|
|
|
|
|
|
H. General flight segment information |
|
16 |
requestedSegmentInfoGroup |
|
1.Flight details |
|
1 |
flightSegmentInfoGroup/ travelProductInfo |
|
a. Carrier code |
2-3an |
|
companyDetails/ marketingCompany |
|
b. Flight number |
1-5an |
|
flightIdentification flightNumber |
|
c. Reservation booking class |
1-2an |
|
flightIdentification/ bookingClass |
|
b. Departure date |
6n |
|
flightDate/ departureDate |
|
d. Departure city |
3an |
|
boardPointDetails/ departureCity |
|
e. Departure time |
4n |
|
flightDate/ departureTime |
|
f. Arrival date |
6n |
|
flightDate/ arrivalDate |
|
g. Arrival time |
4n |
|
flightDate/ arrivalTime |
|
h. Arrival city |
3an |
|
offpointDetails/ arrivalCity |
|
i. Arrival change date indicator |
1n |
|
flightDate/ dateVariation |
|
k. Operating carrier code |
2-3an |
|
companyDetails/ operatingCompany |
|
l. Equipment type |
1-3an |
|
additionalProductDetails/ legDetails/ equipment |
|
j. Special flight segment indicators |
|
1 |
flightTypeDetails |
|
1.Forced transfer (T) / stopover (V) / unknown (U) indicator |
1-6an |
|
connectionIndicator |
|
2. Breakpoint / no breakpoint BM : Fare break point at the next city BN : Inhibit fare break point at the next city |
1-6an |
|
breakpointIndicator |
|
3. Turnaround point PT : Turnaround point at the next city |
1-6an |
|
turnaroundIndicator |
|
4. FlightIndicator / Breakpoint after segment for |
1-6an |
6 |
flightIndicator |
|
2. Route code |
1-3an |
1 |
fareQualifierDetails/ movementType |
|
3. Booking code informative pricing |
1-2an |
1 |
bookingClassInfoGroup/ productInfo/ bookingClassDetails/ designator |
|
4. Segment identification WL : Waitlist B : Flown SB : Stand-by OK : Confirmed OPE : Opened |
1-3an |
1 |
relatedProductInfo/ statusCode |
|
5. Segment number |
1-3n |
1 |
segmentPricingInfoGroup/ travelItineraryInfo/ itemNumber |
|
|
|
|
|
|
I. Zap off option per flight segment |
|
1 |
fareQualifierDetails/ discountDetails |
|
a. Zap off based or total amount qualifier 720 or B : Based 721 or T : Total |
1-3an |
|
fareQualifier |
|
b. Zap off TicketDesignator |
1-15an |
|
rateCategory |
|
c. Zap off amount |
1-8an |
|
amount |
|
d. Zap off percentage amount |
1-8an |
|
percentage |
|
|
|
|
|
|
J. Diagnostic Tool options per flight segment |
|
1 |
fareQualifierDetails/ |
|
a. Diagnostic Tool fare basis (DFB) or fare family (DFF) qualifier |
1-3an |
1 |
discountDetails[0]/ fareQualifier |
|
b. Diagnostic Tool fare basis or fare family |
1-15an |
1 |
discountDetails[0]/ rateCategory |
|
c. Diagnostic Tool Booking Code details |
1-2an |
1 |
discountDetails[1]/ rateCategory |
|
|
|
|
|
|
H. Form of Payment Information |
|
9 |
formOfPaymentInfo/ formOfPaymentDetails |
|
1. Form of payment |
1-3 an |
|
type |
|
2.Identification code (credit card number, …) |
1-20 an |
|
creditCardNumber |
|
3. Amount to charge on this FOP in currency of sale |
1-12 n |
|
chargedAmount |
The informative pricing returns a list of fare construction which is limited to 60 fare constructions in total. Depending on the chosen booking codes for the flight segment the fare constructions are well or badly booked. A booking status is returned per fare construction.
The reply message can become very long for very open requests. Therefore it is recommended to specify in the query per flight segment the booking class, the departure date, connection indicator between flight segments and to limit the informative pricing results by options.
Functional data in the reply:
|
FUNCTIONAL DATA |
MaxRep |
Type |
Xml elements |
|
I- Message function 741 : Itinerary pricing |
|
3an |
messageActionDetails/ messageFunctionDetails/ messageFunction |
|
|
|
|
|
|
Quote itinerary reply |
1 |
|
allFaresInfoGroup |
|
II - Currency conversion information |
3 |
|
involvedCurrenciesInfo/ conversionRateDetails |
|
II.1 - Qualifier - selling currency : 707 - origin currency : 705 |
|
3an |
conversionType |
|
II.2 - Currency |
|
3an |
currency |
|
III - Flight information |
16 |
|
flightInfoGroup |
|
III.1 - Departure point |
|
3an |
involvedFlightInfo/ boardPointDetails/ trueLocationId |
|
III.2 - Arrival point |
|
3an |
involvedFlightInfo/ offpointDetails/ trueLocationId |
|
III.3 - Marketing carrier |
|
2an |
involvedFlightInfo/ companyDetails/ marketingCompany |
|
III.4 - Segment number |
|
1-3n |
itineraryInfoGroup/ travelItineraryInfo/ segmentItemNumber |
|
IV - Product information |
99 |
|
fareProductInfoGroup |
|
IV.1 - General information |
1 |
|
generalAndIdInfo/ segmentControlDetails |
|
-Product reference |
|
1-2n |
productReference |
|
-Number of passengers |
|
1-2n |
numberOfPAx |
|
IV.2 - Passengers information |
1 |
|
specificTravellerDetails |
|
|
99 |
|
travellerDetails |
|
-Passenger reference |
|
1-2n |
referenceNumber |
|
-PTC and Discounts |
5 |
1-6an |
passengerTypeInfoGroup/ fareInfo/ fareTypeGrouping/ aggregatePTCDiscount |
|
-Infant indicator IN : Infant |
|
2an |
passengerTypeInfoGroup/ fareInfo/ fareDetails/ passengerTypeQualifier |
|
IV.3 - Pricing/Ticketing information |
1 |
|
passengerTypeInfoGroup/ pricingticketingDetails |
|
-Type of fare indictor RA: ATPCO nego fares - CAT35 RB: ATPCO nego corporate fares RC: Amadeus Nego Corporate Fares RD: Dynamic Discounted Fares RN: Amadeus Nego Fares RP: Published fares RV: ATPCO private fares - CAT15 RX: Corporate ATPCO private fares - CAT15 RZ: Corporate Dynamic Discounted Fares -Issue separate ticket indicators IST: Issue separate tickets -Restriction indicators RBR: Reservation booking designator restrictions RER: Reservations conditions ROR: Booking Designator Override SRR: Sale Restrictions FLR: Flight number restrictions FQR: Frequency restrictions -OB fees indicators OBI: Ticketing fees have been included OBV: Any change of pricing context impacts OB fees VR: Vendor restriction -Electronic ticket indicator 718: e-ticket not allowed 717: e-ticket requested -Tax indicators TNI: taxes not included TEX: taxes exempted |
20 |
2-3an |
priceTicketDetails/ indicators |
|
IV.4 - Corporate information |
1 |
|
passengerTypeInfoGroup/ corporateFareInfo/ corporateFareIdentifiers |
|
-Corporate name |
1 |
1-35an |
identifyNumber |
|
IV.5 - Currency conversion information |
1 |
|
passengerTypeInfoGroup/ conversionRate/ conversionRateDetails |
|
-Type of conversion 700 : Fare |
|
3an |
conversionType |
|
-Currency code |
|
3an |
currency |
|
-Amount |
|
1-18n |
pricingAmount |
|
-Conversion rate ROE : Rate of Exchange (rate used to convert currency of fare calculation into currency of Origin) |
|
3an |
rateType |
|
IV.6 - Monetary information |
60 |
|
passengerTypeInfoGroup/ monetaryInfo/ monetaryDetails |
|
-Qualifier B : Base fare amount T : Total fare amount E : Equivalent fare amount TX : Total taxes amount OA : Total OA fees amount OB : Total OB fees amount XOB : Total amount without OB fees FFA : Award total amount in miles |
|
1-3an |
typeQualifier |
|
-Amount |
|
1-12n |
amount |
|
IV.7 - Interactive Free text |
99 |
|
passengerTypeInfoGroup/ interactiveFreeText/ freeTextQualification |
|
-Message qualifier 4 : Literal text |
|
1an |
textSubjectQualifier |
|
-Message function |
|
2-3an |
informationType |
|
-Free Text |
99 |
70an |
freeText |
|
IV.8 - Taxes information |
99 |
|
passengerTypeInfoGroup/ taxDetailsInfoGroup/ taxDetailsListInfo/ taxDetails |
|
-Amount |
|
1-12n |
rate |
|
-Country code |
|
2an |
countryCode |
|
-Type |
|
2an |
type |
|
-indicator E:Tax exempted |
1 |
1an |
indicator |
|
IV.9 - ZP and PFC Taxes information |
2 |
|
passengerTypeInfoGroup/ taxDetailsInfoGroup/ elementaryTaxSubDetails |
|
ZP or PFC Taxes details |
20 |
|
monetaryDetails |
|
-Amount |
|
1-12n |
amount |
|
-Location |
|
3an |
location |
|
-Type ZP : ZP taxes XF : PFC taxes |
|
2an |
typeQualifier |
|
IV.10 - Segment information |
16 |
|
|
|
IV.10.a - General info |
1 |
|
passengerTypeInfoGroup/ fareSegmentInfo/ segmentDescriptionInfo |
|
-Segment number |
|
1-3n |
segmentItemNumber |
|
-Indicator X : Connection at destination ST : Segment within side trip |
|
1-2an |
productTypeDetails/ flightIndicator |
|
IV.10.b - Fare information |
1 |
|
passengerTypeInfoGroup/ fareSegmentInfo/ fareQualifierDetails/ additionalFareDetails |
|
-Fare basis or ticket code |
|
1-35an |
fareBasis |
|
-Ticket designator |
|
1-18an |
ticketDesignator |
|
IV.10.c - Booking information |
1 |
|
passengerTypeInfoGroup/ bookingClassInfoGroup/ productInfo bookingClassDetails |
|
-Booking code |
|
1an |
designator |
|
-Class of service (transporting) |
|
1an |
specialService |
|
-Modifier |
|
1an |
option |
Error details :
Open class informative pricing FRA LON with LH, one passenger adult
Only lowest fare option activated (pricingTktOptionGroup /pricingTicketingDetails/ priceTicketDetails/ indicators indicator to LF (Low fare finder - rebooking recommended)
Cryptic : FQP FRA /D25AUG /ALH LON/L
See "Error Messages" section.
Informative pricing mirror trip DUS to NYC via FRA with LH, three passenger adult, child and infant, booking class in request V, specified dates for outbound and inbound.
Cryptic : FQP DUS/CV/D25AUG FRA/CV NYC /D02SEP/CV FRA/CV DUS/OLH/RADT*CH*INF
See "Error Messages" section.
List of Fares all fares of the FQP fare selection panel are to find in the structured response.
Query with one passenger, two flight segments DUS - FRA - DUS with carrier LH.
Cryptic : FQP DUS/D25AUG FRA /D02SEP DUS/OLH/RADT
See "Error Messages" section.
Expanded parameter : Penalty information with flat Amount.
Cryptic : FQP NCE /D25FEB PAR/OAF/R,*PE100A
See "Error Messages" section.
Expanded parameters :
Cryptic : FQP NCE /D27MAY PAR/OAF/R,*PE50P,*NR,*NMX
See "Error Messages" section.
The past travel date should be for a maximum of 12 months
Past Travel date : 10/11/10
Point of sale override : NYC
Cryptic : FQPCHI/D21JUN/AUAMAD/R,NYC,01NOV10
See "Error Messages" section.
Ticketing point override : NYC
IATA rules source override : IAT
Cryptic : FQP CHI /D13APR/AUA MAD/R,.NYC,IATA
See "Error Messages" section.
Price in a foreign currency:
Cryptic : FQP RIO /D13AUG /AIB MAD BCN /R,FC-USD
See "Error Messages" section.
Select fares in a foreign currency:
Cryptic : FQP RIO /D14SEP /AIB MAD BCN /R,FS-USD
See "Error Messages" section.
Manual BSR processing
Cryptic : FQP LON /D14SEP NYC /R,BR-1.23456789
See "Error Messages" section.
Tax exemption, all Taxes : E
Cryptic : FQP LON /D17AUG NYC /R,ET/L
See "Error Messages" section.
Tax Exemption, specific taxes.
Cryptic : FQP LON /D17AUG NYC /R,ET-USAS-XT-YC/L
See "Error Messages" section.
Add Specified Tax US with a decimal and Percentage amount
The amount specified with the option Add Specified Tax should not be more than 6 digits, or 5 digits + the . (for a decimal amount).
Cryptic : FQP LON /D01SEP NYC /R,AT-US123.45A/L
See "Error Messages" section.
Add Specified Tax with tax nature and percentage amount
The amount specified with the option Add Specified Tax should not be more than 6 digits, or 5 digits + the . (for a decimal amount).
Cryptic : FQP LON /D01SEP NYC /R,AT-USAS10P/L
See "Error Messages" section.
Add several Taxes.
Cryptic : FQPLON/D19AUGNYC/R,AT-USLO123456A-DE100A/L
See "Error Messages" section.
Add one Tax and exempt two others
The amount specified with the option Add Specified Tax should not be more than 6 digits, or 5 digits + the . (for a decimal amount).
Cryptic : FQP LON /D19AUG NYC /L /R,AT-USLO,ET-BG-USAS
See "Error Messages" section.
Add (AC) / Withhold (WC) all Country Taxes (for specified countries)
Warning: if 2 countries are requested after AC , only the first one is mapped.
Cryptic : FQP PAR /D14JUL LON NYC /R,AC-GB*WC-US/L
See "Error Messages" section.
Withhold all Taxes.
Cryptic : FQP LON /D14JUL NYC /R,WT/L
See "Error Messages" section.
Withhold all Taxes with tax display code and tax nature.
Cryptic : FQP PAR /D15NOV LON NYC /R,WT-USAS-GB/L
See "Error Messages" section.
Withhold all Surcharges : WQ
Cryptic : FQP PAR /D15NOV /AAF LON/ABA NYC/ABALON/AAFPAR /L /R,WQ
See "Error Messages" section.
Unifares + Public fares request
Cryptic : FQP PAR /D26OCT /AAF LON /R,U
See "Error Messages" section.
Unifares + Corporate Number
Cryptic : FQP PAR /AAF LON /R,P,U000001
See "Error Messages" section.
Unifares + Unifares Corporate number request
Cryptic : FQP PAR /D23OCT /ABALON /R,U*000002-000003
See "Error Messages" section.
Unifares Corporate Name request
Cryptic : FQP PAR /D28FEB /AAFLON/R,U*AMADEUS
See "Error Messages" section.
The Alternate Booking code option (/R,BK-xx) is not allowed in open class. A booking class should be precised (/Cx)
Remark:
If the flight Number is unknown (case of the example), the booking class can be precised with productInfo of Group bookingClassInfoGroup
Cryptic : FQP LON /D28FEB /CY NYC /R,BK-VN/L
See "Error Messages" section.
Validating carrier : AF
Override booking : OBD
Lowest Fare : LF
Cryptic : FQP LON /D17NOV NYC /R,VC-AF,DO-OBD/L
See "Error Messages" section.
Electronic and Paper Ticket : EP
E-Ticket only : ET or E
Paper-Ticket only : PT or P
Cryptic : FQP LON/D11MAY PAR /EP
Frequent flyer indicator : MFF
Program code : BA
E-Ticket only : ET or E (PT or P for Paper-Ticket only and EP for Paper and Electronic Ticket)
Cryptic : FQP LON /D17NOV PAR /ET /MBA
See "Error Messages" section.
OB fees global option
Fee type : OB (Ticketing Fees)
2 possible options: EX (Exempt all fees) or IN (Include all fees).
Cryptic : FQP LON /D24NOV PAR /R,FA
See "Error Messages" section.
OB fees detailed option
2 possible options: FEX (Exempt fee) or FIN (Include fee).
Include fee option used with a form of payment fee subtype can be completed with the amount to be charged on this form of payment.
Cryptic : FQP LON /D26MAY PAR /R,FA-OBFC2,FX-OBFC4
See "Error Messages" section.
Carrier Code + Operating Carrier Code + Flight Number + Reservation Booking Class
If the flight Number is known (case of the example), the booking class should be precised with the same travelProductInfo group.
See "Error Messages" section.
Departure date: 25/02/09
Departure time: 19h00
Origin: NYC
Destination: PAR
By default, the destination Date is equal to the origin Date
See "Error Messages" section.
Equipment Type: DH8
Booking Class : Y
If the flight Number is unknown (case of the example), the booking class should be precised with productInfo of Group bookingClassInfoGroup
See "Error Messages" section.
Fare Breakpoint at the next city / Inhibit Fare Breakpoint at the next city
See "Error Messages" section.
Turnaround point at the next city: PT
Global Routing via a specified route-code : 7AT
See "Error Messages" section.
Surface (non flight segment)
Cryptic: FQP PAR /D27SEP /ABALON--MAN/ABANYC/AAABOS/R,ET
See "Error Messages" section.
Stopover (V) after a flight segment
Cryptic : FQP PAR /D27AUG /ABALON MAN/ABA - NYC/AAA BOS/R,ET
See "Error Messages" section.
Stopover after a Surface segment
Cryptic : FQP PAR /D27AUG /ABALON--MAN/ABA - NYC/AAABOS/R,ET
See "Error Messages" section.
Passenger Discount code specified + Cumulative Passenger discounts
Case of Cumulative Passenger discounts
By default, the passenger type code is "ADT" (for Adult).
If "ADT" is specified in the valueQualifier of the fareInfo : At max. 3 discounts can be specified in the discountCode of the fareInfo.
If another passenger type code (different of "ADT") is specified in the valueQualifier of the fareInfo : At max. 2 discounts can be specified in the discountCode of the fareInfo , and this 2 discounts + the new passenger type code are considered.
Cryptic : FQP LON /D15JUL NYC/RRC-BP-ID90N2
See "Error Messages" section.
Equivalent request as previous (by default Passenger Discount code is ADT )
Case of Cumulative Passenger discounts
By default, the passenger type code is "ADT" (for Adult).
If "ADT" is specified in the valueQualifier of the fareInfo : At max. 3 discounts can be specified in the discountCode of the fareInfo.
If another passenger type code (different of "ADT") is specified in the valueQualifier of the fareInfo : At max. 2 discounts can be specified in the discountCode of the fareInfo , and this 2 discounts + the new passenger type code are considered.
Cryptic : FQP LON /D15JUL NYC/RRC-BP-ID90N2
See "Error Messages" section.
Passenger Discount code specified + Multiple Passenger discounts + Companion Fare only
A booking class should be precised (/Cx) for The Companion Fare Only process.
If the flight Number is unknown (case of the example), the booking class can be precised with productInfo of Group bookingClassInfoGroup
Cryptic : FQP LON /D15AUG /CY NYC /RADT*ADT*ZZ,W
See "Error Messages" section.
Passenger Discount code specified
Multiple and Cumulative Passenger discounts
Cryptic : FQP PAR /D15AUG /AAFLON /ABAMAN /ABALON /RADT*MIL*CH-MIL*ZZ
See "Error Messages" section.
Zap Off
Cryptic : FQP PAR /D27MAY LON NYC /M /R,ZO-T25A*AD25.1, ZO-T10P.2-4
See "Error Messages" section.
Diagnostic tool with stop over and surface sector
In this example, there are 4 segemnts and 1 surface:
LGA-DEN, DEN-MTJ, SURFACE, GUC-DEN, DEN-LGA
We request the fare information corresponding to:
- fare basis HUAUP applied on segment 1-2 (Fare component : LGA-UA-DEN-UA-MTJ)
- fare basis UA0FY applied on segment 4-5 (Fare component : GUC-UA-DEN-UA-LGA)
Cryptic : FQP LGA /AUA /D17AUG /H0813 /CA DEN /AUA /D17AUG /H1115 /CY MTJ --- GUC /AUA /D21AUG /H1026 /CU DEN /AUA /D21AUG /H1339 /CU LGA /R,NYC.NYC,24MAY10 /D S1-2 F-HUAUP, S4-5 F-UA0FY
The function DisplayFaresForCityPair responds with a list of available fares on a given market. It also gives some short information about the rules that apply to these fares. Service Fare Notes can be used as a subsequent in order to have more details about a fare.
The following options can be used:
Remark all dates must be specified in format DDMMYY, e.g. 10 March 2008 is 100308
Not applicable
Not applicable
Not applicable
Date information
Date information can be provided in 3 different ways:
In case of range of dates or inbound and outbound dates, 2 dates must be provided:
Carrier information
It is possible to specify up to 3 airlines. The possibility is also given to exclude common (YY) fares or to return fares from all airlines that have fares on the requested market.
|
FUNCTIONAL DATA |
FORMAT |
REP |
XML ELEMENT |
|
A. Message Action Details |
|||
|
1. Message Identifier, coded 711 : Fare Display by City Pair |
1-3 an |
1 |
msgType/ messageFunctionDetails/ messageFunction |
|
B. Trip/Journey Information Details |
1 |
tripDescription |
|
|
1. Origin |
3-5 an |
origDest/ origin |
|
|
2. Destination |
3-5 an |
origDest/ destination |
|
|
3. Travel Date |
1-2 |
dateFlightMovement/ dateAndTimeDetails |
|
|
3.1. Date The date format should be DDMMYY |
6 n |
date |
|
|
3.2. Qualifier A : Last possible commencement of travel date B : First possible commencement of travel date O : Outbound travel date I : Inbound travel date empty : Specific date |
1-3an |
qualifier |
|
|
C. Airline Details |
1-3 |
transportInformation |
|
|
1. Airline Designator Code (can be a real carrier code or YY or 7YY for shopper display) |
2-3 an |
1 |
transportService/ companyIdentification/ marketingCompany |
|
2. Frequent Flyer process qualifier AI : Frequent flyer |
1-3 an |
1 |
selectionDetail/ selectionDetails/ option |
|
D. Cabin Details and Reservation Booking Designator Details - SET1 |
1 |
transportInformation/ availCabinConf |
|
|
1. Cabin/booking qualifier SB : Booking SC : Cabin |
1-3an |
1 |
productDetailsQualifier |
|
2. Cabin or Reservation Booking Details |
1-3 |
bookingClassDetails |
|
|
a. Cabin or Reservation Booking Designator |
1 a |
1 |
designator |
|
b. Reservation Booking Designator Modifier |
1 an |
1 |
option |
|
E. Cabin Details and Reservation Booking Designator Details - SET2 |
1 |
availCabinConf |
|
|
1. Cabin/booking qualifier SB : Booking SC : Cabin |
1-3an |
1 |
productDetailsQualifier |
|
2. Cabin or Reservation Booking Details |
1-3 |
bookingClassDetails |
|
|
a. Cabin or Reservation Booking Designator |
1 a |
1 |
designator |
|
b. Reservation Booking Designator Modifier |
1 an |
1 |
option |
|
F. Currency Details |
2 |
conversionRate/ conversionRateDetails |
|
|
1. Currency |
1-3 an |
currency |
|
|
2. Currency option FC : Currency selection FS : Currency conversion |
3 an |
conversionType |
|
|
G. Fare and Passenger Type Details |
1 |
flightQualification |
|
|
1. Request Type (APX, CNX, EXC, CH, GRP, ZZ, …) |
2-3 an |
1-3 |
fareCategories/fareType1 fareCategories/fareType2 fareCategories/fareType3 |
|
2. Expanded Parameters NPE : No penalty information NDA : No day or time information NMX : No maximum stay information NMN: No minimum stay information NAP: No advance purchase information PE : Penalty information NR : No restriction NMM : No minimum and no maximum fare NRF : Non refundable fares RF : Refundable fares |
2-3an |
1-6 |
fareCategories/otherFareType |
|
3. Global Direction (7AF, 7AP, 7AT, 7CA, 7CF, 7CT, 7DO, 7EH, 7EM, 7EU, 7FE, 7ME, 7NP, 7PA, 7PE, 7PN, 7PO, 7RW, 7SA, 7SN, 7SP, 7TB, 7TS,7TT, 7US, 7WH) |
1-3 an |
movementType |
|
|
4. Fare options |
1-9 |
fareOptionDetails |
|
|
4.1. Option 772 : Fares shown from lowest to highest 756 : One-way fares only 763 : Round-trip fares only 733 : Half round-trip fares only 784 : Unsaleable fares only NYY : Carrier Fares only, no IATA common fares 734 : IATA fares participating to a carrier or a list of carriers 707 : Add tax 705 : Withhold tax AOB : Add fees XOB : Withhold fees XS : Swedish VAT in Swedish dom ADR : All Date restrictions EXT : Asean Extension fares |
2-3 an |
fareQualifier |
|
|
H. Ticketing/Pricing Details |
1 |
pricingTickInfo |
|
|
1. Ticketing Date (For Past/future date request) |
6 n |
productDateTimeDetails/ ticketingDate |
|
|
2. Non corporate Unifare Details |
1 |
priceTicketDetails |
|
|
2.1. Qualifier RP : Publish fare RU : Unifare |
1-3an |
1-20 |
indicators |
|
I. Corporate Unifare Details |
1 |
multiCorporate/ corporateId |
|
|
1. Qualifier RU : Unifare |
1-3an |
1 |
corporateQualifier |
|
2. Corporate Number/Name |
1-12an |
1-6 |
identity |
|
J. Rule of negotiated fare (Cat 35) |
1 |
fareRule/ tarifFareRule |
|
|
1. Rule number |
1-4n |
tariffClassId |
|
|
K. Service Fee Management Details (/PS-psr_nb) |
1 |
pricingTickInfo |
|
|
1. Option indicator (PS) |
1-3an |
1 |
priceTicketDetails/ indicators |
|
2. PSR number |
1-8n |
1 |
idNumber |
The service returns:
Each fare group contains:
For each fare, the service returns:
|
FUNCTIONAL DATA |
FORMAT |
REP |
XML ELEMENT |
|
A. Message Action Details |
|||
|
1. Message Identifier |
1-3 an |
1 |
transactionType/ messageFunctionDetails/ messageFunction |
|
B. Free text messages: There is one infoText per message type: - Validity messages (tax / surcharge / fee info) - Carrier list/Carrier participating messages - Special fare/routing information messages - More fare Available messages - Number of fares Limitation messages - Additional city pair information |
C |
999 |
infoText |
|
1. Message subject qualifier CAR : List of carriers (with 732/NYY/733) APT : Airport message (with 736) SPC : Special fare / routing information message HED : Header message (others, like tax/charge info) |
1-3 an |
1 |
freeTextQualification/ textSubjectQualifier |
|
2. Message type qualifier - 732 : List of carriers - NYY : Non YY carrier list - 733 : YY carrier list - 736 : Additional city pair information - 734 : Surcharge information - 738 : More fares available - 739 : No fare on this market/carrier - 740 : No fare for currency |
1-3 an |
1 |
freeTextQualification/ informationType |
|
3. Text This data contains : - 1 carrier, - or 1 city (origin first and destination then) , - or 1 currency - or 1 portion of text message if length greater than 70 characters. |
1-70 an |
99 |
freeText |
|
C. Fare Groups (markets, route, ...) |
C |
1-9 |
flightDetails |
|
|
|
|
|
|
a. Trip/Journey Information Details |
C |
1 |
odiGrp |
|
1. Origin |
3-5 an |
originDestination/ origin |
|
|
2. Destination |
3-5 an |
originDestination/ destination |
|
|
3. Begin / End Date (format DDMMYY) |
2 |
flightDateAndTime/ dateAndTimeDetails |
|
|
3.1. Date qualifier A : Not valid after (End) B : Not valid before (Begin) |
1-3 an |
qualifier |
|
|
3.2. Date (DDMMYY) |
6 n |
date |
|
|
b. Airline Details |
C |
1 |
transportService/ companyIdentification |
|
1. Airline Designator Code |
2-3 an |
1 |
marketingCompany |
|
c. Currency Details |
C |
1-20 |
amountConversion/ conversionRateDetails |
|
1. Currency |
1-3 an |
currency |
|
|
2. Rate type (ROE, ...) |
1-3 an |
rateType |
|
|
3. Rate amount |
1-18 n |
pricingAmount |
|
|
4. Rounding unit |
1-18 an |
measurementValue |
|
|
5. Rounding direction 700 : Up 701 : Down 702 : Closest/Nearest |
1-3 an |
measurementSignificance |
|
|
6. Currency / conversion Qualifier (fares currency or conversion currency, or more fares available in currency) 700 : fares currency = currency in the header message line with conversion info from nuc 707 : equivalent conversion currency: the currency the fares are displayed in, if different from the previous one 706 : alternative currency: used for each other possible currencies of the see line |
1-3 an |
conversionType |
|
|
d. Fare Details |
C |
1 |
qualificationFareDetails |
|
1. Global Direction |
1-3 an |
movementType |
|
|
2. Fare Category Code Request Type (NSP, PEX, ...) or fare category and type of fare : 728, Cabotage |
2-3 an |
1-9 |
fareCategories/ fareType |
|
e. Corporate name |
1-35 an |
1 |
pricingAndDateInfo/ idNumber |
|
f. Mileage Information Details |
C |
1-3 |
quantityValue/ quantityDetails |
|
1. Mileage Quantity |
1-5 n |
value |
|
|
2. Mileage Indicator (TPM or MPM) 701 (TPM) or 700 (MPM) |
1-3 an |
qualifier |
|
|
g. Free text information |
C |
1-20 |
flightErrorCode |
|
1. Text |
9 |
freeText |
|
|
2. Message subject qualifier - HED : Header message |
1-3 an |
1 |
freeTextQualification/ textSubjectQualifier |
|
3. Message type qualifier 735 : See info note |
1-4 an |
1 |
freeTextQualification/ informationType |
|
h. Fare routing details |
|
1 |
fareRouteGrp |
|
1. Routing number |
1 |
fareRouteInfo/ identificationNumber |
|
|
D. Fare details |
|
1-500 |
itemGrp |
|
a. Line Number |
1-3 an |
1 |
itemNb/ itemNumberDetails/ number |
|
|
|
|
|
|
b. Airline Details |
|
1 |
transportServiceItem/ companyIdentification |
|
1. Airline Designator Code |
2-3 an |
marketingCompany |
|
|
c. Reservation Booking Designator Details |
|
1 |
productAvailabilityStatus |
|
1. Reservation booking designator |
1 a |
bookingClassDetails/ designator |
|
|
2. Reservation booking designator modifier |
1 an |
bookingClassDetails/ option |
|
|
3. Booking qualifier 742 : Check rules |
1-3an |
productDetailsQualifier |
|
|
d. Fare Qualifier Details |
|
1 |
fareQualifItem |
|
1. Fare Basis Code |
1-10 an |
additionalFareDetails/ rateClass |
|
|
2. Fare Qualifier Sales restrictions indicators : 789 : Ticket/travel future effective data change 792 : Same day effective date change 784 : unsalable fare 723 : fare is add-on constructed Type of Fare: RA : ATPCO nego fares CAT35 RB : ATPCO nego corporate fares RC : Amadeus Nego Corporate Fares RD : Dynamic Discounted Fares RN : Amadeus Nego Fares RP : Published fares RV : ATPCO private fares CAT15 RX : Corporate ATPCO private fares CAT15 RZ : Corporate Dynamic Discounted Fares Default: Publised fare
Routing/mileage indicator: 724 : mileage 725 : routing Other indicators: Web fares indicator : W |
2-3 an |
1-9 |
discountDetails/ fareQualifier |
|
e. Fare Display Details |
|
1 |
monetaryGrp |
|
1. Fare Amount |
20 |
monetaryValues/ monetaryDetails |
|
|
1.1. Fare Amount Qualifier 700 : OW 701 : RT O01 : OB fees for round trip O00 : OB fees for One Way T01 : Total taxes for round trip T00 : Total taxes for one way |
1-3 an |
1 |
typeQualifier |
|
1.2. Fare amount value |
1-11 n |
1 |
amount |
|
2. Fare Qualifier aggregate |
1-3 an |
1-20 |
qualifGrp/ qualificationFare |
|
2.1. Fare Qualifiers (penalty, min/max stay, advance purchase, dates, days) |
1-9 |
discountDetails |
|
|
2.1.1. Fare Qualifier - Penalty : 798 : subject to cancel penalties (+ amount ) 740 : percentage (+percentage) 741 : not refundable 736 : refundable (+ check rule) Default: no penalty restriction - Min/Max stay 745: min stay in days (+ days) 746: max stay in days(+ days) 794: maximum stay in months (+ months) MNR: min stay restrictions (+ Check rules) MXR: max stay restrictions (+ Check rules) MNM: min stay in months (+ months) BMN: min stay more than 365 days BMX: max stay more than 365 days Default: No min max stay restriction - Advance purchase 702 : advances purchase period (+ days + check rules) Default: no advance purchase restriction - Days 726 : Fare restricted to certain days (+ days + check rules (hours, …) Default: no day restriction - Seasonality 766 : seasonality (+Dates) 767 : seasonality on outbound (+Dates) 768: seasonality on inbound (+Dates) TBT: trip by trip indicator Default: no seasonality restriction - Sales restriction 775 : TICKET ONLY ON THIS DATE 776 : TICKET ON OR AFTER THIS DATE 777 : TICKET ON OR BEFORE THIS DATE Default: no sales restriction - Travel restriction dates 782 : COMPLETE ALL TRAVEL BY THIS DATE 783 : ORIGINATE TRAVEL ON OR BEFORE THIS DATE 761 : FINAL TRAVEL MUST COMMENCE BY THIS DATE 786 : TRAVEL EFFECTIVE ON OR AFTER THIS DATE Default: no travel restriction - FARE AND/OR ARBITRARY ZONE FILE 787 : FARE CANCELLED ON THIS DATE 788 : MODIFIED FARE 789 : TICKET/TRAVEL – FUTURE EFF. DATE CHANGE - Blackout 708: blackout/flight application restrictions - Check rules 742 : check rules |
1-3 an |
fareQualifier |
|
|
2.1.2. penalty percentage |
1-3 n |
percentage |
|
|
2.1.3. penalty amount |
1-3 n |
amount |
|
|
B. Details for fare qualifiers aggregate |
1-7 |
qualifSelection/ selectionDetails |
|
|
a. detail value MO : Monday TU : Tuesday WE : Wednesday TH : Thursday FR : Friday SA : Saturday SU : Sunday Number of days, months, weeks |
1-3 an |
1 |
optionInformation |
|
b. detail qualifier 701 : day(s) of week 700 : days 704 : months 702 : Hours 705 : weeks |
1-3 an |
1 |
selectionDetails/ option |
|
C. Dates for fare qualifiers aggregate |
1-20 |
qualifDateFlightMovement/ dateAndTimeDetails |
|
|
a. Date |
4-6 n |
date |
|
|
|
|
|
|
|
f. Fare Display Routing |
|
1 |
farerouteGrp |
|
1. Route number |
1-7n |
infoForFareRoute/ identificationNumber |
|
|
2. Routing info indicators 742 : check rule (no routing info available) |
1-3an |
1-3 |
infoForFareRoute/ fareQualifierDetails/ fareQualifier |
|
3. Via Point |
3-5an |
1-99 |
finalOdiGrp/ lastOdiRoutingInfo/ routingDetails/ station |
In case of error, 2 information are returned:
This example shows a query with origin and destination city/airport provided:
The service returns:
The fare group contains:
For each fare the service returns:
Corresponding cryptic : FQD PAR LON
See "Error Messages" section.
This example shows a query with origin, destination and a specific airline provided:
The service returns 2 fare groups: one for airline IB and one for common fares (YY).
Corresponding cryptic : FQD LON NYC /AIB
See "Error Messages" section.
This example shows a query with origin, destination, specific airline and no IATA common fare provided:
The service returns one fare group for airline IB.
Corresponding cryptic : FQD LON NYC /A-IB
See "Error Messages" section.
This example shows a query with origin, destination and three airlines:
The service returns the fares from the three airlines.
Corresponding cryptic : FQD LON NYC /ALH,AF,BA
See "Error Messages" section.
This example shows a query with origin, destination and common fares only:
The service returns one fare group for common fares (YY).
Corresponding cryptic : FQD LON NYC /AYY
See "Error Messages" section.
This example shows a query with origin and destination city/airport and a specific date
See "Error Messages" section.
This example shows a query with origin and destination city/airport and outbound and inbound travel date
Corresponding cryptic : FQD LON NYC /D27JUL11*15AUG11
See "Error Messages" section.
This example shows a query with origin and destination city/airport and range of travel date
Corresponding cryptic : FQD LON NYC /D27JUL11**15AUG11
See "Error Messages" section.
Example of request with :
Ticketing date: 27May11
Travel date: 14July11
Corresponding cryptic : FQD LONNYC/D14AUG11/R,07JUL11
See "Error Messages" section.
Only one booking code can be specified.
Example of query with:
Origin : LON
Destination : NYC
booking code : Y
The service returns the fares with Y as booking code.
Corresponding cryptic : FQD LON NYC /CY
See "Error Messages" section.
Up to 3 cabin can be specified in the request.
Example of query with:
Origin : LON
Destination : NYC
Carrier : LH
Cabin : F (First)
Corresponding cryptic : FQD LON NYC /ALH /KY
See "Error Messages" section.
Example of Shopper display with:
Corresponding cryptic : FQD LON NYC /S
See "Error Messages" section.
In the query, we can specify the following fare options:
In this example, we request one-way fares only (756).
Only one way fares will be returned by the service.
Corresponding cryptic : FQD LON NYC /IO
See "Error Messages" section.
This example shows a query with :
The service returns :
Corresponding cryptic : FQD PAR FRA /CY /ALH /R,FA
See "Error Messages" section.
This example shows a query with :
Corresponding cryptic : FQD PAR FRA /ALH /R,FX
See "Error Messages" section.
This example shows a query with :
Corresponding cryptic : FQD LON NYC /IDD
See "Error Messages" section.
The service allows to add Taxes if not included by default.
This example shows a query with :
The service returns :
Corresponding cryptic : FQD LON NYC /ALH /CY /R,AT
See "Error Messages" section.
This example shows a query with :
The service converts the amount of the returned fares in NUC.
Corresponding cryptic : FQD LON NYC /CY /R,FC-NUC
See "Error Messages" section.
This example shows a query with origin:
The service returns the fares filed in MXN currency.
Corresponding cryptic : FQD MEX ACA /AAM /R,FS-MXN
See "Error Messages" section.
Up to 3 request type codes can be requested.
This example shows a query with :
Corresponding cryptic : FQD LON NYC /AAB /CB /R,-APX-PEX-MIL
See "Error Messages" section.
This example shows a query with :
The service returns fares with advance purchase and no penalty.
Corresponding cryptic : FQD LON NYC /ABA /R,*AP-NPE
See "Error Messages" section.
The global direction can be specified in the query.
Example of query with:
Origin : LON
Destination : BKK
Global direction : TS (Trans-Siberian route)
The service returns the fares with TS as global direction.
Corresponding cryptic : FQD LON BKK /VTS
See "Error Messages" section.
This example shows a query with :
The service returns Unifare and Public Fares.
Corresponding cryptic : FQD LON NYC /R,UP
See "Error Messages" section.
This example shows a query with :
FQD FRA BER /ALH /CY /R,U*SIEMENS
See "Error Messages" section.
Up to 6 corporate codes or names can be specified.
This example shows a query with :
Origin : PAR
Destination : NCE
List of corporate codes : 000001-000002-000003-000004-000005-000006
Corresponding cryptic : FQD PAR NCE /R,U000001-000002-000003-000004-000005-000006
The SFM must be calculated with the provided Pricing Scheme Reference.
Example of query with:
Origin : PAR
Destination : LON
PS Number : PS and 12345678
Corresponding cryptic: FQD PAR LON /PS-12345678.
The SFM must be calculated with the default Pricing Scheme Reference.
Example of query with:
Origin : PAR
Destination : LON
Default PS Number : PS
Corresponding cryptic: FQD PAR LON /PS.
See "Error Messages" section.
Example of request with rule id specified in the query.
Corresponding cryptic : FQD PAR NCE /AAF /CW /IO /R,RU-FRFF,*RF
See "Error Messages" section.
This example shows a query with:
The service returns 2 fares in 1 group:
|
List of carriers for the itinerary |
Text qualifier |
CAR |
|
Type |
732 |
|
|
List of carriers |
AA, AB, AC, ... |
|
|
List of carriers NOT PARTICIPATING in YY fares |
Text qualifier |
CAR |
|
Type |
NYY |
|
|
List of carriers |
AA, AC, AF, ... |
|
|
Header message (Tax info) |
Text qualifier |
HED |
|
Free Text 1 |
MAY APPLY |
|
|
Free Text 2 |
XF |
|
|
Header message (Tax info) |
Text qualifier |
HED |
|
Free Text 1 |
EXCLUDED |
|
|
Free Text 2 |
XA 3 |
|
|
Free Text 3 |
XY 4.30 |
|
|
Header message (Tax info) |
Text qualifier |
HED |
|
Free Text 1 |
OTHER TAX MAY APPLY |
|
|
Header message (Surcharge info) |
Text qualifier |
HED |
|
Type |
734 |
|
|
Free Text 1 |
SURCHG MAY APPLY-CK RULE |
Fare group :
|
Currency conversion |
Currency |
GBP |
|
|
Rate type |
ROE |
||
|
Rate amount |
0.610352 |
||
|
Rounding unit |
1.00 |
||
|
Rounding direction |
Closest (702) |
||
|
Conversion Type |
700 |
||
|
MPM |
4149 |
|
|
|
TPM |
3458 |
|
|
|
Global direction |
AP |
|
|
|
Request Type |
NSP |
|
|
|
Airline |
BA |
|
|
|
Origin |
LON |
|
|
|
Destination |
NYC |
|
|
|
Validity dates |
Not valid before (B) |
080811 |
|
|
Not valid after (A) |
080811 |
||
|
01 |
Booking code |
S |
|
|
Airline |
BA |
|
|
|
Fare basis |
THW3UKJB |
|
|
|
Fare is mileage based |
724 |
|
|
|
Round Trip fare amount |
908 |
|
|
|
Penalty |
Non-Refundable fare |
741 |
|
|
Minimum stay |
Minimum stay in days |
745 |
|
|
check rules |
742 |
||
|
Day of week (701) |
Sunday (SU) |
||
|
Maximum stay |
Maximum stay in Months |
794 |
|
|
Months |
704 |
||
|
Number of months |
12 |
||
|
Advance purchase |
Advance purchase period |
702 |
|
|
Check rules |
742 |
||
|
Number of days (700) |
21 |
||
|
Day restriction |
Fare restricted to certain days |
726 |
|
|
Check rules |
742 |
||
|
Days (701) |
FR, SA, SU |
||
|
Seasonality |
Seasonal fare |
766 |
|
|
From |
25JUN |
||
|
To |
21AUG |
||
|
Blackout |
Blackout |
708 |
|
|
02 |
Booking code |
S |
|
|
Airline |
BA |
|
|
|
Fare basis |
THX3UKJB |
|
|
|
Fare is mileage based |
724 |
|
|
|
Round Trip fare amount |
868 |
|
|
|
Penalty |
Non-Refundable fare |
741 |
|
|
Minimum stay |
Minimum stay in days |
745 |
|
|
check rules |
742 |
||
|
Day of week (701) |
Sunday (SU) |
||
|
Maximum stay |
Maximum stay in Months |
794 |
|
|
Months |
704 |
||
|
Number of months |
12 |
||
|
Advance purchase |
Advance purchase period |
702 |
|
|
Check rules |
742 |
||
|
Number of days (700) |
21 |
||
|
Day restriction |
Fare restricted to certain days |
726 |
|
|
Check rules |
742 |
||
|
Days (701) |
MO, TU, WE, TH |
||
|
Seasonality |
Seasonal fare |
766 |
|
|
From |
25JUN |
||
|
To |
21AUG |
||
|
Blackout |
Blackout |
708 |
|
See "Error Messages" section.
This example shows a query with:
The service returns 2 fare groups :
Information messages:
|
List of carrier for the itinerary |
Text qualifier |
CAR |
|
Type |
732 |
|
|
List of carriers |
A1 |
|
|
Header message (Tax info) |
Text qualifier |
HED |
|
Free Text 1 |
TAX MAY APPLY |
|
|
Header message (Surcharge info) |
Text qualifier |
HED |
|
Type |
738 |
|
|
Free Text 1 |
MORE FARES AVAIL IN |
|
|
Free Text 2 |
USD |
Currency information
|
Currency conversion |
Currency |
EUR |
|
Rate type |
ROE |
|
|
Rate amount |
0.685142 |
|
|
Rounding unit |
1.00 |
|
|
Rounding direction |
Up (700) |
|
|
Conversion Type |
700 |
|
|
Currency conversion |
Currency |
USD |
|
Conversion Type |
706 (Private alternate currency) |
First fare group:
|
TPM (701) |
428 |
|
|
|
Global direction |
7EH |
|
|
|
Request Type |
NSP |
|
|
|
Airline |
AF |
|
|
|
Origin |
PAR |
|
|
|
Destination |
NCE |
|
|
|
Validity dates |
Not valid before (B) |
090811 |
|
|
Not valid after (A) |
090811 |
||
|
Routing number |
0101 |
|
|
|
01 |
Booking code |
W |
|
|
Airline |
AF |
|
|
|
Fare basis |
W1FFFR |
|
|
|
Fare is routing based |
725 |
|
|
|
One way fare amount |
334 |
|
|
|
Penalty |
Refundable fare |
Default |
|
|
No Minimum stay |
|
|
|
|
Maximum stay |
Maximum stay in Months |
794 |
|
|
Months |
704 |
||
|
Number of months |
12 |
||
|
No Advance purchase |
|
|
|
|
No Day restriction |
|
|
|
|
No Seasonality |
|
|
|
|
No Blackout |
|
|
|
|
Routing number |
101 |
|
|
Second fare group
|
TPM (701) |
428 |
|
|
|
Global direction |
7EH |
|
|
|
Request Type |
NSP |
|
|
|
Airline |
AF |
|
|
|
Origin |
PAR |
|
|
|
Destination |
NCE |
|
|
|
Validity dates |
Not valid before (B) |
090811 |
|
|
Not valid after (A) |
090811 |
||
|
Routing number |
0103 |
|
|
|
01 |
Booking code |
W |
|
|
Airline |
AF |
|
|
|
Fare basis |
WIMFR |
|
|
|
Fare is routing based |
725 |
|
|
|
One way fare amount |
130 |
|
|
|
Penalty |
Refundable fare |
Default |
|
|
No Minimum stay |
|
|
|
|
Maximum stay |
Maximum stay in Months |
794 |
|
|
Months |
704 |
||
|
Number of months |
12 |
||
|
No Advance purchase |
|
|
|
|
No Day restriction |
|
|
|
|
No Seasonality |
|
|
|
|
No Blackout |
|
|
|
|
Routing number |
103 |
|
|
See "Error Messages" section.
Example of output with advance purchase, Minimum and Maximum stay, dates and days restrictions.
Information message:
|
List of carrier for the itinerary |
Text qualifier |
CAR |
|
Type |
732 |
|
|
List of carriers |
AA, AB, AC, etc |
|
|
List of carriers NOT PARTICIPATING in YY fares |
Text qualifier |
CAR |
|
Type |
NYY |
|
|
List of carriers |
AA, AC, etc |
|
|
Header message (Tax info) |
Text qualifier |
HED |
|
Free Text 1 |
MAY APPLY |
|
|
Free Text 2 |
XF |
|
|
Header message (Tax info) |
Text qualifier |
HED |
|
Free Text 1 |
EXCLUDED |
|
|
Free Text 2 |
XA 3 |
|
|
Free Text 3 |
XY 4.30 |
|
|
Header message (Tax info) |
Text qualifier |
HED |
|
Free Text 1 |
OTHER TAX MAY APPLY |
|
|
Header message (Surcharge info) |
Text qualifier |
HED |
|
Type |
734 |
|
|
Free Text 1 |
SURCHG MAY APPLY-CK RULE |
Fare Group:
|
Currency conversion |
Currency |
GBP |
|
|
Rate type |
ROE |
||
|
Rate amount |
0.610352 |
||
|
Rounding unit |
1.00 |
||
|
Rounding direction |
Closest (702) |
||
|
Conversion Type |
700 |
||
|
MPM |
4149 |
||
|
TPM |
3458 |
||
|
Global direction |
AT |
||
|
Request Type |
NSP |
||
|
Airline |
BA |
||
|
Origin |
LON |
||
|
Destination |
NYC |
||
|
Validity dates |
Not valid before (B) |
100811 |
|
|
Not valid after (A) |
090712 |
||
|
01 |
Booking code |
T |
|
|
Airline |
BA |
||
|
Fare basis |
TKW3UKJB |
||
|
Fare is mileage based |
724 |
||
|
Round Trip fare amount |
731 |
||
|
Penalty |
Non-Refundable fare |
741 |
|
|
Minimum stay |
Minimum stay in days |
745 |
|
|
check rules |
742 |
||
|
Day of week (701) |
Sunday (SU) |
||
|
Maximum stay |
Maximum stay in Months |
794 |
|
|
Months |
704 |
||
|
Number of months |
12 |
||
|
Advance purchase |
Advance purchase period |
702 |
|
|
Check rules |
742 |
||
|
Number of days (700) |
21 |
||
|
Day restriction |
Fare restricted to certain days |
726 |
|
|
Check rules |
742 |
||
|
Days (701) |
FR, SA, SU |
||
|
Seasonality |
Seasonal fare |
766 |
|
|
From/To |
22AUG-23OCT |
||
|
From/To |
17DEC-24DEC |
||
|
From/To |
01APR-22JUN |
||
|
Blackout |
Blackout |
708 |
|
See "Error Messages" section.
This example shows a query with:
Description of the reply:
|
List of carrier for the itinerary |
Text qualifier |
CAR |
|
Type |
732 |
|
|
List of carriers |
AA, AB, AC, ... |
|
|
List of carriers NOT PARTICIPATING in YY fares |
Text qualifier |
CAR |
|
Type |
NYY |
|
|
List of carriers |
AA, AC, ... |
|
|
Header message (Tax info) |
Text qualifier |
HED |
|
Free Text 1 |
TAX MAY APPLY |
|
|
Header message (Surcharge info) |
Text qualifier |
HED |
|
Type |
734 |
|
|
Free Text 1 |
SURCHG MAY APPLY-CK RULE |
|
Currency conversion |
Currency |
GBP |
|
Rate type |
ROE |
|
|
Rate amount |
0.685142 |
|
|
Rounding unit |
1.00 |
|
|
Rounding direction |
Up (702) |
|
|
Conversion Type |
700 |
|
MPM (700) |
5128 |
|
|
TPM (701) |
4274 |
|
|
Global direction |
AP |
|
|
Request Type |
NSP |
|
|
Airline |
AF |
|
|
Origin |
PAR |
|
|
Destination |
FDF |
|
|
Message |
Text qualifier |
HED |
|
Type |
735 |
|
|
Text |
*AIR FRANCE*MISCELLANEOUS INFORMATION SEE INFO NOTE AF/0001 |
|
|
Validity dates |
Not valid before (B) |
090811 |
|
Not valid after (A) |
090811 |
|
Booking code |
Z |
|
|
Airline |
AF |
|
|
Fare basis |
ZPRFR1 |
|
|
Fare is routing based |
725 |
|
|
Round Trip fare amount |
2205 |
|
| Routing number | 742 |
|
|
Penalty |
Non-Refundable fare |
741 |
|
Minimum stay |
Minimum stay in days |
745 |
|
check rules |
742 |
|
|
Day of week (701) |
Sunday (SU) |
|
|
Maximum stay |
Maximum stay in Months |
794 |
|
Months |
704 |
|
|
Number of months |
1 |
|
|
Advance purchase |
Advance purchase period |
702 |
|
Check rules |
742 |
|
|
Number of days (700) |
14 |
|
|
Sales restrictions |
TICKET ON OR AFTER THIS DATE |
776 / 27MAY |
|
TICKET ON OR BEFORE THIS DATE |
777 / 11AUG |
See "Error Messages" section.
This example shows an outputfor a US/CAN domestic fare display.
The service returns for each fare the detail of the routing by city/airport code.
For fare 01 : ATL, BDL, BOS, CVG, DTT, FLL, IND, MEM, MSP, ORL, TPA, WAS.
For fare 02 : ATL, BOS, CVG, DTT, MEM, ORL, RDU, WAS.
See "Error Messages" section.
The ConvertCurrency PSP-Service is used to convert currencies under different conditions, based on theoptions input by the user:
The ConvertCurrency PSP-Service is also used to display all stored conversion rates: BSR, BBR and ICHrates between two currencies.
In the input, at least one of the two currencies (Origin or Destination currency) has to be specified. Bydefault, the other is the local currency of the user office.A currency can be specified with:
An optional conversion option can be specified to use a stored rate of conversion. The user can requesta conversion :
If, according to the input, a conversion at the BSR is requested, and this rate is not available in thedatabase and the conversion is not between a hard and a soft currency, the conversion will beprocessed at the ICH rate. As a result, the output displays a conversion at the ICH rate plus anadditional warning message indicating that the requested BSR rate is not available.
If the BSR rate is not available for such conversion, the processing takes a two-step approach toachieve a conversion:
If no conversion rate is specified, default conversion rate used is BSR only.
If no conversion rate is specified, default conversion rates used are BSR, BBR and ICH.
The limitations are:
or if it is a decimal amount with more decimals than the number of commercial decimal of the currency,
No conversion is processed and a reject message VERIFY AMOUNT will be displayed.
or if it is a decimal rate with more than 11 digits,
No conversion is processed and a reject message VERIFY AMOUNT will be displayed.
None
Not applicable
Not applicable
The queries for the ConvertCurrency function are explained with data element examples in the following chapters.
It is important to note that the examples, in each chapter, are illustrations only and are meant to provide the basis for a better understanding on which fields are mandatory for basic operation utilization. It is not a full explanation of every field that can be used for the operation, but rather a guideline to its use.
Note that, for each input, a note (M) is added to indicate if it is mandatory. In case no note is added, the input is optional.
If no reject message is generated, the following information is provided:
Once for the Transaction:
Per Currency (Origin / Destination / Intermediate, if any)
Per Rounding type (rounding of fare / rounding of other charges):
Per currency process (convert From / convert To / convert Via, if any):
Per conversion rate used in the transaction:
Per Amount type (amount Rounded As Fare / Rounded As Charges / Truncated):
If a Fare Quote reject message is generated, then only this reject message is sent back globally.
Conversion of 100 euro into the currency of United States
The following rejects occurs when data specified in the request is not valid, although it is compatible with the message definition
Usual reject examples:
| ERROR MESSAGE | DESCRIPTION |
|---|---|
| VERIFY CURRENCY |
|
| VERIFY COUNTRY CODE |
|
| VERIFY CITY |
|
| INVALID FORMAT |
|
| FUTURE DATE NOT PROCESSED |
|
| PAST DATE MUST BE WITHIN A RANGE OF ONE YEAR |
|
| INVALID DATE |
|
| VERIFY AMOUNT |
|
Conversion of an amount of 52 from the currency of Orly airport to NUC (Neutral Unit of Construction) at the date of 27May07.
ORY
See "Error Messages" section.
Conversion of an amount of 1300 from the currency of Rio de Janeiro (city ISO code: RIO) to CHF, at a userrate of 66.55.
RIO
See "Error Messages" section.
Conversion of 520.30 EUR (Euro) in GBP (Pound Sterling)
See "Error Messages" section.
Conversion of 520.30 EUR in UNITED STATES currency, via all rates
See "Error Messages" section.
Convert Great Britain Pounds into Norwegian Krones at the rate of February, 15th, 2007.
See "Error Messages" section.
As there is no amount to convert specified in the query, it will only display all rates available to convert the first currency into the second currency.
See "Error Messages" section.