To give an idea of the impact that API updates can have on your operational logistics processes, an explanation per event is provided below. This information can be used to determine which information is relevant for your organisation.
This is a draft version and is not yet suitable to base the API integration on. The final version will be published at go-live in May.
| Event in Cargo Controller Export | Update in API | Impact on the logistics process |
|---|---|---|
| Booking expected at terminal | TerminalSubscribed | One or more terminals has indicated that it expects the booking number/reference. As soon as the document notification has been made, it is sent to the terminal. The order of TerminalSubscribed and DocumentAdded is not important. |
| Document notification made | DocumentAdded | A document notification consists of a booking number containing at least 1 equipment and at least 1 document. The document notification to the terminal is completed when, in addition to the document notification, TerminalSubscribed is approved. Important: for some terminals you must also make an appointment via Hinterland Container Notification. This is a separate API that can be requested. More about this can be found in the article Connected terminals and depots for Hinterland Container Notification |
| Delete document from booking | DocumentRemoved | A document is deleted from the equipment. There must always be at least 1 document present on the equipment for access to the terminal. |
| Update of the document number | DocumentNumberUpdated | The document number has been updated. |
| Update of the document type | DocumentTypeUpdated | The document type has been updated. |
| Equipment receive at terminal - Gate-in | TransportEquipmentGateIn | Arrival step 1: the equipment (container or trailer) has arrived at the terminal. When all equipment of the document has arrived at the terminal, the arrival/discharge notification for export cargo or transit cargo is then reported to Customs. See Documentreported |
| Document reported to Customs | DocumentReported |
Arrival step 2: all equipment(s) related to the document have arrived at the same terminal. Portbase forwards the arrival for export and/or transit cargo to Customs. For export cargo, the arrival is reported to Customs, also known as the 'Trader at Exit' notification. For transit cargo, the discharge of the transit document is reported to Customs. |
| Document accepted by Customs | DocumentAccepted | Arrival step 3: arrival/discharge notification for export cargo or transit cargo has been accepted by Customs. The Customs block is resolved if, after this event, no DocumentRejected or InspectionNotified follows. For your information: this is one of the steps to obtain the Confirmation of Exit for export. For transit cargo, this means that the cargo has been successfully discharged. |
| Document rejected by Customs | DocumentRejected | Arrival/discharge notification for export cargo or transit cargo was not successful. There is something wrong with the document; for example, an incorrect document number or the document has an incorrect status for export. Please note: the cargo will not be loaded onto the vessel. Use the error code to determine the reason and take the correct follow-up action. Go to the article Customs error codes in export services for an overview of the most common error codes. |
| Document released | DocumentReleased | Customs does not indicate that the cargo is being reviewed. The cargo can be loaded onto the vessel, provided there is no other block in the terminal system. |
| Document on manifest accepted by Customs | DocumentCleared | Export manifest sent and accepted by Customs; cargo manifested. For your information: this is one of the steps to obtain the Confirmation of Exit for export. For transit cargo, this means that the cargo has successfully departed. |
| Document on manifest cancelled by Customs | DocumentUncleared |
The document that was reported on the manifest has been cancelled. The cargo is no longer manifested. Contact the agent if this document does need to be manifested. |
| Inspection notification | InspectionNotified | The document and associated equipment must be inspected by Customs. This may be a seal review, a scan or a physical review. The terminal and agent are responsible for the inspection. This results in an invoice (via the agent). |
| Inspection release after inspection | InspectionReleased | Inspection has been completed. The cargo can be loaded onto the vessel provided there is no other block in the terminal system. |
| Equipment is on the loading list | TransportEquipmentPlanned |
The equipment has been placed on the loading list by the agent; planned to be loaded onto the vessel. We often see that the loading list is only shared with Portbase shortly before loading. |
| Equipment removed from loading list | TransportEquipmentUnPlanned | Equipment has been removed from the loading list. |
| Equipment loaded onto vessel | TransportEquipmentLoaded | The terminal has sent a loading confirmation. The equipment has been loaded onto the vessel. |
| Vessel Estimated Time of Arrival Updated | VisitEtaUpdated | Estimated time when the inbound vessel will arrive at the terminal. |
| Vessel Estimated Time of Departure Updated | VisitEtdUpdated | Estimated time when the outbound vessel will depart from the terminal. |
| Vessel arrived | VisitArrived | This date can be used to determine when the vessel will depart |
| Vessel departed | VisitDeparted | The vessel has departed. This is one of the steps to obtain the Confirmation of Exit for export. For transit cargo, this means that the cargo has been successfully discharged |
| Cargo window added | CargoWindowAdded | The cargo window for the vessel visit on which this equipment is planned has been added. This is the window (opening/closing) within which the cargo may be delivered according to the terminal. |
| Cargo window updated | CargoWindowUpdated | The cargo window for the vessel visit has been changed by the terminal. |
Related to