Excerpt

hidden	true

POST /v1/export-preadvices

...

API Request Body

Header section

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

ShipperName

shipperName	Mandatory	No	string	Shipper name	ALL
1

ConsigneeName

consigneeName	Optional	No	string	Consignee name	NZTRG / NZTIU
1

BookingReference

bookingReference	Mandatory	No	string	Booking reference	ALL
1

MessageAction

1

PointOfOriginCode

Mandatory

messageAction

Mandatory

No

string (Create/Cancel)

Message action type

ALL

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

loadPortFacility	Mandatory	No	string	Load port facility	ALL
1

Vessel

vessel

Mandatory

GenericPreadviceVessel

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

NotificationEmails

lineOperatorCode

Mandatory

No

string

[]List of notification email addresses

	Line operator code	ALL
1

UserName

loadPortCode

Mandatory

No

string

User name

Load port code	ALL
1

UserReference

portOfDischarge

Mandatory

Optional

string

User reference

No

string

Port of discharge.

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

ALL

1

LineOperatorCode

foreignPortOfDischarge

Optional

Mandatory

No

string

Line operator code

Foreign port of discharge	ALL
1

LoadPortCode

overseasDestinationFinal

Optional

Mandatory

No

string

Load port code

Overseas destination final	ALL
1

PortOfDischarge

notificationEmails

Mandatory

No

string[]

Port

List of

discharge

notification email addresses	ALL
1

ForeignPortOfDischarge

userName

Optional

Mandatory

No

string

Foreign port of discharge

User name	ALL
1	userReference

OverseasDestinationFinal

Mandatory

Optional

No

string

Overseas destination final

User reference

ALL

Container section

PreadviceContainer[]ContainerNumberAttachedContainerNumbersList<string>IsoTypeCodeFlexiTank?IsFull?CommodityCodeIsNonOperatingReefer?GenericPreadviceRefrigeration?co2PercentOptionalo2PercentfloathumidityPercentOptionalNorequiredTemperatureConditionalrefrigerationTypestringhumidityPercentRefrigerationTypestring“Chilled”offPowerTemperatureNZAKLoffPowerTimestampNZAKLVentCargoWeightKgTotalWeightKgHazardouslimitedQuantitiesemsCode2flashPointSetareameasureCm1ContainerSealsMandatoryNoMandatorysealCodeMandatory

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	1	Refrigeration	. 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
float	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	2	onPowerTargetTime	Optional	No	NZAKL		ALL
1	vent	Optional	No	GenericPreadviceVent		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
1	hazardous	Optional	No	GenericPreadviceHazardous[]		List of hazardous details	ALL
2	hazardousClass	Conditional	Yes	float	e.g. 1.1f, 1.1g etc.	ALL
2	unNumber	Conditional	Yes	2	packagingGroup	Conditional	Yes	2	string	e.g. 0005, 0121 etc	ALL
2	quantity	Conditional	Yes	string	Number and Type of packages e.g. 2	marinePollutant	Conditional	Yes	Pallets or 1 box	ALL
2	hazardousWeight	Conditional	Yes	2	quantity	Conditional	Yes	2	float	Weight of the hazardous cargo. Must be in KGs.	ALL
2	packagingGroup	Conditional	Yes	2	hazardContact	Conditional	Yes	3	name	Conditional	Yes	3	phone	string	Values: 0, 1, 2 or 3. If no packaging group then select 0.	ALL
2	limitedQuantities	Conditional	Yes	bool	medicalFirstAidGuideSet	Conditional	Yes	TRG/TIU		ALL
2	marinePollutant	Conditional	Yes	TRG/TIU	1	OverGauge	Optional	No	GenericPreadviceOverDimension[]	List of over-dimension details	2	bool		ALL
2	emsCode	Conditional	Yes	String	TOP, LEFT, RIGHT, FRONT, BACK	2	string	Fire Rating and Spill Rating. F-A to F-Z and S-A to S-Z. No space between values.	ALL
2	hazardContact	Conditional	Yes			ALL
3	name	Conditional	Yes	GenericPreadviceContainerSeal[]	List of container seals	2	sealType	string		ALL
3	phone	Conditional	Yes	string		ALL
2	medicalFirstAidGuideSet	Conditional	Yes	string	1	ArrivalCarrierType	Mandatory	No	GenericPreadviceArrivalCarrierTypes?	Arrival carrier type	1	Carrier	Mandatory	No	string	Carrier details	1	HazardousCertificateBase64	Optional	No	string	Base64 encoded hazardous certficate

