Domestic Round Trip Flight Search

Domestic Flight Search -> Round 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 NameData TypeFormat ExampleRequired

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": "2024-1-15",
            "OriginLocationCode": "LOS",
            "DestinationLocationCode": "ABV"
        },
         {
            "DepartureDate": "2024-1-25",
            "OriginLocationCode": "ABV",
            "DestinationLocationCode": "LOS"
        }
        
    ],
    "FlightPassengers": [
        {
            "Code": "ADT",
            "Quantity": 1
        },
        {
            "Code": "CHD",
            "Quantity": 0
        },
        {
            "Code": "INF",
            "Quantity": 0
        }
        
       
    ],
    "FlightAirlines": [
     /* { 
           "AirlineCode": "9J",
           "Excluded": false
       }*/
    ],
    "FlightClasses": [
        {
            "Name": "Economy"
        }
    ],
    "Currency": "NGN",
    "EnsureAgentUnicityForRoutes": false,
    "OrderbyFlightTime": "asc",
    "OrderbyPrice": "asc",
    "PageSize": 10,
    "From": 0
}

Response Properties

Field NameData TypeFormat 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

FlightRouteIndex

Integer

Sample Response Object

{
    "SessionId": "45e5e70cbc08449c91114a9c64a251f1",
    "TotalCount": 12,
    "ResultList": [
        {
            "TotalCount": 6,
            "ResultList": [
                {
                    "FlightDetails": [
                        {
                            "OperatingAirlineCode": "9J",
                            "OperatingAirlineName": null,
                            "MarketingAirlineCode": "9J",
                            "MarketingAirlineName": null,
                            "Duration": "1h:10m",
                            "StopOvers": 0,
                            "DepartureDate": "2024-01-15T06:30:00",
                            "DepartureAirportCode": "LOS",
                            "DepartureAirportName": "Murtala Muhammed International Airport",
                            "DepartureAirportFullName": "Murtala Muhammed International Airport (LOS)",
                            "ArrivalDate": "2024-01-15T07:40:00",
                            "ArrivalAirportCode": "ABV",
                            "ArrivalAirportName": "Nnamdi Azikiwe International Airport",
                            "ArrivalAirportFullName": "Nnamdi Azikiwe International Airport (ABV)",
                            "FlightEntries": [
                                {
                                    "FlightNumber": "351",
                                    "Aircraft": "MD82",
                                    "MarketingAirlineCode": "9J",
                                    "MarketingAirlineName": null,
                                    "OperatingAirlineCode": "9J",
                                    "OperatingAirlineName": null,
                                    "ArrivalTerminalName": null,
                                    "DepartureTerminalName": null,
                                    "DepartureDate": "2024-01-15T06:30:00",
                                    "DepartureAirportCode": "LOS",
                                    "DepartureAirportName": "Murtala Muhammed International Airport",
                                    "DepartureAirportFullName": "Murtala Muhammed International Airport (LOS)",
                                    "ArrivalDate": "2024-01-15T07:40:00",
                                    "ArrivalAirportCode": "ABV",
                                    "ArrivalAirportName": "Nnamdi Azikiwe International Airport",
                                    "ArrivalAirportFullName": "Nnamdi Azikiwe International Airport (ABV)",
                                    "FlightDuration": "1h:10m",
                                    "HasStopOver": false,
                                    "StopOverDuartion": "0h:00m",
                                    "TotalDuration": "1h:10m",
                                    "FlightClass": "Economy",
                                    "Baggages": "KGS",
                                    "BaggageUnit": null,
                                    "BookingCode": "L",
                                    "AvailablePassengerSeats": [
                                        {
                                            "PassengerType": "ADT",
                                            "PassengerClassCode": "L",
                                            "Quantity": "1",
                                            "FareBasis": "LOW",
                                            "FareType": null
                                        }
                                    ]
                                }
                            ],
                            "FlightRules": []
                        }
                    ],
                    "AgentId": 138,
                    "GDSId": 93,
                    "Currency": "NGN",
                    "BaseFare": 60222.0,
                    "TotalServiceCharge": 0.0,
                    "GdsTotalFare": 86000.0,
                    "TotalFare": 86000.0,
                    "OriginalTotalFare": 86000.0,
                    "ExchangeRate": null,
                    "TicketPurchaseCurrency": "NGN",
                    "PassengerFares": [
                        {
                            "PassengerType": "ADT",
                            "Age": null,
                            "Quantity": 1,
                            "Taxes": 25778.0,
                            "Fees": 0.0,
                            "ServiceCharge": 0.0,
                            "BaseFare": 60222.0,
                            "TotalFare": 86000.0,
                            "GdsTotalFare": 86000.0,
                            "TicketRules": [],
                            "OriginalGdsBaseFare": 60222.0,
                            "OriginalGdsTotalFare": 86000.0,
                            "OriginalAgentMarkupFare": 0.0,
                            "OriginalTotalFare": 86000.0
                        }
                    ],
                    "Properties": {
                        "CombinationID": 1,
                        "RecommendationID": 6,
                        "GdsItineraryIndex": 1,
                        "EnsureAgentUnicityForRoutes": false,
                        "TransportServiceType": 1,
                        "TripsSessionId": "45e5e70cbc08449c91114a9c64a251f1",
                        "GdsSessionId": "42c45b6effa74f5d98acf67ed50e0bed",
                        "GdsCombinationID": 1,
                        "GdsRecommendationID": 0
                    },
                    "IsLocal": true,
                    "TotalFlightDuration": "1h:10m",
                    "FlightRouteIndex": 0
                },
                {
                    "TotalCount": 6,
                    "ResultList": [
                        {
                            "FlightDetails": [
                                {
                                    "OperatingAirlineCode": "9J",
                                    "OperatingAirlineName": null,
                                    "MarketingAirlineCode": "9J",
                                    "MarketingAirlineName": null,
                                    "Duration": "1h:15m",
                                    "StopOvers": 0,
                                    "DepartureDate": "2024-01-25T08:20:00",
                                    "DepartureAirportCode": "ABV",
                                    "DepartureAirportName": "Nnamdi Azikiwe International Airport",
                                    "DepartureAirportFullName": "Nnamdi Azikiwe International Airport (ABV)",
                                    "ArrivalDate": "2024-01-25T09:35:00",
                                    "ArrivalAirportCode": "LOS",
                                    "ArrivalAirportName": "Murtala Muhammed International Airport",
                                    "ArrivalAirportFullName": "Murtala Muhammed International Airport (LOS)",
                                    "FlightEntries": [
                                        {
                                            "FlightNumber": "352",
                                            "Aircraft": "MD82",
                                            "MarketingAirlineCode": "9J",
                                            "MarketingAirlineName": null,
                                            "OperatingAirlineCode": "9J",
                                            "OperatingAirlineName": null,
                                            "ArrivalTerminalName": null,
                                            "DepartureTerminalName": null,
                                            "DepartureDate": "2024-01-25T08:20:00",
                                            "DepartureAirportCode": "ABV",
                                            "DepartureAirportName": "Nnamdi Azikiwe International Airport",
                                            "DepartureAirportFullName": "Nnamdi Azikiwe International Airport (ABV)",
                                            "ArrivalDate": "2024-01-25T09:35:00",
                                            "ArrivalAirportCode": "LOS",
                                            "ArrivalAirportName": "Murtala Muhammed International Airport",
                                            "ArrivalAirportFullName": "Murtala Muhammed International Airport (LOS)",
                                            "FlightDuration": "1h:15m",
                                            "HasStopOver": false,
                                            "StopOverDuartion": "0h:00m",
                                            "TotalDuration": "1h:15m",
                                            "FlightClass": "Economy",
                                            "Baggages": "KGS",
                                            "BaggageUnit": null,
                                            "BookingCode": "L",
                                            "AvailablePassengerSeats": [
                                                {
                                                    "PassengerType": "ADT",
                                                    "PassengerClassCode": "L",
                                                    "Quantity": "1",
                                                    "FareBasis": "LOW",
                                                    "FareType": null
                                                }
                                            ]
                                        }
                                    ],
                                    "FlightRules": []
                                }
                            ],
                            "AgentId": 138,
                            "GDSId": 93,
                            "Currency": "NGN",
                            "BaseFare": 64667.0,
                            "TotalServiceCharge": 0.0,
                            "GdsTotalFare": 86000.0,
                            "TotalFare": 86000.0,
                            "OriginalTotalFare": 86000.0,
                            "ExchangeRate": null,
                            "TicketPurchaseCurrency": "NGN",
                            "PassengerFares": [
                                {
                                    "PassengerType": "ADT",
                                    "Age": null,
                                    "Quantity": 1,
                                    "Taxes": 21333.0,
                                    "Fees": 0.0,
                                    "ServiceCharge": 0.0,
                                    "BaseFare": 64667.0,
                                    "TotalFare": 86000.0,
                                    "GdsTotalFare": 86000.0,
                                    "TicketRules": [],
                                    "OriginalGdsBaseFare": 64667.0,
                                    "OriginalGdsTotalFare": 86000.0,
                                    "OriginalAgentMarkupFare": 0.0,
                                    "OriginalTotalFare": 86000.0
                                }
                            ],
                            "Properties": {
                                "CombinationID": 0,
                                "RecommendationID": 0,
                                "GdsItineraryIndex": 1,
                                "EnsureAgentUnicityForRoutes": false,
                                "TransportServiceType": 1,
                                "TripsSessionId": "45e5e70cbc08449c91114a9c64a251f1",
                                "GdsSessionId": "be0a8e402f9a448caa959a6acd915432",
                                "GdsCombinationID": 1,
                                "GdsRecommendationID": 0
                            },
                            "IsLocal": true,
                            "TotalFlightDuration": "1h:15m",
                            "FlightRouteIndex": 1
                        }
                    ]
                }
            ]
        }
    ]
}

Last updated