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 |
Vessel Schedule API | A summary of all Vessel Schedule information |
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 container 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 users use a combination of the Container Visit API and the Container Visit Event 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.
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 |
How does the pricing work?
The full details of pricing is available here, https://www.portconnect.co.nz/#/content/pricing
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.
Where should we begin with an API integration?
send a link to our detailed technical documents to your developers and they can confirm if/how your system could process the APIs.
Determine what data you are interested in processing into your system.
Once your 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.
Do events get updated? Change?
Chris to further document the clearance process and business rules POAL vs POT vs LPC.