| Note |
|---|
This guide is intended for developers who want to integrate their own applications with PortConnect. |
...
All calls to the PortConnect API must include either the primary or secondary key in the header Ocp-Apim-Subscription-Key. You can regenerate your subscription key any time you choose.
...
- Valid port codes are:
NZAKL,NZTRG, NZTIU or NZLYT - Valid category codes are:
IMPORT,EXPORT,TRANSHIPMENT,DOMESTIC - Facility codes are optional and relate to the port facility where the event takes place. If no facility code is specified, then webhook callbacks will be sent whenever the event occurs, regardless of the location. For instance, if a subscription is created for an export "gate in", and the container is gated in to both an inland port and the sea port, then two gate in events will be sent as webhook callbacks.
- Only some event type codes support the use of the facility code, in all other cases a null value should be supplied. Refer to the table below.
...
- We only permit one
userDefinedReferenceper container. This is a maximum of 50 characters and designed to support container visit identifiers in calling systems. - The user defined reference will be included in the webhook callback payload against the specified container.
- If you create a new subscription with a different user defined reference, it will overwrite the existing subscription including the user defined reference.
- If you have already received events against the first subscription you will receive future events against the new subscription with the new user defined reference.
Notification Types
Valid event type codes are shown in the following table, along with event values that are returned in the webhook callback payload:
Code | Description | Supported Facility Codes | Event Value 1 | Event Value 2 |
|---|---|---|---|---|
| ACTIVE | Container record becomes live in PortConnect system | NZAKL, NZTRG, NZTIU, NZLYT | ||
| AVAILABLE | Availability Advice (Container is fully released) | NZAKL, NZTRG, NZTIU, NZLYT | ||
| AVAILABLECANCELLED | Availability Advice cancelled | NZAKL, NZTRG, NZTIU, NZLYT | ||
| BOOKINGDISCREPANCY | Discrepancy: Booking does not match Preadvise/Gate-in details | NZAKL, NZTRG, NZTIU, NZLYT | Container Visit value | Booking value |
| CLEARED | Cleared Advice (Container is fully cleared) | NZAKL, NZTRG, NZTIU, NZLYT | ||
| CLEAREDCANCELLED | Cleared Advice cancelled | NZAKL, NZTRG, NZTIU, NZLYT | ||
| CUSTOMSRELEASE | Notice of Customs Release | NZAKL, NZMKL, NZTRG, NZTIU, NZLYT, NZOLT | ||
| CUSTOMSRELEASECANCELLED | Notice of Customs Release cancelled | NZAKL, NZMKL, NZTRG, NZTIU, NZLYT, NZOLT | ||
| DEPART | Facility Departure Advice | NZAKL, NZWII | ||
| DISCHARGE | Discharge Advice | NZAKL, NZTRG, NZTIU, NZLYT | ||
| EXPORTCLEARED | CEDO is in place and there are no other stops | NZAKL, NZTRG, NZTIU, NZLYT | ||
| EXPORTCLEAREDCANCELLED | Export Cleared cancelled | NZAKL, NZTRG, NZTIU, NZLYT | ||
| GATEIN | Gate IN advice | NZAKL, NZMKL, NZTRG, NZWII, NZTIU, NZOLT | Mode of transport, eg. Road | Identifier for the truck or train, eg. REL328 |
| GATEOUT | Gate OUT Advice | NZAKL, NZMKL, NZTRG, NZWII, NZTIU, NZOLT, NZLYT, NZCHC | Mode of transport, eg. Road | Identifier for the truck or train, eg. REL328 |
| HAZARDGATERULE | Hazardous Cargo Gate-in rule applies | NZAKL, NZTRG, NZTIU, NZLYT | ||
| LFT24HOURS | Container visit Last Free Time within 24 hours | NZAKL, NZTRG, NZTIU | Last free time | |
| LFTCHANGED | Container visit Last Free Time has been changed | NZAKL, NZTRG, NZTIU | New last free time | |
| LFTEXCEEDED | Container visit Last Free Time exceeded | NZAKL, NZTRG, NZTIU | Last free time | |
| LOAD | Notice of item loaded to Vessel | NZAKL, NZTRG, NZTIU, NZLYT | ||
| LOPRELEASE | Notice of Line Operator Release | NZAKL, NZMKL, NZTRG, NZTIU, NZOLT, NZLYT, NZCHC | ||
| LOPRELEASECANCELLED | Notice of Line Operator Release - cancelled | NZAKL, NZMKL, NZTRG, NZTIU, NZOLT, NZLYT, NZCHC | ||
| MPIRELEASE | Notice of MPI Release | NZAKL, NZMKL, NZTRG, NZTIU, NZOLT, NZLYT, NZCHC | ||
| MPIRELEASECANCELLED | Notice of MPI Release - cancelled | NZAKL, NZTRG, NZTIU, NZLYT | ||
| NOCEDO | No Cedo Warning | NZAKL, NZTRG, NZTIU, NZLYT | 48, 24, 2 hour warning text | |
| PINAVAILABLE | ExpressPin Available | NZAKL | Express Pin number | |
| PINSUSPENDED | ExpressPin Suspended | NZAKL | Express Pin number | |
| VESSELARRIVAL | Vessel Visit Actual Time of Arrival | NZAKL, NZTRG, NZTIU, NZLYT | ||
| VESSELDEPARTURE | Vessel Visit Actual Time of Departure | NZAKL, NZTRG, NZTIU, NZLYT | ||
| PRIORITYGATEIN | Automated Gate-In Notifications when containers arrive at Metroport with a status of Priority (Only available for Imports via Port of Tauranga). | NZTRG |
...
- NZAKL - Ports of Auckland
- NZMKL - MetroPort Auckland
- NZCWF - Crawford Street, Hamilton
- NZTRG - Port of Tauranga, Sulphur Point
- NZWII - Wiri, Ports of Auckland South Auckland Freight Hub
- NZTIU - Timaru Container Terminal
- NZOLT - MetroPort Rolleston
NZLYT - Lyttelton Port Company
NZCHC - CityDepot
Response
Success will result in a return code of 201 Created. The response to the request will confirm the subscription details.
...
- partnerPortCode must be one of NZAKL, NZTRG, NZTIU or NZTRGNZLYT
- vesselVisit must contain a minimum of vesselName and vesselVoyageNbr
- valid UN port codes must be used
- at least one booking item must be supplied
...
- $0.05NZD per call if not subscribed to Track & Trace
- Free for Subscribed Track & Trace users
Container Visits
- $0.05NZD per container/per call (max 10 containers per call) when searching containers directly.
Container Event Subscriptions
- $0.20NZD per event update (Notification) sent*
- Includes 1 free callback to the container visit URL to retrieve standing container data (provided in the callback payload).
*High volume users may qualify for preferred customer discounts.
...