Ticket Reservation

A TicketReservation is a temporary hold on a ticket slot, typically used to reserve capacity in a time slot before completing a purchase. Reservations automatically expire after 15 minutes if not converted to a ticket.

Ticket reservations are useful when you need to:

  • Hold a spot in a time slot while the customer completes checkout
  • Prevent overbooking during the purchase process
  • Manage capacity for time-slotted tickets

Workflow

  1. Create a reservation - Call POST /ticket-reservations with a ticketTypeId and optionally a timeSlotId
  2. Complete the purchase - Call POST /tickets with the ticketReservationId to convert the reservation into an actual ticket
  3. Or cancel - Call DELETE /ticket-reservations/:id if the customer abandons the checkout

If a reservation expires (after 15 minutes), the reserved capacity is automatically released.

PropertyTypeDefaultDescriptionExample
id*stringUnique identifier (128 character string)"aB3xY9kL..."
createdAtstringDate for when the reservation was created"2024-01-15T10:30:00.000Z"
expiresAtstringDate when the reservation will expire"2024-01-15T10:45:00.000Z"
Previous
Ticket
Next
Location