Skip to content
Transdirect Developer Centre

Get courier quotes for a shipment

POST
/api/v5/bookings

With an api-key, boxes the items, fans out to every courier the calling member has enabled, applies member discounts/rules, and inserts a bookings row with status=new. Without an api-key, runs publicly-visible couriers only and is limited to 10 requests/hour per IP.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
object
sender
required
object
address
nullable
address2
nullable
company_name
nullable
email
nullable
name
nullable
phone
nullable
postcode
nullable
suburb
nullable
state
nullable
country
nullable
type
nullable
residential
boolean
nullable
tailgate
boolean
nullable
receiver
required
object
address
nullable
address2
nullable
company_name
nullable
email
nullable
name
nullable
phone
nullable
postcode
nullable
suburb
nullable
state
nullable
country
nullable
type
nullable
residential
boolean
nullable
tailgate
boolean
nullable
items
Array<object>
nullable
object
length
nullable
width
nullable
height
nullable
weight
nullable
quantity
nullable
description
nullable
sku
nullable
declared_value
nullable
insured_value
nullable
include_warranty
boolean
nullable
whole_weight
boolean
nullable
cost
nullable
description
nullable
instructions
object
delivery
nullable
pickup
nullable
referrer
nullable
requesting_site
Any of:
string
timeout
nullable
tailgate_pickup
boolean
nullable
tailgate_delivery
boolean
nullable
pickup_date
string
/^\d{4}-\d{2}-\d{2}$/
options
object
tailgate_pickup
boolean
nullable
tailgate_delivery
boolean
nullable
insurance_value
number
nullable
authority_to_leave
boolean
nullable
disable_cache
boolean
nullable
multipickup
object
address_id
integer
tier
integer
>= 1 <= 2
Examples

Sydney to Sydney cartons

