Get User Details

GET Endpoint for getting the details and balances of the user

https://outward-api-dev.farepod.co/api/v1/user-details

The input body is empty.

The output contains an object with the userId, userName and balances as well as limits for the user.

Output

Search Flights

POST Endpoint to search for flights.

https://outward-api-dev.farepod.co/api/v1/flights

More specifically, the input includes the following fields:

• cabinClass: a string indicating the desired cabin class, such as "ECONOMY" or "BUSINESS".(CabinClassEnum)
• passengers: an object with fields for the number of adult, child, and infant passengers.
• routeInfo: an array of objects representing the desired travel route, each with fields for the origin airport code, destination airport code, and travel date.
• filter: an object with fields for flight filters such as preferred fare type, direct flights only, and connecting flights only.
• pnr: field to specify whether to get flights with instant pnr or all flights(includes awaiting pnr) (FareSearchPnrFilterEnum).
• preferredAirlines: an array of strings representing the preferred airlines for the search.

The output includes an array of objects, with each object representing a potential flight itinerary that matches the search criteria. Each object includes the following fields:

• segments: An array of objects representing the flight segments, with fields such as flight name, flight number, departure and arrival times, and airport codes.
• priceList: An array of objects representing the pricing options for the itinerary, with fields such as total fare, net fare, and fare components broken down by passenger type.
• duration: A number indicating the total duration of the flight itinerary, in minutes.
• listedBy: An object containing agency, sub-agency, and sub-agency user who listed the flight.(Only present for few tickets)

Input

Output

Review Flight

POST Endpoint to review flight by id.

https://outward-api-dev.farepod.co/api/v1/flights/:id

The input request has no body

The output includes an object, with following key fields:

• segments: An array of objects representing the flight segments, with fields such as flight name, flight number, departure and arrival times, and airport codes.
• priceDetail: An object representing the pricing details for the itinerary, with fields such as total fare, net fare, and fare components broken down by passenger type.
• duration: A number indicating the total duration of the flight itinerary, in minutes.
• bookingId: This is the id that should be used to add passenger in the next step
• stops: Whether the flight is 'non-stop', '1 stop' , '2 stops' , etc
• conditions: Details about which fields should be passed in Add Passengers Request

Output

Get Fare Rules

POST Endpoint to search fare rules of a flight by id. Both search and bookingId can be used to get fare rules.

https://outward-api-dev.farepod.co/api/v1/flights/:id/fare-rules

The input body is empty.

The output includes an object, with a single key :

• fareRules: String indicating fare rules of a flight.

Add Passenger Details

POST Endpoint is used to add passenger details. This endpoint returns a booking ID and final amount of booking that is subsequently used in the [book + make endpoint].

https://outward-api-dev.farepod.co/api/v1/bookings/:id/passenger-details

id passed is pricelist.id that we get from search flights

Input includes following fields:

• passengers: Object containing information about the passengers traveling with three keys(adults,children,infants).
  DOB format YYYYMMDD
• contactInfo: Object containing the contact details of the person booking the travel.

The output includes an object, with a 2 key :

• _id: booking id that is later used in payment endpoint.
• amount: Total amount of booking in INR that is later used in payment endpoint.

Input

{
"expiry": "",
"nationality": "",
"number": "" ,
"issueDate": ""
}

Output

Book + Make Payment

POST Endpoint to book and make payment for a flight booking.

https://outward-api-dev.farepod.co/api/v1/bookings/:id/book

The input request body includes the amount to be paid in INR:

      {
        "amount": 4453.6
      }
        

The output includes an object with the following key fields:

• _id: The unique booking ID.
• priceDetail: An object representing the pricing details, including total fare, base fare, taxes, fees, and management fees.
• segments: An array of objects representing the flight segments, with fields like flight name, number, duration, departure, and arrival details.
• passengers: An object containing details of passengers (adults, children, and infants) in the booking.
• status: The current status of the booking ie BookingStatusEnum.

Output

Retrieve Booking Details

GET Endpoint to retreive the booking details.

https://outward-api-dev.farepod.co/api/v1/bookings/:id

The input request body is empty

The output includes an object with the following key fields:

• _id: The unique booking ID.
• priceDetail: An object representing the pricing details, including total fare, base fare, taxes, fees, and management fees.
• segments: An array of objects representing the flight segments, with fields like flight name, number, duration, departure, and arrival details.
• passengers: An object containing details of passengers (adults, children, and infants) in the booking.
• status: The current status of the booking ie BookingStatusEnum.

Output

BookingStatusEnum

Status of booking returned in book and get booking details API

CabinClassEnum

RefundableEnum

PassengerTitleEnum

FareSearchPnrFilterEnum

You should put the credentials in the header of the request. The credentials are as follows: There are two types of credentials:

1. X-API-KEY: The API key is used to authenticate the API request. To be passed in header in every request
2. X-API-SECRET: The API secret is used to create more security for the API request. To be passed in header in every request