Skip to main content
The concepts behind the API, grouped by the part of the integration they belong to. Read them in order for a full picture, or jump to the one you need. Headout inventory follows a strict hierarchy, and most of what follows hangs off it: City → Product → Variant → Time Slot → Booking → Ticket

Integration flow

How the hierarchy fits together, and the order a booking is built in.

Products and variants

How products, variants and their metadata are structured, and what drives the booking form.

Inventory and pricing

Date-level availability against slot-level inventory, remaining counts, and how prices are composed.

Guest details

The dynamic input fields a variant requires, and how to collect them.

Booking lifecycle

The statuses a booking moves through, the transitions between them, and when tickets appear.

Vouchers and tickets

How the voucher reaches the guest and what ticket formats to expect.

Voucher API deep dive

A section-by-section walkthrough of the voucher response — what each part holds and when it is null.

Cancellation and reschedule

What makes a booking amendable, how to request one, and how to observe the outcome.

Webhooks

How booking updates reach you, and how to verify they came from Headout.

Sandbox and production

How the two environments differ in behaviour and data.