Booking lifecycle

Overview

Every shipment in Transdirect starts as a quote and progresses through a series of statuses as it moves from pricing to pickup to delivery.

Quotes and bookings are the same record

A “quote” and a “booking” are the same underlying record, differentiated only by status. When you call POST /api/bookings/v4, a record is created with status new — that’s the quote. Once you add details and confirm, the same record’s status progresses through pending_payment, paid, confirmed, etc. — and the same id is used throughout.

You don’t create a separate booking after quoting. You update the existing quote with full details, then confirm it.

flowchart LR
    A[Quote created] --> B[Details added]
    B --> C[Courier selected]
    C --> D[Payment]
    D --> E[Confirmed]
    E --> F[Picked up]
    F --> G[Delivered]

Booking statuses

Status	Description
new	Quote has been created with basic details (sender/receiver postcodes, items). Pricing has been returned.
pending_payment	Sender and receiver details have been added, a courier has been selected. Awaiting payment.
paid	Payment has been processed. The booking is ready to be sent to the courier.
pending_review	The booking has been flagged for manual review by the Transdirect team.
request_sent	The booking has been submitted to the courier for confirmation.
request_failed	The courier was unable to process the booking. Contact support.
reviewed	The booking has passed manual review and is being processed.
confirmed	The courier has confirmed the booking. A connote (tracking number) has been generated.
cancelled	The booking has been cancelled.
booked_manually	The booking was processed manually by the Transdirect team.
demo	A test booking created while your account is in demo mode. Not sent to any courier.

Step by step

1. Create a quote

Send a POST request to /api/bookings/v4 with the minimum required fields: sender and receiver postcodes/suburbs, and at least one item with weight and dimensions.

The response includes a booking_id and quotes from all available couriers.

2. Add sender and receiver details

Update the booking with PUT /api/bookings/v4/{id} to add full sender and receiver information: name, address, email, phone, and address type (business or residential).

3. Select a courier and pay

Choose a courier from the returned quotes and confirm the booking with POST /api/bookings/v4/{id}/confirm, specifying the courier and pickup_date.

For API integrations, payment is typically handled through your Transdirect account balance or configured payment method.

4. Get your label

Once confirmed, retrieve the shipping label with GET /api/bookings/v4/{id}/label. The label is returned as a PDF.

5. Track the shipment

Track the booking status with GET /api/bookings/v4/track/{id}. See tracking for details on tracking statuses.

Important notes

Note

After a booking has been paid, changes can no longer be made. You can cancel the booking if it has not yet been confirmed by the courier. If the courier has already confirmed the booking, contact support@transdirect.com.au for assistance.

Note

New API integrations start in demo mode. Confirmed bookings will have a demo status and won’t be sent to couriers. Contact support when you’re ready to go live.