Tracking event codes
Every carrier has their own set of tracking event codes. Each integration in Viya maps these to a standard set of tracking event codes. We provide both the carrier-specific codes and the standard codes so you can choose to use our experience or customize to fit your specific use-case.
This document provides an overview of the standard tracking event codes used by Viya.
If you are in need of a specific event code that is not listed here, please contact us.
Event Reason?
Carriers often clarify event types with an event reason. This means that when an application is configured to act on a specific event type, also the reason has to be taken into account.
In Viya, we have standardized this by using a single event code that combines the event type and event reason. This way, you can configure your application to act on a single event code instead of a combination.
The first part of the code is the event type, the second part clarifies that type so can be seen as an event reason.
If an event code has multiple event reasons, and the carrier provides a reason that is not part of the other event reasons, the other event suffix will be used. If no other event suffix exists, the event code without clarification is used.
Revision history
- 13-Dec-2024: Initial version based on Express & Road experience while comparing Edifact/GS1/Peppol standards
- 18-Dec-2024: Rephraze to use 1 standardized code instead of
event Typeandevent Reason
Standard tracking event codes
Booking phase
The pre-transport phase where initial data is shared between shipper and carrier to initiate the transport process
| Event Code | Description |
|---|---|
| dataReceived | Ordering / Booking / Despatch advice data has been received by the carrier. |
| bookingAccepted | Shipment order is accepted by the carrier through explicit confirmation |
| bookingRefused | Shipment order is refused by the carrier through explicit confirmation |
| bookingRemoved | Shipment order data is removed from carrier system, no specific reason provided |
| bookingRemovedOther | Shipment order data is removed from carrier system, other specific reason provided |
| bookingRemovedNoActivity | Shipment order data is removed from carrier system, Shipment was never handled |
| bookingRemovedIncorrectInformation | Shipment order data is removed from carrier system, Shipment information was incorrect |
Pickup phase
The phase that contains all activity related to the collection of the goods
| Event Code | Description |
|---|---|
| pickupScheduled | Pickup request is scheduled in carrier TMS system |
| pickupRescheduled | Pickup request got rescheduled with pickup location, new ETD determined |
| readyForPickup | Goods are ready for pickup |
| driverDespatchedForPickup | Driver is on its way to the pickup location |
| driverArrivedAtPickupLocation | Drive arrived on pickup location, did not yet start loading |
| loadingStartedAtPickupLocation | Loading started at the pickup location |
| loadingCompletedAtPickupLocation | Loading completed at the pickup location (doors are closed, driver did not depart yet) |
| pickupCompleted | Pickup completed: driver left the pickup location with goods loaded |
| pickupCompletedDamaged | Goods were handed over to the carrier in a damaged state |
| pickupCompletedIncomplete | Parts of the goods were missing at pickup |
| customerPickupScheduled | Pickup is scheduled for recipient to pickup the goods |
| customerPickupCompleted | Customer (or carrier ordered by customer) has picked up the goods |
| customerPickupCompletedDamaged | Customer (or carrier ordered by customer) has picked up the goods, goods were in damaged state |
| customerpickupcompletedincomplete | Customer (or carrier ordered by customer) has picked up the goods, not all goods were picked up |
| pickupFailedIncompleteInformation | The pickup request cannot be scheduled as information is missing from the request |
| pickupFailedOther | The pickup request did not complete successfully, no reason provided OR a reason provided that does not fit the other pickup_failed* events. |
| pickupFailedLocationClosed | The pickup request did not complete successfully because the driver did reach the destination within agreed timewindow but the location was closed |
| pickupFailedLocationCannotBeReached | The pickup request did not complete successfully because the driver could not reach the destination within the given date/time due to road infrastructure |
| pickupFailedGoodsNotReady | The pickup request did not complete successfully because the goods were not ready for pickup |
| pickupFailedGoodsLost | The pickup request did not complete successfully because the goods were lost, different from “goods_not_ready” as goods_lost indicates that goods were ready and are now lost. |
| pickupFailedDangerousGoods | The goods were not picked up as they are dangerous goods |
| pickupFailedBondedGoods | The goods were not picked up as they are bonded goods |
| pickupCancelledNoPartyIndicated | The pickup was cancelled, there is no indication which party initiated the cancellation |
| pickupCancelledByShipper | The pickup was cancelled, the shipper initiated the cancellation |
| pickupCancelledByCarrier | The pickup was cancelled, the carrier initiated the cancellation |
Transit phase
The phase that contains activity of the movement of goods between pickup and delivery location
| Event Code | Description |
|---|---|
| originHubArrived | Goods arrived in first hub after collection of goods |
| originHubDeparted | Goods departed from origin hub |
| transportMovement | Any event that indicates transport movement between hubs |
| transitHubArrived | Any event that signals the items arrived in an in-transit hub. This can also be an origin or destination hub in case it is unclear if no origin/destination indicator is provided by the carrier |
| transitHubArrivedMissing | Shipment was reported missing when it should have arrived in hub |
| transitHubArrivedLate | Shipment arrived in transit hub on later time than expected. Possible delay. |
| transitHubArrivedDamaged | Shipment arrived in hub in damaged state |
| transitHubActivity | Any event that indicates any activity inside an in-transit hub. This can also be an origin or destination hub in case it is unclear if no origin/destination indicator is provided by the carrier |
| transitHubDeparted | Any event that signals the items departed from an in-transit hub. This can also be an origin or destination hub in case it is unclear if no origin/destination indicator is provided by the carrier |
| transitHubDepartedLate | Shipment departed from transit hub on later time than expected. Possible delay |
| transitHubDepartedMissing | Shipment was reported missing when it should have departed from hub |
| transitHubDepartedDamaged | Shipment departed from hub in damaged state |
| destinationHubArrived | Goods arrived in last hub before delivery |
| destinationHubArrivedLate | Goods arrived in last hub before delivery on later time than expected. Possible delay |
| destinationHubArrivedMissing | Shipment was reported missing when it should have arrived at the hub |
| destinationHubArrivedDamaged | Goods arrived in last hub before delivery in damaged state |
| availableForCustomsClearance | Shipment arrived in customs area at the carrier |
| waitingForCustomsClearance | Shipment is pending customs clearance. Delivery times are potentially impacted |
| waitingForCustomsClearanceCustomsRequiresAdditionalInformation | Goods are held at customs area, shipper to provide more information to customs to continue inpection |
| releasedFromCustomsClearance | Shipment is released from customs |
| customsInspectionFailedOther | Customs inspection failed. Typically followed with exception on what happens next, eg: return_to_sender, customs_goods_destroyed or customs_additional_information_required |
| customsInspectionFailedMissingInformation | Customs inspection failed. Not enough information available for customs release. |
| customsInspectionFailedNotAllowed | Customs inspection failed, The type or quantity of goods do not pass customs inspection |
| destroyedCustomsInspectionResult | Goods are destroyed as they were not allowed to be imported |
| handoverToOtherCarrier | Goods were transferred from one carrier to another. Eg when handing over to a national carrier |
| damagedInTransit | Goods got damaged handling in transit/hub handling |
| damagedInTransitUnderInvestigationCarrier | goods are damaged, carrier is investigating cause / resolution |
| damagedInTransitUnderInvestigationShipper | goods are damaged, shipper is investigating cause / resolution |
Delivery phase
Phase were the goods are being delivered to the recipient
| Event Code | Description |
|---|---|
| deliveryDateConfirmedWithReceiver | Carrier has agreed a delivery time window with the receiver of the goods |
| deliveryDateConfirmedInCarrierPortal | Receiver of goods confirmed delivery window in carrier portal |
| deliveryArrivalNotice | Carrier has sent an arrival notification to the recipient to inform when the goods will be delivered portal |
| deliveryScheduled | A delivery date has been determined by the carrier (either manual or in agreement with recipient) |
| deliveryRescheduled | A new delivery date has been determined |
| deliveryRescheduledOnRequestOfRecipient | A new delivery date has been determined initiated by the recipient |
| deliveryRescheduledOnRequestOfCarrier | A new delivery date has been determined initiated by the carrier |
| deliveryRescheduledOnRequestOfShipper | A new delivery date has been determined initiated by the shipper |
| deliveryInformationChanged | The delivery information relating to the shipment was changed while in transit or in delivery. Changes can be various like: delivery address & service. |
| outForDelivery | Driver has departed from destination hub and on-its-way to the recipient. Some carriers provide this at start of the route of the driver, others provide this close to the delivery while driver is already in its route. |
| delivered | Goods delivered, no specific indication to which party |
| deliveredDamaged | Goods delivered, no specific indication to which party, (parts of) shipment is damaged. |
| deliveredPartly | Goods delivered, no specific indication to which party, only part of the goods have been delivered |
| deliveredPartlyDamagedRefused | Goods delivered, A part of the goods was damaged, the damaged part has been refused |
| deliveredOther | Goods delivered, specific other reason |
| deliveredWithPermissionToLeaveGoods | Goods delivered, at a place formerly agreed, were goods have been left unattended |
| deliveredConfirmationManuallyCreated | Goods delivered, Proof of delivery is manually created by other party than recipient |
| deliveredSurplus | Goods delivered, recipient indicates more was delivered as expected |
| deliveredWithDelay | Goods delivered, the original delivery time window was exceeded |
| deliveredAtNeighbour | Goods delivered at recipient’s neighbour instead of recipient |
| deliveredAtNeighbourDamaged | Goods delivered at recipient’s neighbour instead of recipient, (parts of) shipment is damaged. |
| deliveredAtNeighbourPartly | Goods delivered at recipient’s neighbour instead of recipient, only part of the goods have been delivered |
| deliveredAtPickupPoint | Goods delivered at carrier indicated pickup facility, for recipient to collect it from |
| deliveredAtPickupPointDamaged | Goods delivered at carrier indicated pickup facility, for recipient to collect it from, (parts of) shipment is damaged. |
| deliveredAtPickupPointPartly | Goods delivered at carrier indicated pickup facility, for recipient to collect it from, only part of the goods have been delivered |
| deliveredAtLocker | goods delivered at locker facility, for recipient to collect it from |
| deliveredAtLockerDamaged | goods delivered at locker facility, for recipient to collect it from, (parts of) shipment is damaged. |
| deliveredAtLockerPartly | goods delivered at locker facility, for recipient to collect it from, only part of the goods have been delivered |
| deliveredWithPicture | goods delivered at consignee, including picture where goods were left |
| deliveredWithPictureDamaged | goods delivered at consignee, including picture where goods were left, (parts of) shipment is damaged. |
| deliveredWithPicturePartly | goods delivered at consignee, including picture where goods were left, only part of the goods have been delivered |
| collectionFromPickupPoint | goods collected from pickup point by recipient |
| collectionFromPickupPointDamaged | goods collected from pickup point by recipient, (parts of) shipment is damaged. |
| collectionFromPickupPointFailedRefusedByRecipient | Goods were refused by the customer, while goods are at pickup point |
| collectionFromPickupPointFailedInvalidIdentification | Goods were refused to handover by the pickup point handler as recipient failed to identify |
| collectionFromPickupPointFailedUnclaimed | Goods in a locker/pickup point have not been claimed by recipient within period |
| deliveryFailedLocationUnavailable | Delivery failed because the delivery location could not be reached |
| deliveryFailedContactCarrier | Carrier contact required to agree after delivery failed |
| deliveryFailedAbsentRecipient | Delivery failed because the consignee was not at the recipient location |
| deliveryFailedRecipientClosed | Delivery failed because the recipient location was closed |
| deliveryFailedOther | Delivery failed, no specific reason provided |
| deliveryFailedAdditionalEquipmentRequired | Delivery failed, delivery requires additional equipment |
| deliveryFailedRefusedByRecipientRequestedOtherDeliveryDate | Delivery failed because the recipient refused to accept the goods as they want to plan another delivery date |
| deliveryFailedRefusedByRecipient | Delivery failed because the recipient refused to accept the goods |
| deliveryFailedRefusedByRecipientIncorrectContactDetails | Delivery failed because the recipient refused to accept the goods because the contact details were incorrect/unknown |
| deliveryFailedDamaged | Delivery failed because the goods were damaged |
| deliveryFailedRefusedByRecipientNotOrdered | Delivery failed because recipient did not order the goods and therefore refused them at delivery. |
| deliveryFailedRefusedByRecipientMissingDocuments | Delivery failed because documents were missing, therefore recipient refused goods at delivery |
| deliveryFailedRefusedByRecipientInventory | Delivery failed because recipient refused shipment due to inventory reasons |
| deliveryFailedRefusedByRecipientLateDelivery | Delivery failed because recipient refused shipment due missing the agreed delivery window |
| deliveryFailedRefusedByRecipientShipmentIncomplete | Delivery failed because recipient refused the shipment as it was not complete |
| deliveryFailedRefusedByRecipientCancelled | Delivery failed because recipient refused the shipment as it was cancelled before |
| deliveryFailedWaitingTimeExceeded | Delivery failed because the waiting time at consignee was exceeded |
| deliveryFailedRecipientMoved | Delivery failed because the recipient was no longer active on that location |
Exceptions
Exceptions that can occur in any phase of the journey
| Event Code | Description |
|---|---|
| cancelledByShipper | Shipment was cancelled by shipper between pickup and delivery, goods will be returned to sender |
| cancelledByCarrier | Shipment was cancelled by carrier between pickup and delivery, goods will be returned to sender |
| lost | Missing goods are are confirmed lost |
| returnToSenderUncollectedFromPickupPoint | Goods returned to sender from pickup point, after not being collected within period |
| returnToSenderRefusedAtDelivery | Goods returned to sender as recipient refused to accept the goods |
| returnToSenderUnknownAddress | Goods returned to sender as carrier could not find indicated address |
| returnToSenderOther | Goods returned to sender, no specific or other indication why |
| returnToSenderDamaged | Goods are returned to sender because they are damaged |
| returnToSenderIncident | Goods are returned to sender because they were involved in an incident |
| returnToSenderCancelledByShipper | Goods are return to sender because the shipper cancelled the shipment |
| returnToSenderCustomsInspectionResult | Goods are returned to sender as something was missing/incorrect during customs inspection |
| delayedAdministrativeRectification | Shipment is delayed because information about the shipment was incorrect and needed to be corrected |
| delayedBankHoliday | Shipment is delayed because of bank holiday within the network |
| delayedDeliveryAppointmentRequired | Shipment is delayed because a delivery appointment needs to be made |
| delayedEquipmentFailure | Shipment is delayed because equipment managed by the carrier had a failure/breakdown/issue |
| delayedForceMajor | Shipment is delayed due to reasons out of control of shipper/carrier/recipient |
| delayedIncorrectLabelling | Shipment is delayed because the labelling on the goods was incorrect, can be goods labels or shipping labels |
| delayedIncorrectAddress | Pickup or Delivery of the goods was delayed due to incorrect address information |
| delayedIndustrialDispute | Shipment is delayed due to an industrial dispute |
| delayedLackOfTransportCapacity | Shipment delayed due to insufficient transport capacity at the carrier |
| delayedMissingDocuments | Shipment delayed due to critical documents missing |
| delayedWrongRouting | Shipment is delayed as it was routed incorrectly within carrier network |
| delayedTemperatureExceeded | Shipment is delayed as the allowed temperature for transportation has exceeded. Resolution steps need to be taken. |
| delayedWaitingForEdi | Shipment is delayed because EDI is still to be received |
| delayedMissedConnection | The goods missed a scheduled connection. Delivery timelines are potentially impacted |
| delayedOther | Delivery timelines are impacted, no specific reason provided |
| delayedAccident | Goods are delayed due to equipment malfunctioned or got into an accident |
| delayedContactCarrierMissingInformation | Carrier needs more information to continue transit/delivery: eg address invalid |
| delayedContactCarrier | Carrier contact required, no specific reason provided |
| missingPartly | Part of a shipment is missing |
| missingUnderInvestigation | Shipment is reported missing, being investigated for followup action |
| destroyedHeavilyDamaged | Goods are destroyed as they were damaged to a degree it could not be transported anymore |
| destroyedOnRequestOfShipper | Goods are destroyed on request of the shipper |
| exceptionOther | Exception occurred, no existing event codes matches the exception |
| other | No existing event code matches the carrier event type or reason |