You can use this endpoint to retrieve the fare rules for each Offer ID. You need to send the selected offer’s Offer ID and ShoppingResponseId, as a query to retrieve the results. This is an optional service.
Schema
Document
-
Name: Provide the name for the request. This is a String value.
-
ReferenceVersion: Provide the version number. This is a Numeric value.
Party
-
Travel Agency Sender:
-
Name: Provide the name for the request. This is a String value.
-
IATA Number: Provide the IATA number for the request. This is a String value.
-
Agency ID: Provide the agency ID for the request. This is a String value.
-
Contacts:
-
EmailContact: Provide the email contact for the request. This is a String value.
-
Address: Provide the address. This is a String value.
-
-
Query
-
Offer: This is an Array.
- attributes: This is a String value.
-
ShoppingResponseId: The Shopping Response ID is a unique identifier that is generated when a customer performs a search for flights and receives a list of available options.This is the required field and the value will be String.
-
OfferID: When a customer performs a search for flights, the airline generates a list of available offers that meet the customer’s search criteria. Each offer within that list is assigned a unique OfferID. It is important to provide the correct numeric value to ensure that the system can identify the correct offer. This is the required field, and the value will be String.
-
- attributes: This is a String value.
Request URL
curl --location --request POST 'https://uat-apigateway.voyzantonline.com/AirFareRules' \
--header 'Authorization: <YOUR_ACCESS_TOKEN>' \
--header 'x-api-key: <your key here>' \
--header 'Content-Type: application/json'\
Request Body Sample
{
"FareRulesRQ": {
"Document": {
"Name": "Voyzant Portal",
"ReferenceVersion": "1.0"
},
"Party": {
"Sender": {
"TravelAgencySender": {
"Name": "Voyzant Agency",
"IATA_Number": "",
"AgencyID": "",
"Contacts": {
"Contact": {
"EmailContact": {
"Address": "pst@voyzant.com"
}
}
}
}
}
},
"Query": {
"Offer": [
{
"attributes": {
"ShoppingResponseId": "1679573644662261475",
"OfferID": "3491199111679573646717385646"
}
}
]
}
}
}
Response Sample
{
"AirFareRulesRS": {
"Document": {
"Name": "API GATEWAY",
"ReferenceVersion": "1.2"
},
"Party": {
"Sender": {
"TravelAgencySender": {
"Name": "Voyzant Agency",
"IATA_Number": "",
"AgencyID": "Voyzant Agency",
"Contacts": {
"Contact": [
{
"EmailContact": "pst@voyzant.com"
}
]
}
}
}
},
"Success": {},
"Rules": [
{
"FareBasisCode": [
{
"Code": "WFFOWAA"
}
],
"AirlineID": "LH",
"FareCode": "70J",
"Rule": [
{
"Category": "Status",
"Text": "SUCCESS"
},
{
"Category": "ItineraryId",
"Text": "3491199111679573646717385646"
},
{
"Category": "FareBasis",
"Text": "WFFOWAA"
},
{
"Category": "Departure",
"Text": "MAA"
},
{
"Category": "Arrival",
"Text": "DXB"
},
{
"Category": "Data",
"Text": {
"RULE APPLICATION": [
"Llufthansa restricted fare application area these fares apply between area 2 and area 3. class of service these fares apply for economy class service",
"Capacity limitations the carrier shall limit the number of passengers carried on any one flight at fares governed by this rule and such fares will not necessarily be available on all flights",
"The number of seats which the carrier shall make available on a given flight will be determined by the carriers best judgment other conditions sequential use of flight coupons this fare is only valid if the flights are taken in the booked sequence",
"Otherwise the fare will be recalculated based on the actual flight routing"
],
"MIN STAY": [
"No restrictions"
],
"MAX STAY": [
"No restrictions"
],
"SEASONS": [
"Applies all year"
],
"BLACKOUTS": [
"None"
],
"DAY/TIME": [
"No restrictions"
],
"SALES RESTRICT": [
"Between area 2 and area 3 if the fare component includes travel between area 2 and area 3 on one or more of the following any lh flight operated by wk tickets must be issued on lh and may not be sold in angola/iran,islamic republic of/south sudan/venezuela/ sudan/zimbabwe/egypt and may only be sold in area 1/area 2/area 3 extension of ticket validity is not permitted",
"If the fare component includes travel within area 2 on one or more of the following any lh flight operated by wk in combination with one or more of the following any lh flight tickets must be issued on lh and may not be sold in angola/iran,islamic republic of/south sudan/venezuela/ sudan/zimbabwe/egypt and may only be sold in area 1/area 2/area 3 extension of ticket validity is not permitted",
"If the fare component includes travel within area 2 on one or more of the following any lh flight operated by wk tickets must be issued on lh and may not be sold in angola/iran,islamic republic of/south sudan/venezuela/ sudan/zimbabwe/egypt and may only be sold in area 1/area 2/area 3 extension of ticket validity is not permitted",
"Otherwise tickets must be issued on lh and may not be sold in angola/iran,islamic republic of/south sudan/venezuela/ sudan/zimbabwe/egypt and may only be sold in area 1/area 2/area 3 extension of ticket validity is not permitted",
"Or tickets must be issued on os and may not be sold in angola/iran,islamic republic of/south sudan/ venezuela/sudan/zimbabwe/egypt and may only be sold in area 1/area 2/area 3 extension of ticket validity is not permitted",
"Or tickets must be issued on lx and may not be sold in angola/iran,islamic republic of/south sudan/ venezuela/sudan/zimbabwe/egypt and may only be sold in area 1/area 2/area 3 extension of ticket validity is not permitted",
"Or tickets must be issued on sn and may not be sold in angola/iran,islamic republic of/south sudan/ venezuela/sudan/zimbabwe/egypt and may only be sold in area 1/area 2/area 3 extension of ticket validity is not permitted",
"Or tickets must be issued on ac and may not be sold in angola/iran,islamic republic of/south sudan/ venezuela/sudan/zimbabwe/egypt and may only be sold in area 1/area 2/area 3 extension of ticket validity is not permitted",
"Or tickets must be issued on ua and may not be sold in angola/iran,islamic republic of/south sudan/ venezuela/sudan/zimbabwe/egypt and may only be sold in area 1/area 2/area 3 extension of ticket validity is not permitted",
"Or tickets must be issued on nh and may not be sold in angola/iran,islamic republic of/south sudan/ venezuela/sudan/zimbabwe/egypt and may only be sold in area 1/area 2/area 3 extension of ticket validity is not permitted",
"Or tickets must be issued on hr and may only be sold in burkina faso/benin/cote d'ivoire/senegal/ mauritius/libyan arab jamahiriya/yemen, republic of/cameroon extension of ticket validity is not permitted"
],
"TVL RESTRICTION": [
"No restrictions"
],
"ADVANCE RES/TKT": [
"For wffowaa type fares reservations are required for all sectors",
"When reservations are made at least 72 hours before departure ticketing must be completed within 72 hours after reservations are made",
"Or reservations are required for all sectors",
"When reservations are made at least 48 hours before departure ticketing must be completed within 48 hours after reservations are made",
"Or reservations are required for all sectors",
"Ticketing must be completed within 24 hours after reservations are made",
"Note v5 due to automated ticketing deadline control difference could exist between the fare rule last ticketing date and the system generated ticketing deadline message",
"The more restrictive ticketing deadline applies",
"Any reservation for fares with ticketing deadline not ticketed at least 26 hours before departure will be cancelled",
"This applies in addition to the above mentioned deadlines",
"Reservations made within 26 hours before departure require ticketing at the same time"
],
"FLT APPLICATION": [
"No restrictions"
],
"CHILD DISCOUNTS": [
"Accompanied child 211 charge 75 percent of the fare",
"Ticket designator ch and percent of discount",
"Note for children turning 12 years enroute children fare has to be used for the entire journey or infant under 2 with a seat charge 75 percent of the fare",
"Ticket designator ch and percent of discount or infant under 2 without a seat charge 10 percent of the fare",
"Ticket designator in and percent of discount",
"Note for infants turning 2 years enroute due to safety regulations a booked seat will be required for the remaining portions of the journey",
"When a separate seat is required on a portion of the journey child fare has to be used for the entire journey",
"Or unaccompanied child 511. id required charge 75 percent of the fare",
"Ticket designator ch and percent of discount",
"Note unaccompanied child under 5 years of age will not be accepted for carriage",
"Service charge for unaccompanied child applies"
],
"TOUR CONDUCTOR": [
"Discount does not apply"
],
"AGTS DISCOUNTS": [
"None unless otherwise specified"
],
"OTHER DISCOUNTS": [
"None unless otherwise specified"
],
"STOPOVERS": [
"For wffowaa type fares note general rule does not apply 1 stopover permitted in each direction in fra/muc/zrh/vie at eur 100.00 each",
"Child/infant discounts apply"
],
"TRANSFERS/RTGS": [
"Unlimited transfers permitted on the fare component fare break surface sectors not permitted and embedded surface sectors permitted on the fare component"
],
"SURCHARGES": [
"If infant 01 without a seat",
"There is no fuel surcharge",
"Note sale of this fare is permitted worldwide",
"This surcharge is only applicable when tickets are sold in islamic republic of iran",
"The provisions below apply only as follows tickets may only be sold in iran,islamic republic of",
"A fuel surcharge of usd 120.00 per coupon will be added to the applicable fare for any sector between europe and middle east",
"And a fuel surcharge of usd 210.00 per coupon will be added to the applicable fare for any sector between europe and africa",
"And a fuel surcharge of usd 210.00 per coupon will be added to the applicable fare for any sector between europe and area 1. and a fuel surcharge of usd 210.00 per coupon will be added to the applicable fare for any sector between europe and area 3. and a fuel surcharge of usd 45.00 per coupon will be added to the applicable fare for any sector within europe",
"And a fuel surcharge of usd 210.00 per coupon will be added to the applicable fare for any sector between middle east and africa",
"And a fuel surcharge of usd 210.00 per coupon will be added to the applicable fare for any sector between middle east and area 1. and a fuel surcharge of usd 210.00 per coupon will be added to the applicable fare for any sector between middle east and area 3. and a fuel surcharge of usd 45.00 per coupon will be added to the applicable fare for any sector within middle east",
"And a fuel surcharge of usd 210.00 per coupon will be added to the applicable fare for any sector between north america and south america",
"And a fuel surcharge of usd 210.00 per coupon will be added to the applicable fare for any sector between north america and area 3. and a fuel surcharge of usd 45.00 per coupon will be added to the applicable fare for any sector between north america and intl",
"Points in the caribbean area/central america",
"And a fuel surcharge of usd 45.00 per coupon will be added to the applicable fare for any sector within africa",
"And a fuel surcharge of usd 210.00 per coupon will be added to the applicable fare for any sector within area 3. note sale of this fare is permitted worldwide",
"This surcharge is only applicable when tickets are sold in islamic republic of iran"
],
"ELIGIBILITY": [
"No restrictions"
],
"ACCOMPANY TVL": [
"No restrictions"
],
"TKT ENDORSEMENT": [
"The original and the reissued ticket must be annotated fare restriction may apply in the endorsement box"
],
"PENALTIES": [
"Cancellations any time cancellations permitted",
"Waived for death of passenger or family member",
"Note waivers must be evidenced by death certificate refund permitted before departure in case of rejection of visa",
"Embassy statement required",
"Refund rules apply per pricing unit",
"When combining nonrefundable fares with refundable fares 1. the most restrictive cancellation condition applies to the entire pricing unit",
"2. the highest cancellation penalty within the pricing unit will be charged",
"Refund for partly used ticket if a return ticket shall be used for one way travel the difference between the return fare and the applicable one way fare will/shall be calculated",
"Applicable one way is the one way fare within the same or higher rbd",
"Any credit will be refunded less any applicable cancellation penalty",
"Child discount does not apply",
"Infant without seat free of charge",
"Refund permitted within ticket validity",
"Any original nonrefundable amount from a previous ticket remains non refundable and will be carried forward to any reissued/exchanged ticket",
"Refund of unused taxes paid to third parties permitted",
"Except for taxes that are legally nonrefundable",
"Passenger facility charges applicable to us airports with tax codes us/ zp/ xf are refundable when the fare is refundable or nonrefundable when the fare is nonrefundable",
"Refund of unused yr not permitted",
"This also includes lh/lx/os/sn dcc distribution cost charge shown as yr on the ticket",
"Refund of unused yq a",
"For totally unused ticket refund of unused yq permitted",
"For partially used ticket should the applicable fare for the routing travelled be higher than the fare originally paid the difference between the applicable fare and the fare originally paid shall be deducted from the yq amount",
"The yq is used to cover possible residual amounts resulting from cancellation penalties higher than the fare amount",
"Any difference between cancellation penalty and the fare originally paid shall be deducted from the yq amount",
"Only the yq residual amount can be then refunded",
"German aviation security charge is potentially refundable for transfer passengers arriving from countries us/ca or me having transfer in fra terminal 1 with no additional security check by federal police in fra",
"The optional payment charge is nonrefundable",
"Changes changes permitted",
"Note reissue/revalidation/exchange permitted",
"Except to lgt/bv/lq/bq type fare",
"Rerouting permitted rules for changes apply by fare component/direction",
"In case of fare combination charge the highest fee of all changed fare components",
"A change is a date/flight/routing/booking code change",
"Change fee applies for every single closed reissue/revalidation/rebooking transaction",
"Child discount does not apply",
"Infant without seat free of charge",
"Changes not permitted in case of no show",
"Refer to refund section",
"If changes are made to any other than the first ticketed flight coupon / the fares in effect at the time of original ticket issue will apply provided the new itinerary qualifies for all the provisions of the originally ticketed booking code fare ignoring advance reservation or ticketing requirements",
"If changes are made to first ticketed flight coupon of a totally unused ticket the fares in effect at time of rebooking/reissue will apply provided the new itinerary qualifies for all the provisions of the originally ticketd booking code fare including advance reservation or ticketing requirements",
"In case of upgrading to a higher return/one way fare the fare difference will be collected",
"In case of downgrading to a lower return/one way fare a credit of the residual amount will be made",
"If applicable collect the change fee and charge the fare difference to the higher fare",
"Revalidation/reissue and emd issuance must be made within 24 hours after change of reservation but not later than departure of the original flight being changed",
"If not done within 24 hours ticket will only be valid for refund or not appicable at all",
"In case of subsequent reissue/exchange the original nonrefundable fare or refund penalty amount remains nonrefundable"
],
"COMBINABILITY": [
"Endonend not permitted",
"Side trips permitted",
"Applicable addon construction is addressed in miscellaneous provisions category 23. open jaws fares may be combined on a half round trip basis to form single or double open jaws",
"A maximum of two international fare components permitted",
"Mileage of the open segment must be equal/less than mileage of the longest flown fare component",
"Provided the open segment must be within within india or within middle east combinations are with any fare for carrier lh/os/lx/ sn/ew/4y in any rule in any tariff",
"Round trips/circle trips fares may be combined on a half round trip basis to form round trips to form circle trips a maximum of two international fare components permitted",
"Provided combinations are with any fare for carrier lh/os/lx/sn/ ew/4y in any rule in any tariff"
],
"HIGHER INTERMEDIATE POINT": [
"The higher intermediate point rule does not apply for stopovers"
],
"DEPOSITS": [
"No restrictions"
],
"GROUPS": [
"Does not apply"
],
"TOURS": [
"Does not apply"
],
"VISIT ANOTHER COUNTRY": [
"Does not apply"
],
"MISCELLANEOUS DATA": [
"None"
],
"VOLUNTARY CHANGES": [
"Voluntary changes conditions may apply for automatedreissue/revalidationrefer to penalties category pe for details"
],
"VOLUNTARY REFUNDS": [
"Voluntary changes conditions may apply for automated refundsrefer to penalties category pe for details"
]
}
}
]
}
]
}
}