API Reference

Events names

The event names will be conducted from the combination of the eventType, and the locationTypeCode, according to the “names table” below. ###

Event name structure for equipment and transport events:

Equipment / transport Event type name-at-Location type name

Event name structure for shipment events:

shipment event type name

Equipment events

equipment_event_type_codeequipment_event_type_name
LOADLoad
DISCDischarge
GTINGate in
GTOTGate out
STUFStuffing
STRPStripping
PICKPick-up
DROPDrop-off
INSPInspected
RSEAResealed
RMVDRemoved
AVPUAvailable for Pick-up
AVDOAvailable for Drop-off
CUSSCustoms Selected for Scan
CUSICustoms Selected for Inspection
CUSRCustoms Released
WAYPWay Point Crossed

Transport events

transport_event_type_codetransport_event_type_name
ARRIArrival
DEPADeparture

Shipment events

shipment_event_type_codeshipment_event_type_name
RECEReceived
DRFTDrafted
PENAPending Approval
PENUPending Update
PENCPending Confirmation
REJERejected
APPRApproved
ISSUIssued
SURRSurrendered
SUBMSubmitted
VOIDVoid
CONFConfirmed
REQSRequested
CMPLCompleted
HOLDOn Hold d
RELSReleased
CANCCancelled

Location type codes

shipmentLocationTypeCodelocation_type_name
PREPOL / ORIGINPREPOL
POLPOL
TSPTSP
PODPOD
POSTPOD / DESTPOSTPOD

Examples

equipmentEventTypeCode/transportEventTypeCode/shipmentEventTypeCodelocationTypeCodeEvent name
LOADPREPOLLoaded at PREPOL
GTOTPOSTPODGate Out at POSTPOD
ARRIPODArrival at POD
RECE-Received
AVPUPREPOLAvailable for Pick-up at PREPOL
DEPATSPDeparture at TSP

API

The API now includes fields from which the users can create the end-to-end milestone exposure, in the same manner mentioned above.

In addition, other relevant details are available to the customers in the API which allow a deeper understanding of the events:

  • equipmentEventTypeCode - an event code describing the transition made to the contianer
  • transportEventTypeCode - an event code describing the transport movement (vessel, truck, rail or barge)
  • shipmenteEventTypeCode - an event code describing a formal transaction to the shipment
  • shipmentLocationTypeCode - a code describing the shipment location at time of the event
  • emptyIndicatorCode - an indication wether the container is loaded or empty

The codes are available in the following structure:
GQL

end pointexample query
GQLquery ExampleQuery {
id
trackedShipments {
data {
shipment {
status {
events {
equipmentEventTypeCode
transporttEventTypeCode
emptyIndicatorCode
shipmentLocationTypeCode
shipmenteEventTypeCode
}
}
}
}
}
}
}
}
webhookdata {
events
[
equipmentEventTypeCode
transporttEventTypeCode
emptyIndicatorCode
shipmentLocationTypeCode
shipmenteEventTypeCode
]
}