Introduction
The Tickets API allows you to manage tickets for your site's events.
With the Tickets API you can:
- Archive tickets.
- Check in tickets, and delete ticket check-ins.
- Get the information about purchased tickets.
Setup
To use the Tickets API, install the @wix/events
package using npm or Yarn:
1npm install @wix/events
or
1yarn add @wix/events
Then import { tickets }
from @wix/events
:
1import { tickets } from '@wix/events'
Archives multiple tickets.
Permission Scopes
For app development, you must have one of the following permission scopes:function bulkUpdateTickets(eventId: string, options: BulkUpdateTicketsOptions): Promise<BulkUpdateTicketsResponse>
Event ID to which the ticket belongs.
Options for updating the tickets.
Checks in 1 or more tickets.
function checkInTickets(eventId: string, options: CheckInTicketsOptions): Promise<CheckInTicketResponse>
Event ID to which the ticket belongs.
Options for tickets to check-in.
Deletes check-ins for 1 or more tickets.
function deleteTicketCheckIns(eventId: string, options: DeleteTicketCheckInsOptions): Promise<DeleteTicketCheckInResponse>
Event ID to which the ticket belongs.
Options for tickets to delete.
Retrieves a ticket by the unique ticket number.
Permission Scopes
For app development, you must have one of the following permission scopes:function getTicket(identifiers: GetTicketIdentifiers, options: GetTicketOptions): Promise<TicketingTicket>
Details for the ticket to retrieve.
Options for the returned ticket data.
Retrieves a list of up to 100 tickets.
Permission Scopes
For app development, you must have one of the following permission scopes:function listTickets(eventId: Array<string>, options: ListTicketsOptions): Promise<ListTicketsResponse>
Event IDs.
Options for defining the returned list of tickets.
Updates a ticket.
Permission Scopes
For app development, you must have one of the following permission scopes:function updateTicket(identifiers: UpdateTicketIdentifiers, options: UpdateTicketOptions): Promise<UpdateTicketResponse>
Details for the ticket to update.
Ticket details to update.