InstaFlights Search

The InstaFlights Search API retrieves roundtrip or one-way flight itineraries with published fares and fare breakdowns for a given city pair and departure date.

In detail: the API uses the Travel Insight engine to retrieve shopped fare data for a given origin available in the Sabre® cache. In total, the API returns 300 of the lowest-priced itineraries, with 50 itineraries per request, then sorts the itineraries by fare in ascending rank order (from low to high).

Multiple search preferences are available to sort and filter results, including the ability to: filter itineraries to exclude particular airlines (excludedcarriers); retrieve online itineraries only (onlineitinerariesonly); limit the response to only those options with enough seats available to support the passenger count (passengercount); or to retrieve itineraries with a total fare that is less than or equal to a given price (maxfare).

API Information

Target Audience
Sabre Travel Network
Current Version
v1
Authentication
Sessionless Token
Method/Endpoint
GET /v1/shop/flights HTTP/1.1

GET /v1/shop/flights/tags/{tagid}

The Tag ID Lookup endpoint has a required tagid URI variable which retrieves the itinerary for a given tag ID. Any valid Tag ID can be substituted for {tagid}. A TagID is returned with each itinerary when enabletagging=true used in a previous InstaFlights Search API request.

Ready to try the APIs?

Ready to get your hands dirty?

 Register Try the APIs

Ready to launch?

Ready to step up to the production level service? We're standing by to fit you for your spacesuit.

Request Production Key

Resources

Data used by the InstaFlights Search API

  • Shopping response data from the Sabre® GDS, which includes published fares and itineraries, that is refreshed on a regular basis using pre-configured points of sale for pre-configured sets of city pairs, pre-configured advance purchase windows, and pre-configured lengths of stay, all as determined by Sabrein its discretion.
  • Flight types: nonstop, connecting, and flights with stops
  • Origin: major airports throughout the world that we support
  • Destination: major airports throughout the world that we support
  • Advance fares: A maximum of 192 days
  • Total fares: All taxes and fees are included, however, ancillary fees charged by airlines, such as baggage and preferred seating, are not included.
  • All fares are for single adult, roundtrip or one-way travel in the economy class of service. The combined total for all passengers (all fares plus tax) is returned in ItinTotalFare.TotalFare.Amount.

Request

origin

string, required

3-letter IATA code of the origin airport or multi-airport city (MAC) code

Sample value: origin=ATL

See usage notes: for more information on retrieving a list of our supported city pairs of origin and destination airports using the City Pairs Lookup API, multi-airport city (MAC) codes using the Multi-Airport City Lookup API, or to identify the airports associated with a MAC using the Airports at Cities Lookup API.

destination

string, required

3-letter IATA code of the destination airport or multi-airport city (MAC) code code

Sample value: destination=LAS

See usage notes: for more information on retrieving a list of our supported city pairs of origin and destination airports using the City Pairs Lookup API, multi-airport city (MAC) codes using the Multi-Airport City Lookup API, or to identify the airports associated with a MAC using the Airports at Cities Lookup API.

departuredate

string, required

Date of departing flight in the time zone of the origin airport

Only one value is accepted

Maximum value: current date + 192 (days)

Sample value: departuredate=2016-10-30

returndate

string, optional

Date of returning flight in the time zone of the destination airport

Only one value is accepted

Maximum value: departuredate + 16 (days) length of stay

Sample value: returndate=2016-10-31

includedcarriers

string, optional

2-letter IATA airline code of one or more airline companies

Searches for itineraries with this marketing airline code in all inbound and outbound flight legs and flight segments, and excludes itineraries with other marketing airline codes from the response

Sample values: includedcarriers=UA,DL,US

excludedcarriers

string, optional

2-letter IATA airline code of one or more airline companies

Searches for itineraries with this marketing airline code in any inbound and outbound flight leg and flight segment, and excludes these itineraries from the response

Sample value: excludedcarriers=US,UA

outboundflightstops

number, optional

The maximum quantity of flight connections on all outbound flight segments on an outbound itinerary

When using this parameter, a connecting flight is a flight with a change of plane.

Valid values: 0–99

Sample value: outboundflightstops=2

The maximum quantity of flight connections on an outbound itinerary

This applies to:

  • Connecting flights. Connecting flights require a change of planes.
  • All outbound flight segments on an outbound itinerary

Note: flights with a stop, without a change of plane, are not considered to be a connection when using this parameter.

inboundflightstops

number, optional

The maximum quantity of flight connections on all inbound flight segments on an inbound itinerary

When using this parameter, a connecting flight is a flight with a change of plane.

Valid values: 0–99

Sample value: inboundflightstops=3

The maximum quantity of flight connections on an inbound itinerary

This applies to:

  • Connecting flights. Connecting flights require a change of planes.
  • All inbound flight segments on an inbound itinerary
includedconnectpoints

string, optional

IATA airport code of connection points that must appear on both the inbound and outbound flight legs on a roundtrip or one-way itinerary with connecting flights

The response includes itineraries with all included connection points on both the outbound and inbound flight legs.

Itineraries with other connections points are notexcluded from the response. Therefore, the response may include itineraries with connection points that you do not specify.

When using this parameter, a connection is defined as a flight with a change of plane.

Valid values: 1–3 IATA airport codes, separated with commas

Sample values: includedconnectpoints=DFW,LAS

excludedconnectpoints

string, optional

IATA airport code of connection points that must not appear on either an inbound, an outbound, or both connecting flights on a roundtrip or one-way itinerary

The response excludes itineraries when the excluded connection points appear anywhere, on either the inbound, outbound, or both flight legs.

When using this parameter, a connection is defined as a flight with a change of plane.

Valid values: 1–3 IATA airport codes, separated with commas

Sample values: excludedconnectpoints=DFW,ORD

outboundstopduration

number, optional

The sum of the total waiting time for all connections on an outbound itinerary

This applies only to connecting flights that require a change of planes. It does not apply to flights with stops, without a change of plane.

Valid values: 0–9999 minutes

Sample value: outboundstopduration=60

Example:

An outbound itinerary has 3 flight segments with 2 connections. The outboundstopduration is the total waiting time for each connection, from the arrival of the first flight segment until the departure of the second segment, plus the waiting time from the arrival of the second segment until the departure of the third segment.

Calculation for outboundstopduration:

The API takes the total elapsed time for all outbound flights. It adds the elapsed times for all outbound flight segments and then subtracts this sum from the total elapsed outbound time.

inboundstopduration

number, optional

The sum of the total waiting time for all connections on an inbound itinerary

This applies only to connecting flights that require a change of plane. It does not apply to flights with stops, without a change of plane.

Valid values: 0–9999 minutes

Sample value: inboundstopduration=100

Example:

An inbound itinerary has 2 flight segments that are connecting flights. The inboundstopduration is the total waiting time for the connection, from the arrival of the first flight segment until the departure of the second and final segment.

