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 | Core concepts — discovery, availability, booking, and post-booking |
| Setup | Authentication, versioning, payloads, pagination, and date formats |
| Integration walkthrough | Step-by-step flows for API Partners and Affiliates |
| Launch checklist | Everything to validate before going live |
| Enums and error codes | Reference values, statuses, and error codes |
Essential resources
How it works
Understand the booking lifecycle — discovery, availability, booking, and post-booking — before you start building.
Setup
Read the technical rules that shape authentication, versioning, payloads, and responses before you follow the walkthrough.
Integration walkthrough
End-to-end flows for API Partners and Affiliates.
Key concepts
The core model — cities, products, variants, inventory, pricing, bookings, tickets — and the rules that govern how they fit together.
Launch checklist
Use this when you are ready to build and validate the integration before launch.
Enums and error codes
Reference material for implementers who need exact values, statuses, and validation rules.
Updates
What's new
Recent changes and release notes.
Upcoming releases
Planned work and near-term roadmap items.