GET

List Orders


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

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Events - all permissions
Read Events - all read permissions
Manage Orders
Read Basic Events Order Info
Manage Events
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/events/v1/orders

Query Params
offsetinteger

Offset.


limitinteger

Limit.


fieldsetArray <string>

Controls which data is returned. See Fieldset.


statusArray <string>

Status.


eventIdArray <string>

Event ID.


orderNumberArray <string>

Order number.


memberIdArray <string>

Site member ID.


facetArray <string>

Field facets. See supported facets.


searchPhrasestring

Textual search filter - search is performed on "full_name", "email" and "order_number".


eventCreatorIdArray <string>

Event creator ID.


sortstring

Sort order. Defaults to "created:asc". See supported fields.


tagArray <string>

Order tag.


contactIdArray <string>

Guest contact IDs.

Response Object
totalinteger

Total orders matching the given filters.


offsetintegerminimum 0

Offset.


limitintegerminimum 0maximum 100

Limit.


ordersArray <Order>

Orders.


facetsMap <string, FacetCounts>format map

Filter facets.


orderFacetsOrderFacets

Order data enriched facets.

List Orders Example 1
Request
cURL
Response
JSON
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?