Calculation for inboundstopduration:

The API takes the total elapsed time for all inbound flights. It adds the elapsed times for all inbound flight segments and then subtracts this sum from the total elapsed inbound time.

outbounddeparturewindow

string, optional

Format: HHMMHHMM

Time range during which a first outbound flight segment can depart on the departure date

The first outbound flight segment is always the first departing flight from an origin airport.

Searches for itineraries that depart during this time range

The departure window is in the time zone of the origin airport.

Valid values in 24-hour notation:

  • HH = 00–23
  • MM = 00–59

Example: outbounddeparturewindow=06300900 searches for first flight segments on outbound flights that depart between 06:30 and 09:00 a.m. on the departure date in the request.

inbounddeparturewindow

string, optional

Format: HHMMHHMM

Time range during which a first inbound flight segment can depart on the return date

The first inbound flight segment is always the first flight on a return trip.

Searches only for itineraries that depart during this time range

The departure window is in the time zone of the departure airport.

Valid values in 24-hour notation:

  • HH = 00–23
  • MM = 00–59

Example: inboundeparturewindow=14001800 searches for first inbound flight segments that depart between 02:00 and 06:00 p.m. on the returndate in the request.

outboundarrivalwindow

string, optional

Format: HHMMHHMM

Time range during which a last outbound flight segment can arrive, after the departure date

The last outbound flight segment is the last flight from a departure airport to a destination.

Searches only for itineraries that arrive during this time range

The arrival window is in the time zone of the destination airport.

Valid values in 24-hour notation:

  • HH = 00–23
  • MM = 00–59

Example: outboundarrivalwindow=18302100 searches for last outbound flight segments on outbound flights that arrive between 06:30 and 09:00 p.m., on the departure date.

inboundarrivalwindow

string, optional

Format: HHMMHHMM

Time range during which a last inbound flight segment can arrive on the return date

The last inbound flight segment is the last flight on a return flight.

Searches only for itineraries that arrive during this time range

The arrival window is in the time zone of the arrival airport.

Valid values in 24-hour notation:

  • HH = 00–23
  • MM = 00–59

Example: inboundarrivalwindow=22000030 searches for last inbound flight segments that arrive at the destination airport between 10:00 p.m. and 12:30 a.m., starting on the returndate in the request.

onlineitinerariesonly

string, optional

An indicator to base the response on online or interline itineraries

The indicator is applied to all flight legs and flight segments on inbound and outbound itineraries.

By default, the API assumes a value of N, so it is not necessary to include this parameter to get both itinerary types.

Valid values:

  • N – returns online and interline itineraries for inbound and outbound flights
  • Y – returns online itineraries only, excluding interline itineraries
eticketsonly

string, optional

Indicator to return itineraries based on ticket types.

By default, the API assumes a value of N and retrieves itineraries with all ticket types. Therefore, if you want itineraries with all ticket types, you can omit this parameter.

The ticket type is returned in the PricedItineraries.TicketingInfo.TicketType field.

Valid values:

  • Y – returns itineraries with e-tickets only. An e-ticket is an electronic ticket.
  • N – returns itineraries with all ticket types
minfare

number, optional

Minimum total itinerary fare

The API retrieves itineraries with a total itinerary fare that is greater than or equal to minfare in ItinTotalFare.TotalFare.Amount.

Sample value: minfare=140

maxfare

number, optional

Maximum total itinerary fare

The API retrieves itineraries with a total itinerary fare that is less than or equal to maxfare in ItinTotalFare.TotalFare.Amount.

When both minfare and maxfare are present in the request, the API retrieves itineraries with total itinerary fares that are greater than or equal to minfare, and less than or equal to maxfare.

Sample value: maxfare=300

limit
string or number, optional
The number of itineraries to retrieve per request
Default value: 50 (itineraries per request)
Sample value: limit=10
See usage notes: for sample scenarios to paginate itineraries with limit and offset parameters.
offset
number, optional
The starting position in the list of all itineraries that meet the query criteria
Default value: 1
Sample value: offset=10
See usage notes: for sample scenarios to paginate itineraries with limit and offset parameters.
sortby

string, optional

Primary sort object in the response

Sort values:

totalfare – ( Default) The totalfare parameter sorts itineraries by the total amount of the itinerary in the ItinTotalFare.TotalFare.Amount response object:

departuretime – The departuretime parameter sorts itineraries by the date and time of departure in the first flight segment in the first flight leg on an itinerary in AirItinerary/OriginDestinationOptions/OriginDateOption/FlightSegment/DepartureDateTime.

elapsedtime . The elapsedtime parameter uses the following response object to sort itineraries:

AirItinerary.OriginDestinationOptions.OriginDestinationOption.ElapsedTime

If you exclude sortby and order, the API sorts itineraries by the default value of totalfare, in order from the lowest to the highest fare.

If you omit the primary sort and order parameters, the API uses default values.

order

string, optional

Sorting order for the sortby primary object

Values:

asc – ( Default) Sorts in ascending order, from lowest to highest

dsc – Sorts in descending order, from highest to lowest

You can use order without sortby – In this case, the API uses the default value for sortby.

sortby2

string, optional

Secondary sort object in the response

Sort values:

You can use sortby2 and order2 with or without including sortby and order – The API applies the default primary sort criteria.

For more information, see sortby .

order2

string, optional

Sorting order for the sortby2 secondary sort object

Values:

  • asc – Sorts in ascending order, from lowest to highest
  • dsc – Sorts in descending order, from highest to lowest

If you use sortby2, then you can omit order2.

pointofsalecountry

string, optional

2-letter ISO 3166 country code

Retrieves data specific to a given point of sale country

Default value: US

Sample value: pointofsalecountry=DE

See usage notes: for more information on point of sale and supported point of sale countries.

passengercount

number, optional

Valid values: a single value from 0-10, inclusive

Limits the response to only those options with enough seats available to support the passenger count

See usage notes: for sample scenarios to limit the response to seats remaining.

view New!
string, optional
The response view definition
Only one value accepted
Sample values:
  • view=IF_ITIN_TOTAL_PRICE - a Sabre response view that excludes numerous response paths for the InstaFlights Search API
  • view=BFM_ITIN_TOTAL_PRICE - a Sabre response view that excludes numerous response paths for the Bargain Finder Max API
Valid values: see the Response View Lookup API for a list of Sabre response views. To create a custom response view, define the response paths to include or exclude using the Custom Response View API, then pass the view as a filter in the request URI, e.g., view=NOWARNINGS to format the response.
enabletagging New!
boolean, optional
Returns a TagID for each itinerary and stores in the Sabre cache:
Default value: false – does not return or store itineraries for subsequent calls to the Sabre cache
Valid values:
  • enabletagging=true – returns and stores itineraries for subsequent calls to the Sabre cache.
  • enabletagging=false – does not return or store itineraries for subsequent calls to the Sabre cache.

