What is an API?
API is the acronym for application programming interface — a software intermediary that allows two applications to talk to each other.
What APIs does PortConnect offer?
API Name | API Description |
|---|---|
Container Visit API | A summary of details related to a container visit. B2B equivalent of searching a container on Track & Trace. |
Vessel Schedule API | A summary of all Vessel Schedule information. B2B equivalent of searching the Vessel Schedule on the PortConnect website. |
Container Visit Event API | Register interest in container visits and event types and then PortConnect will send you event information when those events occur. |
Vessel schedule Event API | Register interest in vessel visits and event types and then PortConnect will send you event information when those events occur. |
Export Pre-Advice API | Send pre-advice to PortConnect directly from your system rather than manually entering the data via our website. |
What ports is the data available for?
Port of Auckland
Port of Tauranga
Timaru Container Terminal
Lyttelton Port Company
Depots
What are the most commonly used APIs?
Our most commonly used APIs are:
Vessel Schedule API
Container Visit API
Container Visit Event API
Container Visit and Container Visit Event Combo
Most of our B2B customers use a combination of the Container Visit Event API and the Container Visit API. Users subscribe to specific events and get informed when they happen then they call the Container Visit API to check any other details that may have changed against the container visit.
See the discount section to understand why this is the preferred method.
What Container event types are available?
A full list of event types is available here, Container Visit Event Types
What are the most commonly used event types?
Below is a summary of event types most commonly used by different company types,
Imports
Importers | Forwarders | Trucking companies |
|---|---|---|
Active | Active | Active |
Available | Available | Available |
Gate Out | Gate Out | LFT 24hrs |
Gate In (inland Port) | Gate In (inland Port) | VBS Changed |
Exports
Exporters | Forwarders | Trucking companies |
|---|---|---|
Gate In | Gate In | Active |
No CEDO warning | No CEDO warning | VBS Changed |
Load | Load |
Do events get updated?
Yes! Some events get recorded multiple times.
Event Type | Description |
|---|---|
Gate In/Out | Gate events can occur across multiple facilities. Gate events include the specific facility location information. |
Line Release, MPI Release, Customs Release, Available, Cleared | These events all have a corresponding Cancelled version that you must subscribe to separately. Clearances can be revoked or updated and PortConnect records a Cancelled type event when this occurs. Once the issue has been resolved then a new release event will be created with a new event time. |
VBS Changed | As trucking companies plan and replan their jobs, VBS bookings may be cancelled and changed. This event will be sent each time a booking is changed. |
Vessel schedule events, other than Actual Arrival and Actual Departure, are often updated.
When can I use the container data APIs? When will container data be available?
Containers will only show up in the APIs when the containers have been created in the ports' systems. For Imports this occurs when the port loads the Baplie (aka the vessel manifest) and for exports this occurs when a pre-advice has been submitted. See the combination section).
How does the pricing work?
The full details of pricing is available here, https://www.portconnect.co.nz/#/content/pricing
High volume users may qualify for preferred customer discounts.
Container Visit API and Container Visit Event API discount
Users who receive Events are entitled to one free call to the Container Visit API for each event they receive. Most users subscribe to specific events then once they receive the event they call the Container Visit API to pick up additional container Visit details.
What is the typical flow of containers through the ports?
Imports
Customs/MPI/Line release
Container created via Baplie (Active)
Cleared event recorded
Discharge
Available event recorded
VBS obtained or Rail booked (rules vary by port)
LFT set
Gate Out of Seaport
Gate in at Inland Port (Optional)
LFT Changed (Optional)
Gate out of inland port (Optional)
Empty container returned to a depot (Depot Gate In)
Exports
Container pre-advised (Active)
CEDO applied (Export Cleared)
VBS obtained
Gate In at Inland Port (Optional)
Gate Out of Inland Port (Optional)
Gate In at Seaport
Load
Are there any differences between ports or other details to consider?
Q | A |
|---|---|
When do containers get created? | Import containers are created when the port receives the Baplie (Vessel Manifest file) from the shipping line. Export containers are created when the export pre-advice is submitted. |
What happens when clearances and release messages are received before the container is active in the port’s system? | NZAKL, NZTRG, NZTIU - The clearances are stored until the import record is created. Once the import record the clearances are recorded with the timestamp from when the messages arrived. NZLYT - The clearances are stored until the import record is created. Once the import record the clearances are recorded with the timestamp from when the messages arrived. |
When can VBS bookings be made? | NZAKL Imports - VBS bookings can be made once containers are cleared and before they are discharged. Exports - VBS bookings can be made once containers have been pre-advised. NZTRG Imports - VBS bookings can only be made once containers are cleared and discharged. Exports - VBS bookings can be made once containers have been pre-advised. Bookings can also be made by Booking Number. Metroport Imports - VBS bookings can only be made once containers are cleared and they have arrived at Metroport. Exports - VBS bookings can be made once containers have been pre-advised. NZLYT Imports - ??? Exports - VBS bookings can be made once containers have been pre-advised. City Depot |
How long back does Track & Trace History go? | NZAKL, NZTRG - Records go back to 2015. NZTIU - Records go back to 2022 NZLYT - Records are currently only available via the Container Visit API which shows up to 1 year of historic data. |
Where should we begin with an API integration?
Send a link to our detailed technical documents to your developers/software provider and they can confirm if/how your system could process the APIs.
Determine what data you are interested in processing into your system.
Once you have determined what data you want and your developers have read the documentation then PortConnect is available to answer any process or technical questions you might have. Send an email to info@portconnect.co.nz to get started.