Skip to content
Transdirect Developer Centre

Create booking / get quote

POST
/bookings/v4

Creates a new booking request and returns available courier quotes. The booking is created with a new status. The returned quotes object contains pricing from all available couriers for the given route and parcel dimensions.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
object
declared_value

Declared value of goods in AUD. Used for insurance calculations.

number
Example
500
include_warranty

Set to false to opt out of warranty/insurance on this quote. Takes precedence over declared_value — even if a non-zero declared_value is sent, every courier in the response will return fee=0 and insured_amount=0. Defaults to true.

boolean
Example
true
referrer

Referrer identifier

string
Example
api
requesting_site

Requesting site domain

string
Example
www.transdirect.com.au
tailgate_pickup

Whether a tailgate/hydraulic lift is required at pickup

boolean
tailgate_delivery

Whether a tailgate/hydraulic lift is required at delivery

boolean
items
required

Items to be shipped

Array<object>
object
weight
required

Weight in kilograms

number
Example
5
height
required

Height in centimetres

number
Example
20
width
required

Width in centimetres

number
Example
30
length
required

Length in centimetres

number
Example
40
quantity
required

Number of identical items

integer
Example
1
description
required

Description of the item

string
Example
Electronics
sender
required
object
postcode
required

Australian postcode (4 digits)

string
Example
2000
suburb
required

Suburb name (uppercase)

string
Example
SYDNEY
type
required

Address type

string
Allowed values: business residential
Example
business
country
required

ISO 3166-1 alpha-2 country code

string
Example
AU
address

Street address

string
Example
123 George Street
company_name

Company or business name

string
Example
Acme Pty Ltd
email

Contact email address

string format: email
Example
shipping@acme.com.au
name

Contact person name

string
Example
John Smith
phone

Contact phone number

string
Example
0412345678
state

Australian state or territory abbreviation

string
Allowed values: NSW VIC QLD SA WA TAS NT ACT
Example
NSW
receiver
required
object
postcode
required

Australian postcode (4 digits)

string
Example
2000
suburb
required

Suburb name (uppercase)

string
Example
SYDNEY
type
required

Address type

string
Allowed values: business residential
Example
business
country
required

ISO 3166-1 alpha-2 country code

string
Example
AU
address

Street address

string
Example
123 George Street
company_name

Company or business name

string
Example
Acme Pty Ltd
email

Contact email address

string format: email
Example
shipping@acme.com.au
name

Contact person name

string
Example
John Smith
phone

Contact phone number

string
Example
0412345678
state

Australian state or territory abbreviation

