Order Object

Attributes
orderNumberstring
Unique order number.

reservationIdstringformat GUID
Reservation ID.

snapshotIdstringRead-onlyformat GUID
Payment snapshot ID. Empty for FREE order.

eventIdstringformat GUID
Event ID.

contactIdstringformat GUID
Contact ID of buyer (resolved using email address).

memberIdstringformat GUID
Member ID of buyer (if relevant).

createdstringRead-onlyformat date-time
RSVP created timestamp.

firstNamestring
Guest first name.

lastNamestring
Guest last name.

emailstringformat EMAIL
Guest email.

checkoutFormobject
Checkout form response. When each purchased ticket is assigned to a guest, guest forms are returned for each ticket, and buyer info is returned.

confirmedboolean
Whether the order is confirmed (triggered once payment gateway processes the payment and funds reach the merchant's account).

statusstring
8 supported values:
NA_ORDER_STATUSFREEPENDINGPAIDOFFLINE_PENDINGINITIATEDCANCELEDDECLINED
Order status.

methodstring
Payment method used for purchase, e.g., "payPal", "creditCard", etc.

ticketsQuantityinteger
Tickets ordered.

totalPriceobject
Total order price.

ticketsPdfstring
URL to ticket PDF.

ticketsArray <Ticket>
Tickets (generated after payment).

archivedboolean
Whether the order is archived.

anonymizedboolean
Whether the order is anonymized by GDPR delete.

fullNamestring
Guest full name.

invoiceobject
Order invoice.

fullyCheckedInboolean
Whether all tickets in order are checked-in.

paymentDetailsobject
Internal order payment details

channelstring
2 supported values:
ONLINEOFFLINE_POS
Checkout channel type
Was this helpful?
Yes
No

GetList Orders

Retrieves a list of orders, including ticket data, with basic filter support.

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.Authorization header required - pass the OAuth Access Token
Endpoint
GET
https://www.wixapis.com/events/v1/orders

Was this helpful?
Yes
No

GetGet Order

Retrieves an order, including ticket data.

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.Authorization header required - pass the OAuth Access Token
Endpoint
GET
https://www.wixapis.com/events/v1/events/{eventId}/orders/{orderNumber}

Was this helpful?
Yes
No

PatchUpdate Order

Updates an order's checkoutForm and/or archived status.

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.Authorization header required - pass the OAuth Access Token
Endpoint
PATCH
https://www.wixapis.com/events/v1/events/{eventId}/orders/{orderNumber}

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

PatchBulk Update Orders

Updates multiple orders' archived status.

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.Authorization header required - pass the OAuth Access Token
Endpoint
PATCH
https://www.wixapis.com/events/v1/events/{eventId}/orders

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

PostConfirm Order

Changes order status to "CONFIRMED" - from "INITIATED, "PENDING", "OFFLINE_PENDING" to "PAID". Previously confirmed orders (with status "PAID" or "FREE") are not changed. Confirming previously "INITIATED" or "PENDING" orders triggers an email with the tickets to the buyer (and to additional guests, if relevant and provided).

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.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/events/v1/events/{eventId}/orders/confirm

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

GetGet Order Summary

Retrieves a summary of total ticket sales.

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.Authorization header required - pass the OAuth Access Token
Endpoint
GET
https://www.wixapis.com/events/v1/orders/summary

Was this helpful?
Yes
No

GetGet Checkout Options

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.Authorization header required - pass the OAuth Access Token
Endpoint
GET
https://www.wixapis.com/events/v1/checkout/options

Was this helpful?
Yes
No

GetList Available Tickets

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.Authorization header required - pass the OAuth Access Token
Endpoint
GET
https://www.wixapis.com/events/v1/checkout/available-tickets

Was this helpful?
Yes
No

PostQuery Available Tickets

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.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/events/v1/checkout/available-tickets/query

Was this helpful?
Yes
No

PostCreate Reservation

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.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/events/v1/checkout/reservations

Was this helpful?
Yes
No

DeleteCancel Reservation

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.Authorization header required - pass the OAuth Access Token
Endpoint
DELETE
https://www.wixapis.com/events/v1/checkout/reservations/{id}

Was this helpful?
Yes
No

PostGet Invoice Preview

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.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/events/v1/checkout/invoices/{reservationId}

Was this helpful?
Yes
No

PostCheckout

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

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.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/events/v1/checkout

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

PatchUpdate Checkout

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.Authorization header required - pass the OAuth Access Token
Endpoint
PATCH
https://www.wixapis.com/events/v1/checkout/{orderNumber}

Was this helpful?
Yes
No

Order Deleted

This event is triggered when an order is deleted via GDPR request.

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

eventIdstringformat GUID
Event ID.

orderNumberstring
Unique order number.

contactIdstring
Contact ID associated with this order

memberIdstringformat GUID
Member ID associated with this order.

anonymizedboolean
Whether order was anonymized by GDPR delete.

orderTypestring
2 supported values:
UNASSIGNED_TICKETSASSIGNED_TICKETS
Order type.

triggeredByAnonymizeRequestboolean
Whether event was triggered by GDPR delete request.

ticketsArray <Ticket>
Tickets generated after payment.
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

localestringformat LANGUAGE_TAG
Locale in which Order was created.

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

Order Confirmed

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 confirmation timestamp in ISO UTC.

languagestringformat LANGUAGE
Site language when Order initiated

silentboolean
Notifications silenced for this domain event.

localestringformat LANGUAGE_TAG
Locale in which Order was created.

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 address.

checkoutFormobject
Checkout form response.

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).

