International Single Trip Flight Search

International Flight Search -> Single Trip

Flight Search API: http://bsptrips.staging.vggdev.com/api/Flight/SearchFlight

FLIGHT SEARCH REQUEST AND RESPONSE SAMPLE

This API used to search for available flight for international routes. Example, Lagos to Dubai or London to Dubai. Below is a sample request for this endpoint and the corresponding response.

Request Header:

Authorization: {Bearer Token}

Content-Type: application/json

MerchantCode: {MerchantCode}

Request Properties:

Field Name	Data Type	Format Example	Required
FlightRoutes	Object Array
FlightRoutes -> DepartureDate	DateTime	2023-08-23
FlightRoutes -> OriginLocationCode	String
FlightRoutes -> DestinationLocationCode	String
FlightPassengers	Object Array
FlightPassengers -> Code	String
FlightPassengers -> Quantity	String
FlightAirlines	Object Array
FlightAirlines -> lightAirlinesAirlineCode	String
FlightAirlines -> Excluded	String
FlightClasses	Object Array
FlightClasses -> Name	String
Currency	String
EnsureAgentUnicityForRoutes	Boolean
OrderbyFlightTime	String
OrderbyPrice	String
PageSize	Integer
From	Integer

Request Body Payload:

{ 
  "FlightRoutes": [
   {
       "DepartureDate": "2023-07-28",
       "OriginLocationCode": "LOS",
       "DestinationLocationCode": "LHR"
   }

],
"FlightPassengers": [
    {
        "Code": "ADT",
        "Quantity": 1
    },
     {
        "Code": "CHD",
        "Quantity": 0
    },
     {
        "Code": "INF",
        "Quantity": 0
    }
    
],
"FlightAirlines": [
   /** {
       "AirlineCode": "P4",
       "Excluded": true
    }**/
],
"FlightClasses": [
    {
        "Name": "Economy"
    }
],
"Currency": "NGN",
"EnsureAgentUnicityForRoutes": false,
"OrderbyFlightTime": "asc",
"OrderbyPrice": "asc",
"PageSize": 50,
"From": 0
}

Response Properties

