Workflow

A typical integration takes these steps, from loading static data to managing bookings. Steps 1 and 2 run in the background on your platform; steps 3 to 5 are the booking flow your customers trigger.

Step	What it does	Endpoint
1. Load static data	Download reference datasets (for example board codes) and cache them on your side.	GET /hotelxv/api/v2/datasets
2. Load hotel content	Fetch the hotels available to you, with names, locations, descriptions, amenities and images.	GET /hotelxv/api/v2/hotels
3. Search availability	Get bookable options (room, board, price, cancellation policy) for one or more hotels.	GET /hotelxv/api/v2/options
4. Confirm an option	Re-check the price and availability of the chosen option and get the guest details the booking needs.	POST /hotelxv/api/v2/options/{option_uid}/actions/confirm
5. Book	Book the confirmed option with the holder and guest details.	POST /hotelxv/api/v2/confirmations/{confirmation_uid}/actions/book
6. Retrieve bookings	List your bookings, or get the current details of specific bookings.	GET /hotelxv/api/v2/bookings
7. Cancel	Cancel a booking.	POST /hotelxv/api/v2/bookings/{booking_uid}/actions/cancel

Each step returns the identifier the next step needs: hotel_uid → option_uid → confirmation_uid → booking_uid. See Identifiers (UIDs).

Options are short-lived: confirm and book soon after the search, and search again if a confirmation fails. Amendments are not available through the API; to change a booking, cancel it and book again.

A booking can come back PENDING. What that means, how you learn the final status (polling or webhook) and what to do meanwhile is on After the Booking.

For request examples see Examples using cURL and the Postman Collection; for every parameter and field see the API reference.