Pickup availability

Endpoint

POST /api/quotes/pickup-availability

Returns available pickup dates and time windows for a courier and sender location — useful before confirming a booking.

Authentication

Requires API key (or basic auth on v4).

Request body

Field	Type	Required	Description
`courier`	string	Yes	Courier string_id (e.g. `"allied"`, `"tnt_road_express"`).
`sender`	object	Yes	Sender location used to resolve pickup windows.

Sender object

Field	Type	Required	Description
`suburb`	string	No	Sender suburb.
`state`	string	No	State code (e.g. `NSW`).
`postcode`	string	No	4-digit AU postcode.
`type`	string	No	`"business"` or `"residential"`.

Example

curl -X POST \
  -H "Api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "courier": "allied",
    "sender": {
      "suburb": "SYDNEY",
      "state": "NSW",
      "postcode": "2000",
      "type": "business"
    }
  }' \
  https://www.transdirect.com.au/api/quotes/pickup-availability

Response

{
  "pickupDates": ["2025-08-27", "2025-08-28", "2025-08-29"],
  "pickupTimes": [
    { "from": "14:00", "to": "18:00" }
  ],
  "fromTime": "14:00",
  "toTime": "18:00",
  "earliest": "2025-08-27"
}

Spec-driven carriers may also return granular fields: readyFromTimes, lastAvailableTimes, todayReadyFromTimes, and pickupWindow (operating hours, cutoff, min window minutes).

Field	Type	Description
`pickupDates`	string[]	Selectable dates `YYYY-MM-DD`
`pickupTimes`	object[]	Windows with `from` / `to` (`HH:MM`)
`fromTime` / `toTime`	string \| null	Earliest ready-from / latest available
`earliest`	string \| null	Earliest available date
`error`	string	Present when availability could not be determined

Use a returned date as pickup-date (hyphenated) on confirm.