...
In order to understand the Export Pre-advice submission, some familiarity with the Export Pre-advice User Guide is recommended. This details how export pre-advice submitted via the PortConnect website. The structure of the API is conceptually very similar to this screen, comprising a header with a list of containers being submitted.
...
| Code Block |
|---|
POST https://api.portconnect.io/v1/export-preadvices |
Request Body
Name | Type | Description |
|---|---|---|
header | PreadviceHeader | Pre-advice header information |
containers | PreadviceContainer[] | List of container information |
comments | string (optional) | Additional comments (not included in Swagger documentation) |
PreadviceHeader
Name | Type | Description | Notes |
|---|---|---|---|
ShipperName | string | Shipper name | |
ConsigneeName | string | Consignee name | |
BookingReference | string |
Booking reference | |||
MessageAction | MessageActions? | Message action type | |
PointOfOriginCode | string | Point of origin code | |
LoadPortFacility | string (required) | Load port facility | |
Vessel | GenericPreadviceVessel | Vessel information | |
shipName | string | ||
voyageNumber | string | ||
partnerPortShippingReference | string | ||
NotificationEmails | string[] | List of notification email addresses | |
MessageType | PreadviceMessageTypes? | Pre-advice message type | |
TradingPartnerCode | string | Trading partner code | |
UserName | string | User name | |
UserReference | string | User reference | |
LineOperatorCode | string | Line operator code | |
LoadPortCode | string |
Load port code | |||
PortOfDischarge | string | Port of discharge | |
ForeignPortOfDischarge | string | Foreign port of discharge | |
OverseasDestinationFinal | string | Overseas destination final |
PreadviceContainer
Name | Type | Description | Notes |
|---|---|---|---|
HazardousCertificateBase64 | string | Base64 encoded hazardous certficate | |
LatestSubmissionStatus | GenericPreadviceContainerSubmission | Latest submission status of the container | |
CurrentStatus | string | Current status of the container | |
ContainerNumber | string (required) | Container number | |
AttachedContainerNumbers | List<string> | List of attached container numbers | |
IsoTypeCode | string (required) | ISO type code for the container | |
FlexiTank | bool? | Indicates if the container is a flexi tank | |
IsFull | bool? | Indicates if the container is full | |
CommodityCode | string (required) | Commodity code | |
IsNonOperatingReefer | bool? | Indicates if the container is a non-operating reefer | |
Refrigeration | GenericPreadviceRefrigeration | Refrigeration details for the container | Only required if container ISO Type is a Reefer ISO type |
isFantainer | bool? | ||
requiredTemperature | float | ||
refrigerationType | string | ||
Vent | GenericPreadviceVent | Vent details for the container | |
IMEX | GenericPreadviceIMEX | IMEX details for the container | |
CargoWeightKg | float | Cargo weight in kilograms | |
TotalWeightKg | float | Total weight of the container in kilograms | |
Hazardous | GenericPreadviceHazardous[] | List of hazardous details | |
OverGauge | GenericPreadviceOverDimension[] | List of over-dimension details | |
ContainerSeals | GenericPreadviceContainerSeal[] | List of container seals | |
sealType | string (required) | ||
sealCode | string (required) | ||
ArrivalCarrierType | GenericPreadviceArrivalCarrierTypes? | Arrival carrier type | |
Carrier | string | Carrier details |
Example Request:
| Code Block |
|---|
POST https://apitest.portconnect.io/v1/export-preadvices |
...