...

• Scheduled vessels: Returns scheduled vessel information, including expected time of arrival and departure.

• Containers: Returns the latest detailed information for specified containers.  Up to 10 containers can be searched at any one time.

• Container event subscriptions: This is a suite of operations which allows container events to be sent to any end point you specify.

• Export Pre-Advice: Submit export container details to our partner ports prior to gate-in.

Getting Started

...

Signing Up

...

• We only permit one userDefinedReference per container. This is a maximum of 50 characters and designed to support container visit identifiers in calling systems.

• The user defined reference will be included in the webhook callback payload against the specified container.

• If you create a new subscription with a different user defined reference, it will overwrite the existing subscription including the user defined reference.

• If you have already received events against the first subscription you will receive future events against the new subscription with the new user defined reference.

Notification Types

Valid event type codes are shown in the following table, along with event values that are returned in the webhook callback payload:

...

Any errors in the request payload will result in a return code of 400 Bad request.  Further information will be supplied in the message payload.

...

Beta Endpoints

Vessel Schedule Notifications

• Vessel Arrival

• Vessel ETA Changed

• Vessel Departure

• Vessel ETD Changed

• Receival Commence Changed

• Receival Cut Off Changed

• Vessel Cancelled

Subscription Create Example

{
    "vessels": [
       { "vesselRef": "KRJ3654"},
       { "lloydNumber": "9700524"},
       { "lloydNumber": "9188934"}
 ],
 "webhookURI": "https://api.yourcompany.co.nz/webhooks/",
 "webhookToken": "yoursecret",
 "emailAddressList": ["info@portconnect.co.nz"],
 "portCode": "NZTRG",
 "wharfType": "Terminal"
}

Subscription Create Response

{
    "subscriptionId": 36,
    "vessels": [
        {
            "expirationDatetime": "2022-08-08T16:54:17.57+12:00",
            "subscriptionVesselScheduleId": 73,
            "vesselRef": "KRJ3654",
            "lloydNumber": null,
            "userDefinedReference": null
        },
        {
            "expirationDatetime": "2022-08-08T16:54:17.57+12:00",
            "subscriptionVesselScheduleId": 74,
            "vesselRef": null,
            "lloydNumber": 9700524,
            "userDefinedReference": null
        },
        {
            "expirationDatetime": "2022-08-08T16:54:17.57+12:00",
            "subscriptionVesselScheduleId": 75,
            "vesselRef": null,
            "lloydNumber": 9188934,
            "userDefinedReference": null
        }
    ]
}

Logic for Vessel Schedule Events

• When PortConnect receive an update from the partner port, we will only generate another event if the previous raised event Arrival Dttm or Departure Dttm is different to the new file.

• 6 hour time limit for Notifications: E.g. It is currently 11.59am, Vessel ETD is set to 6pm so a Notification will be sent. If the time was 12.30pm a Notification would not be sent.

...

Shipping Line Endpoints

PortConnect offers the following end points exclusively for the use of shipping lines.  Shipping line developers will need to contact our user support team to have access to these endpoints.   PortConnect associates an API user id with a specific line operator, so that storage pre-advice and booking api calls are associated with the correct shipping line.   It isn't possible to send or retrieve information in relation to other shipping lines.

...

• $0.05NZD per call if not subscribed to Track & Trace

• Free for Subscribed Track & Trace users

Container Visits

• $0.05NZD per container/per call (max 10 containers per call) when searching containers directly.

Container Event Subscriptions

• $0.20NZD per event update (Notification) sent*

• Includes 1 free callback to the container visit URL to retrieve standing container data (provided in the callback payload).

*High volume users may qualify for preferred customer discounts.

...