{
  "sender": {
    "address": "1 Market Street",
    "company_name": "Sender Pty Ltd",
    "email": "sender@example.com",
    "name": "Sender Contact",
    "phone": "0290000000",
    "postcode": "2000",
    "suburb": "Sydney",
    "state": "NSW",
    "country": "AU",
    "type": "business",
    "tailgate": false
  },
  "receiver": {
    "address": "25 George Street",
    "company_name": "Receiver Pty Ltd",
    "email": "receiver@example.com",
    "name": "Receiver Contact",
    "phone": "0291111111",
    "postcode": "2000",
    "suburb": "Sydney",
    "state": "NSW",
    "country": "AU",
    "type": "business",
    "tailgate": false
  },
  "items": [
    {
      "description": "Carton",
      "length": 30,
      "width": 20,
      "height": 15,
      "weight": 2,
      "quantity": 1,
      "sku": "DEMO-CARTON-1"
    },
    {
      "description": "Carton",
      "length": 40,
      "width": 30,
      "height": 20,
      "weight": 5,
      "quantity": 1,
      "sku": "DEMO-CARTON-2"
    }
  ],
  "declared_value": 250,
  "insured_value": 0,
  "description": "Demo Sydney carton quote",
  "referrer": "api-demo",
  "requesting_site": "api-worker-demo",
  "tailgate_pickup": false,
  "tailgate_delivery": false,
  "options": {
    "authority_to_leave": false,
    "disable_cache": false
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Quote list (sorted by total ascending)

object
id
required
number
nullable
booking_access_token
string
booked_at
required
string
booked_by
required
string
nullable
created_at
required
string
declared_value
required
number
insured_value
required
number
description
required
string
nullable
items
required
Array<object>
object
id
required
number
description
required
string
weight
required
number
length
required
number
width
required
number
height
required
number
quantity
required
number
sku
nullable
label
required
string
notifications
required
object
email
required
boolean
sms
required
boolean
quotes
required

Map of carrier/service key to the quote returned for it.

object
key
additional properties
object
total
required
number
price_insurance_ex
required
number
fee
required
number
applied_gst
required
number
insured_amount
required
number
service
required
string
transit_time
required
string
transit
required
object
text
required
string
type
required
string
Allowed values: business_days hours same_day overnight date_time unknown
min_days
number
max_days
number
min_hours
number
max_hours
number
estimated_delivery_at
string
pickup_dates
required
Array<string>
pickup_time
required
Any of:
string
pickupAvailability
required
object
dates
required
Array<string>
dateLabels
Array<string>
times
required
Array<object>
object
from
required
string
to
required
string
earliest
object
day
required
string
date
required
string
time
required
object
from
required
string
to
required
string
times
Array<object>
object
from
required
string
to
required
string
readyFromTimes
Array<string>
lastAvailableTimes
Array<string>
pickupWindow
object
operatingStart
required
string
operatingEnd
required
string
displayStart
required
string
displayEnd
required
string
sameDayCutoff
required
string
minWindowMinutes
required
number
incrementMinutes
required
number
fixed
required
boolean
currentTimeInPickupTz
string
senderUtcOffsetMinutes

The sender timezone’s UTC offset in minutes when the quote was built.

number
sameDayCutoffAtMs

Epoch ms at which today stops being an offered pickup date. Absent when there is none to expire.

number
readyFromTimes
Array<string>
lastAvailableTimes
Array<string>
todayReadyFromTimes
Array<string>
fixedPickupTime
boolean
pickup_cutoff
string
nullable
pickup_window

Pickup-window rules driving the ready-from / last-available time picker.

object
operatingStart
required
string
operatingEnd
required
string
displayStart
required
string
displayEnd
required
string
sameDayCutoff
required
string
minWindowMinutes
required
number
incrementMinutes
required
number
fixed
required
boolean
currentTimeInPickupTz
string
senderUtcOffsetMinutes

The sender timezone’s UTC offset in minutes when the quote was built.

number
sameDayCutoffAtMs

Epoch ms at which today stops being an offered pickup date. Absent when there is none to expire.

number
pickup_ready_from_times

Selectable “ready from” pickup times (HH:mm), capped before the collection cutoff. The FULL business-day list — same-day narrowing is applied client-side per selected date via pickup_same_day_ready_from.

Array<string>
pickup_last_available_times

Selectable “last available” pickup times (HH:mm) at the uncapped business close.

Array<string>
pickup_same_day_ready_from

Earliest “ready from” time (HH:mm) selectable when the pickup date is today; the picker floors same-day pickups to this. Absent (or null) when today is not an offered pickup date.

string
nullable
rate_card_code
required

Internal rate-card code used to price this quote.

string
free_shipping
boolean
courier
string
surcharge
number
tiers

Available insurance/service tiers for this quote.

Array<object>
object
identifier
required
number
description
required
string
total
required
number
price_insurance_ex
required
number
fee
required
number
applied_gst
required
number
insured_amount
required
number
quote_errors
required

Per-carrier errors for carriers that could not be quoted.

Array<object>
object
courier
required
string
code
required
string
serviceability
string
message
string
""
retryable
boolean
receiver
required

Delivery (destination) address on the quote.

object
id
required
number
address
required
string
address2
string
company_name
required
string
email
required
string
nullable
name
required
string
postcode
required
string
phone
required
string
state
required
string
suburb
required
string
type
required
string
Allowed values: business residential
country
required
string
sender
required

Pickup (origin) address on the quote.

object
id
required
number
address
required
string
address2
string
company_name
required
string
email
required
string
nullable
name
required
string
postcode
required
string
phone
required
string
state
required
string
suburb
required
string
type
required
string
Allowed values: business residential
country
required
string
pickup_window
required

Selected pickup window as a pair of time strings [from, to].

Array<string>
connote
required

Carrier consignment (connote) number, once lodged, or null.

string
nullable
charged_weight
required

Weight the carrier charged on, in kilograms (kg).

number
scanned_weight
required

Weight scanned by the carrier, in kilograms (kg).

number
special_instructions
required

Special handling instructions for the consignment.

string
status
required

Booking status, e.g. “new”/“pending_payment” (quote) or a paid/confirmed state.

string
cost
Any of:
string
updated_at
required

Timestamp the quote/booking was last updated, as an ISO 8601 datetime.

string
pickup_instructions
required

Instructions for the driver at pickup, or null.

string
nullable
tailgate_pickup
required

Whether a tailgate vehicle was requested at pickup.

boolean
tailgate_delivery
required

Whether a tailgate vehicle was requested at delivery.

boolean
pendingVisualChecks
Array<object>
object
bookingCheckId
required
integer
checkId
required
integer
checkName
required
string
checkDescription
string
""
formJson
string
nullable
timing
string
nullable
status
required
string
createdAt
string
nullable
blocksStep
boolean
service_notices

Informational, non-bookable carrier notices (e.g. a carrier whose quote API is temporarily down), shown as their own rows in the quote list.

Array<object>
object
courier
required
string
kind
required
string
message
required
string
meta
object
api_version
required
string
Allowed values: v5
cache
required
object
status
required
string
Allowed values: HIT MISS BYPASS
original_duration_ms
number
served_duration_ms
number
timing
required
object
duration_ms
number
boxing_duration_ms
number
carrier_timings_ms
object
key
additional properties
number
anonymous
boolean
quote_count
number
warnings
Array<object>
object
code
required
string
path
required
string
message
required
string
input
object
postcode
string
suburb
string
state
string
country
string
priority
number
nullable
inferred
object
postcode
string
suburb
string
state
string
country
string
priority
number
nullable
suggestions
Array<object>
object
postcode
string
suburb
string
state
string
country
string
priority
number
nullable
persistence
object
booking_write_mode
required
string
Allowed values: disabled enabled
status
required
string
Allowed values: disabled written failed
via
string
Allowed values: hyperdrive remote-v5 php
book_origin
string
parity
object
mode
required
string
Allowed values: disabled enabled
status
required
string
Allowed values: skipped queued
admin
object
calculations
object
key
additional properties
object
courier
required
string
pipeline
required
string
Allowed values: default family
error

Arbitrary JSON value (string, number, boolean, null, array, or object).

nullable
gstAlreadyIncluded
boolean
fuelLevy
required
Any of:
object
kind
required
string
Allowed values: static
pct
required
number
marginMultiplier
required
number
memberDiscount
number
courierRaw
Any of:
string
carbonOffsetBase
number
trace
Array<object>
object
kind
required
string
atMs
required
number
courier
string
label
required
string
cache

Arbitrary JSON value (string, number, boolean, null, array, or object).

nullable
payload

Arbitrary JSON value (string, number, boolean, null, array, or object).

nullable
steps
required
Array<object>
object
key
required
string
label
required
string
before
number
after
required
number
delta
number
rounding
object
preRound
required
number
postRound
required
number
precision
required
integer
upstreamErrors
object
key
additional properties
object
kind
required
string
Allowed values: upstream_status
status
required
number
reason
required
string
body
string

400

Section titled “400 ”

Validation error

Any of:
object
error
required
string
message
string
member_id
Any of:
string
limit
number
window_seconds
number
upgrade
object
signup_endpoint
string
signup_method
string
quote_endpoint
string
api_key_header
string
docs
string

401

Section titled “401 ”

Invalid api key

Any of:
object
error
required
string
message
string
member_id
Any of:
string
limit
number
window_seconds
number
upgrade
object
signup_endpoint
string
signup_method
string
quote_endpoint
string
api_key_header
string
docs
string

404

Section titled “404 ”

Member not found

Any of:
object
error
required
string
message
string
member_id
Any of:
string
limit
number
window_seconds
number
upgrade
object
signup_endpoint
string
signup_method
string
quote_endpoint
string
api_key_header
string
docs
string

429

Section titled “429 ”

Rate-limited

Any of:
object
error
required
string
message
string
member_id
Any of:
string
limit
number
window_seconds
number
upgrade
object
signup_endpoint
string
signup_method
string
quote_endpoint
string
api_key_header
string
docs
string

503

Section titled “503 ”

Quote reference data unavailable

Any of:
object
error
required
string
message
string
member_id
Any of:
string
limit
number
window_seconds
number
upgrade
object
signup_endpoint
string
signup_method
string
quote_endpoint
string
api_key_header
string
docs
string