Skip to main content
Headout inventory follows a strict hierarchy: City → Product → Variant → Time Slot → Booking → Ticket

Typical end-user journey

  1. User selects a city
  2. Partner fetches all products for that city from their cached catalog data
  3. User selects a product and variant
  4. User selects date and time slot
  5. Partner fetches real-time availability
  6. Partner reads the pax types for the selected slot from the inventory response, and the user picks how many guests of each type. Pax types are dynamic and can change from slot to slot, so never use a fixed list. See Pax types
  7. Partner fetches booking input fields for the selected slot
  8. User enters guest details and initiates payment
  9. A booking request is created with Headout to confirm availability of the selected slot
  10. User completes payment
  11. Booking is confirmed with Headout
  12. Ticket is generated and delivered. Some bookings have no separate ticket. See Bookings with no tickets
  13. Booking updates are received via webhooks