Test URL:

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

Example Messages

All fields example:

...

language	json

...

	NZTRG / NZTIU
2	flashPointSet	Conditional	Yes	float	Range: -999-999	NZTRG / NZTIU
1	overGauge	Optional	No	GenericPreadviceOverDimension[]	List of over-dimension details. Only required if container ISO Type is an Out of Gauge ISO type.	ALL
2	area	Conditional	Yes	String	TOP, LEFT, RIGHT, FRONT, BACK	ALL
2	measureCm	Conditional	Yes	float		ALL
1	containerSeals	Mandatory	No	GenericPreadviceContainerSeal[]	List of container seals	ALL
2	sealType	Mandatory	Yes	string		ALL
2	sealCode	Mandatory	Yes	string		ALL
1	arrivalCarrierType	Mandatory	No	string	Value list: Truck, Rail. This is the mode of arrival at the receival facility which can be an inland port or directly to the Seaport	ALL
1	carrier	Mandatory	No	string	See the following list for all Arrival Carrier Codes.	ALL
1	hazardousCertificateBase64	Optional	No	string	Base64 encoded hazardous certificate. Only required if the container is hazardous. The base64 content must sit within a CDATA segment e.g. “hazardousCertificateBase64”: <![CDATA[Base64ContentHere]]>	NZTRG / NZTIU

Test URL:

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

Example Messages

All fields example:

Code Block

language	json

    {
	"header": {
		"shipperName": "FNT",
		"loadPortCode": "NZAKL",
		"bookingReference": "SHIPPINGLINEBOOKINGREF",
		"pointOfOriginCode": "AKC",
		"vessel": {
			"shipName": "CMA CGM SEMARANG",
			"voyageNumber": "2416",
			"partnerPortShippingReference": "CMC9741"
		},
		"loadPortFacility": "Auckland",
		"lineOperatorCode": "ARMC",
		"portOfDischarge": "AUMEL",
		"foreignPortOfDischarge": "AUMEL",
		"userReference": "UNIQUEREFERENCE",
		"notificationEmails": ["info@portconnect.co.nz"]
	},
	"containers": [{
		"containerNumber": "OOGC1234651HAZD1234510"	
		"attachedContainerNumbers": [],
		"isoTypeCode": "22P14500",
		"isFull": true,
		"commodityCode": "4774",
		"isNonOperatingReefer": false,
		"cargoWeightKg": 16000.0,
		"totalWeightKg": 18000.0,
		"overGaugehazardous": [{
			"areamedicalFirstAidGuideSet": true,
			"TopflashPointSet": true,
			"measureCmhazardousClass": 10.0
		}"2.1",
		{	"unNumber": "1950",
			"areapackagingGroup": "Left1",
			"measureCmlimitedQuantities": 20.0
		},
		{true,
			"areamarinePollutant": "Right"true,
			"measureCmhazardousWeight": 30200.0
		},
		{
			"areaquantity": "Front10",
			"measureCmemsCode": 40.0
		}"F-BS-C",
			"hazardContact": {
				"areaname": "BackJohn Smith",
				"measureCmphone": 50.0"021 588 998"
			}
		}],
		{
			"containerSealsmedicalFirstAidGuideSet": [{true,
			"sealTypeflashPointSet": "Shipper"true,
			"sealCodehazardousClass": "TBC2.2",
		}],
		"arrivalCarrierTypeunNumber": "Truck1950",
			"carrierpackagingGroup": "AACAR 0"
	},
	{
		"containerNumberlimitedQuantities": "REEF1234510"		
false,
			"isoTypeCodemarinePollutant": "2230"false,
			"isFullhazardousWeight": true1000.0,
			"commodityCodequantity": "219975",
			"IsNonOperatingReeferemsCode": false"F-YS-Y",
			"refrigerationhazardContact": {
				"isFantainername": false"John Smith",
				"co2Percentphone": 50.0, "021 588 998"
			"o2Percent": 40.0}
		}],
			"maximumOffPowerHourscontainerSeals": 24.0,[{
			"offPowerTemperaturesealType": -21.0"Shipper",
			"offPowerTimestampsealCode": "2024-09-11T10:00:00+12:00"4455"
		}],
			"onPowerTargetTime": "2024-09-11T10:00:00+12:00"arrivalCarrierType": "Rail",
			"requiredTemperaturecarrier": -21.0"CONLIN"
	},
	{
		"humidityPercentcontainerNumber": 20.0,"OOGC1234651"	
			"refrigerationTypeattachedContainerNumbers": ["ChilledADCU1234510"],
		}"isoTypeCode": "22P1",
		"ventisFull": {true,
			"ventSettingTypecommodityCode": "PercentageOpen47",
			"ventSettingisNonOperatingReefer": 30.0
		} false,
		"cargoWeightKg": 16000.0,
		"totalWeightKg": 18000.0,
		"containerSealsoverGauge": [{
			"sealTypearea": "ShipperTop",
			"sealCodemeasureCm": "1223"10.0
		},
		{
			"sealTypearea": "ShipperLeft",
			"sealCodemeasureCm": "5665"20.0
		}],
		{
			"arrivalCarrierTypearea": "TruckRight",
			"carriermeasureCm": "WALTER"
	}]
}

