Flight Fare Quote

This method is required to re-price the selected itinerary.

Parameters

Name

Description

string

( header )

Must be application/json

Accept - Encoding

string

( header )

Must be gzip

Authorization

string

( header )

Must be Your PID

Must be Your API Key

Customer-Ip

string

( header )

Must be IP address of the customer, as captured by your integration. Send IPV4 addresses only.

Ensure your integration passes the customer’s IP, not your own. This value helps determine their location and other settings.

Also used for fraud recovery and other important analytics.

Definition and request parameters for flight farerule

action

string

( query )

Must be "fareQuote" as parameter

Action methods in Web API controller can have one or more parameters of different types. It can be either primitive type or complex type. Web API binds action method parameters either with URL's query string or with request body depending on the parameter type.

ModeType

string

( query )

Must be either "Test" or "LIVE"

Your application must be approved from Adivaha Personnel. All the transactions will be treated as LIVE once the parameter is set to LIVE.

ResultIndex

string

( query )

Result Index ie. "OB1"

TraceId

string

( query )

Trace Id (Get Trace Id from search response)

REQUEST

API Endpoint: https://www.abengines.com/api/v1/travel-api/flights/

header: array(
'Content-Type:application/json',
'Accept-encoding: gzip',
'PID:'ADD-YOUR-KEY',
'x-api-key:'ADD-YOUR-KEY'
);

POST:
{
  "action": "fareQuote",
  "mode": "Test",
  "ResultIndex": "OB1",
  "TraceId": "da0b789a-f1c7-43dd-bcda-772890fe6edd"
}

Response

The API returns an HTTP response, which generally includes the result of the request invocation

