Get pickup availability for a courier and sender address

POST

/api/v5/quotes/pickup-availability

Production

Returns the available pickup dates and time windows for a given courier and sender address. Requires an API key.

Authorizations

ApiKeyAuth

Request Body

object

courier

required

Courier string_id to check pickup availability for (e.g. “allied”, “tnt_road_express”).

string

>= 1 characters <= 120 characters

sender

required

Sender pickup location whose pickup windows are being queried.

object

suburb

Sender suburb used to resolve the pickup location and its operating hours.

string

"" <= 120 characters

state

Sender state code (e.g. NSW, VIC, QLD).

string

"" <= 20 characters

postcode

Sender 4-digit AU postcode.

string

"" <= 20 characters

type

Sender address type, “business” or “residential”.

string

"" <= 40 characters

Responses

200

Pickup availability

object

pickupDates

required

Selectable pickup dates as YYYY-MM-DD strings.

Array<string>

pickupTimes

required

Selectable pickup time windows for the chosen date.

Array<object>

object

from

required

Window start time (HH:MM, 24-hour).

string

required

Window end time (HH:MM, 24-hour).

string

fromTime

required

Earliest ready-from time for the pickup (HH:MM), or null if unavailable.

string

nullable

toTime

required

Latest available pickup time (HH:MM), or null if unavailable.

string

nullable

earliest

required

Earliest available pickup date (YYYY-MM-DD), or null if none.

string

nullable

readyFromTimes

Allowed “ready from” times (HH:MM) for spec-driven carriers.

Array<string>

lastAvailableTimes

Allowed “last available” cut-off times (HH:MM) for spec-driven carriers.

Array<string>

todayReadyFromTimes

Ready-from times (HH:MM) still selectable for a same-day pickup.

Array<string>

pickupWindow

Granular pickup-window contract for spec-driven carriers.

object

operatingStart

required

Depot operating start time (HH:MM).

string

operatingEnd

required

Depot operating end time (HH:MM).

string

displayStart

required

Suggested window start to display to the user (HH:MM).

string

displayEnd

required

Suggested window end to display to the user (HH:MM).

string

sameDayCutoff

required

Latest booking time (HH:MM) to still qualify for same-day pickup.

string

minWindowMinutes

required

Minimum allowed pickup window length in minutes.

number

incrementMinutes

required

Time-selection increment in minutes.

number

fixed

required

True when the carrier enforces a fixed, non-adjustable pickup window.

boolean

error

Error message when pickup availability could not be determined.

string

400

Validation error

Any of:

object

error

required

string

message

string

member_id

Any of:

string
number

string

limit

number

window_seconds

number

upgrade

object

signup_endpoint

string

signup_method

string

quote_endpoint

string

api_key_header

string

docs

string

401

Invalid api key

Any of:

object

error

required

string

message

string

member_id

Any of:

string
number

string

limit

number

window_seconds

number

upgrade

object

signup_endpoint

string

signup_method

string

quote_endpoint

string

api_key_header

string

docs

string