...
PreadviceHeader
Name | Type | Description | Required | Notes | |||||
|---|---|---|---|---|---|---|---|---|---|
ShipperName | string | Shipper name | Mandatory | ||||||
ConsigneeName | string | Consignee name | |||||||
BookingReference | string | Booking reference | Mandatory | ||||||
MessageActionMessageActions? | string (Create/Cancel) | Message action type | Mandatory | ||||||
PointOfOriginCode | string | Point of origin code | Mandatory | ||||||
LoadPortFacility | string (required) | Load port facility | Mandatory | ||||||
Vessel | GenericPreadviceVessel | Vessel information | Mandatory | ||||||
shipName | string | Vessel Name | Optional | ||||||
voyageNumber | string | Voyage Number | Optional | ||||||
partnerPortShippingReference | string | Port Vessel reference | Optional | ||||||
NotificationEmails | string[] | List of notification email addresses | MessageType | PreadviceMessageTypes? | Pre-advice message type | TradingPartnerCode | string | Trading partner codeMandatory | |
UserName | string | User name | |||||||
UserReference | string | User reference | |||||||
LineOperatorCode | string | Line operator code | Mandatory | ||||||
LoadPortCode | string | Load port code | Mandatory | ||||||
PortOfDischarge | string | Port of discharge | Mandatory | ||||||
ForeignPortOfDischarge | string | Foreign port of discharge | Optional | ||||||
OverseasDestinationFinal | string | Overseas destination final | Optional |
PreadviceContainer
Name | Type | Description | Required | Notes |
|---|---|---|---|---|
HazardousCertificateBase64 | string | Base64 encoded hazardous certficate | Optional | |
LatestSubmissionStatus | GenericPreadviceContainerSubmission | Latest submission status of the container | ||
CurrentStatus | string | Current status of the container | ||
ContainerNumber | string (required) | Container number | Mandatory | |
AttachedContainerNumbers | List<string> | List of attached container numbers | Optional | |
IsoTypeCode | string (required) | 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 (required) | 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 | ||||
RefrigerationType | string (chilled) | |||
Vent | GenericPreadviceVent | Vent details for the container | ||
ventSettingType | ||||
ventSetting | ||||
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 | ||
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 |
...
Test URL:
| Code Block |
|---|
POST https://apitest.portconnect.io/v1/export-preadvices |
Example Request Body full:
| Code Block | ||
|---|---|---|
| ||
"header": {
"shipperName": "ABB HENDERSON",
"bookingReference": "ACD0524204",
"pointOfOriginCode": "Auckland",
"loadPortFacility": "TCT",
"vessel": {
"shipName": "NEFELI",
"voyageNumber": "2116",
"partnerPortShippingReference": "FEL2116"
},
"partnerPortCode": "NZTRG",
"userName": "test-preadvice-portconnect-co-nz",
"userReference": "POT_TEST1",
"lineOperatorCode": "ANNU",
"loadPortCode": "NZTRG",
"portOfDischarge": "AUSYD",
"foreignPortOfDischarge": "AUMEL"
},
"containers": [
{
"ContainerNumber": "XONU1234520",
"IsoTypeCode": "2200",
"FlexiTank": false,
"IsFull": true,
"CommodityCode": "01",
"IsNonOperatingReefer": false,
"IMEX": {
"CustomsClearanceNumber": "",
"ExportEntryNumber": ""
},
"CargoWeightKg": 8000.0,
"TotalWeightKg": 10000.0,
"HazardContact": {
},
"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"
}
]
}'
|
Example Request Body short:
| Code Block | ||
|---|---|---|
| ||
{
"header": {
"shipperName": "ALNEMAH HALAL MEAT LIMITED",
"bookingReference": "1AKL026740",
"lineOperatorCode": "HSUD",
"loadPortCode": "NZTRG",
"portOfDischarge": "USLGB",
"foreignPortOfDischarge": "USLGB"
"pointOfOriginCode": "Bay of Plenty",
"loadPortFacility": "TCT",
"vessel": {
"shipName": "DEBUSSY",
"voyageNumber": "138N",
"partnerPortShippingReference": "USY138N",
},
"notificationEmails": [
"Cameron.Pitches@portconnect.co.nz"
],
"userReference": "CAMTEST001"
},
"containers": [
{
"containerNumber": "CDPU3736837",
"isoTypeCode": "2232",
"flexiTank": false,
"isFull": true,
"commodityCode": "0201",
"isNonOperatingReefer": false,
"refrigeration": {
"isFantainer": false,
"requiredTemperature": -5.0,
"refrigerationType": "Chilled"
},
"cargoWeightKg": 28000.0,
"totalWeightKg": 30000.0,
"containerSeals": [
{
"sealType": "Shipper",
"sealCode": "555"
}
],
"arrivalCarrierType": "Truck"
}
]
} |
...
Export pre-advice partial failure
| Code Block | ||
|---|---|---|
| ||
{
"success": true,
"errors": [],
"containers": [
{
"containerNumber": "CDPU3736837",
"errors": [
"Temperature too high/low for the selected commodity (Range: -5.0 to 2.0). Change commodity or contact Terminal"
],
"success": false
}
]
} |
Pre-Advice validation rules
Must provide a valid booking
Load Port must match the booking
Load Port must be valid
Line Operator code must be valid
Line Operator code must match the booking
Vessel Visit must match the booking
Discharge Port must match the booking
Reefer ISO type containers must have a Temperature (unless specified as a Non-Operating Reefer)
Freight Kind (Full vs Empty) must match the booking
Reefer temperatures must match the booking
Conditioning details must match the booking. Conditioning details include: Humidity %, Vent value, Vent Type, O2% and CO2%
Hazard UN Codes must match the booking
Container ISO Type Groups much match the booking.
Total Pre-Advised Containers must not exceed the booking quanta (count)
Seal Type must be valid