Hazard example

Code Block

language	json

{
	"header": 30.0
		},
		{
			"shipperNamearea": "FNTFront",
			"loadPortCodemeasureCm": "NZAKL"40.0
		},
		"bookingReference": "SHIPPINGLINEBOOKINGREF",
{
			"pointOfOriginCodearea": "AKCBack",
			"vesselmeasureCm": {50.0
		}],
		"shipNamecontainerSeals": "CMA CGM SEMARANG",
[{
			"voyageNumbersealType": "2416Shipper",
			"partnerPortShippingReferencesealCode": "CMC9741TBC"
		}],
		"loadPortFacilityarrivalCarrierType": "AucklandTruck",
		"lineOperatorCodecarrier": "ARMCAACAR "
	},
	{
		"portOfDischargecontainerNumber": "AUMELREEF1234510",		
		"foreignPortOfDischargeisoTypeCode": "AUMEL2230",
		"userReferenceisFull": "UNIQUEREFERENCE"true,
		"notificationEmailscommodityCode": ["chris.boxall@portconnect.co.nz"]
	},
	"containers": [{
"2199",
		"containerNumberIsNonOperatingReefer": "REEF1234510"false,
		"isoTypeCoderefrigeration": "2230",{
			"isFullisFantainer": truefalse,
			"commodityCodeco2Percent": "2199"50.0,
			"cargoWeightKgo2Percent": 1600040.0,
			"totalWeightKgmaximumOffPowerHours": 1800024.0,
			"hazardousoffPowerTemperature": [{-21.0,
			"medicalFirstAidGuideSetoffPowerTimestamp": true"2024-09-11T10:00:00+12:00",
			"flashPointSetonPowerTargetTime": true"2024-09-11T10:00:00+12:00",
			"hazardousClassrequiredTemperature": "2.1"-21.0,
			"unNumberhumidityPercent": "1950"20.0,
			"packagingGrouprefrigerationType": "1Chilled"
		},
			"limitedQuantitiesvent": true,{
			"marinePollutantventSettingType": true"PercentageOpen",
			"hazardousWeightventSetting": 20030.0
		},
			"quantitycargoWeightKg": "10"16000.0,
			"emsCodetotalWeightKg": "F-BS-C"18000.0,
			"hazardContactcontainerSeals": [{
				"namesealType": "John SmithShipper",
				"phonesealCode": "021 588 9981223"
			}
		},
		{
			"medicalFirstAidGuideSetsealType": true"Shipper",
			"flashPointSetsealCode": true"5665"
		}],
			"hazardousClassarrivalCarrierType": "2.2Truck",
			"unNumbercarrier": "1950",
			"packagingGroup": "0",
			"limitedQuantities": falseWALTER"
	}]
}

