flightList
POST
/travel/flight/flightList
Parameters | Required/Optional | Parameter Description |
---|---|---|
SearchDetails | Required | This parameter gets and sets the entire flight search – specified properties entered by user. These search parameters should be submiited as query string with URL. More |
TripType | Required | This is an Enumeration type parameter which has a specified list of values OneWay=0 and RoundTrip=1. |
Adults | Required | Domain for this field contains values from 1-9. At least one adult must be selected. |
Childs | Optional | Domain range for this field is 0-9. |
Infants | Optional | This field’s domain has values from 0-2. Number of infants cannot be more than number of adults as per single booking. |
Cabin | Optinal | This field has enumeration values (Economy =0,Business=2) |
EngineID | Required | This parameter has been defined as Enumeration type which has specified list of constant values. Each int value has been assigned to a different airline Indigo = 0, Spicjet = 1, GoAir = 5, TravelPort = 7, AirAsia=10, AirCosta = 6, Trujet=11 |
Parameters | Parameter Description |
---|---|
Errors | If request has not been submitted successfully or is there any technical error while submitting the request then user will get error with code and description in response. |
Journeys | It includes JourneyDetail and Segments |
Error | Description | Error | Description |
---|---|---|---|
001 | Object not initialized | 009 | Origin required |
002 | Authentication Object not initialized | 010 | Destination required |
003 | UserName is required | 011 | Travellers required |
004 | Password is required | 012 | AdultTraveller required |
005 | Invalid UserName or Password. | 013 | BookSegment required |
006 | unique TransactionId is required | 014 | Segment ItineraryKey has to be same. or Both Segment have same Origin. |
007 | Search details required | 015 | Bond ItineraryKey has to be same. |
008 | Begin date required | 016 | Bond ItineraryKey has not null. |
Parameters | Data Type | Parameter Description |
---|---|---|
Origin | string | This value represents source city name. Three alphabetic IATA code should be entered by user to get valid source city. This field should not contain More than and less than 3 characters. |
Destination | string | It represents destination city/airport name .It cannot be same as source value. Three alphabetic IATA code should be entered by user to get valid destination city. This field should not contain More than and less than 3 characters. |
BeginDate | DateTime | It represents journey date. This value should be entered as string not less than and More than 10 characters in date format ‘yyyy-mm-dd’. |
EndDate | DateTime | It represents return date and should be entered as string not less than and More than 10 characters in date format ‘yyyy-mm-dd’. It cannot be greater than journey date |
EngineID | Enumeration Type | This parameter has been defined as Enumeration type which has specified list of constant values. Each int value has been assigned to a different airline Indigo = 0, Spicjet = 1, GoAir = 5, TravelPort = 7, AirAsia=10, AirCosta = 6, Trujet=11 |
Cabin | string | This field has enumeration values (Economy, Business and First class) |
CurrencyCode | string | This element represents currency code for a speific country (like INR for Indian Rupee). |
Parameters | Data Type | Parameters | Data Type |
---|---|---|---|
BondType | string | IsInternational | bool |
Bonds | Class Type | IsRoundTrip | bool |
Deeplink | string(only for meta search user) | IsSpecial | bool |
EngineID | Enumeration Type | IsSpecialId | bool |
Fare | Class Type | ItineraryKey | string |
FareRule | string | JourneyIndex | int |
IsBaggageFare | bool | NearByAirport | bool |
IsCache | bool | Remark | string |
IsHoldBooking | bool | SearchId | string |
Parameter | Data Type | Parameter Description |
---|---|---|
BoundType | string | Represents Inbound/Outbound flight |
ItineraryKey | string | Represents a string value for a particular journey from source to destination |
IsBaggageFare | bool | Fares for baggage facility(True/False) |
IsSSR | bool | It contains boolean value(True/False) |
JourneyTime | string | Represents journey duration |
Legs | Class Type | Represents details about flight |
SpecialServices | Class Type | Represents special services provided in flight More |
Parameter | Data Type | Parameter Description |
---|---|---|
AircraftCode | string | This is provided by airline (for eg: VX09KHT7TSm+ZhCrSZcPJg==) |
AircraftType | string | Provided by airline |
AirlineName | string | Represents name of the airline(Spice Jet,Indigo,GoAir,GDS) |
Amount | decimal | Calculated amount of other services like tax, PSF, UDF |
ArrivalDate | DateTime | It represents arrival date of the Journey. |
ArrivalTerminal | string | It represents arrival terminal of the Journey. |
ArrivalTime | string | It represents arrival time of the Journey. |
AvailableSeat | string | Total numbers of seats available. |
BaggageUnit | string | Units like KG and G etc. |
BaggageWeight | string | It represents the weight of the baggage. |
BoundType | string | Represents Inbound/Outbound flight |
Cabin | string | This field has enumeration values (Economy =0,Business=2) |
CabinClasses | Class Type | |
Capacity | short | Total capacity |
CarrierCode | string | Flight carrier code |
CurrencyCode | string | Represents currency codes(INR for india) |
DepartureDate | string | It represents departure date of the journey. |
DepartureTerminal | string | It represents departure terminal of the Journey. |
DepartureTime | DateTime | It represents departure time of the journey. |
Destination | string | It represents destination city/airport name .It cannot be same as source value. Three alphabetic IATA code should be entered by user to get valid destination city. This field should not contain More than and less than 3 characters. |
Duration | string | It represents the total time duration of the journey. |
FareBasisCode | string | Flight fare basis code |
FareClassOfService | string | It is an array type having a list of constant values. |
FlightDesignator | string | Flight designator details |
FlightDetailRefKey | string | Id for flight details |
FlightNumber | string | It represents the flight number. |
Group | string | |
IsConnecting | bool | It contains boolean value(True/False) |
NumberOfStops | string | Total number of stops between source to destination |
Origin | string | This value represents source city name. Three alphabetic IATA code should be entered by user to get valid source city. This field should not contain More than and less than 3 characters. |
ProviderCode | string | Airline provider code |
Remarks | string | Brief description |
SSRDetails | Class Type | More |
Sold | int | |
Status | string | Status of the booking |
Parameters | Data Type | Parameter Description |
---|---|---|
BasicFare | decimal | Represents basic fares excluding of any other service charges |
ExchangeRate | decimal | Exchange Rate |
PaxFares | Class Type | It contains information about BaggageUnit,BaggageWeight,BasicFare and PaxType. |
TotalFareWithOutMarkUp | decimal | Total amount |
TotalTaxWithOutMarkUp | decimal | Total tax |
Parameter | Data Type | Parameter Description |
---|---|---|
BaggageUnit | string | >Units like KG and G etc. |
BaggageWeight | string | It represents the weight of the baggage. |
BaseTransactionAmount | decimal | It contains transaction amount |
BasicFare | decimal | Represents basic fares excluding of any other service charges |
CancelPenalty | decimal | Cancel before departure date within twenty four hours(CAN-BEF 24_0:14811) |
ChangePenalty | decimal | Change before departure date within twenty fore hours (CHG-BEF 24_0:4443.0) |
EquivCurrencyCode | string | Flight equivalent currency code |
Fare | Class Type | It includes fare detail More |
FareBasisCode | string | Flight fare basis code |
FareInfoKey | string | Flight fare information key |
FareInfoValue | string | Flight fare information value |
MarkUP | decimal | Flight markup |
PaxType | Enumeration Type | This property has enumeration type and has specified list of constant values as (ADT, CHD and INF) |
Refundable | bool | Represents whether this flight is refundable or non refundable |
TotalFare | decimal | Calculated amount of other services like tax, PSF, UDF |
TotalTax | decimal | Total tax |
TransactionAmount | decimal | Transaction amount |
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/travel/flight/flightList' \
--header 'Token: ZKEYza2COHK0QVkcVkwUb6WeIgWiS' \
--header 'checkSum: 739f448d1cc4f5bbbd048e68ba2b8885b0f8414ed4090ad967df7d15d7cdbbae' \
--header 'Content-Type: application/json' \
--data-raw '{
"FlightSearchDetails": [
{
"Origin": "BOM",
"Destination": " GOI",
"BeginDate": "2020-09-29"
}
],
"EngineID": [
7,
0,
1,
5,
10,
6,
11
],
"TripType": 0,
"Cabin": 0,
"Adults": "1",
"Childs": "0",
"Infants": "0"
}'
Response Response Example
{ "Errors": null, "Insurance": null, "Journeys": [ { "JourneyDetail": null, "Segments": [ { "BondType": "OutBound", "Bonds": [ { "BoundType": "OutBound", "IsBaggageFare": false, "IsSSR": false, "ItineraryKey": "b7SqRwmVDL7OJQP+J0ySES9vx7BMZSMJFZdVwW+LEF0=", "JourneyTime": "01h 20m", "Legs": [ { "AircraftCode": "6E", "AircraftType": "320", "AirlineName": "6E", "AirlinePnr": null, "ArrivalDate": "Tue-29Sep2020", "ArrivalTerminal": "", "ArrivalTime": "12:40", "AvailableSeat": null, "BaggageUnit": "KG", "BaggageWeight": "20", "BookSeat": null, "BoundType": "OutBound", "Cabin": "Economy", "CabinClasses": null, "Capacity": 0, "CarrierCode": "6E", "CurrencyCode": "INR", "DepartureDate": "Tue-29Sep2020", "DepartureTerminal": "1", "DepartureTime": "11:20", "Destination": "GOI", "Duration": "01h 20m", "FareBasisCode": "Q0IP", "FareClassOfService": "Q", "FareRulesKey": null, "FlightDesignator": null, "FlightDetailRefKey": "6E~ 179~ ~~BOM~09/29/2020 11:20~GOI~09/29/2020 12:40~~", "FlightName": "Indigo", "FlightNumber": " 179", "GDSPnr": null, "Group": "0", "IsConnecting": false, "IsSeatOpen": false, "LayoverArrDT": null, "LayoverAt": null, "LayoverDepDT": null, "LayoverDuration": null, "NumberOfStops": "0", "OperatedBy": "", "Origin": "BOM", "ProviderCode": "6E` 179` ``BOM`09/29/2020 11:20`GOI`09/29/2020 12:40``!0`Q` `6E`Q0IP`1057``0`3``X!!6E`320```KG`20`Economy``6E`1`0`False`0``````01h 20m`Q0IP`Q", "Remarks": null, "SSRDetails": null, "Sold": 0, "Status": null } ], "addOnDetail": null } ], "CurrencyCode": "INR", "Deeplink": "", "EngineID": 0, "Fare": { "BasicFare": 2500, "BrandKeys": null, "DueAmount": 0, "ExchangeRate": 0, "FareName": 7, "OfferedFare": 0, "PNRAmount": 0, "PaxFares": [ { "AirlinePnr": null, "BaggageUnit": "KG", "BaggageWeight": "20", "BaseTransactionAmount": 0, "BasicFare": 2500, "Branded": null, "CancelPenalty": 3000, "Cashback": 0, "ChangePenalty": 2500, "Commission": 0, "DFValue": "0", "EquivCurrencyCode": "INR", "Fare": [ { "Amount": 549, "ChargeCode": "Tax", "ChargeType": "Tax"
Request
Header Params
Token
string
required
Example:
ZKEYza2COHK0QVkcVkwUb6WeIgWiS
checkSum
string
required
Example:
739f448d1cc4f5bbbd048e68ba2b8885b0f8414ed4090ad967df7d15d7cdbbae
Body Params application/json