Skip to content

List host sales

Request

Retrieve a list of all recorded sales for the specified host.

Security
SessionKey(Required scopes: customeradministrator)
Path
hostintegerrequired

Unique identifier of the requested host

Query
afterstring, (date-time)

Only return sales transacted on or after the specified date and time

beforestring, (date-time)

Only return sales transacted on or before the specified date and time

eventstring^\d{14}$

Only return sales of tiers associated with the specified event

tierstring^\d{14}$

Only return sales of the specified tier

numberstring

Only return sales associated with the specified order

customerstring

Only return sales generated by the specified customer

statusstring

Only return sales with the specified status

Enum:"pending""cancelled""confirmed""refunded"
sortstring

If set, determines how the returned sales list is sorted

Enum:"recorded""total"
orderstring

If set along with the 'sort' parameter, determines whether the results will be sorted in ascending or descending order.

Default:"asc"
Enum:"asc""desc"
curl -i -X GET \
  'https://docs.ticketingevents.com/_mock/openapi/hosts/{host}/sales?after=2019-08-24T14%3A15%3A22Z&before=2019-08-24T14%3A15%3A22Z&event=string&tier=string&number=string&customer=string&status=pending&sort=recorded&order=asc' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The list of recorded sales was successfully retrieved.

Bodyapplication/json
totalinteger

The total number of results available

pageinteger

The number of the results page returned

recordsinteger

The maximum number of results returned per page

entriesArray of objects(response-16)
Response
{
  "page": 1,
  "records": 25,
  "entries": [
    { … }
  ]
}