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.

Our APIs include:

  • Scheduled vesselsVessels API : 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 API : Returns the latest detailed information for specified containers.  Up to 10 containers can be searched at any one time.

  • API Container event subscriptionsEvent 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 API : Submit export container details to Ports of Auckland, Port of Tauranga and Timaru Container Terminal.

  • Shipping Line EndpointsBooking API Spreadsheet User Guide : PortConnect offers the following end points exclusively for the use of shipping lines.

    • Bookings

    • Storage Pre-Advice

    • OCR

...

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 .  

...

The PortConnect API uses JSON language and only supports JSON with double quotes (“). Child pages (Children Display)styleh1excerptTyperich content