Skip to main content
POST
/
api
/
public
/
v1
/
booking
cURL
curl --location 'https://www.headout.com/api/public/v1/booking' \
--header 'Headout-Auth: <YOUR_API_KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "variantId": "2671",
  "inventoryId": "402612775",
  "customersDetails": {
      "count": 1,
      "customers": [
          {
              "personType": "GENERAL",
              "isPrimary": true,
              "inputFields": [
                  {
                      "id": "NAME",
                      "value": "adult test"
                  },
                  {
                      "id": "EMAIL",
                      "value": "test@email.com"
                  },
                  {
                      "id": "PHONE",
                      "value": "+919888888787"
                  },
                  {
                      "id": "CUSTOM_97179",
                      "value": "some pickup point"
                  },
                  {
                      "id": "CUSTOM_125551",
                      "value": "+919888888787"
                  }
              ]
          }
      ]
  },
  "price": {
      "amount": 120.0,
      "currencyCode": "AED"
  }
}'
{
  "bookingId": "<string>",
  "partnerReferenceId": "<string>",
  "variantId": "<string>",
  "startDateTime": "2023-11-07T05:31:56Z",
  "product": {
    "id": "<string>",
    "name": "<string>",
    "variant": {
      "id": "<string>",
      "name": "<string>"
    }
  },
  "customersDetails": {
    "count": 123,
    "customers": [
      {
        "personType": "<string>",
        "isPrimary": true,
        "inputFields": [
          {
            "id": "<string>",
            "name": "<string>",
            "value": "<string>"
          }
        ]
      }
    ]
  },
  "variantInputFields": [
    {
      "id": "<string>",
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "price": {
    "amount": 123,
    "currencyCode": "<string>"
  },
  "status": "UNCAPTURED",
  "voucherUrl": "<string>",
  "tickets": [
    {
      "publicId": "<string>",
      "url": "<string>",
      "type": "PDF_URL"
    }
  ],
  "seatInfo": [
    {
      "section": "<string>",
      "row": "<string>",
      "seatNumber": "<string>",
      "seatCode": "<string>"
    }
  ],
  "creationTimestamp": 123
}

Authorizations

Headout-Auth
string
header
required

Body

application/json
productId
string

The product to book. Obtain from the product listing endpoints.

variantId
string

The variant (tour option) to book. Obtain from the product's variants list.

inventoryId
string

The specific inventory slot (time/date) to book. Obtain from the inventory listing endpoint.

inventorySeatIds
string[] | null

Specific seat IDs to reserve, for seatmap-based products. Omit for non-seatmap products.

customersDetails
object

Information about all customers included in this booking.

variantInputFields
object[] | null

Booking-level input fields applicable to the whole booking rather than individual customers.

price
object

The total price the customer is paying. Used to validate against current inventory pricing to prevent stale-price bookings.

Response

200 - application/json

Booking created successfully

bookingId
string

Headout's unique identifier for this booking. Use this bookingId for all subsequent operations (capture, cancel, reschedule).

partnerReferenceId
string | null

Your own reference ID for this booking, set when capturing. Useful for correlating Headout bookings with your internal order system.

variantId
string

The variant (tour option) that was booked.

startDateTime
string<date-time>

Scheduled start time for the experience in local time, with no timezone offset (format yyyy-MM-dd'T'HH:mm:ss).

product
object

Summary of the product and variant booked.

customersDetails
object

All customers included in this booking.

variantInputFields
object[]
price
object

Total price paid for this booking.

status
enum<string>

Current lifecycle state of the booking. See Booking Status.

  • UNCAPTURED: Created but not yet captured. Does not lock inventory or price. Auto-expires to CAPTURE_TIMEDOUT after 1 hour.
  • PENDING: Payment captured — confirmed with supplier. Treat as confirmed; show to the customer as a confirmed booking.
  • COMPLETED: Fulfilled — tickets are available in the tickets array.
  • CANCELLED: Cancelled by partner, customer, or Headout.
  • FAILED: Booking failed due to a payment or system error.
  • CAPTURE_TIMEDOUT: Not captured within 1 hour of creation; can no longer be captured.
Available options:
UNCAPTURED,
PENDING,
COMPLETED,
CANCELLED,
FAILED,
CAPTURE_TIMEDOUT
voucherUrl
string

URL to the booking voucher PDF. Available once the booking reaches PENDING or COMPLETED status.

tickets
object[] | null

Individual tickets associated with this booking. Populated after successful fulfillment.

seatInfo
object[] | null

Seat assignment details for seatmap-based products. Null for non-seatmap products.

creationTimestamp
integer

Unix epoch timestamp (seconds) when this booking was first created.