Understanding PortConnect API Subscriptions for Business Users
Tracking Container Movements and Status
PortConnect can help businesses track container movements at different ports. Subscribing allows you to receive real-time updates when significant events occur.
Why Use Subscriptions?
With PortConnect subscriptions, you can:
Stay informed – Get automatic updates about your shipments.
Improve planning – Know when containers are ready to move.
Save time – Reduce or eliminate the need to check container statuses manually.
How It Works
Subscribe to Container Data for Auckland, Tauranga, Lyttelton, and Timaru (including inland ports).
Real-time event notifications as containers move through the port
30 event types covering Import, Export, Domestic and Transhipment moves
Available in API or email/XML formats
To receive updates, you need to subscribe to container visits. Subscriptions can be created in two ways:
By Container Number – Track specific containers.
By Booking Number – Track all containers under a particular booking.
Once you have created a subscription, you can choose to receive updates via:
Email – Notifications sent to one or more email addresses.
API (Webhook) – If your company has a logistics system, updates can be sent directly to it.
Email notifications can create high volumes and should ideally be sent to a shared inbox.
Examples of Key Events to Track
When setting up a subscription, you can choose to receive updates for specific events. The following are examples that might be used to inform you when an import container is ready for pickup and delivery:
Active – When the container becomes live in the PortConnect system.
Discharge – The container has been unloaded at the port but may not be cleared of holds.
Available – The container is available to leave the port i.e. it has been discharged and has no impediments (Stops/holds).
VBS Changed – The VBS booking for this container has been obtained, changed or cancelled.
All Events – You can also receive updates for every event related to a container.
Subscriptions are charged per event. The more event types you request and the more often you request, the higher the costs. Only request what you need for your business.
Your system may not have fields available for all events. However, a single event, AVAILABLE, can cover several events, including holds for LOP, Customs, MPI, and the Discharge event.
A Guide to API Events by Industry Sector
Recommended |
|
Nice to Have |
|
Mode | Container Visit Event Type Code | Description | Benefits | BCO | Fwder | Road Transpt | 3 PL |
---|---|---|---|---|---|---|---|
Imports | Active | The container has become live in the PortConnect system | A key event to start managing the unit |
|
|
|
|
Imports | Available | Container has all holds removed AND has been discharged, ready for uplift | This event will advise when the container is fully cleared and available to leave the port in a single event type |
|
|
|
|
Imports | AvailableCancelled | The container has had a hold reapplied, no longer available | Can save a wasted truck visit |
|
|
|
|
Imports | Cleared | Container has all holds released, but the container may not yet be discharged | Advises when all holds are removed from the container. May occur before or after discharge. |
|
|
|
|
Imports | CustomsRelease | Customs have released their hold |
|
|
|
|
|
Imports | Discharge | Unloaded from vessel to wharf |
|
|
|
|
|
Imports | DischargedNotCleared | Container discharged but still has holds preventing delivery (LOP,CUS,MPI) | Container discharged but not yet available due to holds/stops. |
|
|
|
|
Imports | GateIN | Entered a port facility | Arrived at the inland destination, eg Metroport or Wiri.
|
|
|
|
|
Imports | GateOUT | Exited a port facility |
|
|
|
|
|
Imports | LFT24Hours | Last Free Time has entered the final free 24 hours prior to Demurrage | A warning that action is required |
|
|
|
|
Imports | LFTChanged | Last Free Time has been set or changed | Confirmation of the Last Free Time and/or changes to the time. |
|
|
|
|
Imports | LFTExceeded | Last Free Time has been exceeded, now on demurrage | Alert that cost is being incurred |
|
|
|
|
Imports | LOPRelease | Line Operator has released their hold |
|
|
|
|
|
Imports | MPIRelease | MPI have released their hold |
|
|
|
|
|
Imports | VBSChanged | VBS has been set or changed | Confirmation of when the container is expected to be delivered to or picked up from the port. |
|
|
|
|
Imports | VesselArrival | The vessel has berthed, note the container discharge is a separate event |
|
|
|
|
|
Exports | Active | The container has become live in the PortConnect system | A key event to start managing the unit |
|
|
|
|
Exports | CEDO Release | CEDO has been lodged and approved |
|
|
|
|
|
Exports | CEDO Release cancelled | CEDO has been cancelled, container cannot be loaded until cleared again | Alert that action is required |
|
|
|
|
Exports | Gate In | Gate in to the Inland Port and / or the seaport facility | E.g. received at Metroport or Wiri |
|
|
|
|
Exports | Hazard Gate Rules | Denotes the hours before Vessel ETA that a HAZ container can gate into port (24 or72 hours) | Warns of the restrictions by DG class |
|
|
|
|
Exports | NO Cedo | Warning 48 / 24 / 2 hour warning text | Alert that action is required |
|
|
|
|
Exports | Load | Loaded to vessel |
|
|
|
|
|
Exports | Export Cleared | CEDO in place and no other stops | Includes the CEDO number |
|
|
|
|
Exports | Export Cleared Cancelled | Export cleared has been cancelled | Alert that action is required |
|
|
|
|
Storage | Gate Out | Empty uplift from container depot | Confirmation of time of uplift |
|
|
|
|
Storage | Gate In | Empty dehire to container depot | Confirmation of time of dehire |
|
|
|
|
Managing Your Subscription
Adding More Updates – You can update your subscription to track additional events.
Reducing Updates - If you receive too many notifications, you can remove specific events or cancel a subscription to reduce costs.
Multiple Subscriptions – You can have different subscriptions for different ports, categories, or facility codes.
When reducing the number of events you wish to receive, you must cancel the existing subscriptions to ensure your request has been reset. Please have your technical team visit our guide on this matter: V2 - Create Container Event Subscription | Event Types are applied to all containers associated to the subscription
What This Means for Your Business
By using PortConnect subscriptions, your business can:
✅ Reduce delays by knowing exactly when shipments are ready.
✅ Reduces the need to chase cargo information, reducing workload on staff.
✅ Improve efficiency by automating container tracking.
✅ Ensure better coordination between logistics teams.
For further assistance setting up your subscription, contact your logistics provider or PortConnect support at info@portconnect.co.nz
API Documentation
You can find all of our documentation, including instructions on how to start your API journey and relevant information for technical teams, here, API Documentation
© PortConnect 2023