Skip to content

List customer orders

Request

List customer orders matching the specified search criteria

Security
SessionKey(Required scopes: customeradministrator)
Path
numberstringrequired

Alphanumeric identifier of the user account

Query
recordsinteger

The number of records per page that should be returned

Default:25
pageinteger

The number of the results page to return

Default:1
numberstring

If set, only returns orders whose number matches the specified regular expression

statusstring

If set, only returns orders with the specified status

Enum:"Placed""Cancelled""Timed Out""Fulfilled""Voided""Returned"
sortstring

If set, determines how the returned orders are sorted

Value:"date"
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/accounts/{number}/orders?records=25&page=1&number=string&status=Placed&sort=date&order=asc' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The list of matching customer orders 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-21)

List of orders matching the given criteria

Response
{
  "page": 1,
  "records": 10,
  "entries": [
    { … }
  ]
}