Hazard example

Code Block

language	json

{
	"header": {
		"shipperName": "FNT",
			"marinePollutantloadPortCode": false,
			"hazardousWeight": 1000.0"NZAKL",
			"quantitybookingReference": "75SHIPPINGLINEBOOKINGREF",
			"emsCodepointOfOriginCode": "F-YS-YAKC",
			"hazardContactvessel": {
				"nameshipName": "JohnCMA CGM SmithSEMARANG",
				"phonevoyageNumber": "021 588 9982416",
			}"partnerPortShippingReference": "CMC9741"
		}],
		"containerSealsloadPortFacility": [{"Auckland",
			"sealTypelineOperatorCode": "ShipperARMC",
			"sealCodeportOfDischarge": "1223AUMEL",
		}"foreignPortOfDischarge": "AUMEL",
		{
			"sealTypeuserReference": "ShipperUNIQUEREFERENCE",
			"sealCodenotificationEmails": ["info@portconnect.co.nz"]
	},
	"5665containers"
		}],: [{
		"arrivalCarrierTypecontainerNumber": "TruckREEF1234510",
		"carrierisoTypeCode": "WALTER2230",
	}]
}

Reefer example

Code Block

language	json

{
	"headerisFull": {true,
		"shipperNamecommodityCode": "FNT2199",
		"loadPortCodecargoWeightKg": "NZAKL"16000.0,
		"bookingReferencetotalWeightKg": "SHIPPINGLINEBOOKINGREF"18000.0,
		"pointOfOriginCodehazardous": "AKC",
[{
			"vesselmedicalFirstAidGuideSet": {true,
			"shipNameflashPointSet": "CMA CGM SEMARANG"true,
			"voyageNumberhazardousClass": "24162.1",
			"partnerPortShippingReferenceunNumber": "CMC97411950",
		},
		"loadPortFacilitypackagingGroup": "Auckland1",
			"lineOperatorCodelimitedQuantities": "ARMC"true,
			"portOfDischargemarinePollutant": "AUMEL"true,
			"foreignPortOfDischargehazardousWeight": "AUMEL"200.0,
			"userReferencequantity": "UNIQUEREFERENCE10",
			"notificationEmailsemsCode": ["chris.boxall@portconnect.co.nz"]
	},
	"containers"F-BS-C",
			"hazardContact": [{
				"containerNumbername": "REEF1234510John Smith",
				"isoTypeCodephone": "2230"021 588 998"
			}
		},
		{
			"isFullmedicalFirstAidGuideSet": true,
			"commodityCodeflashPointSet": "2199"true,
			"IsNonOperatingReeferhazardousClass": false,
		"refrigeration": {
"2.2",
			"isFantainerunNumber": false"1950",
			"co2PercentpackagingGroup": 50."0",
			"o2PercentlimitedQuantities": 40.0false,
			"maximumOffPowerHoursmarinePollutant": 24.0false,
			"offPowerTemperaturehazardousWeight": -211000.0,
			"offPowerTimestampquantity": "2024-09-11T10:00:00+12:0075",
			"onPowerTargetTimeemsCode": "2024F-09-11T10:00:00+12:00YS-Y",
			"requiredTemperaturehazardContact": -21.0,{
				"humidityPercentname": 20.0 "John Smith",
				"refrigerationTypephone": "Chilled021 588 998"
			}
		}],
		"ventcontainerSeals": [{
			"ventSettingTypesealType": "PercentageOpenShipper",
			"ventSettingsealCode": 30.0"1223"
		},
		{
			"cargoWeightKgsealType": 16000.0"Shipper",
			"totalWeightKgsealCode": 18000.0"5665"
		}],
		"containerSealsarrivalCarrierType": [{"Truck",
			"sealTypecarrier": "ShipperWALTER",
			"sealCodehazardousCertificateBase64": "1223"
		},
		<![CDATA[JVBERi0xLjcNDQo8PC9UNQ0KJSVFT0Y=]]>
	}]
}

Reefer example

Code Block

language	json

{
	"header": {
			"sealTypeshipperName": "ShipperFNT",
			"sealCodeloadPortCode": "5665NZAKL"
		}],
		"arrivalCarrierTypebookingReference": "TruckSHIPPINGLINEBOOKINGREF",
		"carrierpointOfOriginCode": "WALTERAKC",
	}]
}

