hotel-search

Create Hotel Search Booking Session

Changed on

Create or upsert a resumable hotel-search booking session.

post/hotel-search/booking-sessions/

Request

  • Base URL: https://api.helloaxel.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.helloaxel.com/hotel-search/booking-sessions/
  • Auth: HTTP bearer

Request body

hotel_search_session_idstring uuid nullable

Owned source search; backend resolves and preserves its offer association.

hotel_idinteger required

Hotel identifier

quote_idstring required

Selected quote identifier

check_instring date required

Check-in date

check_outstring date required

Check-out date

checkout_step'review' | 'guests' | 'membership' | 'payment' | 'processing' | 'confirmed' | 'failed' required

Current step in checkout flow

status'active' | 'processing' | 'completed' | 'failed' | 'abandoned'
is_validboolean

Whether the session is still valid for resume/banner display

payloadobject

Snapshot payload from frontend (hotel details, offer, guests, etc)

booking_idstring nullable
hotel_purchase_idstring nullable
confirmation_codestring nullable
failure_reasonstring nullable
replacement_for_booking_idstring nullable

Optional imported booking ID this checkout is intended to replace.

conv_trip_idstring nullable

Optional conversational trip ID (string) carried through checkout

hotel_namestring nullable

Hotel property name for display in payment block

room_typestring nullable

Selected room type name for display in payment block

price_amountinteger nullable

Total customer price in cents for display in payment block

price_currencystring nullable

Currency code for price (e.g. USD)

cancellation_policystring nullable

Cancellation policy text (e.g. 'Free cancellation until Apr 30')

fees_at_property_amountinteger nullable

Total mandatory fees in cents due at property (resort fee, city tax, etc.)

fees_at_property_currencystring nullable

Currency code for fees_at_property (e.g. EUR, USD). Often local currency.

retail_price_amountinteger nullable

Retail comparison price in cents (e.g. Expedia) for strikethrough display

retail_price_currencystring nullable

Currency code for retail price (e.g. USD)

wake_token_hashstring nullable

SHA-256 hex hash of the wake token this checkout originated from. Write-through attribution only — never the raw token. Absence must not block checkout.

srcstring nullable

Short deeplink source slug the checkout originated from (e.g. 'wake_limited_time_flight_offer'). Write-through attribution only.

Response

Successful Response

idstring uuid required
hotel_search_session_idstring uuid nullable
flight_hotel_obligation_idstring uuid nullable
user_idstring uuid required
hotel_idinteger required
quote_idstring required
check_instring date required
check_outstring date required
checkout_step'review' | 'guests' | 'membership' | 'payment' | 'processing' | 'confirmed' | 'failed' required
status'active' | 'processing' | 'completed' | 'failed' | 'abandoned' required
is_validboolean required
payloadobject required
booking_idstring nullable required
hotel_purchase_idstring nullable required
confirmation_codestring nullable required
failure_reasonstring nullable required
replacement_for_booking_idstring nullable
conv_trip_idstring nullable
hotel_namestring nullable
room_typestring nullable
price_amountinteger nullable
price_currencystring nullable
cancellation_policystring nullable
fees_at_property_amountinteger nullable
fees_at_property_currencystring nullable
retail_price_amountinteger nullable
retail_price_currencystring nullable
guest_namesstring[]

Guest names extracted from guest_rooms in payload

created_atstring date-time required
updated_atstring date-time required

Changes

  • 6d10c134a61dRevision changes
    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

  • 5d2121d26b96Revision changes
    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status