Was this helpful?
Yes
No
Ticket Definition Object
Properties
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.
wixFeeConfigobjectRead-only
Configuration of the fixed-rate Wix service fee that is applied at checkout to each ticket sold.
salePeriodobject
Ticket sale period.
saleStatusstringRead-only
3 enum supported values:
SALE_SCHEDULEDSALE_STARTEDSALE_ENDED
Ticket sale status.
stateArray <string>
1 enum supported values:
INCLUDE_HIDDEN_NOT_ON_SALE
Ticket state.
pricingobject
Ticket pricing.
Was this helpful?
Yes
No
PostQuery Ticket Definitions

Deprecation Notice

This endpoint has been replaced with Ticket Definition V3's Query Ticket Definitions and will be removed on October 26, 2024. If your app uses this endpoint, we recommend updating your code as soon as possible.

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.
Endpoint
POST
https://www.wixapis.com/events/v1/ticket-definitions/query
Was this helpful?
Yes
No
GetList Ticket Definitions

Deprecation Notice

This endpoint has been replaced with Ticket Definition V3's Query Ticket Definitions and will be removed on October 26, 2024. If your app uses this endpoint, we recommend updating your code as soon as possible.

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.
Endpoint
GET
https://www.wixapis.com/events/v1/ticket-definitions
Was this helpful?
Yes
No
PostCreate Ticket Definition

Deprecation Notice

This endpoint has been replaced with Ticket Definition V3's Create Ticket Definition and will be removed on October 26, 2024. If your app uses this endpoint, we recommend updating your code as soon as possible.

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.
Endpoint
POST
https://www.wixapis.com/events/v1/ticket-definitions
Event TriggersThis method triggers the following events:
Ticket Definition Ticket Definition Created
Was this helpful?
Yes
No
DeleteDelete Ticket Definition

Deprecation Notice

This endpoint has been replaced with Ticket Definition V3's Delete Ticket Definition and will be removed on October 26, 2024. If your app uses this endpoint, we recommend updating your code as soon as possible.

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.
Endpoint
DELETE
https://www.wixapis.com/events/v1/ticket-definitions
Event TriggersThis method triggers the following events:
Ticket Definition Ticket Definition Deleted
Was this helpful?
Yes
No
GetGet Ticket Definition

Deprecation Notice

This endpoint has been replaced with Ticket Definition V3's Get Ticket Definition and will be removed on October 26, 2024. If your app uses this endpoint, we recommend updating your code as soon as possible.

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.
Endpoint
GET
https://www.wixapis.com/events/v1/ticket-definitions/{definitionId}
Was this helpful?
Yes
No
PatchUpdate Ticket Definition

Deprecation Notice

This endpoint has been replaced with Ticket Definition V3's Update Ticket Definition and will be removed on October 26, 2024. If your app uses this endpoint, we recommend updating your code as soon as possible.

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.
Endpoint
PATCH
https://www.wixapis.com/events/v1/ticket-definitions/{definitionId}
Event TriggersThis method triggers the following events:
Ticket Definition Ticket Definition Updated
Was this helpful?
Yes
No
PutChange Currency

Deprecation Notice

This endpoint has been replaced with Ticket Definition V3's Change Currency and will be removed on October 26, 2024. If your app uses this endpoint, we recommend updating your code as soon as possible.

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.
Endpoint
PUT
https://www.wixapis.com/events/v1/ticket-definitions/currency
Event TriggersThis method triggers the following events:
Ticket Definition Ticket Definition Updated
Was this helpful?
Yes
No
Definition Ticket Definition Created

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.
Event BodyEvent 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

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.
Event BodyEvent 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

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.
Event BodyEvent 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