invoiceobject
Invoice.

reservationIdstring
Reservation ID associated with this order.
Was this helpful?
Yes
No

Order Paid

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 paid timestamp in ISO UTC.

eventIdstringformat GUID
Event ID.

orderNumberstring
Unique order number.

reservationIdstring
Reservation ID associated with this order.
Was this helpful?
Yes
No

Reservation Created

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
Reservation created timestamp in ISO UTC format.

eventIdstringformat GUID
Event ID.

reservationIdstringformat GUID
Reservation ID. Can be used to retrieve a reservation invoice.

expiresstringformat date-time
Reservation expiration timestamp.

statusstring
5 supported values:
RESERVATION_PENDINGRESERVATION_CONFIRMEDRESERVATION_CANCELEDRESERVATION_CANCELED_MANUALLYRESERVATION_EXPIRED
Reservation status.

quantitiesArray <TicketQuantity>maxItems 50
Reservation ticket quantities.
Was this helpful?
Yes
No

Reservation 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
Reservation updated timestamp.

eventIdstringformat GUID
Event ID.

reservationIdstringformat GUID
Reservation ID. Can be used to retrieve a reservation invoice.

statusstring
5 supported values:
RESERVATION_PENDINGRESERVATION_CONFIRMEDRESERVATION_CANCELEDRESERVATION_CANCELED_MANUALLYRESERVATION_EXPIRED
Reservation status.

expiresstringformat date-time
Reservation expiration timestamp.

quantitiesArray <TicketQuantity>maxItems 50
Reservation ticket quantities.
Was this helpful?
Yes
No

Order Initiated

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

languagestringformat LANGUAGE
Site language when Order initiated

localestringformat LANGUAGE_TAG
Locale in which Order was created.

eventIdstringformat GUID
Event ID.

orderNumberstring
Unique order number.

contactIdstring
Contact ID associated with this order.

memberIdstringformat GUID
Member ID associated with this order.

firstNamestring
Guest first name.

lastNamestring
Guest last name.

emailstring
Guest email address.

checkoutFormobject
Checkout form response.

statusstring
8 supported values:
NA_ORDER_STATUSFREEPENDINGPAIDOFFLINE_PENDINGINITIATEDCANCELEDDECLINED
Order status.

invoiceobject
Invoice.

reservationIdstring
Reservation ID associated with this order.

markedAsPaidboolean
Order was marked as paid.
Was this helpful?
Yes
No