Response

The response repeats flight itineraries and a fare breakdown of each itinerary:

  • AirItinerary returns flight itineraries in a FlightSegment array
  • AirItineraryPricingInfo returns fare breakdowns

FlightSegment in AirItinerary

AirItinerary returns flight itineraries in a FlightSegment array:

  • FlightSegment contains flight information for every flight leg in an itinerary
PricedItineraries

array

Repeats for every itinerary in the response

AirItinerary.DirectionInd

string

Identifies the type of trip

If returndate is specified, then the value is Return.

AirItinerary.OriginDestinationOptions.OriginDestinationOption

array

Repeats ElapsedTime and the FlightSegment array for every flight segment on an itinerary

ElapsedTime

number

The total flight time for this flight leg

The total flight time of a flight leg on an itinerary is the time from the departure date-time of the first flight segment to the arrival date-time of the last flight segment in the flight leg.

Elapsed time is calculated in minutes.

When an InstaFlights Search request includes the sortby or sortby2 parameters with the elapsedtime value, the itineraries are sorted by elapsed time in OriginDestinationOption.ElapsedTime.

FlightSegment

array

Repeats for every flight leg or flight segment on an itinerary

FlightSegment has information about a flight segment and the airline companies.

Repeat factor: The maximum is 4

ArrivalAirport.LocationCode

string

3-letter IATA code of the arrival airport for the flight segment

ArrivalDateTime

string

Arrival date-time of a flight segment

Data format: YYYY-MM-DDTHH:MM:SS

Time zones are specific to arrival and departure airports.

ArrivalTimeZone.GMTOffset

number

Offset from Greenwich Mean Time for the arrival flight

This is either a positive or a negative number.

DepartureAirport:LocationCode

3-letter IATA code of the departure airport for the flight segment

DepartureDateTime

string

Departure date-time of a flight segment

Data format: YYYY-MM-DDTHH:MM:SS

Time zones are specific to arrival and departure airports.

When a request specifies DepartureDateTime as a sort option, the API uses the first flight segment in the first flight leg on an itinerary in PricedItinerary.AirItinerary.OriginDestinationOptions.OriginDateOptions.FlightSegment.DepartureDateTime.

DepartureTimeZone.GMTOffset

number

Offset from Greenwich Mean Time for the departing flight

This is either a positive or a negative number.

StopQuantity

number

Quantity of hidden stops on a flight number

Return values: 0-99

ResBookDesigCode

string

A code for the booking class of service that the carrier specifies for the flight segment

1 or 2 uppercase alphabetic characters with a space

ElapsedTime

number

The total flight time of this flight segment, from the departure date-time of the flight segment to the arrival date-time of the flight segment

The time is calculated in minutes.

Equipment.AirEquipType

string

IATA aircraft type code for the flight segment, consisting of 3 alphanumeric characters

FlightNumber

string

Identifying number that the marketing airline assigns to the flight segment

The flight number of the flight. This is required for use with scheduled airline messages, but may be omitted for requests by tour operators.

MarketingAirline.Code

string

Standard IATA code of the marketing airline company for the flight segment

For codeshare flights, the marketing airline of the flight

The IATA code of the airline company that markets this fare to the consumer and collects the payment

If the operating and marketing airlines are the same, the values in OperatingAirline and MarketingAirline match.

This is required for use with scheduled airline messages, but may be omitted for requests by tour operators.

DisclosureAirline.Code

Standard 2-character IATA airline code of the disclosure airline

The disclosure airline can be returned in OperatingAirline.

MarriageGrp

string

Group of connecting flights that must be processed as one unit

Return values:

  • O – Next segment to be married
  • I – Previous segment to be married

Many airlines link connection flights together by calling them "married segments." When two or more segments are married, they must be processed as one unit. The segments must be moved, canceled, and/or priced together. The value of the marriage group must be the same for all segments.

OnTimePerformance.Level

string

IATA Data Element Identifier (DEI) for ontime performance rating

It is the probability that a flight will not be delayed.

If an airline files DEI502, the return value is a 3-digit percentage.

A value of N or NNN indicates that the ontime performance value is not calculated.

OperatingAirline.FlightNumber

string

Identifying number that the operating airline company assigns to the flight

OperatingAirline.Code

string

Standard IATA airline code of the airline that operates the flight segment

The operating airline can also be the disclosure airline. This is used for codeshare flights.

If the operating and marketing airlines are the same, the values in OperatingAirline and MarketingAirline match.

OperatingAirline.CompanyShortName

string

Short name of the company

1 to 64 characters

TPA_Extensions.eTicket.Ind

string

A flag that indicates if this is an electronic ticket

Return values: true or false

DataElement.SubjectToGovernmentApproval

string

A flag that indicates whether the flight is subject to government approval using IATA Data Element

Identifier DEI201

Return values: true or false

FareReference and ItinTotalFare in AirItineraryPricingInfo

AirItineraryPricingInfo returns fare breakdowns:

  • ItinTotalFare–contains the total fare (TotalFare.Amount) and a breakdown of the total, including taxes
  • PTC_FareBreakdown–contains a breakdown of all costs by passenger type, including fare basis codes and tax codes
FareInfos.FareInfo

array

An array of one or more fare reference codes

FareReference

string

The booking code for the fare that corresponds to the flight segment in the itinerary

1 to 8 characters

TPA_Extensions

object

Contains associated cabin information:

  • Cabin, string
  • SeatsRemaining, number
Cabin

string

Cabin code of the flight segment for the itinerary and fare

Return values:

P – Premium first class cabin

F – First class cabin

J – Premium business class cabin

C – Business class cabin

S – Premium economy class cabin

Y – Economy class cabin

SeatsRemaining.Number

number

The quantity of seats available for the specified fare and itinerary

Note: All flight options returned will have a quantity equal to or greater than the passengercount defined in the request.

See usage notes: for sample scenarios to limit the response to seats remaining.

Meal.Code

string

IATA code for the type of meal

Each airline assigns its own meal codes. The codes are typically one character.

AirItineraryPricingInfo.LastTicketDate

string

The last date that the fare can be booked

ItinTotalFare

object

The fare breakdown of the itinerary:

  • Taxes, array
  • TotalFare, object
  • EquivFare, object
  • BaseFare, object
  • FareConstruction, object
Taxes.Tax

array

The sum of all taxes of the itinerary:

  • Amount, number
  • TaxCode, string
  • DecimalPlaces, number
  • CurrencyCode, string
Taxes.Tax.Amount

number

The sum of all taxes applied to the total fare

Taxes.Tax.TaxCode

string

Return value: TOTALTAX

Taxes.Tax.DecimalPlaces

number

Quantity of decimal places in the amount

Return value: 2

Taxes.Tax.CurrencyCode

string

3-character currency code

