OrderRules 19.2
Attachments:
Introduction
This OrderRules service returns fare rules per fare category on the requested origin and destination for the particular travel date.
OrderRules Webservice
Limitations (This list is not exhaustive):
- Fare rules must be requested per fare component.
This web service is called with the following inputs:
Origin airport
- Departure date
- Destination airport
- Fare basis code
The output data this service returns include:
- Departure date
- Destination airport
- Fare basis code
- Fare rule category
- Fare category text
Access
In order to access API, you will need to pass the following two headers for each call.
Authentication and authorization stand on the protocol layer using basic HTTP authentication. Given username and password with separator “:” MUST be base64-encoded and passed as HTTP header “Authorization”. This header is mandatory for all requests. For example, if "TestLogin" set as the username and "TestPass" set as the password, then the field's value is base64-encoding of TestLogin: TestPass, or QWxhZGRpbjpPcGVuU2VzYW1l. Then the Authorization header will appear as Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l
- Header 'Content-Type: text/xml'
- Message structure: <soapenv:Envelope><soapenv:Body> Message... </soapenv:Body></soapenv:Envelope>
OrderRulesRQ structure
<IATA_OrderRulesRQ xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderRulesRQ" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderRulesRQ NDC/19_2_schemas/IATA_OrderRulesRQ.xsd"> <MessageDoc> <RefVersionNumber>19.2</RefVersionNumber> </MessageDoc> <Party> <Sender> <TravelAgency> <AgencyID>TA123</AgencyID> <Name>TravelAgent</Name> <PseudoCityID>IEVPS28ND</PseudoCityID> </TravelAgency> </Sender> </Party> <Request> <CoreRequest> <FareRef> <AirlineDesigCode>PS</AirlineDesigCode> <Arrival> <IATA_LocationCode>CDG</IATA_LocationCode> </Arrival> <Dep> <AircraftScheduledDateTime>2021-01-16</AircraftScheduledDateTime> <IATA_LocationCode>KBP</IATA_LocationCode> </Dep> <FareBasisCode>PL02PPU5</FareBasisCode> </FareRef> </CoreRequest> </Request> </IATA_OrderRulesRQ>
OrderRulesRQ fields description
M = Mandatory; O = Optional; C = Conditional
Field name | Description | M/O/C | Example |
---|---|---|---|
IATA_OrderRulesRQ | The IATA_OrderRulesRQ transaction set requests the cancellation of specified order and returns confirmation of cancellation. | M | <IATA_OrderRulesRQ xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderRulesRQ" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderRulesRQ NDC/19_2_schemas/IATA_OrderRulesRQ.xsd"> |
↳ MessageDoc | NDC Message Document information. | M | |
↳ RefVersionNumber | Service Version. | M | <RefVersionNumber>19.2</RefVersionNumber> |
↳ Party | NDC Message/ Transaction Party(s) information. Note that information about parties is intended for business use, it is not intended for transaction authentication and routing of the message. | M | |
↳ Sender | Information related to the party sending this message. | M | |
↳ TravelAgency | SELLER: Travel Agency | M | |
↳ AgencyID | Unique Agency Seller ID. Example: TA123 | M | <AgencyID>TA123</AgencyID> |
↳ Name | Agency name. Example: Carson Travel | M | <Name>TravelAgent</Name> |
↳ PseudoCityID | Travel Agent's Office ID. | M | <PseudoCityID>IEVPS28ND</PseudoCityID> |
↳ Request | Message payload information. | M | |
↳ CoreRequest | Allows for the querying of rules based on Filed Fare information. | M | |
↳ FareRef | To be used when requesting filed fare information as part of this request. | M | |
↳ AirlineDesigCode | Airline code assigned to a carrier. | M | <AirlineDesigCode>PS</AirlineDesigCode> |
↳ Arrival | The action or process of arriving of a transport vehicle in any place or location. | M | |
↳ IATA_LocationCode | IATA defined code identifying a city or station. | M | <IATA_LocationCode>CDG</IATA_LocationCode> |
↳ Dep | The action or process of leaving of a transport vehicle from any place or location. | M | |
↳ AircraftScheduledDateTime | The Scheduled Date of Arrival of the aircraft at the terminal or departure gate at an airport. | M | <AircraftScheduledDateTime>2021-01-16</AircraftScheduledDateTime> |
↳ IATA_LocationCode | IATA defined code identifying a city or station. | M | <IATA_LocationCode>KBP</IATA_LocationCode> |
↳ FareBasisCode | Fare basis code. | M | <FareBasisCode>PL02PPU5</FareBasisCode> |
OrderRulesRS structure
<IATA_OrderRulesRS xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderRulesRS" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderRulesRS ../NDC/19_2_schemas/IATA_OrderRulesRS.xsd"> <Response> <Rules> <AirlineDesigCode>PS</AirlineDesigCode> <Arrival> <IATA_LocationCode>PRG</IATA_LocationCode> </Arrival> <Dep> <AircraftScheduledDateTime>2021-01-16T00:00:00.000</AircraftScheduledDateTime> <IATA_LocationCode>KBP</IATA_LocationCode> </Dep> <FareRule> <FareRuleText> <RemarkText>FOR X002LLU1 TYPE FARES ECONOMY LITE FARES WITH ONE HAND BAGGAGE UP TO 7KG. CHECKED BAGGAGE NOT INCLUDED. APPLICATION AREA THESE FARES APPLY BETWEEN EUROPE AND UKRAINE. CLASS OF SERVICE THESE FARES APPLY FOR ECONOMY CLASS SERVICE. TYPES OF TRANSPORTATION THIS RULE GOVERNS ONE-WAY AND ROUND-TRIP FARES. FARES GOVERNED BY THIS RULE CAN BE USED TO CREATE ONE-WAY/ROUND-TRIP/OPEN-JAW JOURNEYS.</RemarkText> </FareRuleText> <RuleCode>RU</RuleCode> </FareRule> <FareRule> <FareRuleText> <RemarkText>FOR X002LLU1 TYPE FARES TRAVEL FROM LAST STOPOVER MUST COMMENCE NO LATER THAN 3 MONTHS AFTER DEPARTURE FROM FARE ORIGIN.</RemarkText> </FareRuleText> <RuleCode>MX</RuleCode> </FareRule> <FareRule> <FareRuleText> <RemarkText>FOR X002LLU1 TYPE FARES TICKETS MUST BE ISSUED ON PS . *** GENERAL RULE FOLLOWS *** TICKETS MAY NOT BE SOLD IN IRAN,ISLAMIC REPUBLIC OF.</RemarkText> </FareRuleText> <RuleCode>SR</RuleCode> </FareRule> <FareRule> <FareRuleText> <RemarkText>FOR X002LLU1 TYPE FARES RESERVATIONS ARE REQUIRED FOR ALL SECTORS. NOTE - FOR TICKETING DEADLINE PLEASE SEE AUTOMATED MESSA GE IN YOUR PNR</RemarkText> </FareRuleText> <RuleCode>AP</RuleCode> </FareRule> <FareRule> <FareRuleText> <RemarkText> THE FARE COMPONENT MUST BE ON ONE OR MORE OF THE FOLLOWING PS FLIGHTS 0001 THROUGH 1999 OPERATED BY PS ANY 9B FLIGHT.</RemarkText> </FareRuleText> <RuleCode>FL</RuleCode> </FareRule> <FareRule> <FareRuleText> <RemarkText>FOR X002LLU1 TYPE FARES 1ST INFANT UNDER 2 WITHOUT A SEAT - CHARGE 10 PERCENT OF THE FARE. TICKET DESIGNATOR - IN AND PERCENT OF DISCOUNT.</RemarkText> </FareRuleText> <RuleCode>CD</RuleCode> </FareRule> <FareRule> <FareRuleText> <RemarkText>FOR X002LLU1 TYPE FARES 1 FREE STOPOVER PERMITTED ON THE PRICING UNIT. A STOPOVER MAY NOT EXCEED 48 HOURS.</RemarkText> </FareRuleText> <RuleCode>SO</RuleCode> </FareRule> <FareRule> <FareRuleText> <RemarkText> UNLIMITED TRANSFERS PERMITTED ON THE PRICING UNIT FARE BREAK AND EMBEDDED SURFACE SECTORS NOT PERMITTED ON THE FARE COMPONENT.</RemarkText> </FareRuleText> <RuleCode>TF</RuleCode> </FareRule> <FareRule> <FareRuleText> <RemarkText> THE PROVISIONS BELOW APPLY ONLY AS FOLLOWS - TICKETS MUST BE ISSUED ON QR. A SURCHARGE OF USD 75.00 PER FARE COMPONENT WILL BE ADDED TO THE APPLICABLE FARE FOR TRAVEL. AND - A SURCHARGE OF USD 17.00 PER COUPON WILL BE ADDED TO THE APPLICABLE FARE FOR TRAVEL FOR ANY SECTOR BETWEEN LON AND IEV. PROVIDED TRAVEL IS ON ONE OR MORE OF THE FOLLOWING PS FLIGHTS 117 THROUGH 118. OTHERWISE A SURCHARGE OF USD 17.00 PER COUPON WILL BE ADDED TO THE APPLICABLE FARE FOR TRAVEL FOR ANY SECTOR BETWEEN LON AND IEV. PROVIDED TRAVEL IS ON ONE OR MORE OF THE FOLLOWING PS FLIGHTS 117 THROUGH 118.</RemarkText> </FareRuleText> <RuleCode>SU</RuleCode> </FareRule> <FareRule> <FareRuleText> <RemarkText>FOR X002LLU1 TYPE FARES THE ORIGINAL AND THE REISSUED TICKET MUST BE ANNOTATED - NONEND/NO REF/CHNG FOC - IN THE ENDORSEMENT BOX.</RemarkText> </FareRuleText> <RuleCode>TE</RuleCode> </FareRule> <FareRule> <FareRuleText> <RemarkText>FOR X002LLU1 TYPE FARES CANCELLATIONS ANY TIME TICKET IS NON-REFUNDABLE IN CASE OF CANCEL/NO-SHOW/ REFUND. NOTE - YQ IS REFUNDABLE FOR UNUSED TICKET ONLY IN CASE CANCELLATION MORE THAN 24H BEFORE DEPARTURE CHANGES ANY TIME CHANGES NOT PERMITTED IN CASE OF NO-SHOW. CHANGES PERMITTED FOR REISSUE/REVALIDATION. NOTE - UPGRADE PERMITTED TO HIGHER FARE WITHIN SAME OR HIGHER BRAND ONLY UPON PAYMENT OF THE DIFFERENCE BETWEEN FARE PAID AND HIGHER FARE --------------------------- REROUTING PERMITTED ON PS FARES ONLY WITHIN SAME OR HIGHER BRAND WITH COLLECTION ADDITIONAL TAXES/FARE AMOUNT.IF NEW FARE IS LOWER NO FARE DIFFERENCE REFUND ----------------- VOLUNTARY UPSELL TO MORE HIGHER BRAND OR CABIN PERMITTED IN CASE OF NO DATE OR FLIGHT CHANGE ------ IN SUBSEQUENTLY CHANGES AND REFUND RULES OF NEW FARE WILL BE APPLIED BUT NON-REFUNDABLE AMOUNT REMAINS NON-REFUNDABLE ------</RemarkText> </FareRuleText> <RuleCode>PE</RuleCode> </FareRule> <FareRule> <FareRuleText> <RemarkText>FROM/TO IEV FOR X002LLU1 TYPE FARES CIRCLE TRIPS NOT PERMITTED. APPLICABLE ADD-ON CONSTRUCTION IS ADDRESSED IN MISCELLANEOUS PROVISIONS - CATEGORY 23. END-ON-END END-ON-END COMBINATIONS PERMITTED WITH INTERNATIONAL FARES. VALIDATE ALL FARE COMPONENTS. SIDE TRIPS NOT PERMITTED. PROVIDED - COMBINATIONS ARE WITH ANY -LL TYPE FARES. OPEN JAWS/ROUND TRIPS FARES MAY BE COMBINED ON A HALF ROUND TRIP BASIS WITH PS FARES IN ANY RULE AND TARIFF. -TO FORM SINGLE OR DOUBLE OPEN JAWS -TO FORM ROUND TRIPS OPEN JAWS/ROUND TRIPS NOTE - IN CASE OF COMBINATION THE MOST RESTRICTIVE CONDITIONS APPLY.</RemarkText> </FareRuleText> <RuleCode>CO</RuleCode> </FareRule> <FareRule> <FareRuleText> <RemarkText> THE HIGHER INTERMEDIATE POINT RULE DOES NOT APPLY FOR STOPOVERS. NOTE - HIGHER INTERMEDIATE POINT/MILEAGE EXCEPTIONS DO NOT APPLY. DIFFERENTIAL DOES NOT APPLY. AND - THE HIGHER INTERMEDIATE POINT RULE DOES NOT APPLY FOR CONNECTIONS. NOTE - HIGHER INTERMEDIATE POINT/MILEAGE EXCEPTIONS DO NOT APPLY. DIFFERENTIAL DOES NOT APPLY. NOTE - HIGHER INTERMEDIATE POINT/MILEAGE EXCEPTIONS DO NOT APPLY. DIFFERENTIAL DOES NOT APPLY.</RemarkText> </FareRuleText> <RuleCode>HI</RuleCode> </FareRule> <FareRule> <FareRuleText> <RemarkText> THIS FARE MAY BE USED FOR ADD-ON CONSTRUCTION. THIS FARE MUST NOT BE USED AS THE HIGH OR THE LOW FARE WHEN CALCULATING A DIFFERENTIAL. THIS FARE MUST NOT BE USED AS THE THROUGH FARE WHEN PRICING A FARE COMPONENT WITH A DIFFERENTIAL. NOTE - FULL AND SEQUENTIAL USE OF FLIGHT COUPONS -- THE TICKET/ OR ELECTRONIC TICKET/ IS NOT VALID I F THE FIRST COUPON HAS NOT BEEN USED AND WILL NOT BE HONORED IF ALL THE COUPONS ARE NOT USED IN THE SEQUENCE PROVIDED IN THE TICKET/OR ELECTRONIC TICK ET/ -- CAPACITY LIMITATIONS -- THE CARRIER SHALL LIMIT THE NUMBER OF PASSENGERS C ARRIED ON ANY ONE FLIGHT AT FARES GOVERNED BY THIS RULE AND SUCH FARES WILL NOT NECESSARILY BE AVAIL ABLE ON ALL FLIGHTS. THE NUMBER OF SEATS WHICH THE CARRIER SHALL MAKE AVAILABLE ON A GIVEN FLIGHT WI LL BE DETERMINED BY THE CARRIERS BEST JUDGMENT -- FARES ARE ONLY GUARANTEED IF AUTO-PRICED AND TICKE TED IN GDS ON THE SAME DAY</RemarkText> </FareRuleText> <RuleCode>MD</RuleCode> </FareRule> <FareRule> <FareRuleText> <RemarkText>VOLUNTARY CHANGES CONDITIONS MAY APPLY FOR AUTOMATED REISSUE/REVALIDATION REFER TO PENALTIES CATEGORY *PE FOR DETAILS </RemarkText> </FareRuleText> <RuleCode>VC</RuleCode> </FareRule> <FareRule> <FareRuleText> <RemarkText>VOLUNTARY CHANGES CONDITIONS MAY APPLY FOR AUTOMATED REFUNDS REFER TO PENALTIES CATEGORY *PE FOR DETAILS </RemarkText> </FareRuleText> <RuleCode>VR</RuleCode> </FareRule> </Rules> </Response> </IATA_OrderRulesRS>
OrderRulesRS fields description
M = Mandatory; O = Optional; C = Conditional
Field name | Description | M/O/C | Example |
---|---|---|---|
OrderRulesRS | The Rules transaction set returns rules associated with an Order, including filed details of a specific fare basis code (FBC). | M | <IATA_OrderRulesRS xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderRulesRS" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderRulesRS NDC/19_2_schemas/IATA_OrderRulesRS.xsd"> |
↳ Error | Error(s) that prevented the message from processing. | C | |
↳ Code | The code corresponding to the processing error as defined by PADIS 9321. | M | <Code>911</Code> |
↳ DescText | Free text description of the provided error. | M | <DescText>Unable to process - system error / Invalid query</DescText> |
↳ Response | Message response information. | C | |
↳ Rules | M | ||
↳ AirlineDesigCode | Airline code assigned to a carrier. | M | <AirlineDesigCode>PS</AirlineDesigCode> |
↳ Arrival | The action or process of arriving of a transport vehicle in any place or location. | M | |
↳ IATA_LocationCode | IATA defined code identifying a city or station. | M | <IATA_LocationCode>CDG</IATA_LocationCode> |
↳ Dep | The action or process of leaving of a transport vehicle from any place or location. | M | |
↳ AircraftScheduledDateTime | The Scheduled Date and Time of Arrival of the aircraft at the terminal or departure gate at an airport. | M | <AircraftScheduledDateTime>2021-01-16T00:00:00</AircraftScheduledDateTime> |
↳ IATA_LocationCode | IATA defined code identifying a city or station. | M | <IATA_LocationCode>KBP</IATA_LocationCode> |
↳ FareRule | Special purchasing rules and restrictions used to differentiate fare levels from one another. | M | |
↳ FareRuleText | Additional, supplementary information about the document or service. | M | |
↳ RemarkText | Fare rule text | M | <RemarkText>BETWEEN UKRAINE AND CANADA FOR PL02PPU5 TYPE FARES TRAVEL FROM LAST STOPOVER MUST COMMENCE NO EARLIER THAN 1201AM ON THE FIRST SUN AFTER DEPARTURE FROM FARE ORIGIN OR - TRAVEL FROM LAST STOPOVER MUST COMMENCE NO EARLIER THAN 6 DAYS AFTER DEPARTURE FROM FARE ORIGIN. </RemarkText> |
↳ RuleCode | Fare category number as defined by ATPCO. | M | <RuleCode>MN</RuleCode> |
OrderRules Error/Validation Checks
PADIS Error Code | PADIS Error Text | Cases |
---|---|---|
System errors | ||
911 | Unable to process - system error | Invalid query |
486 | Unknown | The equivalent of -1 error |
304 | System Temporarily unavailable | The system is not available/HOST problem |
916 | EDIFACT version not supported | Not supported NDC service version. |
Agent authorization errors | ||
368 | Not authorized | Wrong agent authentication key. Agent is inactive |
79A | Invalid office identification | OID is missing or incorrect |
Query errors | ||
73V | Invalid PFC city/airport code | Airport/City code does not exist or missing |
914 | Invalid format/data - data does not match syntax rules | Incorrect date format |
102 | Invalid/Missing Departure Date | Departure date is missing in the query |
453 | Bulk fare(s) not supported | |
719 | No fares available | Requested fare is not available in HOST |
107 | Invalid Airline Designator/Vendor Supplier | Provided airline ID =! PS |
© 2021 SOLRING HOLDINGS LIMITED. All rights reserved.