Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Level

Name

Required

Repeats

Type

Description

Applicable Ports

0

containers

PreadviceContainer[]

Yes

List of container information

1

ContainerNumber

Mandatory

No

string

Container number

ALL

1

AttachedContainerNumbers

Optional

No

List<string>

List of attached container numbers

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

1

IsNonOperatingReefer

Optional

No

bool?

Indicates if the container is a non-operating reefer

1

Refrigeration

Optional

No

GenericPreadviceRefrigeration

Refrigeration details for the container.

Only required if container ISO Type is a Reefer ISO type

2

isFantainer

Optional

No

bool?

2

co2Percent

Optional

No

float

2

o2Percent

Optional

No

float

2

humidityPercent

Optional

No

float

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

Yes

string

2

sealCode

Mandatory

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

...

Code Block
languagejson
    {
	"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": "HAZD1234510"	
		"attachedContainerNumbers": [],
		"isoTypeCode": "4500",
		"isFull": true,
		"commodityCode": "74",
		"isNonOperatingReefer": false,
		"cargoWeightKg": 16000.0,
		"totalWeightKg": 18000.0,
		"hazardous": [{
			"medicalFirstAidGuideSet": true,
			"flashPointSet": true,
			"hazardousClass": "2.1",
			"unNumber": "1950",
			"packagingGroup": "1",
			"limitedQuantities": true,
			"marinePollutant": true,
			"hazardousWeight": 200.0,
			"quantity": "10",
			"emsCode": "F-BS-C",
			"hazardContact": {
				"name": "John Smith",
				"phone": "021 588 998"
			}
		},
		{
			"medicalFirstAidGuideSet": true,
			"flashPointSet": true,
			"hazardousClass": "2.2",
			"unNumber": "1950",
			"packagingGroup": "0",
			"limitedQuantities": false,
			"marinePollutant": false,
			"hazardousWeight": 1000.0,
			"quantity": "75",
			"emsCode": "F-YS-Y",
			"hazardContact": {
				"name": "John Smith",
				"phone": "021 588 998"
			}
		}],
		"containerSeals": [{
			"sealType": "Shipper",
			"sealCode": "4455"
		}],
		"arrivalCarrierType": "Rail",
		"carrier": "CONLIN"
	},
	{
		"containerNumber": "OOGC1234651"	
		"attachedContainerNumbers": [],
		"isoTypeCode": "22P1",
		"isFull": true,
		"commodityCode": "47",
		"isNonOperatingReefer": false,
		"cargoWeightKg": 16000.0,
		"totalWeightKg": 18000.0,
		"overGauge": [{
			"area": "Top",
			"measureCm": 10.0
		},
		{
			"area": "Left",
			"measureCm": 20.0
		},
		{
			"area": "Right",
			"measureCm": 30.0
		},
		{
			"area": "Front",
			"measureCm": 40.0
		},
		{
			"area": "Back",
			"measureCm": 50.0
		}],
		"containerSeals": [{
			"sealType": "Shipper",
			"sealCode": "TBC"
		}],
		"arrivalCarrierType": "Truck",
		"carrier": "AACAR "
	},
	{
		"containerNumber": "REEF1234510"		
		"attachedContainerNumbers": [],
		"isoTypeCode": "2230",
		"isFull": true,
		"commodityCode": "2199",
		"IsNonOperatingReefer": false,
		"refrigeration": {
			"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": "5665"
		}],
		"arrivalCarrierType": "Truck",
		"carrier": "WALTER"
	}]
}

...

Hazard example

Code Block
languagejson
{
	"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": ["chris.boxall@portconnect.co.nz"]
	},
	"containers": [{
		"containerNumber": "REEF1234510",
		"attachedContainerNumbers": [],
		"isoTypeCode": "2230",
		"isFull": true,
		"commodityCode": "2199",
		"refrigerationcargoWeightKg": {16000.0,
			"isFantainertotalWeightKg": false18000.0,
			"co2Percenthazardous": 50.0,[{
			"o2PercentmedicalFirstAidGuideSet": 40.0true,
			"maximumOffPowerHoursflashPointSet": 24.0true,
			"offPowerTemperaturehazardousClass": -21.0"2.1",
			"offPowerTimestampunNumber": "2024-09-11T10:00:00+12:001950",
			"onPowerTargetTimepackagingGroup": "2024-09-11T10:00:00+12:001",
			"requiredTemperaturelimitedQuantities": -21.0true,
			"humidityPercentmarinePollutant": 20.0true,
			"refrigerationTypehazardousWeight": "Chilled"200.0,
		},
		"ventquantity": {"10",
			"ventSettingTypeemsCode": "PercentageOpenF-BS-C",
			"ventSettinghazardContact": 30.0{
		},
		"cargoWeightKgname": 16000.0"John Smith",
				"totalWeightKgphone": 18000.0,
		"hazardous": ["021 588 998"
			}
		},
		{
			"medicalFirstAidGuideSet": true,
			"flashPointSet": true,
			"hazardousClass": "2.12",
			"unNumber": "1950",
			"packagingGroup": "10",
			"limitedQuantities": truefalse,
			"marinePollutant": false,
			"hazardousWeight": 2001000.0,
			"quantity": "2075",
			"emsCode": "F-ASYS-BY",
			"hazardContact": {
				"name": "John Smith",
				"phone": "021 345588 678998"
			}
		}],
		"containerSeals": [{
			"sealType": "Shipper",
			"sealCode": "1223"
		},
		{
			"sealType": "Shipper",
			"sealCode": "5665"
		}],
		"arrivalCarrierType": "Truck",
		"carrier": "WALTER"
	}]
}

Reefer example

Code Block
languagejson
{
	"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": ["chris.boxall@portconnect.co.nz"]
	},
	"containers": [{
		"containerNumber": "REEF1234510",
		"isoTypeCode": "2230",
		"isFull": true,
		"commodityCode": "2199",
		"IsNonOperatingReefer": false,
		"refrigeration": {
			"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": "5665"
		}],
		"arrivalCarrierType": "Truck",
		"carrier": "WALTER"
	}]
}

...