Pagination Guide & API Reference
The AirSearch API supports the optional pagination feature. Pagination allows you to control the number of offers returned in the initial response, which can affect response time. All offers are cached on the server, but only the number sent in the search request payload in offersPerPage is returned in the initial response. For example, if offersPerPage is set to 5, only the first 5 offers are returned in the initial response. (An offering is one flight or set of connecting flights available on one leg of the itinerary, returned as a product at a set price with specific terms and conditions. The Search APIs return offerings as individual instances of ProductBrandOffering.)
Pagination is not supported for NDC content; offersPerPage is ignored if sent.
In this topic:
Request
GET Request
Use the following resource for the Pagination GET request (see below):
GET {identifier}/pageNumber=X
Append to any of the search endpoints.
Base path:
Pre-production https://api.pp.travelport.com/9/air/
Production https://api.travelport.com/9/air/
Query Parameters
To use pagination, you must send offersPerPage in the message payload of the initial search POST request.
After the initial POST search request, retrieve the next set of offers by sending a GET request with the following appended to the full endpoint for the search API.
| Parameter | Description | Required/Optional |
|---|---|---|
|
identifier (variable) |
Transaction identifier from the initial search response. In the Fare Family Search or Next Leg Search response, this value is in CatalogProductOfferings/Identifier/value In the AirSearch response, this value is in CatalogOfferingsResponse/CatalogOfferings/Identifier/valueAirSearch CatalogOfferingsResponse/CatalogOfferings/Identifier/value |
Required |
|
pageNumber=X |
Number for the next page of offers to return. |
Required |
Payload
No request body payload.
Response
The response returns offers using the same structure as the initial search response.
Request Example
Using an example ID, you would append the following to the endpoint used for the Search, Next Leg Search, or Next Leg Search POST request to retrieve the second, third, and fourth pages of offers:
- /25b7c31d-823f-4cfb-8317-d10ebf7477c2/?pageNumber=2
- /25b7c31d-823f-4cfb-8317-d10ebf7477c2/?pageNumber=3
- //25b7c31d-823f-4cfb-8317-d10ebf7477c2/?pageNumber=4
Each response returns the number of offers set in the request in offersPerPage.
Refer to AirSearch API Reference for the full endpoint. For example, for AirSearch, the full production URL for the request for page 2 would look like:
https://api.travelport.com/9/air/search/catalogofferings/25b7c31d-823f-4cfb-8317-d10ebf7477c2/?pageNumber=2
Response Example
The response returns offers using the same structure as the initial search response.