...
Port of Auckland
Port of Tauranga
Timaru Container Terminal
Lyttelton Port Company
Depots
What
...
Our most commonly used APIs are:
Vessel Schedule API
Container Visit API
Container Visit Event API
...
is the Container Visit and Container Visit Event
...
combo?
For container data, 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 methodUsers who receive Events are entitled to one free call to the Container Visit API for each event they receive.
What Container event types are available?
...
Below is a summary of event types most commonly used by different company types,
Imports
Importers | Forwarders | Trucking companies |
|---|---|---|
ActiveActive | ||
Cleared | ||
ActiveDischarge | ||
AvailableAvailable | ||
Customs Release | Available | |
Gate Out | Gate Out | LFT 24hrs |
Gate In (inland Port)MPI Release | ||
LOP Release | ||
LFT Changed | ||
VBS Changed | ||
Gate Out | ||
Gate In (inland Port)VBS Changed |
Exports
Exporters | Forwarders | |
|---|---|---|
Active | ||
Gate In | Gate In | Active |
No CEDO warning | No CEDO warning | VBS Changed |
Load | Load |
Do events get updated?
...
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?
...
E.g. a user subscribes to receive the Active event against Container XXX with a category of Import and a port of Port of Auckland. If/when an Import container called XXX is created in the Port of Auckland system then PortConnect will send the Active event.
Imports and exports Some container can sometimes change or move through different ports so PortConnect also provides the option for setting the port as ALL and PortConnect will send events for any matching Container/Category across any port.
e.g. a user subscribed to receive Load and Discharge events against Container YYY with a category of Domestic and a port of ALL. If when a container loads at Auckland and discharges in Lyttelton then two events will be sent. This can also be achieved by creating two subscriptions for the different ports.
What are the different container Categories?
...
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 is created, 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 is created, the clearances are recorded with the timestamp from when the container was created. |
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 - ???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. City Depot Imports - VBS bookings can only be made once containers are cleared and they have arrived at City Depot. Exports - VBS bookings can be made once containers have been pre-advised. |
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 /wiki/spaces/DEV/pages/2549350440 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.
Sign up for an API Key so you can test with the API. See our user-guide here, Creating an API account
Once you have signed up for the API you can obtain an API Key and select a Product type - FULL Access or Trial. We recommend starting with Trail while testing and the product type can be updated once you are ready to go live.
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.
As a software provider, can I apply for multiple API keys for my individual customers?
Yes. PortConnect bills based on the API key used to access the APIs. Software providers have the option to use a single API key and receive the bill related to all their customs or they can use multiple API keys and billing will be sent directly to the individual companies.
Are API keys associated with an organisation in PortConnect?
API keys do not need to be linked directly to a Trading Party in PortConnect but in the Container Visit Event API the Express Pin type events can only be sent to the party that obtained the Express PINs so the API key must be linked to receive the events. The linking will be done by PortConnect staff.