Skip to content

Retrieve order details

Request

Retrieve the details of the requested order

Security
SessionKey(Required scopes: customeradministrator)
Path
numberstringrequired

Alphanumeric identifier of the user account

orderstring^\d{14}$

Unique identifier of the order

curl -i -X GET \
  'https://docs.ticketingevents.com/_mock/openapi/accounts/{number}/orders/{order}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Details of the requested order were successfully retrieved.

Bodyapplication/json
selfstring, (uri)

URI of the order resource

numberstring

Unique identifier of the order

statusstring

Current status of the order

placedstring, (date-time)

The date and time at which the order was placed

subtotalnumber, (float)

Total cost of the ordered items, before convenience fees are applied

feesnumber, (float)

Total applicable convenience fees for this order

totalnumber, (float)

Total to be paid for this order inclusive of item costs (subtotal) and fees

itemsArray of objects

List of items that were ordered

paymentobject

Details of the payment for this order.

Response
{
  "self": "/orders/E8D946240203",
  "number": "E8D946240203",
  "status": "Placed",
  "placed": "2024-02-03T23:22:31+00:00",
  "subtotal": 140,
  "fees": 3.96,
  "total": 143.96,
  "items": [
    { … }
  ],
  "payment": {
    "uri": "https://payments.frubipay.com/1234567890",
    "status": "Pending",
    "method": { … }
  }
}