POST

Query Ticket Definitions


Retrieves a list of ticket definitions, given the provided paging, filtering, and sorting. Query Ticket Definitions runs with these defaults, which you can override:

  • createdDate is sorted in ASC order
  • paging.limit is 100
  • paging.offset is 0

For field support for filters and sorting, see Ticket Definitions: Supported Filters and Sorting. To learn about working with Query endpoints, see API Query Language.

Authentication

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

Permissions
Manage Events - all permissions
Manage Orders
Manage Ticket Definitions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/events-ticket-definitions/v3/ticket-definitions/query

Body Params
queryQueryRequired

Query options. See API Query Language for more details.


fieldsArray <string>maxItems 5

Predefined sets of fields to return.

Response Object
ticketDefinitionsArray <TicketDefinition>

List of ticket definitions.


metadataMetadata

Metadata for the paginated results.

Query ticket definitions by created date with sales details
Request
cURL
curl -X POST 'https://www.wixapis.com/events-ticket-definitions/events-ticket-definitions/v3/ticket-definitions/query' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH TOKEN>' \ -d '{ "query": { "filter": { "createdDate": { "$gt": "2023-05-25T00:00:00.000Z" } }, "fields": [ "SALES_DETAILS" ] } }'
Response
JSON
{ "ticketDefinitions": [ { "id": "625115fd-31cb-4f64-b7bd-06c3137486c0", "eventId": "9d720f99-1b5a-4141-9877-d32985391e18", "revision": "1", "createdDate": "2023-05-25T12:41:24.422Z", "updatedDate": "2023-05-25T12:41:24.422Z", "name": "Shoemaking for Beginners", "description": "Embark on a fascinating journey into the world of shoemaking at our Shoemaking for Beginners event. Discover the art and craftsmanship behind creating your own pair of shoes as our expert instructors guide you through each step of the process. From designing to pattern-making and assembling, this hands-on workshop is your gateway to mastering the fundamentals of shoemaking and unleashing your inner designer.", "policyText": "This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!", "hidden": false, "limited": true, "initialLimit": 12, "actualLimit": 12, "pricingMethod": { "pricingOptions": { "optionDetails": [ { "optionId": "e63f7f77-ce5d-487b-b585-af30d103fbc8", "name": "Regular Ticket", "price": { "value": "50.00", "currency": "USD" } }, { "optionId": "6e409caa-6183-47f1-b0d6-c78b7047f3b2", "name": "Student Ticket", "price": { "value": "25.00", "currency": "USD" } } ] }, "pricingType": "STANDARD", "free": false }, "feeType": "FEE_INCLUDED", "salePeriod": { "startDate": "2023-07-14T10:00:00Z", "endDate": "2023-07-22T00:00:00Z", "displayNotOnSale": false }, "saleStatus": "SALE_ENDED", "salesDetails": { "unsoldCount": 12, "soldCount": 0, "reservedCount": 0, "soldOut": false } }, { "id": "7ffbabb4-708c-449b-a956-78d153cd1faa", "eventId": "39d16ecc-0ec8-4764-8077-8e991f20ef9d", "revision": "1", "createdDate": "2023-05-25T12:06:15.815Z", "updatedDate": "2023-05-25T12:06:15.815Z", "name": "Gospel Concert", "description": "Experience the uplifting power of gospel music at our awe-inspiring Gospel Concert. Join us for an unforgettable evening filled with soul-stirring melodies, powerful harmonies, and heartfelt performances by renowned gospel artists. Let your spirit soar as you immerse yourself in the joyous celebration of faith, music, and unity at this not-to-be-missed event.", "policyText": "This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!", "hidden": false, "limited": true, "initialLimit": 50, "actualLimit": 50, "pricingMethod": { "guestPrice": { "value": "2.00", "currency": "USD" }, "pricingType": "DONATION", "free": false }, "feeType": "FEE_ADDED_AT_CHECKOUT", "salePeriod": { "startDate": "2023-06-28T10:00:00Z", "endDate": "2023-07-08T00:00:00Z", "displayNotOnSale": false }, "saleStatus": "SALE_ENDED", "salesDetails": { "unsoldCount": 3, "soldCount": 0, "reservedCount": 0, "soldOut": false } } ], "metadata": { "count": 2, "offset": null, "total": null, "tooManyToCount": null, "cursors": { "next": null, "prev": null } } }
Errors

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

Did this help?