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.
Was this helpful?
Yes
No

Setup

To use the Tickets API, install the @wix/events package using npm or Yarn:

Copy
1
npm install @wix/events

or

Copy
1
yarn add @wix/events

Then import { tickets } from @wix/events:

Copy
1
import { tickets } from '@wix/events'
Was this helpful?
Yes
No
bulkUpdateTickets( )

Archives multiple tickets.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events - all permissions
Manage Guest List
Learn more about permission scopes.
Copy
function bulkUpdateTickets(eventId: string, options: BulkUpdateTicketsOptions): Promise<BulkUpdateTicketsResponse>
Method Parameters
eventIdstringRequired
Event ID to which the ticket belongs.
optionsBulkUpdateTicketsOptions
Options for updating the tickets.
Returns
Return Type:Promise<BulkUpdateTicketsResponse>
Was this helpful?
Yes
No
checkInTickets( )

Checks in 1 or more tickets.

Copy
function checkInTickets(eventId: string, options: CheckInTicketsOptions): Promise<CheckInTicketResponse>
Method Parameters
eventIdstringRequired
Event ID to which the ticket belongs.
optionsCheckInTicketsOptions
Options for tickets to check-in.
Returns
Return Type:Promise<CheckInTicketResponse>
Was this helpful?
Yes
No
deleteTicketCheckIns( )

Deletes check-ins for 1 or more tickets.

Copy
function deleteTicketCheckIns(eventId: string, options: DeleteTicketCheckInsOptions): Promise<DeleteTicketCheckInResponse>
Method Parameters
eventIdstringRequired
Event ID to which the ticket belongs.
optionsDeleteTicketCheckInsOptions
Options for tickets to delete.
Returns
Return Type:Promise<DeleteTicketCheckInResponse>
Was this helpful?
Yes
No
getTicket( )

Retrieves a ticket by the unique ticket number.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Events - all read permissions
Manage Events - all permissions
Manage Guest List
Read Event Tickets and Guest List
Learn more about permission scopes.
Copy
function getTicket(identifiers: GetTicketIdentifiers, options: GetTicketOptions): Promise<TicketingTicket>
Method Parameters
identifiersGetTicketIdentifiersRequired
Details for the ticket to retrieve.
optionsGetTicketOptions
Options for the returned ticket data.
Returns
Return Type:Promise<TicketingTicket>
Was this helpful?
Yes
No
listTickets( )

Retrieves a list of up to 100 tickets.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Events - all read permissions
Manage Events - all permissions
Manage Guest List
Read Event Tickets and Guest List
Learn more about permission scopes.
Copy
function listTickets(eventId: Array<string>, options: ListTicketsOptions): Promise<ListTicketsResponse>
Method Parameters
eventIdArray<string>Required
Event IDs.
optionsListTicketsOptions
Options for defining the returned list of tickets.
Returns
Return Type:Promise<ListTicketsResponse>
Was this helpful?
Yes
No
updateTicket( )

Updates a ticket.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events - all permissions
Manage Guest List
Learn more about permission scopes.
Copy
function updateTicket(identifiers: UpdateTicketIdentifiers, options: UpdateTicketOptions): Promise<UpdateTicketResponse>
Method Parameters
identifiersUpdateTicketIdentifiersRequired
Details for the ticket to update.
optionsUpdateTicketOptions
Ticket details to update.
Returns
Return Type:Promise<UpdateTicketResponse>
Was this helpful?
Yes
No