Get an order

Fetch one of your saved orders by its Transdirect id, for example to check whether a booking has been linked to it.

GET /api/v5/orders/{id}

Requires your API key in the api-key header. See Authentication.

Path parameters

Parameter	Type	Required	Description
`id`	integer	Yes	Transdirect’s order id: the `id` field from List orders or Create an order. This is not your store’s order number (`order_id`) and not a booking id.

Request

curl "https://api.transdirect.com.au/api/v5/orders/88" \
  -H "api-key: $TD_API_KEY"

import { client, getApiV5OrdersById } from '@transdirect/api-sdk';

client.setConfig({ headers: { 'api-key': process.env.TD_API_KEY! } });

const { data, error } = await getApiV5OrdersById({ path: { id: '88' } });

Response

200 OK with the order. This one has been linked to booking 34500123 on Couriers Please. The fields are described on List orders.

{
  "id": 88,
  "transdirect_order_id": 34500123,
  "transdirect_member_id": 12345,
  "transdirect_order_status": "pending",
  "order_id": "WEB-1042",
  "goods_summary": "2 x Ceramic planter",
  "goods_dump": "",
  "imported_from": "csv",
  "imported_time": "2026-10-15T23:30:00.000Z",
  "purchased_time": "2026-10-16T10:28:00+11:00",
  "sale_price": "89.90",
  "selected_courier": "couriers_please",
  "courier_price": "14.85",
  "paid_time": "",
  "buyer_name": "Jane Citizen",
  "buyer_email": "jane@example.com.au",
  "delivery": {
    "name": "Jane Citizen",
    "email": "jane@example.com.au",
    "phone": "0412345678",
    "address": "1 Collins Street, MELBOURNE VIC 3000"
  },
  "last_updated": "2026-10-15T23:41:12.000Z"
}

To see the shipment itself, fetch the linked booking with GET /api/v5/bookings/{id} using transdirect_order_id.

Errors

Status	Body	Cause
`400`	`{"success":false,"error":{"name":"ZodError","message":"..."}}`	`id` contains something other than digits.
`400`	`{"error":"invalid_order_id"}`	`id` is `0`.
`401`	`{"error":"missing_api_key"}` or `{"error":"invalid_api_key"}`	No key, or the key is unknown or deactivated.
`403`	`{"error":"order_not_found"}`	No order with this `id` on your account, or the order is deleted.
`429`	`{"error":"rate_limited"}`	More than 600 requests in a minute on this key. Wait for the number of seconds in `retry-after`.

A missing or inaccessible order returns 403 with {"error":"order_not_found"}.

Try it

Open Get a saved order in the API Explorer, paste your API key into the authentication box, enter an id and send the request.