Skip to main content
Skip table of contents

Cargo Status (NOTN)

If you wish to use the api outlined below, please see the data user documentation here. If wish to become a data provider, please create a support ticket.

Introduction

Transparency in the supply chain is critical in todays global trade. IPCSAs “Cargo Status” API allows Port Community Systems and Single Window Operators to share information about Cargo Status in the ports they operate in.

The Cargo Status API has been developed by IPCSA, and has identified the key data elements required to provide visibility and transparency on cargo in Ports. This allows PCS and Single Window users to plan their supply chains with real time information. And your users planning of their cargo movements.

This Cargo Status API allows them to provide additional added value information to their users, when it relates to port to port and cross border exchange of information. It will allow for requests for a real time overview of the status of cargo from Gate in and Out times, to Customs Status and loading and discharge information.

Api Request

Transparency in the supply chain is critical in todays global trade. IPCSAs “Cargo Status” API allows Port Community Systems and Single Window Operators to share information about Cargo Status in the ports they operate in.

The Cargo Status API has been developed by IPCSA, and has identified the key data elements required to provide visibility and transparency on cargo in Ports. This allows PCS and Single Window users to plan their supply chains with real time

Base Urls

A data consumer accesses the provider system through the NxtPort NOTN system.

  • Base URL for Acceptance: https://api-uat.nxtport.eu/ipcsa-trackandtrace/v4

  • Base URL for Production: https://api.nxtport.eu/ipcsa-trackandtrace/v4

HTTP verb: GET

Endpoint: {{BaseUrl}}/shipments_info

Headers

Name

Mandatory

Description

Authorization

YES

NxtPort JWT access token

Ocp-Apim-Subscription-Key

YES

NxtPort Subscription Key

Parameters

Two data elements are mandatory to allow requests, with an additional four for more detailed parameter search which are optional for information to be made:

  • IdRequestor - Text reference of requestor user

  • Port - Locode of port (one PCS can manage more than a port)

  • A combination of 

    • IdEquipment - Container number

    • BLNumber - BL Number

    • BookingNumber - Booking number

    • EstimatedDate - Estimated Time Arrival  or departure (+/- 3 days) Format: yyyy-MM-dd

Response

In return, the NoTN platform will, in case the data consumer and data provider have a validated data-sharing agreement, return the following information: 

Mandatory

  • Port - Locode for the Port

  • IdEquipment - Container number

  • IdPortCall - Identification of the Journey for the PCS.

Optional

  • Empty - Empty / Full

  • Carrier - SCAC CODE

  • TypeOfEquipment - ISO - CARS

  • BLNumber - BL number

  • BookingNumber string - Booking number

  • GrossWeight - Gross weight

  • NetWeight - Net weight

  • DangerousGoods - Dangerous Goods

  • Transhipment - Transhipment

  • CustomsStatus - ,INPROCESS,INTERRUPTED,CLEARED

  • CustomsClearanceDateTime - Customs clearance date/time.

  • GateInDateTime - Gate in date/time

  • GateOutDateTime - Gate out date/time:

  • LoadedDateTime - Loaded date/time

  • DischargedDateTime - Discharged date/time.

  • EmptyDeliveredDateTime - Empty delivered date/time.

  • InboundMeansOfTransportType - VESSEL/TRUCK/RAIL/BARGE/OTHER

  • InboundMeansOfTransportName - Vessel name, truck plate, etc…

  • OutboundMeansOfTransportType - VESSEL/TRUCK/RAIL/BARGE/OTHER

  • OutboundMeansOfTransportName - Vessel name, truck plate, etc…

  • TerminalOperatorName - Terminal operator name

  • ReleaseOrderAvalaible:

  • TerminalOperatorCode:

  • InboundTerminalOperatorName:

  • InboundTerminalOperatorCode:

  • OutboundTerminalOperatorName:

  • OutInboundTerminalOperatorCode:

  • InboundCustomsStatus:

  • InboundCustomsClearanceDateTime:

  • OutboundCustomsStatus:

  • OutboundCustomsClearanceDateTime:

  • PlaceOfDestination:

  • PlaceOfOrigin:

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.