Ticket Object

Attributes
ticketNumberstring
Unique ticket number (issued automatically).

orderNumberstring
Associated order number.

ticketDefinitionIdstringformat GUID
Ticket definition ID.

namestring
Ticket name.

priceobject
Ticket price.

freebooleanRead-only
Whether ticket requires payment.

policystring
Ticket policy (as displayed in PDF).

qrCodestring
Deprecated, use check_in_url.

checkInobject
Ticket check-in.

orderStatusstring
8 supported values:
NA_ORDER_STATUSFREEPENDINGPAIDOFFLINE_PENDINGINITIATEDCANCELEDDECLINED
Associated order status.

orderArchivedboolean
Whether order and ticket are visible in order list.

orderFullNamestring
Buyer full name.

guestFullNamestring
Guest full name.

guestDetailsobject
Guest personal details.

archivedboolean
Whether ticket is visible in guest list.

ticketPdfstring
Deprecated, use ticket_pdf_url.

memberIdstringformat GUID
Ticket owner member ID.

anonymizedboolean
Whether ticket was anonymized by GDPR delete. Anonymized tickets no longer contain personally identifiable information (PII).

checkInUrlstring
Ticket check-in URL. Shown as QR code image in PDF. Format: https://www.wixevents.com/check-in/{ticket number},{event id} Example: https://www.wixevents.com/check-in/AAAA-AAAA-BB021,00000000-0000-0000-0000-000000000000

ticketPdfUrlstring
URL for ticket PDF download.

channelstring
2 supported values:
ONLINEOFFLINE_POS
Associated order checkout channel type

walletPassUrlstringRead-onlyformat URI
URL to download ticket in .pkpass format for Apple Wallet
Was this helpful?
Yes
No

GetList Tickets

Retrieves a list of up to 100 tickets, given the provided pagination, filtering & sorting.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Event Tickets and Guest List
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/events/v1/events/{eventId}/tickets

Was this helpful?
Yes
No

PatchBulk Update Tickets

Updates the archived state of multiple tickets. See Partial Updates for more information.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Guest List
Learn more about permission scopes.
Endpoint
PATCH
https://www.wixapis.com/events/v1/events/{eventId}/tickets

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

GetGet Ticket

Retrieves a ticket by unique ticket number.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Event Tickets and Guest List
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/events/v1/events/{eventId}/tickets/{ticketNumber}

Was this helpful?
Yes
No

PatchUpdate Ticket

Updates a ticket. See Partial Updates for more information.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Guest List
Learn more about permission scopes.
Endpoint
PATCH
https://www.wixapis.com/events/v1/events/{eventId}/tickets/{ticketNumber}

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostCheck In Ticket

Checks in 1 or more tickets.

Endpoint
POST
https://www.wixapis.com/events/v1/tickets/check-in

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

DeleteDelete Ticket Check In

Deletes check-ins for 1 or more tickets.

Endpoint
DELETE
https://www.wixapis.com/events/v1/tickets/check-in

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

Order Updated

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
Order updated timestamp in ISO UTC format.

languagestringformat LANGUAGE
Site language when Order initiated

eventIdstringformat GUID
Event ID.

orderNumberstring
Unique order number.

contactIdstring
Contact ID associated with this order.

memberIdstringformat GUID
Member ID associated with this order.

createdstringRead-onlyformat date-time
Order created timestamp.

firstNamestring
Buyer first name.

lastNamestring
Buyer last name.

emailstring
Buyer email.

checkoutFormobject
Checkout form response.

confirmedboolean
Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account.

statusstring
8 supported values:
NA_ORDER_STATUSFREEPENDINGPAIDOFFLINE_PENDINGINITIATEDCANCELEDDECLINED
Order status.

methodstring
Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.

ticketsArray <Ticket>
Tickets generated after payment.

archivedboolean
Whether order was archived and excluded from results.

triggeredByAnonymizeRequestboolean
Whether event was triggered by GDPR delete request.
Was this helpful?
Yes
No