{
    "status": "200",
    "status_message": "OK",
    "responseData": {
        "Response": {
            "Error": {
                "ErrorCode": 0,
                "ErrorMessage": ""
            },
            "InsuranceResult": {
                "Results": [
                    {
                        "InsuranceResultIndex": 1,
                        "PlanCode": "820ed27f-49df-4c00-9464-ed9664ef3c9d",
                        "PlanCoverage": 4,
                        "PlanDescription": "Axa Spl Smart Domestic Plan",
                        "PlanName": "Axa Spl Smart Domestic Plan",
                        "PlanType": 1,
                        "PolicyEndDate": "2021-09-09T23:59:59",
                        "PolicyStartDate": "2021-09-09T00:00:00",
                        "PremiumList": [
                            {
                                "MaxAge": 70,
                                "MinAge": 0,
                                "PassengerCount": 1,
                                "Price": {
                                    "CommissionEarned": 48.3,
                                    "Currency": "INR",
                                    "GrossFare": 161,
                                    "KrishiKalyanTax": 0,
                                    "OfferedPrice": 112.7,
                                    "OfferedPriceRoundedOff": 112.7,
                                    "PublishedPrice": 161,
                                    "PublishedPriceRoundedOff": 161,
                                    "ServiceTax": 0,
                                    "SwachhBharatTax": 0,
                                    "TdsOnCommission": 19.32
                                }
                            }
                        ],
                        "Price": {
                            "CommissionEarned": 48.3,
                            "Currency": "INR",
                            "GrossFare": 161,
                            "KrishiKalyanTax": 0,
                            "OfferedPrice": 112.7,
                            "OfferedPriceRoundedOff": 112.7,
                            "PublishedPrice": 161,
                            "PublishedPriceRoundedOff": 161,
                            "ServiceTax": 0,
                            "SwachhBharatTax": 0,
                            "TdsOnCommission": 19.32
                        }
                    }
                ]
            },
            "IsPriceChanged": false,
            "ResponseStatus": 1,
            "Results": {
                "IsHoldAllowedWithSSR": true,
                "ResultIndex": "OB1",
                "Source": 5,
                "IsLCC": false,
                "IsRefundable": true,
                "IsPanRequiredAtBook": false,
                "IsPanRequiredAtTicket": false,
                "IsPassportRequiredAtBook": false,
                "IsPassportRequiredAtTicket": false,
                "GSTAllowed": true,
                "IsCouponAppilcable": true,
                "IsGSTMandatory": false,
                "IsHoldAllowed": true,
                "AirlineRemark": "CORPORATE FARE.",
                "ResultFareType": "RegularFare",
                "Fare": {
                    "Currency": "INR",
                    "BaseFare": 1000,
                    "Tax": 703,
                    "TaxBreakup": [
                        {
                            "key": "K3",
                            "value": 63
                        },
                        {
                            "key": "YQTax",
                            "value": 0
                        },
                        {
                            "key": "YR",
                            "value": 250
                        },
                        {
                            "key": "PSF",
                            "value": 0
                        },
                        {
                            "key": "UDF",
                            "value": 0
                        },
                        {
                            "key": "INTax",
                            "value": 63
                        },
                        {
                            "key": "TransactionFee",
                            "value": 0
                        },
                        {
                            "key": "OtherTaxes",
                            "value": 327
                        }
                    ],
                    "YQTax": 0,
                    "AdditionalTxnFeeOfrd": 0,
                    "AdditionalTxnFeePub": 0,
                    "PGCharge": 0,
                    "OtherCharges": 0,
                    "ChargeBU": [
                        {
                            "key": "TBOMARKUP",
                            "value": 0
                        },
                        {
                            "key": "GLOBALPROCUREMENTCHARGE",
                            "value": 0
                        },
                        {
                            "key": "CONVENIENCECHARGE",
                            "value": 0
                        },
                        {
                            "key": "OTHERCHARGE",
                            "value": 0
                        }
                    ],
                    "Discount": 0,
                    "PublishedFare": 1703,
                    "CommissionEarned": 8.81,
                    "PLBEarned": 0,
                    "IncentiveEarned": 0,
                    "OfferedFare": 1694.19,
                    "TdsOnCommission": 3.52,
                    "TdsOnPLB": 0,
                    "TdsOnIncentive": 0,
                    "ServiceFee": 0,
                    "TotalBaggageCharges": 0,
                    "TotalMealCharges": 0,
                    "TotalSeatCharges": 0,
                    "TotalSpecialServiceCharges": 0
                },
                "FareBreakdown": [
                    {
                        "Currency": "INR",
                        "PassengerType": 1,
                        "PassengerCount": 1,
                        "BaseFare": 1000,
                        "Tax": 703,
                        "TaxBreakUp": [
                            {
                                "key": "YR",
                                "value": 250
                            },
                            {
                                "key": "INTax",
                                "value": 63
                            },
                            {
                                "key": "K3",
                                "value": 63
                            },
                            {
                                "key": "OtherTaxes",
                                "value": 327
                            }
                        ],
                        "YQTax": 0,
                        "AdditionalTxnFeeOfrd": 0,
                        "AdditionalTxnFeePub": 0,
                        "PGCharge": 0,
                        "SupplierReissueCharges": 0
                    }
                ],
                "Segments": [
                    [
                        {
                            "Baggage": "15KG",
                            "CabinBaggage": null,
                            "CabinClass": 0,
                            "TripIndicator": 1,
                            "SegmentIndicator": 1,
                            "Airline": {
                                "AirlineCode": "AI",
                                "AirlineName": "Air India",
                                "FlightNumber": "9843",
                                "FareClass": "E",
                                "OperatingCarrier": "9I-843"
                            },
                            "Origin": {
                                "Airport": {
                                    "AirportCode": "DEL",
                                    "AirportName": "Indira Gandhi Airport",
                                    "Terminal": "3",
                                    "CityCode": "DEL",
                                    "CityName": "Delhi",
                                    "CountryCode": "IN",
                                    "CountryName": "India"
                                },
                                "DepTime": "2021-09-09T07:15:00"
                            },
                            "Destination": {
                                "Airport": {
                                    "AirportCode": "JAI",
                                    "AirportName": "Jaipur",
                                    "Terminal": "2",
                                    "CityCode": "JAI",
                                    "CityName": "Jaipur",
                                    "CountryCode": "IN",
                                    "CountryName": "India"
                                },
                                "ArrTime": "2021-09-09T08:15:00"
                            },
                            "Duration": 60,
                            "GroundTime": 0,
                            "Mile": 0,
                            "StopOver": false,
                            "FlightInfoIndex": "",
                            "StopPoint": "",
                            "StopPointArrivalTime": "0001-01-01T00:00:00",
                            "StopPointDepartureTime": "0001-01-01T00:00:00",
                            "Craft": "ATR",
                            "Remark": null,
                            "IsETicketEligible": true,
                            "FlightStatus": "Confirmed",
                            "Status": ""
                        }
                    ]
                ],
                "LastTicketDate": "2021-09-09T23:59:00.000",
                "TicketAdvisory": null,
                "FareRules": [
                    {
                        "Origin": "DEL",
                        "Destination": "JAI",
                        "Airline": "AI",
                        "FareBasisCode": "EIP9I",
                        "FareRuleDetail": "",
                        "FareRestriction": "",
                        "FareFamilyCode": "",
                        "FareRuleIndex": ""
                    }
                ],
                "PenaltyCharges": {
                    "ReissueCharge": "3000 INR",
                    "CancellationCharge": "3000 INR"
                },
                "AirlineCode": "AI",
                "ValidatingAirline": "AI"
            },
            "TraceId": "da0b789a-f1c7-43dd-bcda-772890fe6edd"
        }
    }
}

