> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # GetTicket # Package: ticketing # Namespace: TicketManagement # Method link: https://dev.wix.com/docs/api-reference/business-solutions/events/registration/ticketing/tickets/get-ticket.md ## Permission Scopes: Read Event Tickets and Guest List: SCOPE.DC-EVENTS.READ-GUEST-LIST ## Introduction Retrieves a ticket by unique ticket number. --- ## REST API ### Schema ``` Method: getTicket Description: Retrieves a ticket by unique ticket number. URL: https://www.wixapis.com/events/v1/tickets/{ticketNumber} Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: ticketNumber Method parameters: query param name: eventId | type: eventId | description: Event GUID to which the ticket belongs. query param name: fieldset | type: array
| description: Set of fields to return in the response. See [Fieldsets](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_ticket-fieldset). - enum: - GUEST_DETAILS: Include guest details in the ticket response. - TICKET_DETAILS: Include ticket details in the ticket response. - GUEST_FORM: Include individual guest form in the ticket response. param name: ticketNumber | type: none | required: true Return type: GetTicketResponse - name: ticket | type: Ticket | description: Ticket. - name: ticketNumber | type: string | description: Unique ticket number which is assigned automatically when creating a ticket. - name: orderNumber | type: string | description: Associated order number. - name: ticketDefinitionId | type: string | description: Ticket definition GUID. See the Ticket Definition API for additional information. - name: name | type: string | description: Ticket type. - name: price | type: Money | description: Ticket price. - name: currency | type: string | description: 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `USD`. - name: value | type: string | description: Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative. - name: free | type: boolean | description: Whether the ticket requires payment. - name: policy | type: string | description: Ticket and event policies. - name: checkIn | type: CheckIn | description: Ticket check-in. - name: created | type: string | description: Time of a ticket's check-in. - name: orderStatus | type: OrderStatus | description: Associated order status. - enum: - NA_ORDER_STATUS: Order status isn't available for this request fieldset. - FREE: Order is confirmed, no payment is required. - PENDING: Order was paid, but the payment gateway suspended the payment. - PAID: Order is paid. - OFFLINE_PENDING: Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `"PAID"`. - INITIATED: Order is waiting for payment at the cashier. - CANCELED: Order is canceled. - DECLINED: Order payment is declined. - AUTHORIZED: Order payment is authorized. - VOIDED: Order payment is voided. - PARTIALLY_PAID: Order is partially paid with less than the total amount. - name: orderArchived | type: boolean | description: Whether the order and ticket are archived. If set to `true`, they aren't visible in the order list. - name: orderFullName | type: string | description: Buyer full name. - name: guestFullName | type: string | description: Guest full name. - name: guestDetails | type: GuestDetails | description: Guest personal details. - name: guestAssigned | type: boolean | description: Whether ticket belongs to assigned guest. - name: firstName | type: string | description: Guest first name. - name: lastName | type: string | description: Guest last name. - name: email | type: string | description: Guest email. - name: form | type: FormResponse | description: Full form response. - name: inputValues | type: array | description: Form field inputs. - name: inputName | type: string | description: Form field input name. - name: value | type: string | description: Form field value. - name: values | type: array | description: Form field values. - name: contactId | type: string | description: Contact GUID associated with this guest. - name: phone | type: string | description: Guest phone number. - name: archived | type: boolean | description: Whether the ticket is visible in an order. - name: memberId | type: string | description: Ticket owner member GUID. - name: anonymized | type: boolean | description: Whether ticket was anonymized by GDPR delete. Anonymized tickets no longer contain personally identifiable information (PII). - name: checkInUrl | type: string | description: 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"` - name: ticketPdfUrl | type: string | description: URL for ticket PDF download. - name: channel | type: ChannelType | description: Associated order checkout channel type. - enum: - ONLINE: Buyer created the order via an online channel, such as a website or mobile app. - OFFLINE_POS: Sales person created the order and collected the money. - name: walletPassUrl | type: string | description: URL to download a ticket in `.pkpass` format for Apple Wallet. - name: canceled | type: boolean | description: Whether ticket is canceled. ``` ### Examples ### GetTicket ```curl ~~~cURL curl -X GET 'https://www.wixapis.com/events/v1/tickets/FNVL-NIJT-WP021?event_id=ad18d12e-a6a9-4c17-abfa-6ff119479be2&fieldset=GUEST_DETAILS&fieldset=TICKET_DETAILS' \ -H 'Authorization: ' ~~~ ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.ticketing.TicketManagement.getTicket(ticketNumber, options) Description: Retrieves a ticket by unique ticket number. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: ticketNumber Method parameters: param name: options | type: GetTicketOptions none - name: eventId | type: string | description: Event GUID to which the ticket belongs. - name: fieldset | type: array | description: Set of fields to return in the response. See [Fieldsets](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_ticket-fieldset). - enum: - GUEST_DETAILS: Include guest details in the ticket response. - TICKET_DETAILS: Include ticket details in the ticket response. - GUEST_FORM: Include individual guest form in the ticket response. param name: ticketNumber | type: string | description: Unique ticket number. | required: true Return type: PROMISE - name: ticketNumber | type: string | description: Unique ticket number which is assigned automatically when creating a ticket. - name: orderNumber | type: string | description: Associated order number. - name: ticketDefinitionId | type: string | description: Ticket definition GUID. See the Ticket Definition API for additional information. - name: name | type: string | description: Ticket type. - name: price | type: Money | description: Ticket price. - name: currency | type: string | description: 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `USD`. - name: value | type: string | description: Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative. - name: free | type: boolean | description: Whether the ticket requires payment. - name: policy | type: string | description: Ticket and event policies. - name: checkIn | type: CheckIn | description: Ticket check-in. - name: created | type: Date | description: Time of a ticket's check-in. - name: orderStatus | type: OrderStatus | description: Associated order status. - enum: - NA_ORDER_STATUS: Order status isn't available for this request fieldset. - FREE: Order is confirmed, no payment is required. - PENDING: Order was paid, but the payment gateway suspended the payment. - PAID: Order is paid. - OFFLINE_PENDING: Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `"PAID"`. - INITIATED: Order is waiting for payment at the cashier. - CANCELED: Order is canceled. - DECLINED: Order payment is declined. - AUTHORIZED: Order payment is authorized. - VOIDED: Order payment is voided. - PARTIALLY_PAID: Order is partially paid with less than the total amount. - name: orderArchived | type: boolean | description: Whether the order and ticket are archived. If set to `true`, they aren't visible in the order list. - name: orderFullName | type: string | description: Buyer full name. - name: guestFullName | type: string | description: Guest full name. - name: guestDetails | type: GuestDetails | description: Guest personal details. - name: guestAssigned | type: boolean | description: Whether ticket belongs to assigned guest. - name: firstName | type: string | description: Guest first name. - name: lastName | type: string | description: Guest last name. - name: email | type: string | description: Guest email. - name: form | type: FormResponse | description: Full form response. - name: inputValues | type: array | description: Form field inputs. - name: inputName | type: string | description: Form field input name. - name: value | type: string | description: Form field value. - name: values | type: array | description: Form field values. - name: contactId | type: string | description: Contact GUID associated with this guest. - name: phone | type: string | description: Guest phone number. - name: archived | type: boolean | description: Whether the ticket is visible in an order. - name: memberId | type: string | description: Ticket owner member GUID. - name: anonymized | type: boolean | description: Whether ticket was anonymized by GDPR delete. Anonymized tickets no longer contain personally identifiable information (PII). - name: checkInUrl | type: string | description: 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"` - name: ticketPdfUrl | type: string | description: URL for ticket PDF download. - name: channel | type: ChannelType | description: Associated order checkout channel type. - enum: - ONLINE: Buyer created the order via an online channel, such as a website or mobile app. - OFFLINE_POS: Sales person created the order and collected the money. - name: walletPassUrl | type: string | description: URL to download a ticket in `.pkpass` format for Apple Wallet. - name: canceled | type: boolean | description: Whether ticket is canceled. ``` ### Examples ### getTicket ```javascript import { tickets } from '@wix/events'; async function getTicket(ticketNumber,options) { const response = await tickets.getTicket(ticketNumber,options); }; ``` ### getTicket (with elevated permissions) ```javascript import { tickets } from '@wix/events'; import { auth } from '@wix/essentials'; async function myGetTicketMethod(ticketNumber,options) { const elevatedGetTicket = auth.elevate(tickets.getTicket); const response = await elevatedGetTicket(ticketNumber,options); } ``` ### getTicket (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { tickets } from '@wix/events'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { tickets }, // Include the auth strategy and host as relevant }); async function getTicket(ticketNumber,options) { const response = await myWixClient.tickets.getTicket(ticketNumber,options); }; ``` ---