Get Export Pre-advice
An export pre-advice can be retrieved using a GET to the export-preadvices end point, specifying the port and user reference in the URL, and optionally a container number. Specifying the container number restricts the response to only the export pre-advice header and the container number.
Endpoint
GET https://api.portconnect.io/v1/export-preadvices/{partnerPortCode}/{userReference}/{containerNumber}Parameters
Name | Type | Description |
|---|---|---|
partnerPortCode | string | The partner port code |
userReference | string | The user reference |
containerNumber | string | (Optional) The container number to fetch |
Example Request:
This following request gets all export pre-advices for the port NZTRG and with the user reference CAMTEST001
GET https://apitest.portconnect.io/v1/export-preadvices/NZTRG/CAMTEST001Example Response:
The response is the same format as the post request, with the addition of the status of the latest submission. For example:
{
"header": {
"shipperName": "ALNEMAH HALAL MEAT LIMITED",
"bookingReference": "1AKL026740",
"pointOfOriginCode": "Bay of Plenty",
"loadPortFacility": "TCT",
"vessel": {
"lineOperatorCode": "HSUD",
"shipName": "DEBUSSY",
"voyageNumber": "138N",
"partnerPortShippingReference": "USY138N",
"loadPortCode": "NZTRG",
"portOfDischarge": "USLGB",
"foreignPortOfDischarge": "USLGB"
},
"notificationEmails": [
"Cameron.Pitches@portconnect.co.nz"
],
"userName": "test-preadvice-portconnect-co-nz",
"userReference": "CAMTEST001"
},
"containers": [
{
"latestSubmissionStatus": {
"action": "Create",
"success": true
},
"containerNumber": "CDPU3736837",
"isoTypeCode": "2232",
"flexiTank": false,
"commodityCode": "0201",
"isNonOperatingReefer": false,
"refrigeration": {
"isFantainer": false,
"requiredTemperature": -5.0
},
"cargoWeightKg": 28000.0,
"totalWeightKg": 30000.0,
"containerSeals": [
{
"sealType": "Shipper",
"sealCode": "555"
}
],
"arrivalCarrierType": "Truck"
},
{
"latestSubmissionStatus": {
"action": "Create",
"success": true
},
"containerNumber": "CDPU3736997",
"isoTypeCode": "2232",
"flexiTank": false,
"commodityCode": "0201",
"isNonOperatingReefer": false,
"refrigeration": {
"isFantainer": false,
"requiredTemperature": -5.0
},
"cargoWeightKg": 28000.0,
"totalWeightKg": 30000.0,
"containerSeals": [
{
"sealType": "Shipper",
"sealCode": "555"
}
],
"arrivalCarrierType": "Truck"
}
]
}© PortConnect 2023