Introduction

The Ticket Definitions API allows you to manage definitions for tickets to your site's events.

With the Ticket Definitions API you can:

  • Create and update the ticket definitions (price, name, description, quantities, etc.) for tickets to an event.
  • Change the currency used for event tickets.
Was this helpful?
Yes
No

Setup

To use the TicketDefinitions 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 { ticketDefinitions } from @wix/events:

Copy
1
import { ticketDefinitions } from '@wix/events'
Was this helpful?
Yes
No

Ticket Definitions: Supported Filters and Sorting

The following table shows field support for filters and sorting for the TicketDefinition object:

FieldSupported FiltersSortable
createdNot filterableSortable
priceNot filterableSortable
orderIndexNot filterableSortable
ticketDefinitionId$eq ,$ne ,$hasSome ,$in
eventId$eq ,$ne ,$hasSome ,$inSortable
name$eq, $ne, $lt, $lte, $gt, $gte, $hasSome, $in, $contains ,$urlizedSortable

Related content: API Query Language, queryTicketDefinitions( )

Was this helpful?
Yes
No
changeCurrency( )

Changes the currency for all tickets per event.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events - all permissions
Manage Ticket Definitions
Learn more about permission scopes.
Copy
function changeCurrency(options: ChangeCurrencyOptions): Promise<void>
Method Parameters
optionsChangeCurrencyOptions
Returns
Return Type:Promise<void>
Was this helpful?
Yes
No
createTicketDefinition( )

Creates a ticket definition (and enables ticket sales).

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events - all permissions
Manage Ticket Definitions
Learn more about permission scopes.
Copy
function createTicketDefinition(eventId: string, options: CreateTicketDefinitionOptions): Promise<CreateTicketDefinitionResponse>
Method Parameters
eventIdstringRequired
Event ID.
optionsCreateTicketDefinitionOptionsRequired
Returns
Return Type:Promise<CreateTicketDefinitionResponse>
Was this helpful?
Yes
No
deleteTicketDefinition( )

Deletes a ticket definition.

Does not affect tickets that were already ordered.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events - all permissions
Manage Ticket Definitions
Learn more about permission scopes.
Copy
function deleteTicketDefinition(eventId: string, options: DeleteTicketDefinitionOptions): Promise<void>
Method Parameters
eventIdstringRequired
Event ID.
optionsDeleteTicketDefinitionOptions
Details of tickets to delete.
Returns
Return Type:Promise<void>
Was this helpful?
Yes
No
getTicketDefinition( )

Retrieves a ticket definition.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events - all permissions
Manage Orders
Manage Ticket Definitions
Learn more about permission scopes.
Copy
function getTicketDefinition(definitionId: string, options: GetTicketDefinitionOptions): Promise<TicketDefinition>
Method Parameters
definitionIdstringRequired
Ticket definition ID.
optionsGetTicketDefinitionOptions
Details for the ticket to retrieve.
Returns
Return Type:Promise<TicketDefinition>
Was this helpful?
Yes
No
listTicketDefinitions( )

Retrieves a list of up to 100 ticket definitions, with basic filter support.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events - all permissions
Manage Orders
Manage Ticket Definitions
Learn more about permission scopes.
Copy
function listTicketDefinitions(options: ListTicketDefinitionsOptions): Promise<ListTicketDefinitionsResponse>
Method Parameters
optionsListTicketDefinitionsOptions
Details for the tickets to retrieve.
Returns
Return Type:Promise<ListTicketDefinitionsResponse>
Was this helpful?
Yes
No
queryTicketDefinitions( )

Retrieves a list of up to 100 ticket definitions, supporting structurized queries.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events - all permissions
Manage Orders
Manage Ticket Definitions
Learn more about permission scopes.
Copy
function queryTicketDefinitions(options: QueryTicketDefinitionsOptions): Promise<QueryTicketDefinitionsResponse>
Method Parameters
optionsQueryTicketDefinitionsOptions
Returns
Return Type:Promise<QueryTicketDefinitionsResponse>
Was this helpful?
Yes
No
updateTicketDefinition( )

Updates a ticket definition.

See Partial Updates for more information.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events - all permissions
Manage Ticket Definitions
Learn more about permission scopes.
Copy
function updateTicketDefinition(definitionId: string, eventId: string, options: UpdateTicketDefinitionOptions): Promise<UpdateTicketDefinitionResponse>
Method Parameters
definitionIdstringRequired
Ticket definition ID.
eventIdstringRequired
Event ID.
optionsUpdateTicketDefinitionOptions
Ticket definition details to update.
Returns
Return Type:Promise<UpdateTicketDefinitionResponse>
Was this helpful?
Yes
No