Trips Documentation
Trips Documentation
Trips Documentation
  • API Documentation
    • Getting Started
    • Flight Search
      • International Single Trip Flight Search
      • International Round Trip Flight Search
      • Domestic Single Trip Flight Search
      • Domestic Round Trip Flight Search
    • Confirm Ticket Price
      • Confirm Ticket Price - International (Single Trip)
      • Confirm Ticket Price - International (Round Trip)
      • Confirm Ticket Price - Domestic (Single Trip)
      • Confirm Ticket Price - Domestic (Round Trip)
    • Flight Booking
      • International - Flight Booking (Single Trip)
      • International - Flight Booking (Round Trip)
      • Domestic - Flight Booking (Round Trip)
      • Domestic - Flight Booking (Single Trip)
    • My Booking
    • Cancel Flight
    • My Reservation
Powered by GitBook
On this page
  1. API Documentation
  2. Flight Search

International Round Trip Flight Search

International 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 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"
   },
   {
       "DepartureDate": "2023-07-28",
       "OriginLocationCode": "LHR",
       "DestinationLocationCode": "LOS"
   }

],
"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

PreviousInternational Single Trip Flight SearchNextDomestic Single Trip Flight Search

Last updated 1 year ago