Setup

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

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

Creates a ticket definition.

It is allowed to create up to 100 definitions 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 createTicketDefinition(ticketDefinition: TicketDefinition, options: CreateTicketDefinitionOptions): Promise<TicketDefinition>
Method Parameters
ticketDefinitionTicketDefinitionRequired
Ticket definition info.
optionsCreateTicketDefinitionOptions
Optional fields.
Returns
Return Type:Promise<TicketDefinition>
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(ticketDefinitionId: string, options: GetTicketDefinitionOptions): Promise<TicketDefinition>
Method Parameters
ticketDefinitionIdstringRequired
Ticket definition ID.
optionsGetTicketDefinitionOptions
Optional fields.
Returns
Return Type:Promise<TicketDefinition>
Was this helpful?
Yes
No
queryTicketDefinitions( )

Retrieves a list of ticket definitions, given the provided paging, filtering, and sorting. Query Ticket Definitions runs with these defaults, which you can override:

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(query: QueryV2, options: QueryTicketDefinitionsOptions): Promise<QueryTicketDefinitionsResponse>
Method Parameters
queryQueryV2Required
Query options. See API Query Language for more details.
optionsQueryTicketDefinitionsOptions
Optional fields.
Returns
Return Type:Promise<QueryTicketDefinitionsResponse>
Was this helpful?
Yes
No