Update a booking
Capture a booking and trigger fulfillment by setting status to PENDING, and assign your internal partnerReferenceId for reconciliation.
This must be called after creating a booking to confirm it. Bookings not captured within one hour are automatically moved to CAPTURE_TIMEDOUT.
Authorizations
Path Parameters
ID of the booking to update.
Body
Set to PENDING to capture the booking and trigger fulfillment.
PENDING Your internal reference ID for this booking (e.g., order number). This field is required, cannot be null, and may be an empty string if you don't have a partnerReferenceId. Otherwise, provide your partner reference ID.
Response
Booking updated successfully
Headout's unique identifier for this booking. Use this bookingId for all subsequent operations (capture, cancel, reschedule).
Identifier of the voucher issued for this booking. Pass it to Get a voucher to retrieve the structured voucher payload.
Your own reference ID for this booking, set when capturing. Useful for correlating Headout bookings with your internal order system.
The variant (tour option) that was booked.
Scheduled start time for the experience in local time, with no timezone offset (format yyyy-MM-dd'T'HH:mm:ss).
Summary of the product and variant booked.
All customers included in this booking.
Total price paid for this booking.
Current lifecycle state of the booking. See Booking Status.
UNCAPTURED: Created but not yet captured. Does not lock inventory or price. Auto-expires toCAPTURE_TIMEDOUTafter 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 theticketsarray.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.
UNCAPTURED, PENDING, COMPLETED, CANCELLED, FAILED, CAPTURE_TIMEDOUT URL to the booking voucher PDF. Available once the booking reaches PENDING or COMPLETED status.
Individual tickets associated with this booking. Populated after successful fulfillment.
Seat assignment details for seatmap-based products. Null for non-seatmap products.
Unix epoch timestamp (seconds) when this booking was first created.