Lock a stay offer

Lock the best supplier rate that satisfies a sold offer, at the total the offer showed. The traveler chose an option, not a supplier: travel.tech asks the provider for a lock on one candidate rate at a time, checks the locked terms (board, cancellation, free-cancellation deadline, merchant, price) against what was sold, and stops at the first that satisfies them. A candidate that fails is passed over without the traveler seeing it. The response is the locked fare (StayFareOut) at the offer's total; book it with the fare id it returns.

409 PRICE_ACCEPTANCE_REQUIRED means a rate satisfies the offer but not at the price shown: details[0] carries previousTotal, newTotal and cause, and message says it in one line. Lock again with acceptedTotal set to newTotal and a new Idempotency-Key (reusing a key with another acceptedTotal answers 422). 410 OFFER_EXPIRED with recoveryAction REFRESH means no rate behind the offer can be locked; search again. 409 OFFER_LOCK_IN_PROGRESS means another call with the same key is still working.

Idempotency-Key is required. Replaying a key for the same offer returns the first answer with no provider call. The route answers 404 while the feature is off.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The offer's id from the offers frame of POST /v1/stays/offers.

Body Params
Headers

Client-generated idempotency key (UUID v4 recommended). Replaying it for the same offer returns the first answer without asking the provider again.

Responses

401

Unauthenticated

404

No such offer for the caller, or the feature is off

410

No rate behind the offer can be locked; refresh search

422

Missing Idempotency-Key, or an invalid acceptedTotal

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:
application/json