> ## Documentation Index
> Fetch the complete documentation index at: https://partner.headout.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# How it works

Every integration follows the same path — from browsing the catalog to delivering a ticket. This page walks through that journey once, introducing each concept as it becomes relevant.

## The booking lifecycle

### Discovery

Find the right experiences to show to your users.

* Start with a **city** to scope the catalog to a specific market
* Browse collections, categories, and **products** — a product is a bookable experience like a tour, attraction, show, theme park pass, or transfer
* Each product has one or more **variants** — independently purchasable versions that can differ by inclusions, language, cancellation policy, nationality rules, or pricing
* Open product details to see variants, pricing, policies, and what guest information is needed

### Availability

See what can actually be booked right now.

* Check live inventory for a specific variant and date
* Each result is a **time slot** — a bookable window with pricing and remaining capacity
* Inventory is real-time — it reflects what is actually available at that moment

### Booking

Create the reservation once the customer has chosen an option and provided their details.

* Collect guest information based on what the product requires
* Submit the **booking** with the selected time slot and guest details
* The booking is confirmed once payment is captured

### Post-booking

Keep the customer informed after the booking is placed.

* **Tickets** are delivered to the customer — a QR code, PDF, wallet pass, or similar
* Tickets are generated instantly or within a short window depending on the product
* Booking status updates flow automatically via webhooks
* Cancellations and reschedules are handled through the API based on each product's policy

## Sandbox and go-live

Headout provides a sandbox environment where you can test the full integration flow — discovery, availability, booking, and webhooks — without affecting live data. Once everything works in sandbox, you move through a launch checklist with Headout before going live on production.

***

## Next steps

* [Setup](https://partner.headout.com/docs/guide/setup.md) — technical rules for authentication, versioning, and payloads
* [Integration walkthrough](https://partner.headout.com/docs/guide/walkthrough.md) — the end-to-end flow with API references
* [Launch checklist](https://partner.headout.com/docs/guide/checklist.md) — what to validate before going live


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.