Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

eventId

string

options

BulkUpdateTicketsOptions

import { tickets } from 'wix-events.v2';

async function bulkUpdateTickets(eventId, options) {
  try {
    const result = await tickets.bulkUpdateTickets(eventId, options);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


bulkUpdateTickets example for dashboard page code

import { tickets } from 'wix-events.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedBulkUpdateTickets = elevate(tickets.bulkUpdateTickets);

export const bulkUpdateTickets = webMethod(
  Permissions.Anyone,
  async (eventId, options) => {
    try {
      const result = await elevatedBulkUpdateTickets(eventId, options);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


bulkUpdateTickets example for exporting from backend code

bulkUpdateTickets

BulkUpdateTicketsResponse

CheckInTicketsOptions

import { tickets } from 'wix-events.v2';

async function checkInTickets(eventId, options) {
  try {
    const result = await tickets.checkInTickets(eventId, options);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


checkInTickets example for dashboard page code

import { tickets } from 'wix-events.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedCheckInTickets = elevate(tickets.checkInTickets);

export const checkInTickets = webMethod(
  Permissions.Anyone,
  async (eventId, options) => {
    try {
      const result = await elevatedCheckInTickets(eventId, options);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


checkInTickets example for exporting from backend code

checkInTickets

CheckInTicketResponse

DeleteTicketCheckInsOptions

import { tickets } from 'wix-events.v2';

async function deleteTicketCheckIns(eventId, options) {
  try {
    const result = await tickets.deleteTicketCheckIns(eventId, options);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


deleteTicketCheckIns example for dashboard page code

import { tickets } from 'wix-events.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedDeleteTicketCheckIns = elevate(tickets.deleteTicketCheckIns);

export const deleteTicketCheckIns = webMethod(
  Permissions.Anyone,
  async (eventId, options) => {
    try {
      const result = await elevatedDeleteTicketCheckIns(eventId, options);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


deleteTicketCheckIns example for exporting from backend code

deleteTicketCheckIns

DeleteTicketCheckInResponse

identifiers

GetTicketIdentifiers

GetTicketOptions

Retrieves a ticket by the unique ticket number.

import { tickets } from 'wix-events.v2';

async function getTicket(identifiers, options) {
  try {
    const result = await tickets.getTicket(identifiers, options);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


getTicket example for dashboard page code

import { tickets } from 'wix-events.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedGetTicket = elevate(tickets.getTicket);

export const getTicket = webMethod(
  Permissions.Anyone,
  async (identifiers, options) => {
    try {
      const result = await elevatedGetTicket(identifiers, options);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


getTicket example for exporting from backend code

getTicket

TicketingTicket

Options for defining the returned list of tickets.

ListTicketsOptions

Retrieves a list of up to 100 tickets.

import { tickets } from 'wix-events.v2';

async function listTickets(eventId, options) {
  try {
    const result = await tickets.listTickets(eventId, options);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


listTickets example for dashboard page code

import { tickets } from 'wix-events.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedListTickets = elevate(tickets.listTickets);

export const listTickets = webMethod(
  Permissions.Anyone,
  async (eventId, options) => {
    try {
      const result = await elevatedListTickets(eventId, options);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


listTickets example for exporting from backend code

listTickets

ListTicketsResponse

UpdateTicketIdentifiers

UpdateTicketOptions

import { tickets } from 'wix-events.v2';

async function updateTicket(identifiers, options) {
  try {
    const result = await tickets.updateTicket(identifiers, options);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


updateTicket example for dashboard page code

import { tickets } from 'wix-events.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedUpdateTicket = elevate(tickets.updateTicket);

export const updateTicket = webMethod(
  Permissions.Anyone,
  async (identifiers, options) => {
    try {
      const result = await elevatedUpdateTicket(identifiers, options);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


updateTicket example for exporting from backend code

updateTicket

UpdateTicketResponse

---
title: Introduction
---
# Introduction

The Tickets API allows you to manage tickets for your site's events.

With the Tickets API you can:

- Archive tickets.
- Check in tickets, and delete ticket check-ins.
- Get the information about purchased tickets.


## Before you begin

It’s important to note the following points before starting to code:  

- Install the **Wix Events & Tickets** app from [Wix App Market](https://www.wix.com/app-market/wix-events?referral=category&appIndex=5&referralTag=booking--events).
- This API is not relevant for RSVP events.
- To use the Tickets API, import `tickets` from the `wix-events.v2` module:

```js
import { tickets } from 'wix-events.v2';
```


velo-deps_wix-events.v2_tickets

Address

Main address line, usually street and number as free text.

addressLine

streetAddress

addressLine1

Free text providing more detailed address info. Usually contains Apt, Suite, and Floor.

addressLine2

city

country

postalCode

Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY

subdivision

AddressLocation

latitude

number

longitude

archived

boolean

A unique ticket number which is assigned automatically when creating a ticket.

ticketNumber

tickets

ChannelType

CheckIn

created

Counts

checkedIn

count

Ticket numbers which check-ins to delete.

FacetCounts

counts

FormResponse

inputValues

FormattedAddress

address

formatted

Predefined sets of fields to return.
- `TICKET_DETAILS`: Returns `ticketNumber`, `orderNumber`, `ticketDefinitionId`, `name`, `price`, `free`, `policy`, `qrCode`, `checkIn`, `orderStatus`, `orderArchived`, `archived`, `orderFullName`, `ticketPdf`, `checkInUrl` and `ticketPdfUrl`.
- `GUEST_DETAILS`: Returns `guestDetails`.
- `GUEST_FORM`: Returns `guestDetails.form`.

Default: If a fieldset is not included in the request, returns only the `memberId` and `anonymized` fields.

fieldset

GuestDetails

contactId

email

firstName

form

Whether ticket belongs to assigned guest.

guestAssigned

lastName

GuestDetailsUpdate

InputValue

inputName

value

values

facet

Number of items to load per page. See [Pagination](/wix-events-v2/pagination).

limit

memberId

Offset. See [Pagination](/wix-events-v2/pagination).

offset

orderNumber

orderStatus

Textual search filter - search is performed on `"orderFullName"`, `"guestFullName"`, and `"ticketNumber"`.

searchPhrase

Sort order.

Default: `"ticketNumber"`:`"asc"`.

sort

Ticket states. Possible values:
- `ORDER_ARCHIVED`: Returns tickets of the archived orders.
- `ORDER_ACTIVE`: Returns tickets of the non-archived orders.
- `TICKET_ARCHIVED`: Returns archived tickets.
- `TICKET_ACTIVE`: Returns non-archived tickets.
- `CHECKED_IN`: Returns checked-in tickets.
- `NON_CHECKED_IN`: Returns tickets that are not checked in.
- `FREE`: Returns free tickets.
- `PAID`: Return paid tickets.
- `MEMBER`: Return members' tickets.

state

ticketDefinitionId

facets

Total tickets matching the given filters.

total

Money

amount

Currency in the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. For example, `USD`.

currency

Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative.

OrderStatus

State

StreetAddress

name

TicketDetails

areaLabel

Number of places in the spot. If not provided - defaults to 1.

capacity

priceOverride

pricingOptionId

pricingOptionName

rowLabel

seatId

seatLabel

sectionLabel

tableLabel

TicketFacetCounts

TicketFacets

TicketFieldset

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

anonymized

Whether the ticket is visible in an order.

channel

checkIn

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`

checkInUrl

free

guestDetails

guestFullName

Whether order and ticket are visible in order list.

orderArchived

orderFullName

Associated order status. Possible values:
- `FREE`: The order is confirmed, no payment is required.
- `PENDING`: The order was paid, but the payment gateway suspended the payment.
- `PAID`: The order is paid.
- `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
- `INITIATED`: The order is awaiting for payment.
- `CANCELED`: The order is canceled.
- `DECLINED`: The order is declined.

policy

price

ticketPdfUrl

An URL to download a ticket in the `.pkpass` format for Apple Wallet.

getTicket( )

Permission Scopes