v1

latestOpenAPI 3.0.32026-07-14133451.7 KB

Shopping

Incremental poll for search results (BETA)

A IncrementalPollResponse will be returned, given a IncrementalPollRequest including a requestId, and zero or more flightKey values corresponding to zero or more selected flights from previous IncrementalPollResponse if applicable.

Unlike regular poll above, incremental poll returns results based on flights previously selected by client. It can provide a better experience for the client by making incremental choices.

Before the IncrementalPollResponse of entire Trip, which is a Trip that includes all Flight records, is returned,

segmentGroups will be empty, because it is not ready for booking.
prices will be the lowest of all Trip records matching the selected Flight records.

For example, to search for a round-trip, in other words, a Trip of an departure Flight and a return Flight,

First call to this endpoint without any flightKey would result in a list of Trip records with only an outbound Flight in each.

Secong call to this endpoint with the flightKey of a selected outbound Flight, would result in a list of Trip records with both Flight records in each, which forms a round-trip.

Corresponding response status code indicates whether another poll is neccessary until results are returned.

post/shopping/incrementalpolls

Request body

requestIdstring required

This is the request ID found in the SearchResponse.

flightKeysstring[]

This is a list of zero or more flightKey values corresponding to zero or more flights selected from a trip in the previous IncrementalPollResponse.

offsetinteger

This is the offset of the results to be polled next.

sizeinteger

This is the maximum number of results to be polled. The actual number of results might be less when there is no more results available at the moment.

currencystring

Currency code of results to be polled.

Example request

{
  "requestId": "OW|Economy|1-0-0|UnlimitedStarter-UnlimitedCandidate|20210901:@YTO:@AMS",
  "flightKeys": [
    "20211128:1740:HEL:CPH:AY959-20211129:1100:CPH:BCN:VY1871-20211129:1850:BCN:CDG:VY8240"
  ],
  "currency": "USD"
}

Response

This is the last IncrementalPollResponse for the current IncrementalPollRequest. There is no more available.

(If a non-existing requestId or flightKey was provided, a IncrementalPollResponse with empty result set will be returned.)

messagestring

message returned by server side if there is any