Field Name	Data Type	Format Example
SessionId	String
TotalCount	Integer
ResultList	Array of Object
ResultList -> FlightDetails	Array of Object
ResultList -> FlightDetails -> OperatingAirlineCode	String
ResultList -> FlightDetails -> OperatingAirlineName	String
ResultList -> FlightDetails -> MarketingAirlineCode	String
ResultList -> FlightDetails -> MarketingAirlineName	String
ResultList -> FlightDetails -> Duration	String
ResultList -> FlightDetails -> StopOvers	Integer	0 or 1
ResultList -> FlightDetails -> DepartureDate	DateTime	2023-07-28T06:45:00
ResultList -> FlightDetails -> DepartureAirportCode	String
ResultList -> FlightDetails -> DepartureAirportName	String
ResultList -> FlightDetails -> DepartureAirportFullName	String
ResultList -> FlightDetails -> ArrivalDate	DateTime	2023-07-28T16:50:00
ResultList -> FlightDetails -> ArrivalAirportCode	String
ResultList -> FlightDetails -> ArrivalAirportName	String
ResultList -> FlightDetails -> ArrivalAirportFullName	String
ResultList -> FlightDetails -> FlightEntries	Array of Object
ResultList -> FlightDetails -> FlightEntries -> FlightNumber	String
ResultList -> FlightDetails -> FlightEntries -> Aircraft	String
ResultList -> FlightDetails -> FlightEntries -> MarketingAirlineCode	String
ResultList -> FlightDetails -> FlightEntries -> MarketingAirlineCode	String
ResultList -> FlightDetails -> FlightEntries -> MarketingAirlineName	String
ResultList -> FlightDetails -> FlightEntries -> OperatingAirlineCode	String
ResultList -> FlightDetails -> FlightEntries -> OperatingAirlineName	String
ResultList -> FlightDetails -> FlightEntries -> ArrivalTerminalName	String
ResultList -> FlightDetails -> FlightEntries -> DepartureTerminalName	String
ResultList -> FlightDetails -> FlightEntries -> DepartureDate	DateTime
ResultList -> FlightDetails -> FlightEntries -> DepartureAirportCode	String
ResultList -> FlightDetails -> FlightEntries -> DepartureAirportName	String
ResultList -> FlightDetails -> FlightEntries -> DepartureAirportFullName	String
ResultList -> FlightDetails -> FlightEntries -> ArrivalDate	DateTime
ResultList -> FlightDetails -> FlightEntries -> ArrivalAirportCode	String
ResultList -> FlightDetails -> FlightEntries -> ArrivalAirportName	String
ResultList -> FlightDetails -> FlightEntries -> ArrivalAirportFullName	String
ResultList -> FlightDetails -> FlightEntries -> FlightDuration	String
ResultList -> FlightDetails -> FlightEntries -> HasStopOver	Boolean
ResultList -> FlightDetails -> FlightEntries -> StopOverDuartion	String
ResultList -> FlightDetails -> FlightEntries -> TotalDuration	String
ResultList -> FlightDetails -> FlightEntries -> FlightClass	String
ResultList -> FlightDetails -> FlightEntries -> Baggages	String
ResultList -> FlightDetails -> FlightEntries -> BaggageUnit	String
ResultList -> FlightDetails -> FlightEntries -> BookingCode	String
ResultList -> FlightDetails -> FlightEntries -> AvailablePassengerSeats	Array of Object
ResultList -> FlightDetails -> FlightEntries -> AvailablePassengerSeats -> PassengerType	String
ResultList -> FlightDetails -> FlightEntries -> AvailablePassengerSeats -> PassengerClassCode	String
ResultList -> FlightDetails -> FlightEntries -> AvailablePassengerSeats -> Quantity	String
ResultList -> FlightDetails -> FlightEntries -> AvailablePassengerSeats -> FareBasis	String
ResultList -> FlightDetails -> FlightEntries -> AvailablePassengerSeats -> FareType	String
ResultList -> FlightDetails -> FlightRules	Array of Object
ResultList -> FlightDetails -> AgentId	Integer
ResultList -> FlightDetails -> GDSId	Integer
ResultList -> FlightDetails -> Currency	String
ResultList -> FlightDetails -> BaseFare	Decimal
ResultList -> FlightDetails -> TotalServiceCharge	Decimal
ResultList -> FlightDetails -> GdsTotalFare	Decimal
ResultList -> FlightDetails -> TotalFare	Decimal
ResultList -> FlightDetails -> ExchangeRate	Decimal
ResultList -> FlightDetails -> TicketPurchaseCurrency	String
ResultList -> FlightDetails -> PassengerFares	Array of Object
ResultList -> FlightDetails -> PassengerFares -> PassengerType	String
ResultList -> FlightDetails -> PassengerFares -> Age	String
ResultList -> FlightDetails -> PassengerFares -> Quantity	integer
ResultList -> FlightDetails -> PassengerFares -> Taxes	Decimal
ResultList -> FlightDetails -> PassengerFares -> Fees	Decimal
ResultList -> FlightDetails -> PassengerFares -> ServiceCharge	Decimal
ResultList -> FlightDetails -> PassengerFares -> BaseFare	Decimal
ResultList -> FlightDetails -> PassengerFares -> TotalFare	Decimal
ResultList -> FlightDetails -> PassengerFares -> GdsTotalFare	Decimal
ResultList -> FlightDetails -> PassengerFares -> TicketRules	Array Object
ResultList -> FlightDetails -> PassengerFares -> OriginalGdsBaseFare	Decimal
ResultList -> FlightDetails -> PassengerFares -> OriginalGdsBaseFare	Decimal
ResultList -> FlightDetails -> PassengerFares -> OriginalGdsBaseFare	Decimal
ResultList -> FlightDetails -> PassengerFares -> OriginalGdsTotalFare	Decimal
ResultList -> FlightDetails -> PassengerFares -> OriginalAgentMarkupFare	Decimal
ResultList -> FlightDetails -> Properties	Object
ResultList -> FlightDetails -> Properties -> CombinationID	Integer
ResultList -> FlightDetails -> Properties -> RecommendationID	Integer
ResultList -> FlightDetails -> Properties -> GdsSearchID	String
ResultList -> FlightDetails -> Properties -> GdsItinerayCode	String
ResultList -> FlightDetails -> Properties -> EnsureAgentUnicityForRoutes	Boolean
ResultList -> FlightDetails -> Properties -> TransportServiceType	Integer
ResultList -> FlightDetails -> Properties -> TripsSessionId	String
ResultList -> FlightDetails -> Properties -> GdsSessionId	String
ResultList -> FlightDetails -> Properties -> GdsCombinationID	Integer
ResultList -> FlightDetails -> Properties -> GdsRecommendationID	Integer
ResultList -> FlightDetails -> IsLocal	Boolean

Sample Response Object

