Stream priced stay offers (SSE)

Stream the offers of one property as suppliers answer. Takes the body of POST /v1/stays/fares (searchSolutionId + propertyId, or a direct property block) with an optional currency, and accepts a bearer token or a guest session token. Each offer is one combination of room, board and cancellation terms with one price; no supplier is named. The route answers 404 while the feature is off. A malformed searchSolutionId, an unknown or malformed propertyId, or an expired search whose property is no longer known returns 410 OFFER_EXPIRED. A repeat request for the same property replays the newest snapshot without new supplier calls.

Frame vocabulary (event: names on this stream):

  • offers — the whole offer set; revision rises by 1 per frame. An offer's id, total and freeCancellationUntil never change within a set; later frames add offers.
  • done — terminal frame, data: {complete, reason} with reason one of all_suppliers, deadline, no_rates. An empty result is offers: [] followed by done with no_rates.
  • error — terminal frame on failure; data: {"code": ..., "message": ...} with PROVIDER_ERROR or MAX_NIGHTS_EXCEEDED as on the fares stream, or INTERNAL_ERROR when an offer could not be stored.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

POST body for /v1/stays/offers: the fares body plus a display currency.

Search-solutions Mercury UUID from the search stream. Required together with top-level propertyId on the search-stream path; omit when using property.

Property Mercury UUID from the search stream. Required together with searchSolutionId on the search-stream path; omit when using property (which carries the raw autocomplete propertyId instead).

StayPropertyDestination | null

Named-property destination from autocomplete for direct fares without a prior search. Mutually exclusive with searchSolutionId + top-level propertyId.

date
required

Check-in date as YYYY-MM-DD. Must match the value supplied to the preceding POST /v1/stays/search request.

date
required

Check-out date as YYYY-MM-DD. Must be strictly after checkIn and match the value supplied to the preceding POST /v1/stays/search request.

rooms
array of objects
required
length ≥ 1

Per-room occupancy. Must match the rooms supplied (or derived from passengers) on the preceding POST /v1/stays/search request.

Rooms*

SHA-256 solution key for lineage tracking.

boolean
Defaults to false

Booking profile: true for personal travel, false for business travel. Must match the bookingProfile supplied to the preceding POST /v1/stays/search request.

length between 3 and 3
^[A-Z]{3}$

ISO 4217 code for the prices to return, for example EUR. Omit it to keep the provider's internal currency. Every offer in a set is priced in one currency.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthenticated

404

Stay offers are not enabled

410

Malformed search, unknown property, or expired search with an unknown property; refresh search

503

Provider or offer store unavailable

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/event-stream
application/json