Skip to content
Transdirect Developer Centre

Using the API Explorer

The API Explorer lists every v5 endpoint with its parameters, request body and responses, and lets you send real requests from your browser. It reads the same OpenAPI spec as the TypeScript SDK, so what you see there is what the API accepts.

Open the API Explorer Every v5 endpoint, ready to send. Your key stays in your browser.

The same explorer is also available at api.transdirect.com.au/reference.

Send your first request

Section titled “Send your first request”

  1. Get an API key. In the members area go to Settings > Integrations, connect Custom API and copy the key. See authentication.

  2. Paste the key. In the explorer, find Authentication (above the first endpoint) and paste the key into Value. The explorer sends it as the api-key header with your requests (endpoints that need no key ignore it), and remembers it in this browser.

  3. Pick an endpoint. A good first call is Get the currently authenticated member (GET /api/v5/member). It changes nothing and confirms your key works.

  4. Send it. Choose Test Request, then Send. The response, status code and headers appear alongside. A 401 with missing_api_key means the key was not entered; invalid_api_key means the key is wrong or deactivated.

  5. Copy the code. Every endpoint shows a ready-made request in curl and other languages, with your key filled in. Paste it into your own code or terminal.

Some endpoints need no key at all, such as GET /api/v5/couriers, GET /api/v5/locations/search and GET /api/v5/tracking/{reference}. You can try those straight away.

Requests are real

Section titled “Requests are real”

The explorer calls the live API with your key. A quote creates a draft booking on your account, and confirming a booking on a real courier books and charges it.

To try the full booking flow safely, switch on the Demo courier for your key first (members area, Settings > Integrations, the key’s menu, Demo courier). Quote as normal, then confirm with "courier": "demo" and "payment_method": "demo". Demo bookings are never charged and never sent to a courier. See testing with demo mode.

Tips

Section titled “Tips”
  • Your key stays with you. It is saved in this browser’s local storage for this site only, and sent only to https://api.transdirect.com.au. On a shared computer, empty the Value field under Authentication when you are done. The explorer here and the one at api.transdirect.com.au/reference each keep their own copy.
  • Booking ids. Endpoints such as confirm and label take the booking id from the quote response. Copy it from a quote you have just made.
  • PDFs. Label, manifest and invoice endpoints return a PDF. The explorer shows the response type; use the curl command to save the file.
  • The spec itself is at https://api.transdirect.com.au/openapi.json if you want to import it into Postman, Insomnia or a client generator.

Next steps

Section titled “Next steps”