> ## 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.
# Introduction
Headout is a global marketplace for tours, activities, and experiences — from skip-the-line museum tickets and Broadway shows to theme park passes and guided city tours across cities worldwide.
The Headout Partner API lets you integrate Headout's curated inventory directly into your own platform. List experiences, check real-time availability, create bookings, and manage the full post-booking lifecycle — all through a single API.
## What you can build
* **Discovery & storefront** — Browse cities, collections, and thousands of experiences. Build a branded storefront powered by Headout's supply.
* **Real-time booking** — Check live availability, collect guest details, and create bookings with instant or delayed confirmation.
* **Post-booking management** — Track booking status, deliver tickets, handle cancellations and reschedules — all via API or webhooks.
* **Affiliate deep-linking** — Show Headout inventory in your storefront and hand off checkout to Headout with attributed deep links.
## Two integration paths
Headout supports two partner types, each with its own API surface and level of control.
| | API Partner | Affiliate |
| ------------ | ---------------------------------------------- | ------------------------------------------------------ |
| **Control** | Full booking flow in your product | Discovery + handoff to Headout checkout |
| **Booking** | You create and manage bookings via API | Headout handles checkout and fulfillment |
| **Pricing** | Access to `netPrice` and `headoutSellingPrice` | Access to `headoutSellingPrice` and `commissionAmount` |
| **Webhooks** | Receive booking status and ticket updates | Not applicable |
| **Best for** | OTAs, super-apps, travel platforms | Content sites, affiliate marketplaces, media partners |
## API overview
The API is organized around the booking lifecycle:
| API | Purpose |
| ------------------------------------------- | ------------------------------------------------------------------ |
| **Cities** | Discover supported markets |
| **Collections, Categories & Subcategories** | Browse and filter the catalog |
| **Products** | List and fetch experience details, variants, pricing, and policies |
| **Inventory** | Check real-time availability and slot-level pricing |
| **Bookings** | Create, capture, cancel, and reschedule reservations |
| **Webhooks** | Receive async updates for booking status and ticket generation |
## How the docs are organized
| Section | What it covers |
| ----------------------------------------------------- | ------------------------------------------------------------------ |
| [How it works](/docs/guide/how-it-works) | Core concepts — discovery, availability, booking, and post-booking |
| [Setup](/docs/guide/setup) | Authentication, versioning, payloads, pagination, and date formats |
| [Integration walkthrough](/docs/guide/walkthrough) | Step-by-step flows for API Partners and Affiliates |
| [Launch checklist](/docs/guide/checklist) | Everything to validate before going live |
| [Enums and error codes](/docs/guide/enums-and-error-codes) | Reference values, statuses, and error codes |
***
## Essential resources
Understand the booking lifecycle — discovery, availability, booking, and post-booking — before you start building.
Read the technical rules that shape authentication, versioning, payloads, and responses before you follow the walkthrough.
End-to-end flows for API Partners and Affiliates.
The core model — cities, products, variants, inventory, pricing, bookings, tickets — and the rules that govern how they fit together.
Use this when you are ready to build and validate the integration before launch.
Reference material for implementers who need exact values, statuses, and validation rules.
## Updates
Recent changes and release notes.
Planned work and near-term roadmap items.