Concepts

Response & supplier model

How a search response is shaped — results, prices, deeplinks, and the supplier map.

Every search returns results[], meta, and _links. Each results[] entry is one unified stay per property, carrying a suppliers.<name> map across different providers.

The stay

Each stay holds the property-level fields:

  • id, name, type
  • location (address, coordinates, distanceInMeters), capacity
  • averageRatings — a weighted average of the ratings across every supplier that lists the stay
  • url — a Stay22 deeplink carrying your aid, so the booking is tracked to you

meta carries currency, page, pageSize, total, and hasMore (plus checkin, checkout, and nights for dated searches); _links.self is the canonical URL for the request and _links.next pages forward. See Pagination.

Suppliers

The suppliers.<name> map (e.g. booking) holds, per supplier:

  • link — a Stay22 deeplink to that supplier, carrying your aid
  • media, rating, policies — as that supplier lists them
  • price — price.total is the full-stay amount in meta.currency (divide by meta.nights for per-night). Per supplier, three states, never 0: a { total } object when quoted; null when that supplier couldn't be reached (availability unknown, not sold out); omitted when the search ran without dates or the supplier returned no quote. States can mix across suppliers on one stay. See Pricing & quotes

In clustered responses, sparse stays flow through results[] and dense areas through clusters[]; a stay never appears in both. See Clustering.

On this page