Skip to content

List orders

GET /api/orders

Returns orders that have been imported into Transdirect from external integrations such as WooCommerce, Shopify, eBay, PayPal, or CSV uploads. Orders represent sales from your online store that can be converted into bookings.

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

A successful response returns a 200 status code with an array of order objects.

[
{
"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
},
{
"id": 5002,
"order_number": "SHOP-2087",
"source": "shopify",
"status": "booked",
"receiver_name": "Sarah Lee",
"receiver_email": "sarah@example.com.au",
"receiver_phone": "0412345678",
"receiver_address": "100 Collins Street",
"receiver_suburb": "MELBOURNE",
"receiver_postcode": "3000",
"receiver_state": "VIC",
"receiver_country": "AU",
"items": [
{
"description": "Gadget X",
"quantity": 1,
"weight": 3.0
}
],
"created_at": "2025-08-14T09:15:00+1000",
"booking_id": 123456
}
]
FieldTypeDescription
idintegerUnique order ID
order_numberstringThe order number from the external system
sourcestringIntegration source (e.g. woocommerce, shopify, ebay, paypal, csv)
statusstringOrder status (e.g. pending, booked)
receiver_namestringRecipient’s full name
receiver_emailstringRecipient’s email address
receiver_phonestringRecipient’s phone number
receiver_addressstringDelivery street address
receiver_suburbstringDelivery suburb
receiver_postcodestringDelivery postcode
receiver_statestringDelivery state or territory
receiver_countrystringDelivery country code
itemsarrayArray of item objects with description, quantity, and weight
created_atstringISO 8601 timestamp of when the order was imported
booking_idinteger or nullThe associated booking ID if the order has been converted to a booking, otherwise null
Status codeMeaning
401Unauthorised — invalid credentials or API key