Versions Compared

Key

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

...

Name

Type

Description

Required

Notes

HazardousCertificateBase64

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

AttachedContainerNumbers

List<string>

List of attached container numbers

Optional

IsoTypeCode

string

ISO type code for the container

Mandatory

FlexiTank

bool?

Indicates if the container is a flexi tank

Optional

IsFull

bool?

Indicates if the container is full

Mandatory

CommodityCode

string

Commodity code

Mandatory

IsNonOperatingReefer

bool?

Indicates if the container is a non-operating reefer

Optional

Refrigeration

GenericPreadviceRefrigeration

Refrigeration details for the container

Optional

Only required if container ISO Type is a Reefer ISO type

isFantainer

bool?

Optional

requiredTemperature

float

Optional

refrigerationType

string

Optional

humidityPercent

Optional

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

ContainerSeals

GenericPreadviceContainerSeal[]

List of container seals

Mandatory

sealType

string (required)

Mandatory

sealCode

string (required)

Mandatory

ArrivalCarrierType

GenericPreadviceArrivalCarrierTypes?

Arrival carrier type

Mandatory

Carrier

string

Carrier details

Mandatory

...

All fields example:

Code Block
languagejson
    {
	"header": {
        		"shipperName": "ABB HENDERSONFNT",
        "bookingReference		"loadPortCode": "ACD0524204NZAKL",
        "pointOfOriginCode		"bookingReference": "AucklandSHIPPINGLINEBOOKINGREF",
        "loadPortFacility		"pointOfOriginCode": "TCTAKC",
        		"vessel": {
            			"shipName": "NEFELICMA CGM SEMARANG",
            "			"voyageNumber": "21162416",
            			"partnerPortShippingReference": "FEL2116CMC9741"
        		},
		"loadPortFacility":        "partnerPortCode"Auckland",
		"lineOperatorCode": "NZTRGARMC",
        "userName		"portOfDischarge": "test-preadvice-portconnect-co-nzAUMEL",
        "userReference		"foreignPortOfDischarge": "POT_TEST1AUMEL",
        "lineOperatorCode		"userReference": "ANNUUNIQUEREFERENCE",
        "loadPortCode		"notificationEmails": ["info@portconnect.co.nz"]
	},
	"containers": [{
		"containerNumber": "NZTRGHAZD1234510",
        "portOfDischarge	
		"attachedContainerNumbers": [],
		"isoTypeCode": "AUSYD4500",
        "foreignPortOfDischarge		"isFull": true,
		"AUMELcommodityCode": "74",
		"isNonOperatingReefer": false,
 },
    "containers		"cargoWeightKg": 16000.0,
		"totalWeightKg": 18000.0,
		"hazardous": [{
			"medicalFirstAidGuideSet": true,
			"flashPointSet": true,
			"hazardousClass":        {
      "ContainerNumber"2.1",
			"unNumber": "XONU12345201950",
      "IsoTypeCode			"packagingGroup": "22001",
      "FlexiTank			"limitedQuantities": falsetrue,
      "IsFull			"marinePollutant": true,
			"hazardousWeight":      "CommodityCode200.0,
			"quantity": "0110",
      "IsNonOperatingReefer			"emsCode": false,
      "IMEX"F-BS-C",
			"hazardContact": {
        "CustomsClearanceNumber				"name": "John Smith",
        "ExportEntryNumber				"phone": ""021 588 998"
    			}
		},
      "CargoWeightKg		{
			"medicalFirstAidGuideSet": 8000.0true,
			"flashPointSet": true,
			"hazardousClass": "2.2",
			"unNumber": "1950",
			"TotalWeightKgpackagingGroup": 10000."0",
			"limitedQuantities":      "HazardContactfalse,
			"marinePollutant": {
        
      },
      "Hazardous": [
        
      ],
      "OverGauge": [
        
      ],
      "ContainerSeals": [
        {
          "SealType": "Shipper",
          "SealCode": "hghghg"
        }
      ],
      "ArrivalCarrierType": "Truck"
    },
    {
      "ContainerNumber": "CONU1234560",
      "IsoTypeCode": "2030",
      "FlexiTank": false,
      "IsFull": true,
      "CommodityCode": "2199",
      "IsNonOperatingReefer": false,
      "Refrigeration": {
        "IsFantainer": false,
        "Co2Percent": 55.0,
        "O2Percent": 34.0,
        "TimeAllowedOffPowerHours": 3,
        "TimeAllowedOffPowerMinutes": 2,
        "ActiveRefrigerationRequired": true,
        "RequiredTemperature": 5.0,
        "HumidityPercent": 78.0,
        "RefrigerationType": 1
      },
      "Vent": {
        "VentSettingType": "PercentageOpen",
        "VentSetting": 3.0
      },
      "IMEX": {
        "CustomsClearanceNumber": "",
        "ExportEntryNumber": ""
      },
      "CargoWeightKg": 8000.0,
      "TotalWeightKg": 10000.0,
      "HazardContact": {
        
      },
      "Hazardous": [
        
      ],
      "OverGauge": [
        
      ],
      "ContainerSeals": [
        {
          "SealType": "Shipper",
          "SealCode": "aaaaa"
        },
        {
          "SealType": "Shipper",
          "SealCode": "bbbbbbbbb"
        },
        {
          "SealType": "Shipper",
          "SealCode": "cccccccc"
        }
      ],
      "ArrivalCarrierType": "Truck"
    }
    ]
}'
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",
		"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"
	}]
}

Reefer / 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",
		"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,
		"hazardous": [{
			"medicalFirstAidGuideSet": true,
			"flashPointSet": true,
			"hazardousClass": "2.1",
			"unNumber": "1950",
			"packagingGroup": "1",
			"limitedQuantities": true,
			"marinePollutant": false,
			"hazardousWeight": 200.0,
			"quantity": "20",
			"emsCode": "F-AS-B",
			"hazardContact": {
				"name": "John Smith",
				"phone": "021 345 678"
			}
		}],
		"containerSeals": [{
			"sealType": "Shipper",
			"sealCode": "1223"
		},
		{
			"sealType": "Shipper",
			"sealCode": "5665"
		}],
		"arrivalCarrierType": "Truck",
		"carrier": "WALTER"
	}]
}

...