Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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?

  1. send a link to our detailed technical documents to your developers and they can confirm if/how your system could process the APIs.

  2. Determine what data you are interested in processing into your system.

  3. 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.

What is the typical flow of containers through the ports?

...

Imports

  1. Customs/MPI/Line release

  2. Container created via Baplie

  3. Cleared event recorded

  4. Discharge

  5. Available event recorded

  6. VBS obtained or Rail booked

  7. LFT set

  8. Gate Out of Seaport

  9. Gate in at Inland Port (Optional)

  10. LFT Changed (Optional)

  11. Gate out of inland port (Optional)

...

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 20XX

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?

  1. 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.

  2. Determine what data you are interested in processing into your system.

  3. 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.