Table of Contents

style	none

API Request Body

Header section

Level	Name	Required	Type	Description	Applicable Ports
0	header	PreadviceHeader	No	Pre-advice header information

containers

Name	Type	Description	Required	Notes

1

PreadviceContainer[]

List of container information

Header section

ShipperNameShipperName	Mandatory	string	Shipper name	ALL
Mandatory1	ConsigneeName	Optional	string	Consignee name	NZTRG / NZTIU
Optional1	BookingReference	Mandatory	string	Booking reference	ALL
Mandatory1	MessageAction	Mandatory	string (Create/Cancel)	Message action type	ALL
Mandatory1	PointOfOriginCode	Mandatory	string	Point of origin code	ALL
Mandatory1	LoadPortFacility	Mandatory	string	Load port facility	ALL
Mandatory1	Vessel	Mandatory	GenericPreadviceVessel	Vessel information	ALL
Mandatory2	shipName	Conditional	string	Vessel Name	ALL
Optional2	voyageNumber	Conditional	string	Voyage Number	ALL
Optional2	partnerPortShippingReference	Conditional	string	Port Vessel reference	ALL
Optional1	NotificationEmails	Mandatory	string[]	List of notification email addresses	ALL
Mandatory1	UserName	Mandatory	string	User name	ALL
Mandatory1	UserReference	Mandatory	string	User reference	ALL
Mandatory1	LineOperatorCode	Mandatory	string	Line operator code	ALL
Mandatory1	LoadPortCode	Mandatory	string	Load port code	MandatoryALL
1	PortOfDischarge	Mandatory	string	Port of discharge	ALL
Mandatory1	ForeignPortOfDischarge	Optional	string	Foreign port of discharge	ALL
Optional1	OverseasDestinationFinal	Optional	string	Overseas destination final	OptionalALL

Container section

Level	Name	Required	Repeats	Type	DescriptionRequired	Applicable PortsNotes
0	HazardousCertificateBase64containers	string	Base64 encoded hazardous certficate	Optional	LatestSubmissionStatus	GenericPreadviceContainerSubmission	Latest submission status of the container	Optional	CurrentStatus	string	Current status of the container	Optional	ContainerNumber	string	Container number	Mandatory	AttachedContainerNumbersPreadviceContainer[]	Yes	List of container information
1	ContainerNumber	Mandatory	No	string	Container number	ALL
1	AttachedContainerNumbers	Optional	No	List<string>	List of attached container numbers
Optional1	IsoTypeCode	Mandatory	No	string	ISO type code for the container	ALL
Mandatory1	FlexiTank	Optional	No	bool?	Indicates if the container is a flexi tank	NZTRG / NZTIU
Optional1	IsFull	Mandatory	No	bool?	Indicates if the container is full	ALL
1	CommodityCode	Mandatory	CommodityCodeNo	string	Commodity code
Mandatory1	IsNonOperatingReefer	Optional	No	bool?	Indicates if the container is a non-operating reefer
1	Refrigeration	Optional	RefrigerationNo	GenericPreadviceRefrigeration	Refrigeration details for the containerOptional. Only required if container ISO Type is a Reefer ISO type
2	isFantainer	Optional	No	bool?
2	co2Percent	Optional	requiredTemperature No	float
2	o2Percent	Optional	refrigerationType No	stringfloat
Optional2	humidityPercent	Optional	No	RefrigerationType	string (chilled)	Optional	Vent	GenericPreadviceVent	Vent details for the container	Optional	ventSettingType	Optional	ventSetting	Optional	IMEX	GenericPreadviceIMEX	IMEX details for the container	Mandatory	CargoWeightKg	float	Cargo weight in kilograms	Mandatory	TotalWeightKg	float	Total weight of the container in kilograms	Mandatory	Hazardous	GenericPreadviceHazardous[]	List of hazardous details	Optional	medicalFirstAidGuideSet	Optional	flashPointSet	Optional	hazardousClass	Optional	unNumber	Optional	packagingGroup	Optional	limitedQuantities	marinePollutant	hazardousWeight	quantity	emsCode	hazardContact	name	phone	OverGauge	GenericPreadviceOverDimension[]	List of over-dimension details	ContainerSealsfloat
2	requiredTemperature	Conditional	No	float
2	refrigerationType	Optional	No	string
2	humidityPercent	Optional	No
2	RefrigerationType	Optional	No	string	“Chilled”
2	offPowerTemperature	Optional	No			NZAKL
2	offPowerTimestamp	Optional	No			NZAKL
2	onPowerTargetTime	Optional	No			NZAKL
1	Vent	Optional	No	GenericPreadviceVent	Vent details for the container
2	ventSettingType	Optional	No
2	ventSetting	Optional	No
1	CargoWeightKg	Mandatory	No	float	Cargo weight in kilograms
1	TotalWeightKg	Mandatory	No	float	Total weight of the container in kilograms
1	Hazardous	Optional	No	GenericPreadviceHazardous[]	List of hazardous details
2	hazardousClass	Conditional	Yes
2	unNumber	Conditional	Yes
2	packagingGroup	Conditional	Yes
2	limitedQuantities	Conditional	Yes
2	marinePollutant	Conditional	Yes
2	hazardousWeight	Conditional	Yes
2	quantity	Conditional	Yes
2	emsCode	Conditional	Yes
2	hazardContact	Conditional	Yes
3	name	Conditional	Yes
3	phone	Conditional	Yes
2	medicalFirstAidGuideSet	Conditional	Yes			TRG/TIU
2	flashPointSet	Conditional	Yes			TRG/TIU
1	OverGauge	Optional	No	GenericPreadviceOverDimension[]	List of over-dimension details
2	area	Conditional	Yes	String	TOP, LEFT, RIGHT, FRONT, BACK
2	measureCm	Conditional	Yes
1	ContainerSeals	Mandatory	No	GenericPreadviceContainerSeal[]	List of container seals
2	sealType	Mandatory	sealType Yes	string (required)
2	sealCode	Mandatory	sealCode Yes	string (required)
1	ArrivalCarrierType	Mandatory	ArrivalCarrierTypeNo	GenericPreadviceArrivalCarrierTypes?	Arrival carrier type
1	Carrier	Mandatory	CarrierNo	string	Carrier detailsMandatory
1	HazardousCertificateBase64	Optional	No	string	Base64 encoded hazardous certficate

Test URL:

Code Block
POST https://apitest.portconnect.io/v1/export-preadvices

...

Versions Compared

Old Version 12

New Version 13

Key

API Request Body

Header section

Header section

Container section

Test URL:

Page Comparison

Versions Compared

Old Version 12

New Version 13

Key

API Request Body

Header section

Header section

Container section

Test URL: