Get an order

Endpoint

GET /api/orders/{id}

Returns the details of a specific order.

Path parameters

Parameter	Type	Required	Description
`id`	integer	Yes	The order ID

Request

curl -X GET \
  -H "Api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  https://www.transdirect.com.au/api/orders/5001

Response

A successful response returns a 200 status code with the order object.

{
  "id": 5001,
  "order_number": "WC-1042",
  "source": "woocommerce",
  "status": "pending",
  "receiver_name": "John Smith",
  "receiver_email": "john@example.com.au",
  "receiver_phone": "0498765432",
  "receiver_address": "42 George Street",
  "receiver_suburb": "SYDNEY",
  "receiver_postcode": "2000",
  "receiver_state": "NSW",
  "receiver_country": "AU",
  "items": [
    {
      "description": "Widget Pro",
      "quantity": 2,
      "weight": 1.5
    }
  ],
  "created_at": "2025-08-15T10:30:00+1000",
  "booking_id": null
}

Response fields

Field	Type	Description
`id`	integer	Unique order ID
`order_number`	string	The order number from the external system
`source`	string	Integration source (e.g. `woocommerce`, `shopify`, `ebay`, `paypal`, `csv`)
`status`	string	Order status. See statuses below.
`receiver_name`	string	Recipient’s full name
`receiver_email`	string	Recipient’s email address
`receiver_phone`	string	Recipient’s phone number
`receiver_address`	string	Delivery street address
`receiver_suburb`	string	Delivery suburb
`receiver_postcode`	string	Delivery postcode
`receiver_state`	string	Delivery state or territory
`receiver_country`	string	Delivery country code
`items`	array	Array of item objects with `description`, `quantity`, and `weight`
`created_at`	string	ISO 8601 timestamp of when the order was imported
`booking_id`	integer or null	The associated booking ID if converted to a booking, otherwise `null`

Order statuses

Status	Description
`pending`	Order imported but not yet ready to book.
`ready_to_book`	Order has the details needed for a booking and is ready to be converted.
`booked`	Order has been converted to a confirmed booking.
`manually_dispatched`	Order was fulfilled outside the Transdirect booking flow.
`cancelled`	Order has been cancelled.
`deleted`	Order has been marked deleted.
`removed`	Order has been removed from the active list.

Error responses

Status code	Meaning
`401`	Unauthorised — invalid credentials or API key
`404`	Not found — the order does not exist or does not belong to your account