Submit Export Pre-advice

Submit Export Pre-advice

 

API Request Body

 

API key details

All calls to the PortConnect API must include either the primary or secondary key in the Ocp-Apim-Subscription-Key field.

Header section

Level

Name

Required

Repeats

Type

Description

Applicable Ports

Level

Name

Required

Repeats

Type

Description

Applicable Ports

0

header

PreadviceHeader

No

-

Pre-advice header information

 

1

shipperName

Mandatory

No

string

Shipper name

ALL

1

consigneeName

Optional

No

string

Consignee name

NZTRG / NZTIU

1

bookingReference

Mandatory

No

string

Booking reference

ALL

1

messageAction

Mandatory

No

string (Create/Cancel)

For new Pre-Advice or updates to previously submitted containers enter “Create”. To Cancel a previously submitted incorrect container number enter "Cancel".

ALL

1

pointOfOriginCode

Mandatory

No

string

Point of origin code

ALL

1

loadPortFacility

Mandatory

No

string

Load port facility

ALL

1

vessel

Mandatory

No

 

Vessel information

ALL

2

shipName

Conditional

No

string

Vessel Name

ALL

2

voyageNumber

Conditional

No

string

Voyage Number

ALL

2

partnerPortShippingReference

Conditional

No

string

Port Vessel reference

ALL

1

lineOperatorCode

Mandatory

No

string

Line operator code

ALL

1

loadPortCode

Mandatory

No

string

Load port code

ALL

1

portOfDischarge

Optional

No

string

Port of discharge.

If the segment is omitted then PortConnect will look up and populate the value from the booking.

ALL

1

foreignPortOfDischarge

Optional

No

string

Foreign port of discharge

ALL

1

overseasDestinationFinal

Optional

No

string

Overseas destination final

ALL

1

notificationEmails

Mandatory

No

string[]

List of notification email addresses

ALL

1

userName

Mandatory

No

string

User name

ALL

1

userReference

Mandatory

No

string

User reference

ALL

Container section

Level

Name

Required

Repeats

Type

Description

Applicable Ports

Level

Name

Required

Repeats

Type

Description

Applicable Ports

0

containers

Mandatory

Yes

List of container information

 

ALL

1

containerNumber

Mandatory

No

string

Container number

ALL

1

attachedContainerNumbers

Optional

No

string[]

List of attached container numbers.

Only required if the container has attached containers.

NZTRG / NZTIU

1

isoTypeCode

Mandatory

No

string

ISO type code for the container

ALL

1

flexiTank

Optional

No

bool

Indicates if the container is a flexi tank

NZTRG / NZTIU

1

isFull

Mandatory

No

bool

Indicates if the container is full

ALL

1

commodityCode

Mandatory

No

string

Commodity code

ALL

1

isNonOperatingReefer

Optional

No

bool

Indicates if the container is a non-operating reefer.

Only required if container ISO Type is a Reefer ISO type.

ALL

1

refrigeration

Optional

No

 

Refrigeration details for the container.

Only required if container ISO Type is a Reefer ISO type.

ALL

2

isFantainer

Optional

No

bool

 

ALL

2

requiredTemperature

Conditional

No

float

 

ALL

2

refrigerationType

Optional

No

string

“Chilled”

ALL

2

activeRefrigerationRequired

Conditional

 

 

 

NZTRG

2

offPowerTemperature

Optional

No

float

 

NZAKL

2

offPowerTimestamp

Optional

No

DateTime

 

NZAKL

2

onPowerTargetTime

Optional

No

DateTime

 

NZAKL

2

humidityPercent

Optional

No

float

 

ALL

2

co2Percent

Optional

No

float

 

ALL

2

o2Percent

Optional

No

float

 

ALL

1

vent

Optional

No

 

Vent details for the container

ALL

2

ventSettingType

Optional

No

string

 

ALL

2

ventSetting

Optional

No

float

 

ALL

1

cargoWeightKg

Mandatory

No

float

Cargo weight in kilograms

ALL

1

totalWeightKg

Mandatory

No

float

Total weight of the container in kilograms

ALL

© PortConnect 2026