string
Allowed values: NSW VIC QLD SA WA TAS NT ACT
Example
NSW
Example
{
  "declared_value": 500,
  "referrer": "api",
  "requesting_site": "www.transdirect.com.au",
  "tailgate_pickup": false,
  "tailgate_delivery": false,
  "items": [
    {
      "weight": 5,
      "height": 20,
      "width": 30,
      "length": 40,
      "quantity": 1,
      "description": "Electronics"
    }
  ],
  "sender": {
    "postcode": "2000",
    "suburb": "SYDNEY",
    "type": "business",
    "country": "AU"
  },
  "receiver": {
    "postcode": "3000",
    "suburb": "MELBOURNE",
    "type": "residential",
    "country": "AU"
  }
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Booking created with available quotes

object
id

Unique booking identifier

integer
Example
12345678
booked_at

ISO 8601 timestamp derived from booking_time (set at booking creation, not confirmation)

string
Example
2026-02-15T10:30:00+11:00
booked_by

Identifier of who booked (e.g. API key name)

string | null
Example
My API Key
created_at

ISO 8601 timestamp of the API response time. Note: this is the current server time at the moment of the response, not the original creation time of the booking.

string
Example
2026-02-15T14:05:32+11:00
updated_at

ISO 8601 timestamp of the API response time (same behaviour as created_at)

string
Example
2026-02-15T14:05:32+11:00
declared_value

Declared value of the goods in AUD

number
Example
500
insured_value

Insured value of the goods in AUD

number
0
description

Goods description

string | null
Example
Electronic components
label

URL to download the shipping label PDF

string
Example
https://www.transdirect.com.au/api/bookings/v4/12345678/label
items

List of items in the booking

Array<object>
object
id

Unique item identifier

integer
Example
1
description

Description of the item

string
Example
Electronics
weight

Weight in kilograms

number
Example
5
length

Length in centimetres

number
Example
40
width

Width in centimetres

number
Example
30
height

Height in centimetres

number
Example
20
quantity

Number of identical items

integer
Example
1
quotes

Available courier quotes keyed by courier identifier (only present when status is new)

object
key
additional properties
object
total

Total price including fees in AUD

number
Example
25.5
price_insurance_ex

Price excluding insurance in AUD

number
Example
22
fee

Transdirect service fee in AUD

number
Example
3.5
insured_amount

Insurance coverage amount in AUD

number
0
service

Service type offered by the courier

string
Example
road
transit_time

Estimated transit time

string
Example
2-3 business days
pickup_dates

Available pickup dates

Array<string>
Example
[
  "2026-02-16",
  "2026-02-17"
]
pickup_time

Pickup time window

string
Example
Before 4:00pm
tiers

Available pricing tiers (for multi-tier couriers)

Array<object>
object
identifier

Tier identifier used when confirming a booking (pass this value as the tier field in the confirm request)

integer
Example
1
description

Human-readable tier description

string
Example
Express Service - Next Business Day
total

Total price for this tier in AUD

number
Example
35
price_insurance_ex

Price excluding insurance for this tier in AUD

number
Example
31.5
fee

Service fee for this tier in AUD

number
Example
3.5
sender
object
id

Address identifier

integer
Example
1
address

Street address

string
Example
123 George Street
company_name

Company or business name

string
Example
Acme Pty Ltd
email

Contact email address

string format: email
Example
shipping@acme.com.au
name

Contact person name

string
Example
John Smith
postcode

Australian postcode (4 digits)

string
Example
2000
phone

Contact phone number

string
Example
0412345678
state

Australian state or territory abbreviation

string
Allowed values: NSW VIC QLD SA WA TAS NT ACT
Example
NSW
suburb

Suburb name (uppercase)

string
Example
SYDNEY
type

Address type

string
Allowed values: business residential
Example
business
country

ISO 3166-1 alpha-2 country code

string
Example
AU
receiver
object
id

Address identifier

integer
Example
1
address

Street address

string
Example
123 George Street
company_name

Company or business name

string
Example
Acme Pty Ltd
email

Contact email address

string format: email
Example
shipping@acme.com.au
name

Contact person name

string
Example
John Smith
postcode

Australian postcode (4 digits)

string
Example
2000
phone

Contact phone number

string
Example
0412345678
state

Australian state or territory abbreviation

string
Allowed values: NSW VIC QLD SA WA TAS NT ACT
Example
NSW
suburb

Suburb name (uppercase)

string
Example
SYDNEY
type

Address type

string
Allowed values: business residential
Example
business
country

ISO 3166-1 alpha-2 country code

string
Example
AU
status

Current booking status. When status is new, the raw lowercase value is returned. For all other statuses the humanized title-case form is returned (e.g. Confirmed, Cancelled, Booked Manually).

string
Example
new
cost

Total booking cost in AUD (only present when status is not new)

number | null
Example
25.5
additional_charges

Total additional charges in AUD (only present when status is not new)

number | null
0
courier

Selected courier identifier (only present when status is not new)

string | null
Example
allied
connote

Consignment note number assigned by the courier (null until confirmed)

string | null
Example
ABC123456
charged_weight

Charged weight in kg (may differ from actual weight due to volumetric calculations)

number
Example
5
scanned_weight

Actual scanned weight in kg as measured by the courier

number
Example
4.8
pickup_window

Two-element array of ISO 8601 timestamps representing the pickup window [from, to]. Empty array if no pickup time has been set.

Array<string>
Example
[
  "2026-02-17T09:00:00+11:00",
  "2026-02-17T17:00:00+11:00"
]
pickup_instructions

Custom pickup instructions for the driver

string | null
Example
Call on arrival
special_instructions

Special delivery instructions (semicolon-separated if multiple)

string
Example
Leave at front door if no one home
tailgate_pickup

Whether a tailgate/hydraulic lift is required at pickup

boolean
tailgate_delivery

Whether a tailgate/hydraulic lift is required at delivery

boolean
notifications

Notification preferences

object
email

Send email notifications

boolean
Example
true
sms

Send SMS notifications

boolean
order

Linked order details (only present if this booking is associated with an order)

object
order_id

Internal order record ID

integer
Example
5001
order_number

External order number (e.g. WooCommerce order number)

string
Example
WC-1234
Example
{
  "id": 12345678,
  "booked_at": null,
  "created_at": "2026-02-15 10:30:00",
  "declared_value": 500,
  "insured_value": 0,
  "status": "new",
  "connote": null,
  "charged_weight": 5,
  "special_instructions": "",
  "tailgate_pickup": false,
  "tailgate_delivery": false,
  "notifications": {
    "email": true,
    "sms": false
  },
  "items": [
    {
      "id": 1,
      "description": "Electronics",
      "weight": 5,
      "length": 40,
      "width": 30,
      "height": 20,
      "quantity": 1
    }
  ],
  "sender": {
    "id": 1,
    "address": "",
    "company_name": "",
    "email": "",
    "name": "",
    "postcode": "2000",
    "phone": "",
    "state": "NSW",
    "suburb": "SYDNEY",
    "type": "business",
    "country": "AU"
  },
  "receiver": {
    "id": 2,
    "address": "",
    "company_name": "",
    "email": "",
    "name": "",
    "postcode": "3000",
    "phone": "",
    "state": "VIC",
    "suburb": "MELBOURNE",
    "type": "residential",
    "country": "AU"
  },
  "quotes": {
    "allied": {
      "total": 25.5,
      "price_insurance_ex": 22,
      "fee": 3.5,
      "insured_amount": 0,
      "service": "road",
      "transit_time": "2-3 business days",
      "pickup_dates": [
        "2026-02-16",
        "2026-02-17"
      ],
      "pickup_time": "Before 4:00pm",
      "tiers": []
    },
    "fastway": {
      "total": 18.75,
      "price_insurance_ex": 15.25,
      "fee": 3.5,
      "insured_amount": 0,
      "service": "parcel",
      "transit_time": "3-5 business days",
      "pickup_dates": [
        "2026-02-16",
        "2026-02-17"
      ],
      "pickup_time": "Before 5:00pm",
      "tiers": []
    }
  }
}

400

Section titled “400 ”

Validation error

object
error

Error code or type

string
Example
validation_error
message

Human-readable error message

string
Example
The sender postcode field is required.

401

Section titled “401 ”

Unauthorized

object
error

Error code or type

string
Example
validation_error
message

Human-readable error message

string
Example
The sender postcode field is required.