/
Track & Trace to API data mapping

Track & Trace to API data mapping

 

Summary

This document maps Track & Trace data fields to the equivalent fields in the Container Visit and Container visit event APIs.

 

Track & Trace high level view

Imports and Arriving Transhipments

image-20250105-231115.png

Track & Trace field

Container Visit API field

Container Visit Event API field / event type name

Track & Trace field

Container Visit API field

Container Visit Event API field / event type name

Port

portCode

partnerPortCode

Container

containerNumber

containerNumber

Category

category

containerVisitTypeCode

Vessel Visit

inboundVesselName + containerOperatorVoyageId

inboundVesselName

Vessel ETA/ATA

inboundVesselPublishedArrivalDatetime + inboundVesselActualArrivalDatetime

-

Location

containerLocation

containerVisitEventLocation

Status

containerStatus

containerStatus

MT Return

emptyReturnDepotCode + emptyReturnDepotName

-

ISO

containerIsoTypeCode

containerIsoTypeCode

Weight (Kg)

declaredWeight

-

Security Check

securityCheck

-

Cleared

-

‘Cleared’ event type

Impediment Groups

-

-

Temp

requiredTemperature

-

Hazard

hazardCount + hazards

-

Over Size

oversizeCount + oversizes

-

Last Free Time

lastFreeDatetime

‘LFT Changed’ event type

 

Exports and Departing Transhipments

image-20250105-224907.png

Track & Trace field

Container Visit API field

Container Visit Event API field / event type name

Track & Trace field

Container Visit API field

Container Visit Event API field / event type name

Port

portCode

partnerPortCode

Container

containerNumber

containerNumber

Category

category

containerVisitTypeCode

Vessel Visit

inboundVesselName + containerOperatorVoyageId

outboundVesselName

Vessel ETA/ATA

outboundVesselPublishedArrivalDatetime + outboundVesselActualArrivalDatetime

-

Location

containerLocation

containerVisitEventLocation

Status

containerStatus

containerStatus

Booking Reference

bookingReference

bookingReference

ISO

containerIsoTypeCode

containerIsoTypeCode

Weight (Kg)

declaredWeight

-

Cleared

-

‘Cleared’ event type

Impediment Groups

-

-

Gate-In

seaPortArrivalDatetime

‘Gate In’ event type

Seaport Commence Receival

-

-

Seaport Receival Cut-Off

-

-

Temp

requiredTemperature

-

Hazard

hazardCount + hazards

-

Over Size

oversizeCount + oversizes

-

Booking Discr.

-

‘Booking Discrepancy’ event type

 

Depot

Track & Trace field

Container Visit API field

Container Visit Event API field / event type name

Track & Trace field

Container Visit API field

Container Visit Event API field / event type name

Depot

-

containerVisitEventLocation

Container

containerNumber

containerNumber

Location

containerLocation

containerVisitEventLocation

Status

containerStatus

containerStatus

ISO

containerIsoTypeCode

containerIsoTypeCode

Weight (Kg)

declaredWeight

-

Gate-In

receivedDatetime

‘Gate In’ event type

Gate-Out

deliveredDatetime

‘Gate Out’ event type

 

Track & Trace detail view

Imports and Arriving Transhipments

Track & Trace field

Container Visit API field

Container Visit Event API field / event type name

Track & Trace field

Container Visit API field

Container Visit Event API field / event type name

Container

containerNumber

containerNumber

ISO

containerIsoTypeCode

containerIsoTypeCode

Declared Weight (Kg)

declaredWeight

-

Declared Weight VGM?

declaredWeightVgm

-

Commodity

commodityCode

-

Status

containerStatus

containerStatus

Seals

seals

-

Attached Equipment

attachedEquipment

-

Refrigeration

Temperature

requiredTemperature

-

Vent Setting

ventSetting

-

Humidity

humidityPercent

-

Oxygen

o2Percent

-

Carbon Dioxide

cO2Percent

-

Packed Off Power

packedOffPowerDatetime

-

Packed Off Power Temp

PackedOffPowerTemp

-

Max Time Off Power

maxHoursAllowedOffPower

-

Target Connect Date

-

-

Visit Details

Port

portCode

partnerPortCode

Category

category

containerVisitTypeCode

Vessel Name

inboundVesselName

inboundVesselName

Voyage

containerOperatorVoyageId

-

Location

containerLocation

containerVisitEventLocation

Line Operator

containerOperatorCode + containerOperatorName

-

Load Port

loadPortCode + loadPortName

-

Discharge Port

dischargePortCode + dischargePortName

‘Discharge’ event type

Destination Port

destinationPortCode

-

Last Free Time

lastFreeDatetime

‘LFT Changed’ event type

VBS Slot Date/Time

vbsSlotDatetime

‘VBS Changed’ event type

Seaport Departure Mode

-

'Gate Out' event type containerVisitEventValue1

Seaport Outbound Carrier

