Setup

To use the Checkout API, install the @wix/events package using npm or Yarn:

Copy
1
npm install @wix/events

or

Copy
1
yarn add @wix/events

Then import { checkout } from @wix/events:

Copy
1
import { checkout } from '@wix/events'
Was this helpful?
Yes
No

Introduction

The Checkout API allows you to manage and track ticket reservations.

With the Checkout API you can:

  • Get lists of available tickets.
  • Create, update, and cancel ticket reservations.
  • Checkout reserved tickets.
  • Preview reservation invoices.
Was this helpful?
Yes
No

Checkout: Supported Filters and Sorting

The following table shows field support for filters and sorting for the Ticket object:

FieldSupported FiltersSortable
createdNot filterableSortable
priceNot filterableSortable
orderIndexNot filterableSortable
ticketDefinitionId$eq, $ne, $hasSome, $in
eventId$eq, $ne, $hasSome, $in
name$eq, $ne, $lt, $lte, $gt, $gte, $hasSome, $in, $contains, $urlizedSortable

Related content: API Query Language, queryAvailableTickets( ), listAvailableTickets( )

Was this helpful?
Yes
No

cancelReservation( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Cancels ticket reservation and returns tickets to stock.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events - all permissions
Manage Orders
Learn more about permission scopes.
Params
_idstringRequired
Reservation ID.

eventIdstringRequired
Event ID.
Response Object
void
Was this helpful?
Yes
No

checkout( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Checkout of reserved tickets.

Creates order and associates it with a site contact. Guest details must be sent according to the Registration Form input fields. (To change an existing "INITIATED, "PENDING", or "OFFLINE_PENDING" order, call the Update Checkout endpoint).

There is a possibility to use a separate ready-made Wix checkout form where the user will be redirected from your non-Wix site or a custom ticket picker created with Velo. To construct the checkout form path, get your event base URL by using the getEvent() function and add the following path: /{{EVENT_PAGE_SLUG}}/{{SLUG}}/ticket-form?reservationId={{YOUR_RESERVATION_ID}}

Example: https://johndoe.wixsite.com/weddings/event-details/doe-wedding/ticket-form?reservationId=2be6d34a-2a1e-459f-897b-b4a66e73f69a

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events - all permissions
Manage Orders
Learn more about permission scopes.
Params
eventIdstringRequired
Event ID.

optionsCheckoutOptionsForRequest
An object representing the available options for checking out a reserved ticket.
Response Object
CheckoutResponse
Was this helpful?
Yes
No

createReservation( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Reserves tickets for 20 minutes. Reserved tickets are deducted from tickets stock and cannot be bought by another party. When the reservation expires, the tickets are added back in the stock.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events - all permissions
Manage Orders
Learn more about permission scopes.
Params
eventIdstringRequired
Event ID.

optionsCreateReservationOptions
An object representing the available options for creating a reservation.
Response Object
CreateReservationResponse
Was this helpful?
Yes
No

getCheckoutOptions( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Returns checkout meta data used in checkout UX.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events - all permissions
Manage Orders
Learn more about permission scopes.
Request
This method does not take any parameters
Response Object
GetCheckoutOptionsResponse
Was this helpful?
Yes
No

getInvoice( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Generates a preview of a reservation invoice, including the given coupon or pricing plan.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Events - all read permissions
Manage Events - all permissions
Read Basic Events Order Info
Manage Orders
Learn more about permission scopes.
Params
reservationIdstringRequired
Reservation ID.

eventIdstringRequired
Event ID.

optionsGetInvoiceOptions
An object representing the available options for generating a preview of a reservation invoice.
Response Object
GetInvoiceResponse
Was this helpful?
Yes
No

listAvailableTickets( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Returns tickets available to reserve.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events - all permissions
Manage Orders
Learn more about permission scopes.
Params
optionsListAvailableTicketsOptions
An object representing the available options for retrieving a list of tickets available for reservation.
Response Object
ListAvailableTicketsResponse
Was this helpful?
Yes
No

queryAvailableTickets( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Returns tickets available to reserve.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events - all permissions
Manage Orders
Learn more about permission scopes.
Params
optionsQueryAvailableTicketsOptions
An object representing the available options for retrieving a list of tickets available for reservation.
Response Object
QueryAvailableTicketsResponse
Was this helpful?
Yes
No

updateCheckout( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates order and tickets (supported only for unconfirmed orders). Guest details must be sent according to Registration Form input fields.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events - all permissions
Manage Orders
Learn more about permission scopes.
Params
orderNumberstringRequired
Unique order number.

eventIdstringRequired
Event ID.

optionsUpdateCheckoutOptions
An object representing the available options for updating an order and tickets.
Response Object
UpdateCheckoutResponse
Was this helpful?
Yes
No