Data Consumers

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

Request parameters

Documentation on how to implement this API can be found here. 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:

Data providers

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.

This Cargo Status API allows data providers to provider data relating to the ports they operate in.

Data elements

The following data elements are either mandatory or optional depending on the ability of the Data Provider to provide the data as set out in the table for data providers list on the NoTN Website.

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:

Become a Data Provider

Subscribe to this API as a Data Provider, if you agree with the Terms and Conditions for the Cargo Status API for both the Data Consumer and as the Data Provider. If, as a Data Provider, you have additional Terms and Conditions over and above the standard Terms of Conditions these have to be shown in the Data Providers Matrix on the Data Consumers page. Create a support ticket to let us know!

Onboarding

In order to participate as a data provider: 

• Register to the NoTN platform, if you haven't already done so. 
• Read the Getting Started guidelines
• Initiate the data provider setup by creating a support ticket
• Implement the integration guidelines that can be found in the Documentation
• Make a digital handshake with your IPCSA PCS partners