Retrieves a list of orders, including ticket data, with basic filter support.
You can only call this method when authenticated as a Wix app or Wix user identity.
Offset.
Limit.
Controls which data is returned. See Fieldset.
Status.
Event ID.
Order number.
Site member ID.
Field facets. See supported facets.
Textual search filter - search is performed on "full_name", "email" and "order_number".
Event creator ID.
Sort order. Defaults to "created:asc". See supported fields.
Order tag.
Guest contact IDs.
Total orders matching the given filters.
Offset.
Limit.
Orders.
Filter facets.
Order data enriched facets.
curl -X GET 'https://api.wix.com/events/v1/orders?eventId=619d52c0-c93b-4155-a55c-108048f20b3f&offset=0&limit=1&fieldset=DETAILS&fieldset=FORM&fieldset=TICKETS&facet=status' \
-H 'Authorization: <AUTH TOKEN>'{
"total": 10,
"limit": 1,
"orders": [
{
"orderNumber": "FM9X-EHKF-ZO",
"reservationId": "89f8cce3-d6aa-4b5d-a3ae-1667d81ceb8d",
"snapshotId": "f16f73a4-9c62-4f66-a4d2-2a01fe45fc96",
"eventId": "619d52c0-c93b-4155-a55c-108048f20b3f",
"contactId": "a5146d63-9f90-49d2-9979-34506942a02e",
"memberId": "",
"created": "2020-04-07T06:42:35.381Z",
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@somedomain.com",
"checkoutForm": {
"inputValues": [
{
"inputName": "firstName",
"value": "John"
},
{
"inputName": "lastName",
"value": "Doe"
},
{
"inputName": "email",
"value": "john.doe@somedomain.com"
}
]
},
"confirmed": true,
"status": "PAID",
"method": "payPal",
"ticketsQuantity": 1,
"totalPrice": {
"amount": "10.00",
"currency": "EUR"
},
"ticketsPdf": "<url_to_pdf>",
"tickets": [
{
"ticketNumber": "FM9X-EHKF-ZO021",
"orderNumber": "FM9X-EHKF-ZO",
"ticketDefinitionId": "0abf130e-2157-4131-a164-72c849d3f142",
"name": "VIP enterance",
"price": {
"amount": "10.00",
"currency": "EUR"
},
"free": false,
"policy": "This is your event ticket. Ticket holders must present their tickets on entry. Looking forward to seeing you there!",
"checkInUrl": "https://www.wixevents.com/check-in/FM9X-EHKF-ZO021,619d52c0-c93b-4155-a55c-108048f20b3f",
"orderStatus": "PAID",
"orderArchived": false,
"orderFullName": "John Doe",
"guestFullName": "Sarah Doe",
"guestDetails": {
"guestAssigned": true,
"firstName": "Sarah",
"lastName": "Doe",
"email": "sarah.doe@somedomain.com",
"form": {
"inputValues": [
{
"inputName": "email",
"value": "sarah.doe@somedomain.com"
},
{
"inputName": "lastName",
"value": "Doe"
},
{
"inputName": "firstName",
"value": "Sarah"
}
]
},
"contactId": "8777c2c8-d46e-466c-b602-e5144e2cb588"
},
"archived": false,
"ticketPdfUrl": "<url_to_pdf>",
"anonymized": false
}
],
"archived": false,
"anonymized": false,
"fullName": "John Doe",
"fullyCheckedIn": false,
"transactionId": "de57fc42-d98c-4715-8627-65e0bc0b36af"
}
],
"facets": {
"status": {
"counts": {
"INITIATED": 6,
"PAID": 3,
"OFFLINE_PENDING": 1
}
}
},
"orderFacets": {
"facets": {
"status": {
"counts": {
"INITIATED": {
"count": 6,
"tickets": 20,
"ticketsCheckIn": 0
},
"PAID": {
"count": 3,
"tickets": 7,
"ticketsCheckIn": 0
},
"OFFLINE_PENDING": {
"count": 1,
"tickets": 1,
"ticketsCheckIn": 1
}
}
}
}
}
}This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.