Skip to main content
GET
Get a hotel search as map points
The list is unpaginated, so the whole result set can be drawn at once. Each point has the hotel’s name, its position, the total of the cheapest room found for it and the itemId to open its rooms with the search item endpoint. There is one point per hotel — when the same property appears more than once, the cheapest occurrence wins — and hotels with no known position are left out, so the list can be shorter than the search’s totalCount. It works on hotel searches only and takes no query parameters. While status is PROCESSING or FAILED, results is empty: poll until status is COMPLETED. Amounts are integers in cents: 125000 is R$ 1.250,00. An error the travel provider reports about the request is returned with its own status, code and message.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of your organization.

Format: UUID

searchId
string
required

ID of the hotel search, as returned when it was created.

Pattern: ^srch_[0-9A-Za-z]{21}$

Response

Successful response

Every hotel of a search that can be placed on a map.

status
enum<string>
required

Status of the search: PROCESSING, COMPLETED or FAILED. results is filled only when it is COMPLETED.

Available options:
PROCESSING,
FAILED,
COMPLETED
Example:

"COMPLETED"

results
object[]
required

One point per hotel, with the cheapest room found, in a single unpaginated list. Hotels with no known position are left out, so it can be shorter than the search's totalCount. Empty while status is PROCESSING or FAILED.