Sample value: USD

ItinTotalFare.TotalFare

object

  • Amount, number
  • DecimalPlaces, number
  • CurrencyCode, string
TotalFare.Amount

number

The combined total for all passengers (all fares plus tax)

If sortby or sortby2 are specified with a value of totalfare, then the itineraries in the response are sorted by ItinTotalFare.TotalFare.Amount.

TotalFare.DecimalPlaces

number

Quantity of decimal places in the amount

Return value: 2

TotalFare.CurrencyCode

string

3-character currency code

Sample value: USD

ItinTotalFare.EquivFare

object

The fare breakdown of the equivalent fare of the itinerary:

  • Amount, number
  • DecimalPlaces, number
  • CurrencyCode, string
EquivFare.Amount

number

The equivalent fare amount

EquivFare.DecimalPlaces

number

Quantity of decimal places in the amount

Return value: 2

EquivFare.CurrencyCode

string

3-character currency code

Sample value: USD

ItinTotalFare.BaseFare

object

The fare breakdown of the base fare:

  • Amount, number
  • DecimalPlaces, number
  • CurrencyCode, string
BaseFare.Amount

number

The amount of the base fare

BaseFare.DecimalPlaces

number

Quantity of decimal places in the amount

Return value: 2

BaseFare.CurrencyCode

string

3-character currency code

Sample value: USD

ItinTotalFare.FareConstruction

object

  • Amount, number
  • DecimalPlaces, number
  • CurrencyCode, string
FareConstruction.Amount

number

FareConstruction.DecimalPlaces

number

Quantity of decimal places in the amount

Return value: 2

FareConstruction.CurrencyCode

string

3-character currency code

Sample value: USD

PTC_FareBreakdowns in AirItineraryPricingInfo

AirItineraryPricingInfo.PTC_FareBreakdowns.PTC_FareBreakdown

object

The fare breakdown of an itinerary:

  • repeats one PTC_FareBreakdown for each passenger type and provides pricing for each passenger type on an itinerary
Endorsements.NonRefundableIndicator

string

Indicator for whether a fare is refundable

Return values:

  • true – The fare is not refundable.
  • false – The fare is refundable.
FareBasisCodes.FareBasisCode

array

An array of fare basis codes for the fare for this passenger type

The fare basis codes in the response are used to price the segments in the itinerary.

Repeat factor: A maximum of 10.

FareBasisCode.content

string

The fare basis code

FareBasisCode.BookingCode

string

Booking code of the fare basis code

1 character

FareBasisCode.DepartureAirport.LocationCode

string

The IATA airport code of the departure airport

FareBasisCode.ArrivalAirport.LocationCode

string

The IATA airport code of the arrival airport

PTC_FareBreakdown.PassengerFare

object

A breakdown of the fare for the passenger type and quantity into taxes, total fare, equivalent fare, and base fare objects

PTC_FareBreakdown.PassengerFare.BaseFare

object

The base fare for the passenger type and quantity

PassengerFare.BaseFare.Amount

number

The amount of the base fare for the passenger type and quantity

PassengerFare.BaseFare.CurrencyCode

string

3-character currency code

Sample value: USD

PassengerFare.EquivFare.Amount

number

The equivalent fare amount for the passenger type and quantity

PassengerFare.EquivFare.DecimalPlaces

number

Quantity of decimal places in the amount

Return value: 2

PassengerFare.EquivFare.CurrencyCode

string

3-character currency code

Sample value: USD

PassengerFare.Taxes.Tax

array

A repeating array of the tax codes and amounts that are applied to the fare for the passenger type and quantity

Repeat factor: Repeats for every tax code that is applied to a fare.

PassengerFare.Taxes.Tax.Amount

number

The amount of tax for the tax code in PassengerFare.Taxes.Tax.TaxCode

PassengerFare.Taxes.Tax.TaxCode

string

The tax code as assigned by a national government

PassengerFare.Taxes.Tax.DecimalPlaces

number

Quantity of decimal places in the amount

Return value: 2

PassengerFare.Taxes.Tax.CurrencyCode

string

3-character currency code

PassengerFare.Taxes.TotalTax

object

The sum of all tax code amounts for the breakdown of this passenger type and quantity

PassengerFare.Taxes.TotalTax.Amount

number

The sum of the total taxes in PTC_Breakdown.PassengerFare.Taxes.Tax

PassengerFare.Taxes.TotalTax.DecimalPlaces

number

Quantity of decimal places in the amount

Return value: 2

PassengerFare.Taxes.TotalTax.CurrencyCode

string

3-character currency code

Sample value: USD

PassengerFare.TotalFare.Amount

number

The amount of the total fare for the passenger type and quantity

This is a sum of the base fare and the total taxes.

PassengerFare.TotalFare.CurrencyCode

string

3-character currency code

Sample value: USD

PassengerFare.TPA_Extensions.Surcharges

object

Surcharge amounts for this passenger fare in the fare's currency

Surcharges.Ind

string

The type code of the surcharge

1 alphabetic character

Surcharges.Type

string

The type of the surcharge

PassengerTypeQuantity.Quantity

number

The quantity of passengers for this Passenger Type Code

Return value: 1

PassengerTypeQuantity.Code

string

The Passenger Type Code

3 alphabetic characters

Return value: ADT (adult passenger type)

AirItineraryPricingInfo.TPA_Extensions.DivideInParty.Indicator

string

An indicator for different passenger types that are booked in different inventories

The API supports a single adult passenger type of ADT, therefore, you can ignore this indicator.

Return values: true or false

Miscellaneous Data in Root and PricedItineraries

This table includes descriptions of other itinerary information.

PricedItineraries.SequenceNumber

number

The order or position of the itinerary in the response

The sequence number can be the value of an offset parameter in the request.

PricedItineraries.TPA_Extensions.ValidatingCarrier.Code

string

The IATA code of the airline company that issues the ticket, holds the payment for the flight, and reimburses other airlines, such as marketing and operating airlines

1 to 8 characters

PricedItineraries.TicketingInfo.TicketType

string

TicketingInfo object with a TicketType string

The type of ticketing for the itinerary.

Return values:

  • eTicket
  • Paper
ReturnDateTime

string

Returns the specified return date in the time zone of the destination airport

Data format: YYYY-MM-DDTHH:MM:SS

DepartureDateTime

string

Returns the specified departure date in the time zone of the origin airport

Data format: YYYY-MM-DDTHH:MM:SS

DestinationLocation

string

Returns the specified 3-letter IATA destination airport or multi-airport city (MAC) code

OriginLocation

string

Returns the specified 3-letter IATA origin airport or multi-airport city (MAC) code