Fare Quote Response

1. TraceId

(string)

Trace ID

2. IsPriceChanged

(Boolean)

Is Price changed (Value - true or false)

3. ResponseStatus

(string)

Response Status [NotSet = 0, Successfull = 1, Failed = 2, InValidRequest = 3, InValidSession = 4,InValidCredentials = 5]

4 Results [ ]

4.1 ResultIndex

(string)

Result Index

4.2 Source

(string)

Airline Source Code

4.3 IsLCC

(Boolean)

Is the result for LCC or Non LCC (Value - True or False)

4.4 IsRefundable

(Boolean)

Is the fare refundable or not (Value - True or False)

4.5 AirlineRemark

(string)

Airline remarks

4.6 Fare

4.6.1 Currency

(string)

Currency

4.6.2 BaseFare

(Decimal)

The total Base fare of the booking

4.6.3 Tax

(Decimal)

The total tax of the booking

4.6.4 YQTax

(Decimal)

It is Fuel surcharge. It is part of Tax

4.6.5 AdditionalTxnFeeOfrd

(Decimal)

It is additional Transaction fee that API User can charge from the customer(It will always be zero)

4.6.6 AdditionalTxnFeePub

(Decimal)

It is additional Transaction fee that API User can charge from the customer(It will always be zero)

4.6.7 OtherCharges

(Decimal)

Some additional charge by airline airport.

4.6.8 ChargeBU[]

It will contain different charge breakup that is service charge or Credit card charge.

4.6.9 Discount

(Decimal)

The total discount amount of the booking. Will be zero for API customer.

4.6.10 PublishedFare

(Decimal)

Published Fare

4.6.11 PLBEarned

(Decimal)

Performance Linked Bonus on a particular airline.

4.6.12 IncentiveEarned

(Decimal)

Incentive applicable(if any)

4.6.13 OfferedFare

(Decimal)

Offered Fare

4.6.14 TdsOnCommission

(Decimal)

TDS on the commission earned.

4.6.15 TdsOnPLB

(Decimal)

TDS on the incentive earned.

4.6.16 ServiceFee

(Decimal)

Service Fee

4.7 FareBreakdown[]

Details of fare breakup into several part. It give fare of Each Passenger Type.

4.7.1 Currency

(String)

Currency

4.7.2 PassengerType

(Integer)

