Was this helpful?
Yes
No
Ticket Definition Object
Attributes
idstringformat GUID
Ticket definition ID.
priceobject
Ticket price.
freeboolean
Whether the ticket is free (read only).
namestring
Ticket name.
descriptionstring
Ticket description.
limitPerCheckoutintegerminimum 0maximum 20
Limit of tickets that can be purchased per checkout. Set to 20 for unlimited ticket definition.
orderIndexinteger
Custom sort index.
policystring
Policy information plain text block, as printed on the ticket.
dashboardobject
Sensitive dashboard data.
eventIdstringformat GUID
Event ID associated with the ticket.
wixFeeConfigobject
Configuration of the fixed-rate Wix service fee that is applied at checkout to each ticket sold.
salePeriodobject
Ticket sale period.
saleStatusstringRead-only
3 supported values:
SALE_SCHEDULEDSALE_STARTEDSALE_ENDED
Ticket sale status.
stateArray <string>
Ticket state.
pricingobject
Ticket pricing.
Was this helpful?
Yes
No
PostQuery Ticket Definitions

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 Orders
Manage Ticket Definitions
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

POST
https://www.wixapis.com/events/v1/ticket-definitions/query
Was this helpful?
Yes
No
GetList Ticket Definitions

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 Orders
Manage Ticket Definitions
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

GET
https://www.wixapis.com/events/v1/ticket-definitions
Was this helpful?
Yes
No
PostCreate Ticket Definition

Creates a ticket definition (and enables ticket sales).

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Ticket Definitions
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

POST
https://www.wixapis.com/events/v1/ticket-definitions

Event Triggers

This method triggers the following events:
Was this helpful?
Yes
No
DeleteDelete Ticket Definition

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 Ticket Definitions
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

DELETE
https://www.wixapis.com/events/v1/ticket-definitions

Event Triggers

This method triggers the following events:
Was this helpful?
Yes
No
GetGet Ticket Definition

Retrieves a ticket definition.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Manage Ticket Definitions
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

GET
https://www.wixapis.com/events/v1/ticket-definitions/{definitionId}
Was this helpful?
Yes
No
PatchUpdate Ticket Definition

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 Ticket Definitions
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

PATCH
https://www.wixapis.com/events/v1/ticket-definitions/{definitionId}

Event Triggers

This method triggers the following events:
Was this helpful?
Yes
No
PutChange Currency

Changes the currency for all tickets (per event).

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Ticket Definitions
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

PUT
https://www.wixapis.com/events/v1/ticket-definitions/currency

Event Triggers

This method triggers the following events:
Was this helpful?
Yes
No
Definition Ticket Definition Created

Permissions

WIX_EVENTS.READ_TICKET_DEFINITIONS
Learn more about permissions.

Event Body

Event Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
timestampstringformat date-time
Ticket Definition created timestamp in ISO UTC format.
ticketDefinitionIdstringformat GUID
Ticket Definition ID.
eventIdstringformat GUID
Event ID.
originatedFromobject
Originated from.
Was this helpful?
Yes
No
Definition Ticket Definition Updated

Permissions

WIX_EVENTS.READ_TICKET_DEFINITIONS
Learn more about permissions.

Event Body

Event Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
timestampstringformat date-time
Ticket definition updated timestamp in ISO UTC format.
ticketDefinitionIdstringformat GUID
Ticket definition ID.
eventIdstringformat GUID
Event ID.
Was this helpful?
Yes
No
Definition Ticket Definition Deleted

Permissions

WIX_EVENTS.READ_TICKET_DEFINITIONS
Learn more about permissions.

Event Body

Event Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
timestampstringformat date-time
Ticket definition deleted timestamp in ISO UTC format.
ticketDefinitionIdstringformat GUID
Ticket definition ID.
eventIdstringformat GUID
Event ID.
Was this helpful?
Yes
No