V2User's Guide
|
V2 User's Guide |
The Powered Fares interface.
The supported functions that this interface provides are:
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 Itinerqry takes into account the full functionality available with the Amadeus cryptic transaction FQP.
The verb CheckRules is used to display fare notes after Fare Display or after Pricing transactions. (This PSP service provides the same information as the cryptic FQN transaction.)
DisplayFaresForCityPair allows to receive a list of fares available on a given market by considering certain options.
DisplayFaresForCityPair takes into account the full functionality available with the Amadeus cryptic transaction FQD.
The InformativePricingWithoutPNR function provided in the PoweredFare interface allows pricing an itinerary informatively, without any PNR.
This function provided in the Powered Fare interface allows to perform an informative Best Pricing request on an itinerary, without any PNR.
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.
The PricePNRWithBookingClass function provided in the Powered Fares interface prices the flight segments for either the selected passengers or for the entireflight itinerary in a newly created or retrieved PNR.
The PricePNRWithLowerFares function provided in the Powered Fare interface displays alist of the lowest fares for the booked itinerary.
The PricePNRWithLowestFare function provided in the PoweredFare interface allows you to display the lowest possible fare for a given itinerary.
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
CheckRules doesn't support the info-notes display (stand-alone service similar to cryptic FQN with for example FQN TAX/tax type).
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 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 FQP transaction prices itineraries with specified or open variable data such as dates and reservation booking designators. For example: if dates are not input, the date of the first segment is today's date and dates on all other segments are open.
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:
Not applicable
Not applicable
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.
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.
errorMSGs 22
Example : 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)
See "Error Messages" section.
Example : 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.
Only lowest fare option activated (pricingTktOptionGroup /pricingTicketingDetails/ priceTicketDetails/ indicators indicator to LF (Low fare finder - rebooking recommended)
Reply: One priced fare construction for every passenger. Perpassenger cheapest of a fare selection list corresponding to thecryptic FQP.
See "Error Messages" section.
Example : 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 to FRA with carrier LH.
The order of the fare construction is from the cheapest to the mostexpensive and can differ to the order in the fare selection crypticpanel.
See "Error Messages" section.
Flat Amount
See "Error Messages" section.
Percentage Amount + 2 others parameters
See "Error Messages" section.
See "Error Messages" section.
descriptionOfOperation 29
See "Error Messages" section.
See "Error Messages" section.
See "Error Messages" section.
All Taxes
See "Error Messages" section.
Withhold all Surcharges
See "Error Messages" section.
Specified Tax Display codes and Nature
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).
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).
See "Error Messages" section.
Add several Taxes
See "Error Messages" section.
Add one Taxe and Remove 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).
See "Error Messages" section.
Add / Withhold all Country Taxes (for specified countries)
Codeset to add : AC / Codeset to withhold: WC.
Warning: if 2 countries are requested after AC , only the first one is mapped
See "Error Messages" section.
Withhold all Taxes
See "Error Messages" section.
Withhold all Taxes with tax display code and tax nature
See "Error Messages" section.
Amadeus Nego request
See "Error Messages" section.
Unifares + Public fares request
See "Error Messages" section.
Unifares + Corporate Number
See "Error Messages" section.
Amadeus Nego Corporate + Public fares request
See "Error Messages" section.
Amadeus Nego + Amadeus Nego Corporate + Public fares request
See "Error Messages" section.
Unifares + Unifares Corporate number request
See "Error Messages" section.
Unifares Corporate Name request
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
See "Error Messages" section.
See "Error Messages" section.
Codeset for E-Ticket only : ET or E
Codeset for Paper-Ticket only: PT or P
See "Error Messages" section.
OB fees global option
fee type codeset possible: OB (Ticketing Fees)
2 options possibles: EX (Exempt all fees) or IN (Include all fees).
See "Error Messages" section.
OB fees detailed option
2 options possibles: 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.
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.
Origin date, city and time + Destination city
By default, the destination Date is equal to the origin Date
See "Error Messages" section.
Equipment Type + Booking Class
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 / Global Routing via a specified route-code
See "Error Messages" section.
Surface (non flight segment)
See "Error Messages" section.
Stopover after a flight segment
See "Error Messages" section.
Stopover after a Surface segment
See "Error Messages" section.
Passenger Discount code specified + Cumulative Passenger discounts
Case of Cumulative Passenger discountsBy 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.
See "Error Messages" section.
equivalent request as previous (by default Passenger Discount code is ADT )
Case of Cumulative Passenger discountsBy 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.
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
See "Error Messages" section.
Passenger Discount code specified + Multiple and Cumulative Passenger discounts
See "Error Messages" section.
Zap Off
See "Error Messages" section.
CheckRules 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
If no reject message is generated, the reply can have one of the following forms:
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
Usual reject examples:
| 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 ITM field
If many items are set in the ITM 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.
Text corresponding to one or more rules
This is the reply of the previous operation
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.
List of fare components composing a recommendation
This is the reply of the previous operation
See "Error Messages" section.
Request the list of available categories of the first fare
See "Error Messages" section.
List of available categories
This is the reply of the previous operation
See "Error Messages" section.
The Service 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 (see PSP Service Fare Notes).
The following options can be used:
Generally all options available with the cryptic transaction FQD are as well available for DisplayFaresForCityPair.
Remark all dates must be specified in format DDMMYY, e.g. 10 March 2008 is 100308
Not applicable
Not applicable
Not applicable
Date information for FQD request can be provided in 3 different ways
In case of range of dates or inbound and outbound dates, 2 dates must be provided:
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
Corporate Name Not Found
Entry not Authorised : Entry not authorized for current sign-in
See "Error Messages" section.
See "Error Messages" section.
See "Error Messages" section.
Only booking code Y
See "Error Messages" section.
See "Error Messages" section.
See "Error Messages" section.
See "Error Messages" section.
Corporate number # 000093
See "Error Messages" section.
See "Error Messages" section.
See "Error Messages" section.
See "Error Messages" section.
Ticketing date: 27May08 and travel date: 14July08
See "Error Messages" section.
See "Error Messages" section.
Example of Cryptic Input:
See "Error Messages" section.
In this example, Advance Purchase (AP) and No Penalties (NPE).
See "Error Messages" section.
Convert the amount of the returned fares in NUC
See "Error Messages" section.
Display only the fares filled in EUR.
See "Error Messages" section.
Example of Cryptic Input:
See "Error Messages" section.
Example of Cryptic Input:
See "Error Messages" section.
Both Origin and Destination city are provided
See "Error Messages" section.
Example of Cryptic Input:
See "Error Messages" section.
See "Error Messages" section.
Service Fee Management request example, with PSR number provided.
Corresponding cryptic: FQD PAR LON /MLH/PS-12345678.
Service Fee Management request , without PSR number provided.
Corresponding cryptic: FQD PAR LON /MLH/PS.
Example of Cryptic Input:
See "Error Messages" section.
See "Error Messages" section.
This example shows a
See "Error Messages" section.
Only First Cabin
See "Error Messages" section.
Example of Cryptic Input:
See "Error Messages" section.
See "Error Messages" section.
Add Taxes if not included by default
See "Error Messages" section.
Example of Cryptic Input:
See "Error Messages" section.
Negotiated and Published Fares
See "Error Messages" section.
In this example, only one way fares will be returned
See "Error Messages" section.
Example of Cryptic Input:
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.
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.
See "Error Messages" section.
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.
The InformativeBestPricingWithoutPNR function provided in the PoweredFare interface allows 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 entry.
The rules applicable for a standard Best 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.
All the pricing options that are not explicitly specified above are not supported.
In particular following options are not supported:
None.
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.
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)
This option allows to search for the best fare:
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.
- List of lower available fares
- Lowest fare for booking class
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.
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 allows to exempt either all applicable taxes, or all taxes of a given country, or specific taxes designated by their code.
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 PricePNRWithBookingClass function provided in the PoweredFares interfaceprices the flight segments for either the selected passengers or for the entire flightitinerary in a newly created or retrieved PNR.
The system prices all passengers as full fare adults and prices all segments at the lowest applicable fare(s) for the class of service booked. The class of service is obtained automatically from the PNR.Unless otherwise requested through the use of the additional pricing options,the price is by and large calculated in the currency of the origin country wherethe system (terminal) is set.
If there is only passenger and or only one fare type is applicable for an itinerary,the system displays a ticket image.
If more than one fare is applicable for an itinerary, the system displays a list ofapplicable fares from this list you can select the best fare.The system will also take into consideration the discount codes that are includedin the passenger name field.
The system will display the price for three minutes, if you do not use the information in the response within that time, you will need to generate it again.
(Discount codes, passenger type codes, and discount elements)Discount codes can be used when searching for the best and or lowest fares(a.k.a. Best buy) for an itinerary. Passenger type codes must be entered in thename fields of the PNR, or alternatively, store fare discount elements.It is possible to use PricePNRWithLowestFare (best buy) for multiple passengertypes, provided that the lowest fare per passenger is in the same class for allpassengers.A warning message is given if different booking classes apply.
It is possible to select an individual passenger in a PNR and to price their itinerary.This option is not available with the PriceWithLowestFare (Best buy).
Fares are associated with specific passenger type codes that are used to select fares.
If there are no fares for the PTC you request, the system does not price the PNR.
This option applies to fares that use automated rules, such as the Americas,Trans-Atlantic, Transpacific, Pacific and Asia.
Use this option to price only the passenger type code requested.The system does not propose any lower fares in addition to, or instead of,the fares applicable to the Passenger Type Code.
On occasions you need to include the qualifiers PAX to indicate that it is anon-infant passenger so that the appropriate discount is applied.
A lone infant passenger must be specified in the name field of the responsibleadult for the system to calculate which fare is applicable.It should be noted that some infant discounts are only applicable if the infantis traveling with an adult.If the infant qualifier is not specified an adult fare.
If a fare is published in USD, you can display and price such a fare in USD, evenif the country of commencement of travel uses another currency.When a fare is published in USD, the system provides the base fareamount in USD and calculates the equivalent amount based on the bankersselling rate (BSR) into the currency ofcommencement of travel (COC), it is not calculated via NUC.
Please note that this does not impact fares that are published in USD due to softcurrency situations, or for fares that are a combination of USD and local currency fares.
At time of pricing, you can override the default currency.A foreign currency means a currency other than that of the country of origination oftravel (COC), pricing in a foreign currency is available for everyone, but ticketingin a foreign Currency is only allowed in markets that are authorized to issuetickets in more than one currency (local currency and USD).
The international sales indicator is SITI, as the fare is considered "sold inside, ticketed inside", and the TST will be flagged with the indicator 'I', meaning automatically priced.
It is possible to choose which parts of a segment are to be included in the itinerary pricing.However it is not possible to split married segments (connecting flights) and price the segments individually.
In an itinerary will be considered as ticketed, the system assumes a surface segment when arrival and departure takes place in two different cities.
The PNRWithBookingClass function allows for the following supported operation(s):
These are the supported options that can be used to further customize your queries:
| The PricePNRWithBookingClass can process different discounts and passenger types within a PNR, provided that all passengers are booked in the same class. |
| You cannot perform PricePNRWithBookingClass pricing by passenger. If you need to passenger-select to enter discounts, select all passengers. |
| You can perform PricePNRWithBookingClass 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 PricePNRWithBookingClass 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. TBC |
| You cannot apply best buy for a stretcher passenger, where you have used the st sell command to reserve seats. TBC |
| 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. |
There are no limits to the number of pricing options that can be used in a pricingrequest, however the entire pricing entry cannot exceed 99 characters.
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
Note: the field values RLO AND RLI cannot be usedtogether in the same query requests.
RLO displays pricing for the lowest possible fare thatmatches the current itinerary (same booking codes and dates)
| /overrideInformation/attributeDetails/attributeType | RLO |
RLI displays a list of fares thatmatch the current itinerary (same booking codes and dates).
| /overrideInformation/attributeDetails/attributeType | RLI |
Not applicable.
See opening chapter - section "Prerequisite"
Depending on the flavor of the API that is used, each query will follow a given structure, The queries for the function operations are clearly explained with data element examples in a generic table view that can be adapted to the specific flavor of the API in use.
It is important to note that the examples in each chapter are only illustrations and aremeant to provide the basis for a better understanding on which fields are mandatory forbasic operation utilisation. It is not a full explanation of every field that can beutilised for the operation, but rather a guideline to its use.
A PNR with a name should be retrieved to perform the pricing transaction.
Neither the PNR nor data within is modified whatsoeverby this function.
Amadeus negotiated fares consists of a group of functions that have been integrated intothe Amadeus Fare Quote System, as a result, agents can continue to work in a familiarAmadeus setting using the same options as in fare quote and with negotiated fares.They can display, automatically price and ticket special fares offered by airlines,this is because the negotiated fares functions include fares that are cheaper thanpublished fares.These cheaper fares are set by agreements between airlines, travel agency chains,and travel agency offices.Using negotiated fares there are three different fare levels: published fares, netfares and selling fares.
Allows you to display, price, and ticket discounted fares byadding an option to the standard request
TBD - Please provide definition if appropriate
The following example allows to describe many case of pricing reply, each FareList shows a specific example:
| Message | Description |
|---|---|
| CM00005 - Check segment number | A segment with the TATTOO number specified in the REF segment is not present in the PNR |
| 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 (ATC segment) Point of sale/ticketing not a city code (3 letters) (POS segment) DPI/REF for discounts not following DPI-REF rules. |
| CM01856 - Scrolling rqst not supported | TST display request not well formatted when using scrollling option See TST display |
| CM01908 - Check passenger number | A segment with the TATTOO number specified in the REF segment is not present in the PNR |
| CM01959 - Need PNR | A request has been made without a retrieved/newly created PNR. |
| CM02032 - Invalid corporate code | The number of corporate codes specified in the ATC is greater than allowed (1corp code). |
| CM02230 - Single selection code only | Different passenger types specified in the same REF segment. |
| CM03504 - Combination not allowed | A not valid reference qualifier entered in the REF segment. Example: specify a REF in the TST display when already have a TST selection (IRV present)A not valid combination in the pricing query - /LI and /LO options |
| CM04701 - Exceeds maximum fare disc codes | More than three cumulative discount codes specified. |
| CM04725 - Invalid passenger association | Passenger selected in REF from the DPI-REF group are not selected in the global REF.See DPI-REF rules. |
| CM04070 - Unable to process + seg name | Process error - normally it shouldn't be related with data from the request - the name of theprogram 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 RCI segment does not match the retrieved PNR. |
| CM13301 - Invalid point of sale | The city qualifier in the POS segment does not correspond to a point of sale/point of tktcodeset ( normally this error should not occur). |
| CM12400 - Invalid DIAG format | Empty or blank string specified in DIAG option in "attributeDescription" field of ATC segment("override information"). |
| CM07785 - Check TRAP format | Empty or blank string specified in TRAP option in "attributeDescription" field of ATC segment("override information"). |
"Local REF" - REF segment from the group "discountInformation"
"Global Ref" - REF segment from "paxSegReference"
Rules:
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.
This example shows an added amount of tax.
See "Error Messages" section.
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 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 requesting booking date overridewith a specific date option.
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 pricing by cabin classes F, C and Y.
| F | FIRST |
| C | CLUB (BUSINESS) |
| Y | ECONOMY |
See "Error Messages" section.
This example shows a pricing by classwith preference first to F then C then default to any on flight.
See "Error Messages" section.
This example shows a pricingby cabin class, request with preference for F then C then Y.
| F | FIRST |
| C | CLUB (BUSINESS) |
| Y | ECONOMY |
See "Error Messages" section.
This example shows a default to any existing Cabin.The plus sign (+) is used to default to any other existingcabin on the flight.
See "Error Messages" section.
The exemption of all fees is requested
Equivalent Cryptic Entry: FXX /R,FX
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.
In a single request, there may be a mix of added and exempted fees
Equivalent Cryptic Entry: FXX /R,FX,FA-OBT01
See "Error Messages" section.
Specific Fees can be exempted.
Equivalent Cryptic Entry: FXX /R,FX-OBT01-OBT02-OBFCA
which means that airline ticketing fees (OB) with subcodes T01, T02 and FCA are 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 exempt tax type EE.
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.
This example shows pricing by fare basis.
See "Error Messages" section.
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.
Equivalent Cryptic Entry: FXX /R,FC123456*50-FC234567*50-FC345678
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.
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 booking code override X.
See "Error Messages" section.
This example shows a booking code override XN.
See "Error Messages" section.
This example shows a pricing on a past date, 12 May 2004.
See "Error Messages" section.
This example shows added tax as a percentage.
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 example shows a prohibit breakpoint.In order to avoid ambiguities, the REF segment is filled.
See "Error Messages" section.
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.
This example shows all taxes withheld by country code.
See "Error Messages" section.
This example shows a transfer.In order to avoid ambiguities, the REF segment is filled.
See "Error Messages" section.
This example shows a turnaround point.In order to avoid ambiguities, the REF segment is filled.
See "Error Messages" section.
Price one unifare corporate names/codes plus unifare option.
Equivalent Cryptic Entry: FXX /R,UU008310
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 Powered Fare interface displays alist of the lowest fares for the booked itinerary.You then select from the list the fare thatyou require to be used for the voyage.It is possible to use discount codes with this function for multiple passenger types.
The system displays a list of the Lowest fares for the booked itinerary, you can then choose from this list to make a manual rebooking.
(Discount codes, passenger type codes, and discount elements)Discount codes can be used when searching for the best and or lowest fares (a.k.a. Best buy) for an itinerary. Passenger type codes must be entered in the name fields of the PNR, or alternatively, store fare discount elements. It is possible to use PricePNRWithLowerFares (best buy) for multiple passenger types, provided that the lowest fare per passenger is in the same class for all passengers. A warning message is given if different booking classes apply.
Military personnel are confirmed passengers TBC
Fares are associated with specific passenger type codes that are used to select fares.Amadeus recommends that you use PTCs wherever possible, as they are more precise, for example, you can specify the age of the Passenger. It should also be noted that new PTCs are created periodically.
It is possible to choose which parts of a segment are to be included in the itinerary pricing.However it is not possible to split married segments (connecting flights) and price the segments individually.
Pricing overrides functionalities are permitted in all Amadeus Markets. However, some carriers may restrict the use of some override options, or all.
TBD
Add text - information needed
Add text - information needed
The PricePNRWithLowerFares function allows for the following supported operations:
Please refer the PricePNRWithBookingClass for other supported options.
| The PricePNRWithLowerFares can process different discounts and passenger types within a PNR, provided that all passengers are booked in the same class. |
| 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. TBC |
| You cannot apply best buy for a stretcher passenger, where you have used the st sell command to reserve seats. TBC |
| 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. |
The PricePNRWithLowerFares function does not support these options:
Please refer the PricePNRWithBookingClass for the unsupported operations.
A PNR with a name should be retrieved to perform the pricing transaction.
Depending on the flavor of the API that is used, each query will follow a given structure.The queries for the function operations are clearly explained with data element examples in a generictable view that can be adapted to the specific flavor of the API in use.
It is important to note that the examples in each chapter are only illustrations and are meant toprovide the basis for a better understanding on which fields are mandatory for basic operationutilisation, It is not a full explanation of every field thatcan be utilised for the operation, but rather a guideline to its use.
Neither the PNR nor data within is modified whatsoeverby this function.
Text Required
| Message | Description |
|---|---|
| CM00005 - Check segment number | A segment with the TATTOO number specified in the REF segment is not present in the PNR |
| 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 (ATC segment) Point of sale/ticketing not a city code (3 letters) (POS segment) DPI/REF for discounts not following DPI-REF rules. |
| CM01856 - Scrolling rqst not supported | TST display request not well formatted when using scrollling option See TST display |
| CM01908 - Check passenger number | A segment with the TATTOO number specified in the REF segment is not present in the PNR |
| CM01959 - Need PNR | A request has been made without a retrieved/newly created PNR. |
| CM02032 - Invalid corporate code | The number of corporate codes specified in the ATC is greater than allowed (1corp code). |
| CM02230 - Single selection code only | Different passenger types specified in the same REF segment. |
| CM03504 - Combination not allowed | A not valid reference qualifier entered in the REF segment. Example: specify a REF in TST display when already have a TST selection (IRV present)A not valid combination in the pricing query - /LI and /LO options |
| CM04701 - Exceeds maximum fare disc codes | More than three cumulative discount codes specified. |
| CM04725 - Invalid passenger association | Passenger selected in REF from the DPI-REF group are not selected in the global REF.See DPI-REF rules. |
| CM04070 - Unable to process + seg name | Process error - normally it shouldn't be related with data from the request - the name of theprogram 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 RCI segment does not match the retrieved PNR. |
| CM13301 - Invalid point of sale | The city qualifier in the POS segment does not correspond to a point of sale/point of tktcodeset ( normally this error should not occur). |
| CM12400 - Invalid DIAG format | Empty or blank string specified in DIAG option in "attributeDescription" field of ATC segment("override information"). |
| CM07785 - Check TRAP format | Empty or blank string specified in TRAP option in "attributeDescription" field of ATC segment("override information"). |
"Local REF" - REF segment from the group "discountInformation"
"Global Ref" - REF segment from "paxSegReference"
Rules:
Please refer the PricePNRWithBookingClass
See "Error Messages" section.
This example shows an added amount of tax.
See "Error Messages" section.
Please refer the PricePNRWithBookingClass
See "Error Messages" section.
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.
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 requesting booking date overridewith a specific date option.
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 pricing by cabin classes F, C and Y.
| F | FIRST |
| C | CLUB (BUSINESS) |
| Y | ECONOMY |
See "Error Messages" section.
This example shows a pricing by classwith preference first to F then C then default to any on flight.
See "Error Messages" section.
This example shows a pricingby cabin class, request with preference for F then C then Y.
| F | FIRST |
| C | CLUB (BUSINESS) |
| Y | ECONOMY |
See "Error Messages" section.
This example shows a default to any existing Cabin.The plus sign (+) is used to default to any other existingcabin on the flight.
See "Error Messages" section.
Please refer the PricePNRWithBookingClass
See "Error Messages" section.
Please refer the PricePNRWithBookingClass
See "Error Messages" section.
Please refer the PricePNRWithBookingClass
See "Error Messages" section.
This example shows exempt tax type EE.
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.
This example shows pricing by fare basis.
See "Error Messages" section.
Please refer the PricePNRWithBookingClass
See "Error Messages" section.
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 booking code override X.
See "Error Messages" section.
This example shows a booking code override XN.
See "Error Messages" section.
This example shows a pricing on a past date, 12 May 2004.
See "Error Messages" section.
This example shows added tax as a percentage.
See "Error Messages" section.
This transaction requests, from the reservation system, the lowestpossible fare information related to PNR itinerary.
See "Error Messages" section.
This example shows a prohibit breakpoint.In order to avoid ambiguities, the REF segment is filled.
See "Error Messages" section.
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.
This example shows all taxes withheld by country code.
See "Error Messages" section.
This example shows a transfer.In order to avoid ambiguities, the REF segment is filled.
See "Error Messages" section.
This example shows a turnaround point.In order to avoid ambiguities, the REF segment is filled.
See "Error Messages" section.
Price one unifare corporate names/codes plus unifare option.
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.
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 PricePNRWithLowestFare function provided in the PoweredFare interface allows you to display the lowest possible fare for a given itinerary. If there is only one passenger then a ticket image is displayed, alternatively if there is more than one passenger a list of passengers is displayed with their accompanying fare details.
Text Required
Display the lowest possible applicable fare and find out if there is seat availability (no rebooking)
The PricePNRWithLowestFare function allows for the following supported operations:
Please refer the PricePNRWithBookingClass for the other supported option
| The PricePNRWithLowestFare can process different discounts and passenger types within a PNR, provided that all passengers are booked in the same class. |
| You cannot perform PricePNRWithLowestFare pricing by passenger. If you need to passenger-select to enter discounts, select all passengers. |
| You can perform PricePNRWithLowestFare 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 PricePNRWithLowestFare 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. TBC |
| You cannot apply best buy for a stretcher passenger, where you have used the st sell command to reserve seats. TBC |
| 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. |
Please refer the PricePNRWithBookingClass for the unsupported operations.
A PNR with a name should be retrieved to perform the pricing transaction.
Depending on the flavor of the API that is used, each query will follow a given structure.The queries for the function operations are clearly explained with data element examples in a generictable view that can be adapted to the specific flavor of the API in use.
It is important to note that the examples in each chapter are only illustrations and are meant toprovide the basis for a better understanding on which fields are mandatory for basic operationutilisation, It is not a full explanation of every field thatcan be utilised for the operation, but rather a guideline to its use.
Neither the PNR nor data within is modified whatsoeverby this function.
Text Required
| Message | Description |
|---|---|
| CM00005 - Check segment number | A segment with the TATTOO number specified in the REF segment is not present in the PNR |
| 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 (ATC segment) Point of sale/ticketing not a city code (3 letters) (POS segment) DPI/REF for discounts not following DPI-REF rules. |
| CM01856 - Scrolling rqst not supported | TST display request not well formatted when using scrollling option See TST display |
| CM01908 - Check passenger number | A segment with the TATTOO number specified in the REF segment is not present in the PNR |
| CM01959 - Need PNR | A request has been made without a retrieved/newly created PNR. |
| CM02032 - Invalid corporate code | The number of corporate codes specified in the ATC is greater than allowed (1corp code). |
| CM02230 - Single selection code only | Different passenger types specified in the same REF segment. |
| CM03504 - Combination not allowed | A not valid reference qualifier entered in the REF segment. Example: specify a REF in TST display when already have a TST selection (IRV present)A not valid combination in the pricing query - /LI and /LO options |
| CM04701 - Exceeds maximum fare disc codes | More than three cumulative discount codes specified. |
| CM04725 - Invalid passenger association | Passenger selected in REF from the DPI-REF group are not selected in the global REF.See DPI-REF rules. |
| CM04070 - Unable to process + seg name | Process error - normally it shouldn't be related with data from the request - the name of theprogram 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 RCI segment does not match the retrieved PNR. |
| CM13301 - Invalid point of sale | The city qualifier in the POS segment does not correspond to a point of sale/point of tktcodeset ( normally this error should not occur). |
| CM12400 - Invalid DIAG format | Empty or blank string specified in DIAG option in "attributeDescription" field of ATC segment("override information"). |
| CM07785 - Check TRAP format | Empty or blank string specified in TRAP option in "attributeDescription" field of ATC segment("override information"). |
"Local REF" - REF segment from the group "discountInformation"
"Global Ref" - REF segment from "paxSegReference"
Rules:
Please refer the PricePNRWithBookingClass
See "Error Messages" section.
This example shows an added amount of tax.
See "Error Messages" section.
Please refer the PricePNRWithBookingClass
See "Error Messages" section.
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.
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 requesting booking date overridewith a specific date option.
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 pricing by cabin classes F, C and Y.
| F | FIRST |
| C | CLUB (BUSINESS) |
| W |
ECONOMY/COACH PREMIUM |
| M |
ECONOMY BUT NOT ECONOMY/COACH PREMIUM |
| Y | ECONOMY (Y = W + M) |
See "Error Messages" section.
This example shows a pricing by classwith preference first to F then C then default to any on flight.
See "Error Messages" section.
This example shows a pricingby cabin class, request with preference for F then C then Y.
| F | FIRST |
| C | CLUB (BUSINESS) |
| Y | ECONOMY |
See "Error Messages" section.
This example shows a default to any existing Cabin.The plus sign (+) is used to default to any other existingcabin on the flight.
See "Error Messages" section.
Please refer the PricePNRWithBookingClass
See "Error Messages" section.
Please refer the PricePNRWithBookingClass
See "Error Messages" section.
Please refer the PricePNRWithBookingClass
See "Error Messages" section.
This example shows exempt tax type EE.
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.
This example shows pricing by fare basis.
See "Error Messages" section.
Please refer the PricePNRWithBookingClass
See "Error Messages" section.
This example processes only the lowest available.
See "Error Messages" section.
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 booking code override X.
See "Error Messages" section.
This example shows a booking code override XN.
See "Error Messages" section.
This example shows a pricing on a past date, 12 May 2004.
See "Error Messages" section.
This example shows added tax as a percentage.
See "Error Messages" section.
This example shows a prohibit breakpoint.In order to avoid ambiguities, the REF segment is filled.
See "Error Messages" section.
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.
This example shows all taxes withheld by country code.
See "Error Messages" section.
This example shows a transfer.In order to avoid ambiguities, the REF segment is filled.
See "Error Messages" section.
This example shows a turnaround point.In order to avoid ambiguities, the REF segment is filled.
See "Error Messages" section.
Price one unifare corporate names/codes plus unifare option.
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.
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.