Example Request Body short:

Code Block

language	json

{
  "header		"vessel": {
    "shipperName			"shipName": "ALNEMAHCMA HALALCGM MEAT LIMITEDSEMARANG",
    "bookingReference			"voyageNumber": "1AKL0267402416",
    "lineOperatorCode			"partnerPortShippingReference": "CMC9741"
		},
		"loadPortFacility": "HSUDAuckland",
    "loadPortCode		"lineOperatorCode": "NZTRGARMC",
    		"portOfDischarge": "USLGBAUMEL",
    		"foreignPortOfDischarge": "USLGBAUMEL"
    "pointOfOriginCode,
		"userReference": "Bay of PlentyUNIQUEREFERENCE",
    "loadPortFacility		"notificationEmails": "TCT",
    "vessel["info@portconnect.co.nz"]
	},
	"containers": [{
      "shipName		"containerNumber": "DEBUSSYREEF1234510",
      "voyageNumber		"isoTypeCode": "138N2230",
		"isFull":      "partnerPortShippingReferencetrue,
		"commodityCode": "USY138N2199",
    },
    "notificationEmails		"IsNonOperatingReefer": false,
		"refrigeration": [
      "Cameron.Pitches@portconnect.co.nz"
    ],
    "userReference": "CAMTEST001"
  },
  "containers": [
    {
      "containerNumber": "CDPU3736837",
      "isoTypeCode": "2200",
      "flexiTank": false,
      "isFull": true,
      "commodityCode": "0201"
      },
      "cargoWeightKg": 28000.0,
      "totalWeightKg": 30000.0,
      "containerSeals": [
        {
          {
			"isFantainer": false,
			"co2Percent": 50.0,
			"o2Percent": 40.0,
			"maximumOffPowerHours": 24.0,
			"offPowerTemperature": -21.0,
			"offPowerTimestamp": "2024-09-11T10:00:00+12:00",
			"onPowerTargetTime": "2024-09-11T10:00:00+12:00",
			"requiredTemperature": -21.0,
			"humidityPercent": 20.0,
			"refrigerationType": "Chilled"
		},
		"vent": {
			"ventSettingType": "PercentageOpen",
			"ventSetting": 30.0
		},
		"cargoWeightKg": 16000.0,
		"totalWeightKg": 18000.0,
		"containerSeals": [{
			"sealType": "Shipper",
			"sealCode": "1223"
		},
		{
			"sealType": "Shipper",
          			"sealCode": "5555665"
        }
      		}],
      		"arrivalCarrierType": "Truck",
		"carrier": "WALTER"
  	}
  ]
}

Example Response:

Export pre-advice success

...

Versions Compared

Old Version 14

New Version Current

Key

API Request Body

Header section

Container section

Test URL:

Example Messages

All fields example:

Test URL:

Example Messages

All fields example:

Hazard example

Hazard example

Reefer example

Reefer example

Example Request Body short:

Example Response:

Export pre-advice success

Page Comparison

Versions Compared

Old Version 14

New Version Current

Key

API Request Body

Header section

Container section

Test URL:

Example Messages

All fields example:

Test URL:

Example Messages

All fields example:

Hazard example

Hazard example

Reefer example

Reefer example

Example Request Body short:

Example Response:

Export pre-advice success