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_code | equipment_event_type_name |
---|---|
LOAD | Load |
DISC | Discharge |
GTIN | Gate in |
GTOT | Gate out |
STUF | Stuffing |
STRP | Stripping |
PICK | Pick-up |
DROP | Drop-off |
INSP | Inspected |
RSEA | Resealed |
RMVD | Removed |
AVPU | Available for Pick-up |
AVDO | Available for Drop-off |
CUSS | Customs Selected for Scan |
CUSI | Customs Selected for Inspection |
CUSR | Customs Released |
WAYP | Way Point Crossed |
Transport events
transport_event_type_code | transport_event_type_name |
---|---|
ARRI | Arrival |
DEPA | Departure |
Shipment events
shipment_event_type_code | shipment_event_type_name |
---|---|
RECE | Received |
DRFT | Drafted |
PENA | Pending Approval |
PENU | Pending Update |
PENC | Pending Confirmation |
REJE | Rejected |
APPR | Approved |
ISSU | Issued |
SURR | Surrendered |
SUBM | Submitted |
VOID | Void |
CONF | Confirmed |
REQS | Requested |
CMPL | Completed |
HOLD | On Hold d |
RELS | Released |
CANC | Cancelled |
Location type codes
shipmentLocationTypeCode | location_type_name |
---|---|
PREPOL / ORIGIN | PREPOL |
POL | POL |
TSP | TSP |
POD | POD |
POSTPOD / DEST | POSTPOD |
Examples
equipmentEventTypeCode/transportEventTypeCode/shipmentEventTypeCode | locationTypeCode | Event name |
---|---|---|
LOAD | PREPOL | Loaded at PREPOL |
GTOT | POSTPOD | Gate Out at POSTPOD |
ARRI | POD | Arrival at POD |
RECE | - | Received |
AVPU | PREPOL | Available for Pick-up at PREPOL |
DEPA | TSP | Departure 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 point | example query |
---|---|
GQL | query ExampleQuery { id trackedShipments { data { shipment { status { events { equipmentEventTypeCode transporttEventTypeCode emptyIndicatorCode shipmentLocationTypeCode shipmenteEventTypeCode } } } } } } } } |
webhook | data { events [ equipmentEventTypeCode transporttEventTypeCode emptyIndicatorCode shipmentLocationTypeCode shipmenteEventTypeCode ] } |