Postman Collection

Postman is a free tool for sending API requests. Our Postman collection contains a ready-made request for every endpoint of the API, in the order you use them.

Download the ApiXV Postman collection

The collection is generated from the OpenAPI specification each time we publish the documentation, so it always matches the current API.

Getting started

1. In Postman, choose Import and select the downloaded file.
2. Open the collection and go to the Variables tab:
   • apiKey: your API key (see Environments & Authorization). It is sent as Authorization: ApiKey <key> on every request.
   • baseUrl: the environment to call. The collection starts on the demo environment; change it to https://cloud.apixv.com for production.
3. Run the requests in order. Each request stores the identifiers the next one needs:

Request	Stores
2. Get Hotel Content	the first five hotel_uids from your hotel list (only while hotel_uids is empty)
3. Get Availability and Pricing	the option_uid of the first available option
4. Confirm a Rate (Pre-booking)	the confirmation_uid
5. Book a Confirmed Option	the booking_uid

The availability request searches a two-night stay for two adults, 30 days from today. To search other dates, set the check_in and check_out variables (YYYY-MM-DD).

The confirm and book requests send price_tolerance, client_reference and the guest details in the JSON body. Edit the body of request 5 to match your occupancy (see 4. FAQ - Quote & Booking).

On production, request 5 makes a real booking, and request 7 cancels it. Cancellation fees may apply according to the option's cancellation policy, so check it before you book.