{
    "SessionId": "0cfb0155d1d1461ca4cc4753a17d4b68",
    "TotalCount": 50,
    "ResultList": [
        {
            "FlightDetails": [
                {
                    "OperatingAirlineCode": "AT",
                    "OperatingAirlineName": "Royal Air Maroc",
                    "MarketingAirlineCode": "AT",
                    "MarketingAirlineName": "Royal Air Maroc",
                    "Duration": "10h:05m",
                    "StopOvers": 1,
                    "DepartureDate": "2023-07-28T06:45:00",
                    "DepartureAirportCode": "LOS",
                    "DepartureAirportName": "Murtala Muhammed Airport",
                    "DepartureAirportFullName": "Murtala Muhammed Airport (LOS)",
                    "ArrivalDate": "2023-07-28T16:50:00",
                    "ArrivalAirportCode": "LHR",
                    "ArrivalAirportName": "Heathrow",
                    "ArrivalAirportFullName": "Heathrow (LHR)",
                    "FlightEntries": [
                        {
                            "FlightNumber": "554",
                            "Aircraft": "Boeing 737-800 (winglets) pax",
                            "MarketingAirlineCode": "AT",
                            "MarketingAirlineName": "Royal Air Maroc",
                            "OperatingAirlineCode": "AT",
                            "OperatingAirlineName": "Royal Air Maroc",
                            "ArrivalTerminalName": null,
                            "DepartureTerminalName": null,
                            "DepartureDate": "2023-07-28T06:45:00",
                            "DepartureAirportCode": "LOS",
                            "DepartureAirportName": "Murtala Muhammed Airport",
                            "DepartureAirportFullName": "Murtala Muhammed Airport (LOS)",
                            "ArrivalDate": "2023-07-28T11:15:00",
                            "ArrivalAirportCode": "CMN",
                            "ArrivalAirportName": "Mohamed V Airport",
                            "ArrivalAirportFullName": "Mohamed V Airport (CMN)",
                            "FlightDuration": "4h:30m",
                            "HasStopOver": false,
                            "StopOverDuartion": "0h:00m",
                            "TotalDuration": "4h:30m",
                            "FlightClass": "Economy",
                            "Baggages": "2",
                            "BaggageUnit": "PC",
                            "BookingCode": "K",
                            "AvailablePassengerSeats": [
                                {
                                    "PassengerType": "ADT",
                                    "PassengerClassCode": "K",
                                    "Quantity": "7",
                                    "FareBasis": "KA0WAAFA,KA0WAAFA",
                                    "FareType": null
                                }
                            ]
                        },
                        {
                            "FlightNumber": "800",
                            "Aircraft": "7M8",
                            "MarketingAirlineCode": "AT",
                            "MarketingAirlineName": "Royal Air Maroc",
                            "OperatingAirlineCode": "AT",
                            "OperatingAirlineName": "Royal Air Maroc",
                            "ArrivalTerminalName": null,
                            "DepartureTerminalName": null,
                            "DepartureDate": "2023-07-28T13:30:00",
                            "DepartureAirportCode": "CMN",
                            "DepartureAirportName": "Mohamed V Airport",
                            "DepartureAirportFullName": "Mohamed V Airport (CMN)",
                            "ArrivalDate": "2023-07-28T16:50:00",
                            "ArrivalAirportCode": "LHR",
                            "ArrivalAirportName": "Heathrow",
                            "ArrivalAirportFullName": "Heathrow (LHR)",
                            "FlightDuration": "3h:20m",
                            "HasStopOver": true,
                            "StopOverDuartion": "2h:15m",
                            "TotalDuration": "5h:35m",
                            "FlightClass": "Economy",
                            "Baggages": "2",
                            "BaggageUnit": "PC",
                            "BookingCode": "K",
                            "AvailablePassengerSeats": [
                                {
                                    "PassengerType": "ADT",
                                    "PassengerClassCode": "K",
                                    "Quantity": "9",
                                    "FareBasis": "KA0WAAFA,KA0WAAFA",
                                    "FareType": null
                                }
                            ]
                        }
                    ],
                    "FlightRules": []
                }
            ],
            "AgentId": 5,
            "GDSId": 2,
            "Currency": "NGN",
            "BaseFare": 585008.0,
            "TotalServiceCharge": 26385.0,
            "GdsTotalFare": 813134.0,
            "TotalFare": 844519.0,
            "ExchangeRate": null,
            "TicketPurchaseCurrency": null,
            "PassengerFares": [
                {
                    "PassengerType": "ADT",
                    "Age": null,
                    "Quantity": 1,
                    "Taxes": 228126.0,
                    "Fees": 0.0,
                    "ServiceCharge": 26385.0,
                    "BaseFare": 585008.0,
                    "TotalFare": 844519.0,
                    "GdsTotalFare": 813134.0,
                    "TicketRules": [],
                    "OriginalGdsBaseFare": 0.0,
                    "OriginalGdsTotalFare": 0.0,
                    "OriginalAgentMarkupFare": 0.0
                }
            ],
            "Properties": {
                "CombinationID": 0,
                "RecommendationID": 0,
                "GdsSearchID": "AIR-WS-64407345886c30e5c80ed6ec01bb05e8",
                "GdsItinerayCode": "51fba1e7671278fa30c4d7781c7739daf5c0681c:0",
                "EnsureAgentUnicityForRoutes": false,
                "TransportServiceType": 2,
                "TripsSessionId": "0cfb0155d1d1461ca4cc4753a17d4b68",
                "GdsSessionId": "a34ac44c18a94ddc874b863543c061dd",
                "GdsCombinationID": 0,
                "GdsRecommendationID": 0
            },
            "IsLocal": false
        }
    ]
}