Confirm a booking

Endpoint

POST /api/bookings/v4/{id}/confirm

Confirms a booking with a selected courier and pickup date. This triggers the payment process and submits the booking to the chosen courier.

Before confirming, ensure the booking has full sender and receiver details. Use update booking to add any missing information.

Authentication

Note

Requires authentication via API key or basic auth.

Path parameters

Parameter	Type	Required	Description
id	integer	Yes	The unique booking ID.

Request body

Field	Type	Required	Description
courier	string	Yes	Courier identifier from the quotes response (e.g. "allied", "couriers_please", "tnt").
pickup-date	string	Yes	Desired pickup date in YYYY-MM-DD format. Must be one of the dates from the courier’s pickup_dates array.
pickup-time	string	No	Pickup time window in HH:MM-HH:MM format (e.g. "09:00-17:00"). Optional — pass the value from the courier’s pickup_time field if provided.
tier	integer	No	Frequent rate tier identifier. Only applicable for couriers that offer frequent rates (e.g. Couriers Please, Aramex).

Caution

The confirm request uses hyphenated field names (pickup-date, pickup-time), unlike most other endpoints which use underscores. The response side (pickup_dates, pickup_time on quote objects) still uses underscores.

Example request

curl -X POST \
  -H "Api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "courier": "allied",
    "pickup-date": "2025-08-18"
  }' \
  https://www.transdirect.com.au/api/bookings/v4/12345678/confirm

With frequent rate tier

curl -X POST \
  -H "Api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "courier": "couriers_please",
    "pickup-date": "2025-08-18",
    "tier": 1
  }' \
  https://www.transdirect.com.au/api/bookings/v4/12345678/confirm

Response

A successful confirmation returns a 204 No Content status with no response body.

After confirmation, retrieve the booking to check its updated status and obtain the connote (consignment note number) once the courier has confirmed.

Demo mode

Note

If your account is in demo mode, confirmed bookings receive a demo status instead of being sent to a courier. No charges are incurred and no actual pickup is scheduled. Demo labels are available for testing.

Contact support@transdirect.com.au when you’re ready to enable live bookings.

Choosing a courier

When selecting a courier, use the identifier returned in the quotes object from the create booking response. Common courier identifiers include:

Identifier	Courier
allied	Allied Express
couriers_please	Couriers Please
tnt	TNT / FedEx
aramex	Aramex
hunter	Hunter Express
northline	Northline
toll	Toll

Tip

The pickup-date must be one of the dates returned in the courier’s pickup_dates array. Passing an unavailable date will result in an error.

Error responses

Status code	Description
400	Bad request — missing required fields or invalid courier/date.
401	Unauthorised — invalid or missing credentials.
404	Not found — no booking exists with the given ID, or it belongs to another member.
422	Unprocessable entity — the booking is missing required details (e.g. sender/receiver address) or has already been confirmed.

Next steps

• Get the booking to check the updated status and connote
• Get the shipping label once the booking is confirmed
• Track the booking after pickup