TagID New!
string
The tag ID for the respective itinerary
A tag ID is returned when enabletagging=true is used in a previous InstaFlights Search API request
The tag ID can be used to retrieve an itinerary from the Tag ID Lookup URL
Note: tag IDs have a finite lifetime of 30 minutes. Expiration values are subject to change without notice. 404 Not Found is returned if a given tag ID is not found or expired.
Page New!
object
Returns associated "pagination" information:
  • Size, number
  • TotalTags, number
  • Offset, number
Size New!
number
The number of elements returned on the current page
TotalTags New!
number
The total number of tags cached from the initial request
Offset New!
number
Returns the value specified in offset
prevResults

object

Retrieves a previous set of itineraries in an InstaFlights Search request

The prevResults link is included when a request specifies a value for offset that is not 1. For API requests that support the offset and limit parameters, the prevResults link retrieves the previous set of response data. To calculate an offset, the API subtracts the value in limit from the offset in the current request.

nextResults

object

Retrieves the next set of itineraries in an InstaFlights Search API request

In API requests that support the offset and limit parameters, a nextResults link is included. The nextResults link retrieves the next set of response data. To calculate an offset, the API adds the value in limit to the offset in the current request. When data is no longer available, the nextResults link is excluded, for example, no more published fares are available for retrieval for a given request.

self

object

Returns the URL of the request that generated the response

tagLookupLinkTemplate New!
Formats an API request with placeholders to retrieve the itinerary associated with a given tag ID
linkTemplate

object

Formats an API request with placeholders for required and optional query parameters

Examples: request and response

The following example demonstrates a basic request and response for roundtrip itineraries: with enabletagging=true to return tag IDs, and a limit value of 2 itineraries.

GET https://api.sabre.com/v1/shop/flights?origin=ATL&destination=LAS&departuredate=2016-08-13&returndate=2016-08-15&limit=1&enabletagging=true HTTP/1.1
{
	"PricedItineraries": [{
		"AirItinerary": {
			"OriginDestinationOptions": {
				"OriginDestinationOption": [{
					"FlightSegment": [{
						"DepartureAirport": {
							"LocationCode": "ATL"
						},
						"ArrivalAirport": {
							"LocationCode": "LAS"
						},
						"MarketingAirline": {
							"Code": "F9"
						},
						"ArrivalTimeZone": {
							"GMTOffset": -7
						},
						"TPA_Extensions": {
							"eTicket": {
								"Ind": true
							}
						},
						"StopQuantity": 0,
						"ElapsedTime": 252,
						"ResBookDesigCode": "W",
						"MarriageGrp": "O",
						"Equipment": {
							"AirEquipType": 320
						},
						"DepartureDateTime": "2016-08-13T18:15:00",
						"ArrivalDateTime": "2016-08-13T19:27:00",
						"FlightNumber": 1455,
						"OnTimePerformance": {
							"Percentage": 86
						},
						"OperatingAirline": {
							"FlightNumber": 1455,
							"Code": "F9"
						},
						"DepartureTimeZone": {
							"GMTOffset": -4
						}
					}],
					"ElapsedTime": 252
				},
				{
					"FlightSegment": [{
						"DepartureAirport": {
							"LocationCode": "LAS"
						},
						"ArrivalAirport": {
							"LocationCode": "ATL"
						},
						"MarketingAirline": {
							"Code": "F9"
						},
						"ArrivalTimeZone": {
							"GMTOffset": -4
						},
						"TPA_Extensions": {
							"eTicket": {
								"Ind": true
							}
						},
						"StopQuantity": 0,
						"ElapsedTime": 238,
						"ResBookDesigCode": "W",
						"MarriageGrp": "O",
						"Equipment": {
							"AirEquipType": 320
						},
						"DepartureDateTime": "2016-08-15T21:45:00",
						"ArrivalDateTime": "2016-08-16T04:43:00",
						"FlightNumber": 1456,
						"OnTimePerformance": {
							"Percentage": 79
						},
						"OperatingAirline": {
							"FlightNumber": 1456,
							"Code": "F9"
						},
						"DepartureTimeZone": {
							"GMTOffset": -7
						}
					}],
					"ElapsedTime": 238
				}]
			},
			"DirectionInd": "Return"
		},
		"TPA_Extensions": {
			"ValidatingCarrier": {
				"Code": "F9"
			},
			"TagID": "instaflights~dfa7834f-34ab-4edc-835e-0cd14927d642~1"
		},
		"SequenceNumber": 1,
		"AirItineraryPricingInfo": {
			"PTC_FareBreakdowns": {
				"PTC_FareBreakdown": {
					"FareBasisCodes": {
						"FareBasisCode": [{
							"BookingCode": "W",
							"DepartureAirportCode": "ATL",
							"AvailabilityBreak": true,
							"ArrivalAirportCode": "LAS",
							"content": "W14AXS5"
						},
						{
							"BookingCode": "W",
							"DepartureAirportCode": "LAS",
							"AvailabilityBreak": true,
							"ArrivalAirportCode": "ATL",
							"content": "W14AXS5"
						}]
					},
					"PassengerTypeQuantity": {
						"Quantity": 1,
						"Code": "ADT"
					},
					"PassengerFare": {
						"FareConstruction": {
							"CurrencyCode": "USD",
							"DecimalPlaces": 2,
							"Amount": 119.06
						},
						"TotalFare": {
							"CurrencyCode": "USD",
							"Amount": "156.20"
						},
						"Taxes": {
							"TotalTax": {
								"CurrencyCode": "USD",
								"DecimalPlaces": 2,
								"Amount": 37.14
							},
							"Tax": [{
								"CurrencyCode": "USD",
								"DecimalPlaces": 2,
								"TaxCode": "US1",
								"Amount": 8.94
							},
							{
								"CurrencyCode": "USD",
								"DecimalPlaces": 2,
								"TaxCode": "ZP",
								"Amount": "8.00"
							},
							{
								"CurrencyCode": "USD",
								"DecimalPlaces": 2,
								"TaxCode": "AY",
								"Amount": "11.20"
							},
							{
								"CurrencyCode": "USD",
								"DecimalPlaces": 2,
								"TaxCode": "XF",
								"Amount": "9.00"
							}]
						},
						"BaseFare": {
							"CurrencyCode": "USD",
							"Amount": 119.06
						},
						"EquivFare": {
							"CurrencyCode": "USD",
							"DecimalPlaces": 2,
							"Amount": 119.06
						}
					}
				}
			},
			"FareInfos": {
				"FareInfo": [{
					"TPA_Extensions": {
						"Cabin": {
							"Cabin": "Y"
						},
						"SeatsRemaining": {
							"BelowMin": false,
							"Number": 4
						}
					},
					"FareReference": "W"
				},
				{
					"TPA_Extensions": {
						"Cabin": {
							"Cabin": "Y"
						},
						"SeatsRemaining": {
							"BelowMin": false,
							"Number": 4
						}
					},
					"FareReference": "W"
				}]
			},
			"TPA_Extensions": {
				"DivideInParty": {
					"Indicator": false
				}
			},
			"ItinTotalFare": {
				"FareConstruction": {
					"CurrencyCode": "USD",
					"DecimalPlaces": 2,
					"Amount": 119.06
				},
				"TotalFare": {
					"CurrencyCode": "USD",
					"DecimalPlaces": 2,
					"Amount": "156.20"
				},
				"Taxes": {
					"Tax": [{
						"CurrencyCode": "USD",
						"DecimalPlaces": 2,
						"TaxCode": "TOTALTAX",
						"Amount": 37.14
					}]
				},
				"BaseFare": {
					"CurrencyCode": "USD",
					"DecimalPlaces": 2,
					"Amount": 119.06
				},
				"EquivFare": {
					"CurrencyCode": "USD",
					"DecimalPlaces": 2,
					"Amount": 119.06
				}
			}
		},
		"TicketingInfo": {
			"TicketType": "eTicket"
		}
	}],
	"ReturnDateTime": "2016-08-15",
	"DepartureDateTime": "2016-08-13",
	"DestinationLocation": "LAS",
	"OriginLocation": "ATL",
	"Links": [{
		"rel": "self",
		"href": "https://api.sabre.com/v1/shop/flights?origin=ATL&destination=LAS&departuredate=2016-08-13&returndate=2016-08-15&limit=1&enabletagging=true"
	},
	{
		"rel": "linkTemplate",
		"href": "https://api.sabre.com/v1/shop/flights?origin=<origin>&destination=<destination>&departuredate=<departuredate>&returndate=<returndate>&offset=<offset>&limit=<limit>&sortby=<sortby>&order=<order>&sortby2=<sortby2>&order2=<order2>&minfare=<minfare>&maxfare=<maxfare>&includedcarriers=<includedcarriers>&excludedcarriers=<excludedcarriers>&outboundflightstops=<outboundflightstops>&inboundflightstops=<inboundflightstops>&outboundstopduration=<outboundstopduration>&inboundstopduration=<inboundstopduration>&outbounddeparturewindow=<outbounddeparturewindow>&outboundarrivalwindow=<outboundarrivalwindow>&inbounddeparturewindow=<inbounddeparturewindow>&inboundarrivalwindow=<inboundarrivalwindow>&onlineitinerariesonly=<onlineitinerariesonly>&eticketsonly=<eticketsonly>&includedconnectpoints=<includedconnectpoints>&excludedconnectpoints=<excludedconnectpoints>&pointofsalecountry=<pointofsalecountry>&passengercount=<passengercount>&enabletagging=<enabletagging>"
	},
    {
        "rel": "tagLookupLinkTemplate"
        "href": "https://api.sabre.com/v1/shop/flights/tags/<tagid>"
}]
}

