getTicketDefinition( )


Note: This function replaces the deprecated getTicketDefinition() function. The deprecated function will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the migration instructions.

Retrieves a ticket definition by ID.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Events - all permissions
Manage Orders
Manage Ticket Definitions
Learn more about app permissions.
Method Declaration
Copy
function getTicketDefinition(
  ticketDefinitionId: string,
  options: GetTicketDefinitionOptions,
): Promise<TicketDefinition>;
Method Parameters
ticketDefinitionIdstringRequired

Ticket definition ID.


optionsGetTicketDefinitionOptions

Optional fields.

Returns
Return Type:Promise<TicketDefinition>
JavaScript
import { ticketDefinitionsV2 } from "wix-events.v2"; async function getTicketDefinition(ticketDefinitionId, options) { try { const result = await ticketDefinitionsV2.getTicketDefinition( ticketDefinitionId, options, ); return result; } catch (error) { console.error(error); // Handle the error } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?