You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

searchFlightsBySlice operation finds flight solutions for the specified search criteria and give the opportunity to combine fare families for each slice of a journey, controls the results with one or more parameters, and returns search results in XML as a result set.

Solutions include information for a requested slice of a journey (for any type of request), already selected slices (for subsequent requests) and preselected slices (for all requests but the last one). Operation require additional requests in case RoundTrip or MultiCity as many as requested slices in the first request. To make subsequent request it's enough to use the ID of a slice solution selected on previous slice to receive all options for a next one until price solutions will be selected for a whole journey or pre-selected solutions for the rest of slices will suit you.

Operation used as a first step before making booking

Moreover:

  • If you are not sure that the requested dates provide the best prices use searchFlightsFlex operation prior, to find suitable departure dates (works only for OneWay and RoundTrip)
  • To receive price solution for a whole journey by a single request use searchFlightsJourney operation instead
  • Flight numbers have already been cleared? Use flightInfo operation instead to check all available price solutions for the itinerary (also provides fare rules as optional output)

Table of contents

Request (AirShoppingRQ)

Required inputs

For the first request (first slice of a journey)

#NameDescription
1

Agent credentials

Use credentials that you received from our technical support. Check out Quick Start for how to get it and References for more details
2Passengers

List of PTC and their Quantity for the whole journey

3Itinerary

For each slice (one slice for One Way trip, two for Round Trip and more for MultiCity. Check glossary for more info):

  • Departure city or airport IATA code and Date
  • Arrival city or airport IATA code and Date

For subsequent requests (from second to the last slices of a journey)

#NameDescription
1

Agent credentials

Use credentials that you received from our technical support. Check out Quick Start for how to get it and References for more details
2Solution ID

Selected price solution ID for the previous slice (from results of preceding request)

Optional parameters

For the first request (first slice of a journey)

#NameDescription
13D agreement credentials

To apply appropriate discounts, which depends on corporate client, agent and itinerary details.

(warning) Available only for scenario with 3D Agreement. Use credentials that you received from our technical support. Check out Quick Start for how to get those IDs

Skipping of 3D agreement credentials input provides receiving prices without discounts for the corporate client

2Sale Currency

Choose your sale currency for prices in response:

  1. RUB
  2. USD
  3. EUR
  4. CNY
  5. KZT

RUB used by default

(warning) Sale currency for search does not depend on Agent credentials

(warning) It is not a double currency conversion (the filed fare currency → the airline's sale currency → the agent's sale currency)
Conversion is executed to the requested sale currency directly from the filed fare currency

3Fare Output Type


  1. BrandedFares — to receive pricing divided by fare families for each itinerary solution (includes up to 4 price solutions)
  2. LowFare — for the only one cheapest price solution for each itinerary solution

BrandedFares used by default

4Sorting Type

Sorts the results based on the following values in each solution (from lowest to highest)

  1. arrival — arrival (earliest to latest), total price (lowest to highest), departure (earliest to latest), duration (shortest to longest)
  2. carrier — single carrier first, stop count (fewest to most), total price (lowest to highest), departure (earliest to latest)
  3. departure — departure (earliest to latest), total price (lowest to highest), duration (shortest to longest)
  4. default — total price (lowest to highest), departure (earliest to latest)
  5. destination — destination (A to Z), total price (lowest to highest), departure (earliest to latest), duration (shortest to longest)
  6. origin — origin (A to Z), total price (lowest to highest), departure (earliest to latest), duration (shortest to longest)

Total price of the cheapest priced solution used for each itinerary in case multiple fare output (BrandedFares)

"default" sorting used by default

5Cabin Type Filter
  1. Y — for COACH and PREMIUM-COACH cabin types only
  2. D — for BUSINESS and FIRST cabin types only

Returns all cabin types by default

6Direct Flights Only Filter

Excludes transit and transfer itineraries from search results

Returns all types of itinerary by default: direct, transit and transfer (Check glossary for more information about difference between itinerary types)

For subsequent requests (from second to the last slices of a journey)

Will be used the same options mentioned in the first request. Do not need to input them for subsequent requests

Response (AirShoppingRS)

For all requests but the last one

#NameDescription
1General
  • Sale Currency Decimals
  • Conversion rate from filed to sale currency
2Solution
  • Up to 50 unique itinerary solutions
  • Up to 4 price solutions for each itinerary, including:
    • For a whole journey:
      • Preferred Fare Family name or "Cheapest Fare" mark
      • Pricing for all passenger types
    • For each slice:
      • Status or ID:
        • Selected (already selected at previous requests)
        • Requested (currently requested slice)
        • Preselected (the cheapest price for subsequent slices)
      • Solution ID
        • Hash for requested slice (to be able make subsequent requests)
        • Like "OF1SL1" for others
      • Pricing for all passenger types and for 1 of each
      • Checked baggage allowance for each passenger type
    • For each segment:
      • Fare family name
      • Cabin type
      • For each passenger type:
        • RBD and seats left count (up to 9)
        • Fare code
        • Hand luggage allowance
    • For each leg:
      • Included meals
    • For each fare: 
      • Penalties

(Check glossary for more information about difference between journey, slice, segment and leg)

3Itinerary
  • For each slice:
    • Departure airport IATA code
    • Arrival airport IATA code
  • For each segment:
    • Departure airport IATA code, terminal name and datetime
    • Arrival airport IATA code, terminal name and datetime
    • Marketing and operating carrier IATA code and flight number
    • Board description
    • Flight distance and duration
  • For each stop between legs:
    • Arrival airport IATA code, terminal name and datetime
    • Ground duration
4Pricing
  • For a whole journey — pricing for all passengers:
    • Total (fares + taxes) in sale currency with discounts
    • Fare in sale and filed currencies with discounts
    • Applied discount in sale currency
    • Taxes in sale currency
  • For each slice in sale currency
    • Pricing for all passengers :
      • Total (fare + tax) with discounts
      • Fare with discounts
      • Applied discounts
      • Taxes
    • Breakdown for 1 of each passenger type:
      • Fare with discounts
      • Applied discounts
      • Taxes
5Penalties
  • For each Fare:
    • Type (No Show, Prior Departure, After departure)
    • Minimum and maximum penalty amount
6Checked baggage allowance
  • For each slice and each passenger type:
    • Common baggage:
      • Weight (kg), Size (lb) and Count
      • Value for ticket issue (NO / 2PC / 20K)
    • List of special equipment types
7Hand luggage allowance
  • For each segment and each passenger type: 
    • Weight (kg)
    • Count
8Included meals
  • For each leg: 
    • Type
    • Description

(Check glossary for more information about difference between journey, slice, segment and leg)

9Requested inputs
  • Passengers
  • Sale Currency
  • Fare Output Type
  • Sorting Type
  • Cabin Filter
  • Direct Flights Only Filter

For the last request (the last slice in a journey)

The same but Solution ID for the last requested slice will be like "OF1SL1" because there's no need to make any additional requests

Samples

v0.52 | searchFlightsBySlice operation | Samples

OW + 1xADT + Direct + S7 flight | v0.52 | searchFlightsBySlice operation

Check out

  • No labels