List bookings through the legacy v4 alias
GET /api/v5/bookings/v4
Legacy “/v4” alias of GET /; lists the member’s bookings and quotes and behaves identically, including conditional-request (304) support. Requires an API key.
Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ”Only return bookings created at or after this time (ISO 8601 datetime).
Only return bookings created at or after this time (ISO 8601 datetime).
Column to sort by (e.g. booking_time, paid_date, status, cost, courier); prefix with ”-” for descending. Defaults to newest first (booking_time descending).
Column to sort by (e.g. booking_time, paid_date, status, cost, courier); prefix with ”-” for descending. Defaults to newest first (booking_time descending).
Responses
Section titled “ Responses ”Booking list
object
Booking identifier.
ISO 8601 timestamp the booking was confirmed.
Name of the user who confirmed the booking, if known.
ISO 8601 timestamp the booking (or quote) was created.
Declared value of the goods in AUD.
Insured (transit cover) value in AUD.
Short booking description.
Items included in the booking.
object
Booking item identifier.
Package type or contents description.
Item weight in kg.
Item length in cm.
Item width in cm.
Item height in cm.
Number of identical items of these dimensions.
Shipping label reference or URL for the booking.
Notification preferences for the booking.
object
Email notifications flag (always false on this endpoint).
SMS notifications flag (always false on this endpoint).
Per-courier errors encountered while quoting.
object
Courier string_id that failed to quote.
Error code for the quote failure.
Canonical cross-courier serviceability code — see SERVICEABILITY_CODES.
Whether the failure is transient and worth retrying.
Booking status as a human label, not the stored machine code: v5 maps codes through a fixed lookup table, e.g. “paid” -> “Paid”, “pending_payment” -> “Pending Payment”, “sending_to_courier” -> “Sending to Courier”, “on_hold” -> “On hold”, “cancelled_refund” -> “Cancel Refund”. The mapping is not title-casing and is not reversible - both “pending_review” and “on_hold_suspicious” return “Pending Review” - and a code with no label (“from_on_hold”) is passed through unchanged. Note “new”: this response returns “New”, but POST /api/bookings/v4 returns the raw “new” on create. Match case-insensitively, or accept both forms.
Whether the booking has been paid.
Extra charges applied on top of the base cost, in AUD.
Courier string_id selected for the booking.
Linked e-commerce order, if the booking came from one.
object
Transdirect order identifier linked to this booking.
External order number from the source platform.
object
Address identifier.
Street address line.
Company/business name at this address.
Contact email for this party.
Contact person name at this address.
4-digit AU postcode (or destination postcode for international).
Contact phone number.
State code (e.g. NSW, VIC).
Suburb/locality.
Address type, “business” or “residential”.
2-letter ISO country code (e.g. AU).
object
Address identifier.
Street address line.
Company/business name at this address.
Contact email for this party.
Contact person name at this address.
4-digit AU postcode (or destination postcode for international).
Contact phone number.
State code (e.g. NSW, VIC).
Suburb/locality.
Address type, “business” or “residential”.
2-letter ISO country code (e.g. AU).
Confirmed pickup window as [start, end] time strings.
Carrier consignment note / tracking number, once lodged.
Weight the carrier charged on, in kg (may be volumetric).
Actual weight scanned by the carrier, in kg.
Free-text delivery instructions.
ISO 8601 timestamp the booking was last updated.
Free-text pickup instructions.
Whether tailgate assistance was requested at pickup.
Whether tailgate assistance was requested at delivery.
Collection point (pickup from depot/store) details, when applicable.
object
Collection point agent identifier.
Collection point network provider.
Display name of the collection point store.
Surcharge for using the collection point, in AUD.
Whether the closest collection point should be auto-selected.
Booking list cache validator still current
Invalid booking list query
object
Human-readable error message describing why the request failed.
Missing or invalid API key
No bookings found