Flight API · Search & pricing
FlightStartSearch
This function is designed to search flights availability and fares for GDS and LCC content. It returns available flights for GDS and then launch routers searching LCC suppliers in relation to the search request.
It facilitates a wide range of options, ensuring that customers can narrow down or broaden the flights search, in order to precisely match their request.
Request
<FlightStartSearchRQ>
<Credentials>
<Login>?</Login>
<Password>?</Password>
</Credentials>
<User>?</User>
<OfficeIds>
<OfficeId Curr="?">?</OfficeId>
<OfficeId>?</OfficeId>
</OfficeIds>
<Curr>?</Curr>
<Ilng>?</Ilng>
<Flight>
<Content>?</Content>
<Passenger>
<Adult>?</Adult>
<Child>?</Child>
<Infant>?</Infant>
</Passenger>
<FareOptions>
<Type>?</Type>
</FareOptions>
<FlightOptions>
<Class>?</Class>
<Company>?</Company>
<FlightType>?</FlightType>
<AirportOnly>?</AirportOnly>
<Luggage>?</Luggage>
</FlightOptions>
<Itineraries>
<Itinerary>
<Ref>?</Ref>
<Class>?</Class>
<Departure>
<Code>?</Code>
<Type>?</Type>
</Departure>
<Arrival>
<Code>?</Code>
<Type>?</Type>
</Arrival>
<TimeDetails>
<Date>?</Date>
<RangeOfDate>
<Qualifier>?</Qualifier>
<Interval>?</Interval>
</RangeOfDate>
<Time></Time>
<RangeOfTime>
<Interval>?</Interval>
</RangeOfTime>
</TimeDetails>
</Itinerary>
</Itineraries>
</Flight>
</FlightStartSearchRQ>| Root | Sub root | Tag | Description | Values & Format |
|---|---|---|---|---|
| Credentials | Mandatory | |||
| Login | Mandatory | |||
| Password | Mandatory | |||
| User | Mandatory | |||
| OfficeIds | Optional | If you don’t specify any officeId, we use the first one in DB | Only for GDS | |
| OfficeId | Optional | alphanumeric character | Only for GDS | |
| OfficeId:Curr | Optional | 3 alphanumeric character | Only for GDS to specify the currency per office id | |
| Curr | Optional | 3 alphanumeric character | GDS : We use this node for officeid without attribute curr. | |
| Ilng | Mandatory | Numeric value | Default value 2 (English) | |
| Flight | Mandatory | |||
| Content | Mandatory | Type of requested flights | all, LCC : low cost flights, GDS : regular flights, Train: low cost trains | |
| Passenger | Mandatory | This parameter is designed to specify the number of seats required for the travelling passengers of flights | Maximum 9 passengers | |
| Passenger:Adult | Mandatory | Numeric value | At least one adult must be specified | |
| Passenger:Child | Mandatory | Numeric value | It can be 0 or plus | |
| Passenger:Infant | Mandatory | Numeric value | It can be 0 or plus | |
| FareOptions:Type | Optional(GDS only) | The user has the ability to between two types of fare : *No Restriction, return all available flights without restriction *Refundable, return only flights that may be refundable | NR : No Restriction RF : Refundable fares Default value NR | |
| FlightOptions: Class | Optional(GDS only) | The user has the ability to specify a desired cabin class of requested flights | M : Standard economic W : Premium economic Y : Economic C : Business F : First | |
| FlightOptions: Company | Optional(GDS only) | The user has the ability to specify which operator he wants of requested flights | 2 alphanumeric character | |
| FlightOptions: FlightType | Optional | The User has the ability to request Non-Stop or Direct flights; or also a combination of these categories | N: Direct (No-Stop) D: Direct (with technical stopover) X: Direct (No-Stop) & Direct (with technical stopover) E: Exclude mixed company | |
| FlightOptions: AirportOnly | Optional | The User has the ability to propose nearby airports or only exact airports | True or False by default False | |
| FlightOptions: RejectMixed | Optional | The User has the ability to request only flights companies. | True or False by default False | |
| FlightOptions: Luggage | Optional | The User has the ability to request flights with bags | True : filter flights with bags Other value or no node : return all flights | |
| Itineraries: Itinerary: | Mandatory | At least one itinerary | ||
| Ref | Mandatory | Rank of itinerary for requested flights, Numeric value | Incremental value, initial value is 1 | |
| Class | Optional(GDS only) | The user has the ability to specify a desired cabin class of requested itinerary | M : Standard economic W : Premium economy Y : Economic C : Business F : First | |
| Departure | Mandatory | The user must specify a departure location, each location is composed of | ||
| Departure:Code | Mandatory | International code of airport or city | 3 alphanumeric character | |
| Departure:Type | Type of location | Airport City | ||
| Arrival | Optional | The user must specify an arrival location, each location is composed of | ||
| Arrival:Code | Mandatory | International code of airports or cities | 3 alphanumeric character | |
| Arrival:Type | Optional | Type of location | Airport City | |
| TimeDetails:Date | Mandatory | The earliest date that a recommended flight may "depart from" | dd/MM/yyyy | |
| TimeDetails: RangeOfDate | Optional(GDS only) | The User has the ability to request that the requested flights include the day before or the day after the date specified for an itinerary | ||
| TimeDetails: RangeOfDate: Qualifier | Optional(GDS only) | P : Plus M : Minus, C: Plus & Minus | ||
| TimeDetails: RangeOfDate: Interval | Optional(GDS only) | It is currently not possible to request more than 1 day forward and/or1 day backward for the searchable date range | [1..2] | |
| TimeDetails: Time | Optional(GDS only) | The earliest time that a recommended flight may "depart from" | HH:MM | |
| TimeDetails: RangeOfTime: Inetrval | Optional(GDS only) | The User has the ability to specify an applicable time window range, in terms of hours, to a specified time by departure option. Thus, allowing the requested flights include any flight recommendations that depart within the specified number of hours on either side of the specified time by departure | [1..12] |
Response
<FlightStartSearchRS>
<lcc>
<CarrierCode>?</CarrierCode>
<Suppliers>
<Supplier>?</Supplier>
<Supplier>?</Supplier>
</Suppliers>
</lcc>
<Flights>
<Flight>
<Content>?</Content>
<Currency>?</Currency>
<Amount>?</Amount>
<Duration>?</Duration>
<Stops>?</Stops>
<SFM>?</SFM>
<OfficeId>?</OfficeId>
<Itineraries>
<Itinerary>
<Ref>?</Ref>
<Duration>?</Duration>
<Stops>?</Stops>
<AvailableSeats>?</AvailableSeats>
<Segments>
<Segment>
<FlightId>?</FlightId>
<Operator>?</Operator>
<Equipment>?</Equipment>
<Depart>?</Depart>
<DepartDate>?</DepartDate>
<DepartTime>?</DepartTime>
<DepartTerminal>?</DepartTerminal>
<Arrive>?</Arrive>
<ArriveDate>?</ArriveDate>
<ArriveTime>?</ArriveTime>
<ArriveTerminal>?</ArriveTerminal>
<Class>?</Class>
<BookingClass>?</BookingClass>
<AvailableSeats>?</AvailableSeats>
</Segment>
</Segments>
</Itinerary>
</Itineraries>
</Flight>
</Flights>
</FlightStartSearchRS>| Root | Sub root | Tag | Description |
|---|---|---|---|
| lcc | Optional | Available only if the value of parameter "Content" in request is "all, lcc or train" | |
| CarrierCode | Optional | Carrier code to be used to get lcc flights | |
| Suppliers : Supplier | Optional | List of Supplier which can assume lcc flights | |
| Flights:Flight | |||
| Content | Mandatory | Type of flight : always GDS | |
| C urrency | Mandatory | Currency’s code used to calculate Flight Amount 3 alphanumeric character | |
| Amount | Mandatory | Amount of flight | |
| Duration | Mandatory | Duration of flight | |
| Stops | Mandatory | Total stop of flight | |
| OfficeId | Mandatory | OfficeId to be used for API FlightDetailRQ, Only for GDS | |
| SFM | Optional | Contains Amadeus service fees, to be used for API FlightDetailRQ, Only for GDS | |
| Itineraries: Itinerary | Mandatory | Response for each requested itinerary | |
| Ref | Mandatory | Rank of itinerary for the flight | |
| Duration | Optional | Duration of itinerary : 99h99m | |
| Stops | Mandatory | Count of stops for the itinerary | |
| AvailableSeats | Mandatory | This node serves to check the number of available seats by itinerary | |
| Segments: Segment | Mandatory | Each itinerary can be composed by one or more segments | |
| FlightId | Mandatory | Number of flight for the segment | |
| Operator | Mandatory | Used operator for the segment | |
| Equipment | Optional | Used equipment for the segment | |
| Depart | Mandatory | Departure location for the segment | |
| DepartDate | Mandatory | Depart date for the segment : dd/MM/yyyy | |
| DepartTime | Mandatory | Depart time for the segment : HH:MM | |
| DepartTerminal | Optional | Used terminal for the segment | |
| Arrive | Mandatory | Arrive location for the segment | |
| ArriveDate | Mandatory | Arrival date for the segment : dd/MM/yyyy | |
| ArriveTime | Mandatory | Arrival time for the segment : dd/MM/yyyy | |
| ArriveTerminal | Optional | Used terminal for the segment | |
| Class | Optional | Type of class for the segment | |
| BookingClass | Optional | Type of booking class for the segment | |
| AvailableSeats | Optional | This node serves to check the number of available seats by segment |
Example
Request
<FlightStartSearchRQ>
<Credentials>
<Login>Cu2gOrbzhN0=</Login>
<Password>mtPXhFzrzuM=</Password>
</Credentials>
<User>707</User>
<OfficeIds>
<OfficeId>OOOO01</OfficeId>
<OfficeId>OOOO02</OfficeId>
</OfficeIds>
<Curr>MAD</Curr>
<Ilng>1</Ilng>
<Flight>
<Content>all</Content>
<Passenger>
<Adult>1</Adult>
<Child>0</Child>
<Infant>0</Infant>
</Passenger>
<FareOptions>
<Type>NR</Type>
</FareOptions>
<FlightOptions>
<Class>M</Class>
<Company>AF</Company>
<FlightType>N</FlightType>
<AirportOnly>True</AirportOnly>
</FlightOptions>
<Itineraries>
<Itinerary>
<Ref>1</Ref>
<Departure>
<Code>PAR</Code>
<Type>City</Type>
</Departure>
<Arrival>
<Code>TUN</Code>
<Type>City</Type>
</Arrival>
<TimeDetails>
<Date>01/10/2012</Date>
<RangeOfDate>
<Qualifier>P</Qualifier>
<Interval>1</Interval>
</RangeOfDate>
</TimeDetails>
</Itinerary>
</Itineraries>
</Flight>
</FlightStartSearchRQ>Response
<FlightStartSearchRS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<lcc>
<CarrierCode>V14EVYBWRB1EY35S</CarrierCode>
<Suppliers>
<Supplier>Air Mediterranee</Supplier>
<Supplier>Transavia</Supplier>
</Suppliers>
</lcc>
<Flights>
<Flight>
<Content>gds</Content>
<Currency>MAD</Currency>
<Amount>11777</Amount>
<Duration>02h30m</Duration>
<Stops>0</Stops>
<OfficeId>OOOO01</OfficeId>
<SFM>0</SFM>
<Itineraries>
<Itinerary>
<Ref>1</Ref>
<Duration>02h30m</Duration>
<Stops>0</Stops>
<AvailableSeats>7</AvailableSeats>
<Segments>
<Segment>
<key>?</Key>
<FlightId>2184</FlightId>
<Operator>AF</Operator>
<Equipment>319</Equipment>
<Depart>CDG</Depart>
<DepartDate>01/10/2012</DepartDate>
<DepartTime>07:35</DepartTime>
<DepartTerminal>2F</DepartTerminal>
<Arrive>TUN</Arrive>
<ArriveDate>01/10/2012</ArriveDate>
<ArriveTime>09:05</ArriveTime>
<ArriveTerminal>M</ArriveTerminal>
<Class>M</Class>
<BookingClass>B</BookingClass>
<AvailableSeats>7</AvailableSeats>
</Segment>
</Segments>
</Itinerary>
</Itineraries>
</Flight>
</Flights>
</FlightStartSearchRS>