Create or update a booking custom declaration through the legacy v4 alias

POST

/api/v5/bookings/v4/{id}/custom_declaration

• Production

Legacy “/v4” alias that creates or updates an international booking’s customs declaration. Requires an API key and booking ownership. Only valid for international couriers that require customs.

Parameters

Path Parameters

id

required

string

/^\d+$/

Example

623630

Numeric booking ID.

Request Body

Any of:

object

object

name

Sender/declarant contact name.

string

nullable >= 1 characters

email

Sender/declarant email address.

string

nullable >= 1 characters

phone

Sender/declarant phone number.

string

nullable >= 1 characters

company_name

Sender company/business name.

string

"" nullable

street_number

Street number of the sender address.

string

nullable >= 1 characters

street_name

Street name of the sender address.

string

nullable >= 1 characters

street_type

Street type of the sender address (e.g. St, Rd, Ave).

string

nullable >= 1 characters

booking_party_details_type

Any of:

string

string

Allowed values: 1

number

number

Allowed values: 1

string

string

Allowed values: 0

number

number

Allowed values: 0

string

string

Allowed values: commercial

string

string

Allowed values: private

reason_of_shipment

Reason for export (e.g. sale, gift, sample).

string

nullable >= 1 characters

items

required

Goods line items covered by the declaration (at least one).

Array<object>

>= 1 items

object

item

Name of the goods line item.

string

nullable >= 1 characters

weight

required

Item weight in kg.

number

quantity

required

Number of units of this item.

integer

invoice_value

required

Declared invoice value per line, in AUD.

number

invoice_description

Customs description of the goods.

string

nullable >= 1 characters

manufacturer_country

Country of manufacture (2-letter ISO code or country name).

string

nullable >= 1 characters

postcode

Sender 4-digit AU postcode.

string

"" nullable

suburb

Sender suburb.

string

"" nullable

state

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

string

"" nullable

country

Sender 2-letter ISO country code.

string

"" nullable

object

object

custom_declaration

required

object

name

Sender/declarant contact name.

string

nullable >= 1 characters

email

Sender/declarant email address.

string

nullable >= 1 characters

phone

Sender/declarant phone number.

string

nullable >= 1 characters

company_name

Sender company/business name.

string

"" nullable

street_number

Street number of the sender address.

string

nullable >= 1 characters

street_name

Street name of the sender address.

string

nullable >= 1 characters

street_type

Street type of the sender address (e.g. St, Rd, Ave).

string

nullable >= 1 characters

booking_party_details_type

Any of:

string

string

Allowed values: 1

number

number

Allowed values: 1

string

string

Allowed values: 0

number

number

Allowed values: 0

string

string

Allowed values: commercial

string

string

Allowed values: private

reason_of_shipment

Reason for export (e.g. sale, gift, sample).

string

nullable >= 1 characters

items

required

Goods line items covered by the declaration (at least one).

Array<object>

>= 1 items

object

item

Name of the goods line item.

string

nullable >= 1 characters

weight

required

Item weight in kg.

number

quantity

required

Number of units of this item.

integer

invoice_value

required

Declared invoice value per line, in AUD.

number

invoice_description

Customs description of the goods.

string

nullable >= 1 characters

manufacturer_country

Country of manufacture (2-letter ISO code or country name).

string

nullable >= 1 characters

postcode

Sender 4-digit AU postcode.

string

"" nullable

suburb

Sender suburb.

string

"" nullable

state

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

string

"" nullable

country

Sender 2-letter ISO country code.

string

"" nullable

Responses

200

Custom declaration saved

object

status

required

Always “success” when the declaration was accepted.

string

Allowed values: success

message

required

Confirmation message for the accepted declaration.

string

400

Invalid or unsupported custom declaration

object

errors

required

List of validation error messages for the declaration.

Array<string>

401

Missing or invalid API key

404

Booking not found