latestOpenAPI 3.0.12026-08-102668257.3 KB

8e9a8f8010ab

Shopping and Ticketing

Price Compare Search

Purpose: Search comparable fares for a route/date/airline filter. The endpoint performs synchronous smart search and is intended for fare comparison scenarios.

Dependency: No preceding function needs to be called before this API.

Important notes:

The returned settlement currency is determined by client configuration or the optional currency request field.
Total payable amount for one adult passenger is normally adultPrice + adultTax + transactionFeePerPax.
When supportCreditTransPayment = 1, vendorFare contains the airline/vendor-side fare. When pass-through payment is not supported, supportCreditTransPayment = 0 and vendorFare may be null or omitted.
ancillaryProductElements depends on client configuration and airline support.
links may include airline terms and conditions.
When status = 0 but routings is empty, check noResultReason for the business reason and possible recent available flight dates.
Display-currency values are for display only and should not be used for settlement, fare comparison, or accounting.

post/priceCompareSearch.do

Headers

Acceptstring required

Expected response media type. Use application/json.

Content-Typestring required

Request body media type. Use application/json.

Accept-Encodingstring required

Enable gzip response compression when supported.

x-atlas-client-idstring required

Atlas client ID. The server uses this value as the request customer identifier.

x-atlas-client-secretstring required

Atlas client secret for authentication. Use the secret assigned to the client ID.

Request body

tripType'1' | '2' required

Trip type. 1 = one-way, 2 = round trip. retDate is required when tripType = 2.

requestIdstring nullable

Client-side request identifier for tracing and troubleshooting. Optional but recommended.

adultNuminteger required

Adult passenger count. Must be at least 1. adultNum + childNum cannot exceed 9.

childNuminteger required

Child passenger count. adultNum + childNum cannot exceed 9.

infantNuminteger required

Infant passenger count. Cannot exceed the adult passenger count.

fromCitystring required

Departure city or airport IATA code in uppercase. If an airport code is supplied here, results are filtered by that airport.

fromAirportstring nullable

Optional departure airport IATA code. Leave empty when fromCity already represents the desired city/airport filter.

toCitystring required

Arrival city or airport IATA code in uppercase. If an airport code is supplied here, results are filtered by that airport.

toAirportstring nullable

Optional arrival airport IATA code. Leave empty when toCity already represents the desired city/airport filter.

fromDatestring required

Departure date in YYYYMMDD format.

retDatestring nullable

Return date in YYYYMMDD format. Required for round-trip searches; use null or omit for one-way searches.

airlinesstring[] nullable

Airline IATA code filter in uppercase. The response only contains flights operated/marketed by the specified airlines when supplied.

fromFlightNumbersstring[] nullable

Optional outbound flight-number filter. Use one string per candidate itinerary. For connecting flights, join segment flight numbers with a comma, e.g. OD1001,OD1002.

retFlightNumbersstring[] nullable

Optional return flight-number filter. For connecting flights, join segment flight numbers with a comma.

includeMultipleFareFamilyboolean nullable

Whether to return multiple fare families for the same flight. false returns the lowest fare per flight by default.

currencystring nullable

Optional settlement currency in ISO 4217 format. Use only when the client has multiple settlement currencies configured with Atlas.

displayCurrencystring nullable

Optional display currency in ISO 4217 format. Display-currency amounts are for presentation only and should not be used for settlement or accounting.

maxResponseTimeinteger nullable

Optional client-side expected maximum response time in milliseconds. Actual timeout is also controlled by Atlas configuration.

baggagePieceinteger nullable

Optional requested checked baggage pieces used for filtering or pricing when supported.

baggageWeightinteger nullable

Optional requested checked baggage weight in kilograms used for filtering or pricing when supported.

requestSourcestring nullable

Traffic source label, e.g. Google Flights, Organic Search, or SkyScanner. Used for analytics and traffic governance.

channelstring nullable

Optional client channel label used for reporting and traffic segmentation.

mainChannelstring nullable

Optional primary channel label used for reporting and traffic segmentation.

subChannelIDstring nullable

Optional secondary channel identifier used for reporting and traffic segmentation.

residentCodestring nullable

Optional resident discount code when an airline or market supports resident fares.

Response

Successful HTTP response. Business success or failure is indicated by the status field in the response body.

statusinteger required

Business status code. 0 means success. Common non-zero values:

100: Missing required request data.
101: Illegal request data or invalid format.
102: Illegal request parameter.
105: OD is not in the client's round-trip whitelist.
106: Search is not allowed for this client.
107: Insufficient balance.
108: Route is restricted or blocked by system limitations.
109: Search limit exceeded. For price compare, this may also mean daily quota exceeded.
110: Too many concurrent requests.
111: Real-time search is not allowed.
112: Search timed out.
113: Airline is under maintenance in Atlas.
114: No flights present.
116: Search data was not captured.
123: Too many requests but too few paid orders.
124: Unsupported settlement currency.
126: requestId does not exist or request is already ended.
900: Unauthorized access.
9999: Internal system error.

msgstring nullable required

Business message. Usually success or null for successful responses; contains the error message when status is non-zero.

requestIdstring nullable

Atlas request identifier returned for tracing. May be absent when the request fails before request initialization.

clientRequestIdstring nullable

Echo of the client request identifier when provided.

smartEndboolean nullable

Whether the smart-search process has completed for this synchronous response.