seaPortCarrier

'Gate Out' event type containerVisitEventValue2

Inland Port Outbound Carrier

inlandPortCarrier

'Gate Out' event type containerVisitEventValue2

Empty Return Depot

emptyReturnDepotCode + emptyReturnDepotName

-

Security Check

securityCheck

-

Impediments

stops

-

Event Details

Last Updated

lastUpdated

-

Activated Date

activatedDate

‘Active’ event type

Vessel ETA/ATA

inboundVesselPublishedArrivalDatetime + inboundVesselActualArrivalDatetime

-

Vessel ETD/ATD

inboundVesselPublishedDepartureDatetime + inboundVesselActualDepartureDatetime

-

Customs Release

customsReleaseDatetime

‘Customs Release’ event type

Line Release

lineReleaseDatetime

‘Line Release’ event type

MPI Release

mpiReleaseDatetime

‘MPI Release’ event type

Discharge Date

dischargedDatetime

‘Discharge’ event type

Seaport Gate In Date

seaPortArrivalDatetime

'Gate In' event type

Inland Port Gate In Date

inlandPortArrivalDatetime

'Gate In' event type

Seaport Gate Out Date

seaPortGateOutDateTime

'Gate Out' event type

Inland Port Gate Out Date

inlandPortGateOutDateTime

'Gate Out' event type

 

Exports and Departing Transhipments

Track & Trace field

Container Visit API field

Container Visit Event API field / event type name

Track & Trace field

Container Visit API field

Container Visit Event API field / event type name

Container

containerNumber

containerNumber

ISO

containerIsoTypeCode

containerIsoTypeCode

Declared Weight (Kg)

declaredWeight

-

Declared Weight VGM?

declaredWeightVgm

-

Commodity

commodityCode

-

Status

containerStatus

containerStatus

Seals

seals

-

Attached Equipment

attachedEquipment

-

Refrigeration

Temperature

requiredTemperature

-

Vent Setting

ventSetting

-

Humidity

humidityPercent

-

Oxygen

o2Percent

-

Carbon Dioxide

cO2Percent

-

Packed Off Power

packedOffPowerDatetime

-

Packed Off Power Temp

PackedOffPowerTemp

-

Max Time Off Power

maxHoursAllowedOffPower

-

Target Connect Date

-

-

Visit Details

Port

portCode

partnerPortCode

Category

category

containerVisitTypeCode

Vessel Name

outboundVesselName

outboundVesselName

Voyage

containerOperatorVoyageId

-

Location

containerLocation

containerVisitEventLocation

Line Operator

containerOperatorCode + containerOperatorName

-

Booking Reference

bookingReference

bookingReference

Load Port

loadPortCode

‘Load’ event type

Discharge Port

dischargePortCode

-

Destination Port

destinationPortCode

-

VBS Slot Date/Time

vbsSlotDatetime

‘VBS Changed’ event type

Seaport Inbound Carrier

seaPortInboundCarrier

'Gate In' event type containerVisitEventValue2

CEDO Number

cedoNumberCode

‘CEDO Release’ event type

Impediments

stops

-

Event Details

Last Updated

lastUpdated

-

Activated Date

activatedDate

‘Active’ event type

Vessel ETA/ATA

outboundVesselPublishedArrivalDatetime + outboundVesselActualArrivalDatetime

-

Vessel ETD/ATD

outboundVesselPublishedDepartureDatetime + outboundVesselActualDepartureDatetime

-

CEDO Release

-

‘CEDO Release’ event type

Seaport Gate In Date

seaPortArrivalDatetime

‘Gate In’ event type

Inland Port Gate In Date

inlandPortArrivalDatetime

‘Gate In’ event type

Seaport Gate Out Date

seaPortGateOutDateTime

‘Gate Out’ event type

Load Date

loadDatetime

‘Load’ event type

Inland Port Gate Out Date

inlandPortGateOutDateTime

‘Gate Out’ event type

 

Depot

Track & Trace field

Container Visit API field

Container Visit Event API field / event type name

Track & Trace field

Container Visit API field

Container Visit Event API field / event type name

Container

containerNumber

containerNumber

ISO

containerIsoTypeCode

containerIsoTypeCode

Declared Weight (Kg)

declaredWeight

-

Status

containerStatus

containerStatus

Depot

-

containerVisitEventLocation

Category

category

containerVisitTypeCode

Location

containerLocation

containerVisitEventLocation

Line Operator

containerOperatorCode + containerOperatorName

containerOperatorSCACCode

Last Updated

lastUpdated

-

Activated Date

activatedDate

‘Active’ event type

Depot Gate In Date

receivedDatetime

'Gate In' event type

Depot Gate Out Date

deliveredDatetime

‘Gate Out’ event type

Related content

API - FAQs
More like this
Container Visits Search
Container Visits Search
More like this
Track and Trace
Track and Trace
More like this

© PortConnect 2023