The following example demonstrates a request for a detailed itinerary from the Tag ID Lookup URL.

GET https://api.sabre.com/v1/shop/flights/tags/instaflights~dfa7834f-34ab-4edc-835e-0cd14927d642~1 HTTP/1.1
{
  "AirItinerary": {
    "OriginDestinationOptions": {
      "OriginDestinationOption": [
        {
          "FlightSegment": [
            {
              "DepartureAirport": {
                "LocationCode": "ATL"
              },
              "ArrivalAirport": {
                "LocationCode": "LAS"
              },
              "MarketingAirline": {
                "Code": "F9"
              },
              "ArrivalTimeZone": {
                "GMTOffset": -7
              },
              "TPA_Extensions": {
                "eTicket": {
                  "Ind": true
                }
              },
              "StopQuantity": 0,
              "ElapsedTime": 252,
              "ResBookDesigCode": "W",
              "MarriageGrp": "O",
              "Equipment": {
                "AirEquipType": 320
              },
              "DepartureDateTime": "2016-08-13T18:15:00",
              "ArrivalDateTime": "2016-08-13T19:27:00",
              "FlightNumber": 1455,
              "OnTimePerformance": {
                "Percentage": 86
              },
              "OperatingAirline": {
                "FlightNumber": 1455,
                "Code": "F9"
              },
              "DepartureTimeZone": {
                "GMTOffset": -4
              }
            }
          ],
          "ElapsedTime": 252
        },
        {
          "FlightSegment": [
            {
              "DepartureAirport": {
                "LocationCode": "LAS"
              },
              "ArrivalAirport": {
                "LocationCode": "ATL"
              },
              "MarketingAirline": {
                "Code": "F9"
              },
              "ArrivalTimeZone": {
                "GMTOffset": -4
              },
              "TPA_Extensions": {
                "eTicket": {
                  "Ind": true
                }
              },
              "StopQuantity": 0,
              "ElapsedTime": 238,
              "ResBookDesigCode": "W",
              "MarriageGrp": "O",
              "Equipment": {
                "AirEquipType": 320
              },
              "DepartureDateTime": "2016-08-15T21:45:00",
              "ArrivalDateTime": "2016-08-16T04:43:00",
              "FlightNumber": 1456,
              "OnTimePerformance": {
                "Percentage": 79
              },
              "OperatingAirline": {
                "FlightNumber": 1456,
                "Code": "F9"
              },
              "DepartureTimeZone": {
                "GMTOffset": -7
              }
            }
          ],
          "ElapsedTime": 238
        }
      ]
    },
    "DirectionInd": "Return"
  },
  "TPA_Extensions": {
    "ValidatingCarrier": {
      "Code": "F9"
    },
    "TagID": "instaflights~dfa7834f-34ab-4edc-835e-0cd14927d642~1"
  },
  "SequenceNumber": 1,
  "AirItineraryPricingInfo": {
    "PTC_FareBreakdowns": {
      "PTC_FareBreakdown": {
        "FareBasisCodes": {
          "FareBasisCode": [
            {
              "BookingCode": "W",
              "DepartureAirportCode": "ATL",
              "AvailabilityBreak": true,
              "ArrivalAirportCode": "LAS",
              "content": "W14AXS5"
            },
            {
              "BookingCode": "W",
              "DepartureAirportCode": "LAS",
              "AvailabilityBreak": true,
              "ArrivalAirportCode": "ATL",
              "content": "W14AXS5"
            }
          ]
        },
        "PassengerTypeQuantity": {
          "Quantity": 1,
          "Code": "ADT"
        },
        "PassengerFare": {
          "FareConstruction": {
            "CurrencyCode": "USD",
            "DecimalPlaces": 2,
            "Amount": 119.06
          },
          "TotalFare": {
            "CurrencyCode": "USD",
            "Amount": "156.20"
          },
          "Taxes": {
            "TotalTax": {
              "CurrencyCode": "USD",
              "DecimalPlaces": 2,
              "Amount": 37.14
            },
            "Tax": [
              {
                "CurrencyCode": "USD",
                "DecimalPlaces": 2,
                "TaxCode": "US1",
                "Amount": 8.94
              },
              {
                "CurrencyCode": "USD",
                "DecimalPlaces": 2,
                "TaxCode": "ZP",
                "Amount": "8.00"
              },
              {
                "CurrencyCode": "USD",
                "DecimalPlaces": 2,
                "TaxCode": "AY",
                "Amount": "11.20"
              },
              {
                "CurrencyCode": "USD",
                "DecimalPlaces": 2,
                "TaxCode": "XF",
                "Amount": "9.00"
              }
            ]
          },
          "BaseFare": {
            "CurrencyCode": "USD",
            "Amount": 119.06
          },
          "EquivFare": {
            "CurrencyCode": "USD",
            "DecimalPlaces": 2,
            "Amount": 119.06
          }
        }
      }
    },
    "FareInfos": {
      "FareInfo": [
        {
          "TPA_Extensions": {
            "Cabin": {
              "Cabin": "Y"
            },
            "SeatsRemaining": {
              "BelowMin": false,
              "Number": 4
            }
          },
          "FareReference": "W"
        },
        {
          "TPA_Extensions": {
            "Cabin": {
              "Cabin": "Y"
            },
            "SeatsRemaining": {
              "BelowMin": false,
              "Number": 4
            }
          },
          "FareReference": "W"
        }
      ]
    },
    "TPA_Extensions": {
      "DivideInParty": {
        "Indicator": false
      }
    },
    "ItinTotalFare": {
      "FareConstruction": {
        "CurrencyCode": "USD",
        "DecimalPlaces": 2,
        "Amount": 119.06
      },
      "TotalFare": {
        "CurrencyCode": "USD",
        "DecimalPlaces": 2,
        "Amount": "156.20"
      },
      "Taxes": {
        "Tax": [
          {
            "CurrencyCode": "USD",
            "DecimalPlaces": 2,
            "TaxCode": "TOTALTAX",
            "Amount": 37.14
          }
        ]
      },
      "BaseFare": {
        "CurrencyCode": "USD",
        "DecimalPlaces": 2,
        "Amount": 119.06
      },
      "EquivFare": {
        "CurrencyCode": "USD",
        "DecimalPlaces": 2,
        "Amount": 119.06
      }
    }
  },
  "TicketingInfo": {
    "TicketType": "eTicket"
  },
  "Links": [
    {
      "rel": "self",
      "href": "https://api.sabre.com/v1/shop/flights/tags/instaflights~dfa7834f-34ab-4edc-835e-0cd14927d642~1"
    },
    {
    "rel": "linkTemplate",
    "href": "https://api.sabre.com/v1/shop/flights/tags/<tagid>"
  }]
}