Passenger Type Adult-1 Child-2 Infant-3

4.7.3 PassengerCount

(Integer)

Number of Passenger

4.7.4 BaseFare

(Decimal)

The total Base fare of the booking for particular pax type

4.7.5 Tax

(Decimal)

The total tax of the booking for particular pax type

4.8 Segments[]

4.8.1 TripIndicator

(Integer)

Trip Indicator (1 for Outbound 2 for Inbound flights)

4.8.2 SegmentIndicator

(Integer)

Segment Indicator (1 for Outbound 2 for Inbound flights)

4.8.3 Airline

4.8.3.1 AirlineCode

(String)

Airline code

4.8.3.2 AirlineName

(String)

Airline name

4.8.3.3 FlightNumber

(String)

Flight Number

4.8.3.4 FareClass

(String)

Fare Class

4.8.3.5 OperatingCarrier

(String)

Operating Carrier

4.8.4 Origin

4.8.4.1 Airport

4.8.4.1.1 AirportCode

(String)

Airport code

4.8.4.1.2 AirportName

(String)

Airport name

4.8.4.1.3 Terminal

(String)

Terminal number

4.8.4.1.4 CityCode

(String)

City code

4.8.4.1.5 CityName

(String)

City name

4.8.4.1.6 CountryCode

(String)

Country code

4.8.4.1.7 CountryName

(String)

Country name

4.8.5 DepTime

(Date Time)

Departure time

4.8.6 Destination

4.8.6.1 Airport

4.8.6.1.1 AirportCode

(String)

Airport code

4.8.6.1.2 AirportName

(String)

Airport name

4.8.6.1.3 Terminal

(String)

Terminal number

4.8.6.1.4 CityCode

(String)

City code

4.8.6.1.5 CityName

(String)

City name

4.8.6.1.6 CountryCode

(String)

Country code

4.8.6.1.7 CountryName

(String)

Country name

4.8.7 ArrTime

(Date Time)

Arrival time

4.8.8 AccumulatedDuration

(Time)

Accumulated duration

4.8.9 Duration

(Time)

Duration (if in case duration is 0 refer the node of Accumulated Duration)

4.8.10 GroundTime

(Time)

Ground time

4.8.11 Mile

(String)

Miles

4.8.12 StopOver

4.8.13 StopPoint

(String)

Stopover point

4.8.14 StopPointArrivalTime

(Date Time)

Stopover arrival time

4.8.15 StopPointDepartureTime

(Date Time)

Stopover departuretime

4.8.16 Craft

(String)

Craft

4.8.17 IsETicketEligible

(Boolean)

Is E-Ticket eligible (Value- true or false)

4.8.18 FlightStatus

(String)

Flight status

4.8.19 Status

(String)

Status

4.9 LastTicketDate

(Date Time)

Last ticket date

4.10 TicketAdvisory

(String)

Ticket Advisory

4.11 FareRules

This is the fare rules of the flight fare offered.

4.11.1 Origin

(String)

Origin

4.11.2 Destination

(String)

Destination

4.11.3 Airline

(String)

Airline

4.11.4 FareBasisCode

(String)

Fare basis code

4.11.5 FareRuleDetail

(String List)

Fare rule details

4.11.6 FareRestriction

(String)

Fare restriction

4.13 ValidatingAirline

(String)

Validating airline

4.14 Error

4.14.1 ErrorCode

(Integer)

Code corresponding to the Error

4.14.2 ErrorMessage

(string)

Contains error message

5 Penalty

Cancellation/Re-issuance

5.1 ReissueCharge

(Amount)

Re-issuance Charge

5.2 CancellationCharge

(Amount)

CancellationCharge

Last Update	14 April 20
Created	24 March 15
Products	WP Plugin,White Labels,Mobile Apps,B2B Software,Trip Composer,Corporate/Self Booking Tool
Documentation	Well Documented
FAQs	Travel API Integration,Hotels API Integration,Flights API Integration,Payment Gateway Integration