POST

Query Available Tickets


Returns tickets available to reserve.

Permissions
Manage Events - all permissions
Manage Orders
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/events/v1/checkout/available-tickets/query

Body Params
offsetintegerminimum 0

Offset.


limitintegerminimum 0maximum 1000

Limit.


filterstruct

Ticket definition. See supported fields and operators.


fieldsetArray <string>maxItems 20

sortstringmaxLength 100

Sort order, defaults to "created:asc". See supported fields.

Response Object
metaDataMetaData

Ticket definitions meta data.


definitionsArray <TicketDefinition>

Ticket definitions.

Query Available Tickets Example 1
Request
cURL
curl -X POST 'https://www.wixapis.com/events/v1/tickets/available/query' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH TOKEN>' \ --data-binary '{ "offset": 0, "limit": 100, "order": "orderIndex:asc", "filter": { "name": { "$contains": "ticket" } } }'
Response
JSON
{ "metaData": { "count": 2, "offset": 0, "total": 2 }, "definitions": [ { "id": "48da25d2-afb2-4955-92a0-b820635ac321", "price": { "amount": "0.00", "currency": "EUR" }, "free": true, "name": "Nice ticket", "description": "", "limitPerCheckout": 20, "orderIndex": 4, "eventId": "fd56076c-38f4-4705-b9eb-ec322b85c745" }, { "id": "9c13fb37-f2c6-4c9c-8950-41c49b0a5c84", "price": { "amount": "100.00", "currency": "EUR" }, "free": false, "name": "VIP ticket", "description": "", "limitPerCheckout": 20, "orderIndex": 5, "eventId": "fd56076c-38f4-4705-b9eb-ec322b85c745" } ] }
Errors

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

Did this help?