Usage notes

Country and airport codes

Point of sale

The point of sale is the geographic location in which the fare itinerary is eligible to be ticketed. The default point of sale (US) can be overridden with any supported point of sale country specified in the pointofsalecountry parameter. For example, the following will retrieve fare data specific to the Germany (DE) point of sale: pointofsalecountry=DE. The response will be fares eligible for sale in Germany.

Airports at Cities Lookup API

To identify the airports associated with a multi-airport city (MAC) code, use the Airports at Cities Lookup API and pass one of the MACs in the request. The Airports at Cities Lookup API retrieves our list of major airport, rail station and other codes that are associated with a single multi-airport city (MAC) code in the request.

City Pairs Lookup API

To get a list of our supported city pairs of origin and destination airports, use the City Pairs Lookup API. You can pass any of these origin and destination airport codes in an InstaFlights Search API request.

Multi-Airport City Lookup API

To get a list of city codes that are served by more than one airport, use the Multi-Airport City Lookup API. These multi-airport codes can be used with applicable REST APIs.

Example: Within the InstaFlights Search API, to search for the lead fares from DFW to any airport associated with New York City, use "DFW" for origin and "NYC" for destination. The response will include the lowest fare and lowest nonstop fare. The lowest fare will be from DFW to any one of the airports that belong to NYC, e.g., DFW to LGA. The lowest nonstop fare will be from DFW to any one of the airports that belong to NYC, but may not be the same airport associated with the lowest fare, e.g., DFW to JFK.

Sample scenarios

Compress response

To reduce network latency, whenever an InstaFlights Search request specifies a limit that exceeds 50, request a compressed response. Format the HTTP header field as follows:

Accept-Encoding: gzip

Paginate itineraries with "limit" and "offset"

Paginate search results by specifying how many itineraries to return per request in limit and specifying the starting position to begin retrieving itineraries in offset. This allows you to more quickly retrieve and return search queries for mobile application requests. Rather than returning all itineraries, you could return 10 itineraries per request in limit (limit=10) and specify a starting position of 1 in offset (offset=1). Then you can select a starting position of 11 (offset=11) to retrieve the next 10 results (limit=10).

  1. The first request retrieves itineraries from 1 to 10.
    GET https://api.sabre.com/v1/shop/flights?enabletagging=true&limit=10&offset=1 HTTP/1.1
  2. The next request retrieves itineraries from 11 to 20.
    GET https://api.sabre.com/v1/shop/flights?limit=10&offset=11 HTTP/1.1
  3. The last request retrieves itineraries from 21 to 30.
    GET https://api.sabre.com/v1/shop/flights?limit=10&offset=21 HTTP/1.1

Retrieve a specific itinerary for a given tag ID from the Tag ID Lookup URL New!

  1. The first request returns a Tag ID with each itinerary (enabletagging=true).
    GET https://api.sabre.com/v1/shop/flights?enabletagging=true HTTP/1.1
  2. The next request retrieves an itinerary from the Tag ID Lookup URL.
    GET https://api.sabre.com/v1/shop/flights/tags/[TAGID] HTTP/1.1

Limit the response to seats remaining

To limit the response to a minimum quantity of seats required, pass the minimum quantity in the passengercount parameter. This option limits the response to include only itineraries that support the required passengers.

This parameter corresponds to SeatsRemaining in the response, which includes only itineraries where this number is equal to or greater than the passengercount value passed in the request. If no passengercount is passed, all flight itinerary options will be returned.

The following URI illustrates a request for itineraries with 3 seats (required) on a flight from DFW (Dallas - Fort Worth) to LAS (Las Vegas).

GET https://api.sabre.com/v1/shop/flights?origin=DFW&destination=LAS&departuredate=2014-11-20&returndate=2014-11-29&passengercount=3 HTTP/1.1

Errors

An HTTP status code is always returned.

Errors that are specific to this API follow. For information about the error response format, see the: Sabre APIs: common errors.

Note —Optional parameters are checked for errors when a value is supplied.

Status 404 NOT FOUND

No results were found

The service cannot find data to fulfill the parameters in the request. For example, data is not available for the origin or dates.

An origin or destination in the request is not a valid IATA airport code.

The origin or destination are not supported.

Status 413 FULL head

The API returns this error when a request URI is too long. For example, the HTTP request"s query string exceeds the server limit.

