Search Pagination API Reference
Get |
search/properties/{SearchIdentifier}?pageNumber={x} For {SearchIdentifier} send the value from the v11 search response in PropertiesResponse/Properties/Identifier/value. Use this base path if you have not yet received or not migrated to the new credentials from Travelport:
Use this base path after you have migrated to the new credentials from Travelport (using .net instead of .com):
|
Related Content: JSON Hotel APIs Guide, Hotel Search Guide, Search by Location API Reference, Search by ID API Reference
The v11 hotel search APIs (Search by Location and Search by ID) use pagination by default. Search responses return up to 100 properties in the initial response, or all available properties if fewer than 100. The search response notes the total number of properties found and includes an identifier to be used for retrieving additional pages. See the Hotel Search Guide for more details.
If the search response indicates that more than 100 properties are available, you can use the Search Pagination request to retrieve each additional page of 100 properties until all available properties have been retrieved.
Request
Query Parameters
Parameter | Description | Required/Optional |
---|---|---|
pageNumber |
The page number of the page of results to retrieve (e.g., second page is pageNumber=2, etc.). The Search by ID or Search by Location response returns page 1, so values here should be between 2 and 5 inclusive. You are not required to retrieve pages consecutively. |
Required |
Request Body
This API does not send a request payload.
Response
Pagination responses use the standard search response structure. See the Search by Location and Search by ID API references for documentation and examples.