Versions Compared

Key

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

...

The PortConnect API (Application programming interface) is a new, more modern way of sending and retrieving data from PortConnect.  PortConnect receives container event information 24 hours a day from our partner ports Ports of Auckland, Port of Tauranga, Timaru Container Terminal and Lyttelton Port Company.  Events are received at least every ten minutes.All API operations work for all partner ports.

Our APIs include:

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

  • Vessel Schedule Event Subscriptions: Receive real-time alerts for key vessel information, including changes to ETA and details of vessels omitting a port.

  • Container Visits: 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 or email you specify.

  • Export Pre-Advice: Submit export container details to Ports of Auckland and , Port of Tauranga to gate-inand Timaru Container Terminal.

  • Shipping Line Endpoints: PortConnect offers the following end points exclusively for the use of shipping lines.

    • Bookings

    • Storage Pre-Advice

...

Signing Up

In order to use the PortConnect API, you need to sign up to our Microsoft APIM based developer portal, which is located at https://developer.portconnect.io .  

...