The response will be empty as a result.

Please consider reducing the number of request parameters in the URI or separating parameters into multiple HTTP requests.

Status 400 BAD REQUEST

Parameter 'origin' must be specified

origin is missing.

origin is missing a value.

Parameter 'returndate' must be specified

returndate is missing.

returndate is missing a value.

Parameter 'departuredate' must be specified

departuredate is missing.

departuredate is missing a value.

Parameter 'departuredate' must have a format of 'yyyy-MM-dd' and be a valid date

The date is not valid, for example, yyyy-02-29 when the year is not leap year.

The month is not valid, for example, 13.

The day is not valid for the month, for example 2013-04-31.

The date has an incorrect format, for example, a hyphen character is omitted.

Although the data type is string, the service detected non-numeric characters for yyyy, mm, or dd.

A date is formatted as yyyy-dd-mm instead of yyyy-mm-dd.

The value in dd is a single digit.

The value in mm is a single digit.

Parameter '{parameter name}' exceeds the maximum days allowed

{parameter name} applies to departuredate and returndate.

For the maximum dates that you can pass, see Request.

Parameter 'returndate' must have a format of 'yyyy-MM-dd' and be a valid date

The date is not valid, for example, the returndate is yyyy-02-29 when the year is not leap year.

The month is not valid, for example, 13.

The day is not valid for the month, for example 2013-04-31.

The date has an incorrect format, for example, a hyphen character is omitted.

Although the data type is string, the service detected non-numeric characters for yyyy, mm, or dd.

A date is formatted as yyyy-dd-mm instead of yyyy-mm-dd.

The value in dd is a single digit.

The value in mm is a single digit.

Parameter 'departuredate' must have exactly one value

Multiple dates are included. This API permits a single date.

Parameter 'departuredate' must be before 'returndate'

A date range is not valid, for example, departuredate is later than returndate.

Parameter 'departuredate' must be today or a future date

departuredate includes a past date.

Date range in 'departuredate' and 'returndate' exceeds the maximum allowed

For the maximum days between departuredate and returndate, see the returndate request parameter.

Parameter 'excludedcarriers' must be specified

One or more airline codes in the set is missing a value.

Example: excludedcarriers=dl,,ua or dl,ua,

Parameter 'includedcarriers' must be specified

One or more airline codes in the set is missing a value.

Example: excludedcarriers=dl,,ua or dl,ua,

Parameter 'outboundflightstops' must be of type 'number'

The value for this parameter is a type mismatch.

Example: outboundflightstops=foo

Parameter 'outboundflightstops' must be between 0 and 99

The value is out of range.

Parameter 'inboundflightstops' must be of type 'number'

The value for this parameter is a type mismatch.

Example: inboundflightstops=foo

Parameter 'inboundflightstops' must be between 0 and 99

The value is out of range.

Parameter 'includedconnectpoints' must be specified

includedconnectpoints is missing one or more values in the set.

Example: includedconnectpoints=ATL,MIA, or ATL,,MIA

Parameter 'excludedconnectpoints' must be specified

excludedconnectpoints is missing one or more values in the set.

Example: excludedconnectpoints=ATL,MIA, or ATL,,MIA

Parameter 'includedconnectpoints' must not have more than 3 elements

For the maximum values, see includedconnectpoints in Request.

Example: includedconnectpoints=ATL,MIA,DFW,LAS

Parameter 'excludedconnectpoints' must not have more than 3 elements

For the maximum values, see excludedconnectpoints in Request.

Example: includedconnectpoints=ATL,MIA,DFW,LAS

Parameter 'outboundstopduration' must be of type 'number'

The value for this parameter is a type mismatch.

Example: outboundstopduration=foo

Parameter 'outboundstopduration' must be between 0 and 9999

The value is out of range.

Parameter 'inboundstopduration' must be of type 'number'

The value for this parameter is a type mismatch.

Example: inboundstopduration=foo

Parameter 'inboundstopduration' must be between 0 and 9999

The value is out of range.

Parameter 'outbounddeparturewindow' must have a format of 'HHmmHHmm' and be a valid time range
Parameter 'outboundarrivalwindow' must have a format of 'HHmmHHmm' and be a valid time range

Type mismatch - Example: outbounddeparturewindow=foo

Invalid time range format - Examples: Too many or too few digits: outbounddeparturewindow=1234123455

Invalid time range - The maximum is 1259, not 1260. Example: outbounddeparturewindow=12001260

Parameter 'inbounddeparturewindow' must have a format of 'HHmmHHmm' and be a valid time range
Parameter 'inboundarrivalwindow' must have a format of 'HHmmHHmm' and be a valid time range

Type mismatch - Example: inbounddeparturewindow=foo

Invalid time range format - Examples: Too many or too few digits: inbounddeparturewindow=1234123455

Invalid time range - Example: inbounddeparturewindow=12001260

Parameter 'onlineitinerariesonly' must contain either a 'y' or 'n' value

The value is not valid.

Parameter 'eticketsonly' must contain either a 'y' or 'n' value

The value is not valid.

Parameter 'limit' must be between 1 and 2147483647

limit is 0 or a negative number or greater than 2147483647.

Parameter 'limit' must be of type 'number'

A value has an incorrect JSON format for the corresponding parameter. In this case, the value must be a number.

limit is greater than 2147483647.

Parameter 'offset' must be between 1 and 2147483647

offset is 0 or a negative number or greater than 2147483647.

Parameter 'offset' must be of type 'number'

A value has an incorrect JSON format for the corresponding parameter. In this case, the value must be a number.

offset is greater than 2147483647.

Parameter 'sortby' must be one of '{totalfare,departuretime,elapsedtime}

Parameter 'sortby2' must be one of '{totalfare,departuretime,elapsedtime}

The value is not valid.

Parameter 'order' must be one of '{asc,dsc}'

Parameter 'order2' must be one of '{asc,dsc}'

The value is not valid.

Parameter 'maxfare' must be greater than or equal to 'minfare'

The amount in maxfare is less than the amount in minfare .

Parameter 'minfare' must be greater than or equal to 0.0

The amount in minfare is a negative number.

Parameter 'maxfare' must be greater than 0.0

The amount in maxfare is a negative number or 0.

Parameter 'minfare' must be of type 'number'

A value has an incorrect JSON format for the corresponding parameter.

In this case, the value must be a number.

Parameter 'maxfare' must be of type 'number'

A value has an incorrect JSON format for the corresponding parameter.

In this case, the value must be a number.

Parameter 'passengercount' must be of type 'number'

The value for this parameter is a type mismatch.

Example: passengercount=foo

Parameter 'passengercount' must be between 0 and 10

The value is out of range.

Missing or invalid required parameter(s)

destination is missing.

No view named '{view}' is defined
The specified '{view}' does not exist.

Docs Navigation