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 process.
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.
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 - 07-Mar-2025: Changed list to include more processes within the transport journey
Why standardize tracking events?
Tracking events can be categorized in many ways, how they are categorized depends on the carrier and the challenges you need to solve. In Viya, we have standardized the tracking events to help you with the following questions:
When is the expected delivery?
For most receivers this is the most important question so they can plan their attendance, receiving activities, production schedule etc.. Throughout the journey, the expected delivery date can change due to various reasons. Some examples include:
- The recipient requires a delivery appointment to be made
- Exceptions occurr, causing a delay in the delivery: eg: equipment failure, incorrect labelling, wrong routing, temperature exceeded, bank holidays, industrial disputes, etc..
- Customs requires additional information, goods are held at customs area
- Network issues like missed connections, lack of transport capacity, etc..
Although the exact delivery moment might not be known if an event happens: knowing that the originally anticipated delivery date is not going to be met is important for the recipient to plan accordingly.
Who should take action?
In general the carrier is expected to take action when the transportation journey begins but.. exceptions can happen where either the shipper or recipient has to take action. Some examples include:
- The shipper has to provide additional information to customs
- The recipient has to provide a delivery window
- The recipient has to provide additional information to the carrier
- Goods are damaged, will they still be accepted by the recipient?
How is my shipping performance?
Agreements between shipper and carrier should include performance indicators. We typically see a delivery performance, but they can be broken down to a ‘pickup performance’, ‘deliver performance’ and ‘data availability’.
By using the tracking events, it is possible to indicate if an event puts the ownership of a delay in the hands of the carrier, the shipper or the recipient. Also valuable insights in customer behavior (refusals/out of home) and shipper accuracy (information completeness/labeling/data quality) can be derived.
When should I invoice my customer?
Some examples include:
- For returns you can settle already upon reporting the return, or only when the return is handed over to the carrier, after receiving the goods or after a final inspection.
- For outbound shipments you can invoice for example: upon booking, upon pickup, upon delivery, or upon confirmation of delivery.
How do I get proof of export?
To apply for a reduced VAT rate or to claim back VAT, you need to prove that the goods have left the country or European Union. Typically delivery events outside the country are used as input for a proof of export.
Event code breakdown
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. With the questions we have outlined above we crafted a list of codes that combine:
process phase: Which part of a transport journey is the event related to? Egbooking,customs,transit,delivery, etc.state: what is the state for the process phase? egrequested,planned,completed, etc.state detail: often the reason why the state is set. Here the state & event reason are combined.responsibility: if a pickup or delivery is delayed: who is considered responsible for the delay?
The result is a standardized single event code that combines all these factors. This way, you can configure your application to act on a single event code instead of a combination.
Standard tracking event codes
Booking
The booking phase where initial data is shared between shipper and carrier to initiate the transport process
| Event Code | Description |
|---|---|
| bookingRequested | 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 |
| bookingFailed | Shipment booking failed |
| bookingCancelledNoActivity | Shipment booking is cancelled because there was no operational activity executed for the requested shipment |
| bookingCancelledIncorrectInformation | Shipment booking is cancelled because information in the booking was incorrect or incomplete |
| bookingCancelledOther | Shipment booking is cancelled, other or no reason specified |
Booking change
When a booking was initially made but changes are requested by the shipper or carrier
| Event Code | Description |
|---|---|
| bookingChangeRequestedAddressChange | A request is made to change the shipment after it was originally booked |
| bookingChangeRequestedServiceLeveLChange | A request is made to change services related to the shipment |
| bookingChangeRequestedIncotermChange | A request is made to change the incoterm of the shipment |
| bookingChangeRequestedWeightOrDimensionChange | A request is made to update the weights or dimensions of the shipment |
| bookingChangeRequestedOther | A request is made to update the shipment with other or no reason specified. |
| bookingChangeAccepted | The requested change to the shipment is accepted by the carrier, the change still has to be completed |
| bookingChangeRefusedCannotChangeAnymore | Booking change is refused as the shipment has passed its point-of-no-return |
| bookingChangeRefusedOther | Booking change is refused with other or no reason specified |
| bookingChangeFailed | The requested change to the shipment failed |
| bookingChangeCompleted | Changes to the booking where completed succesfully |
| bookingChangeCancelled | The request to change the shpiment is cancelled |
Cash on delivery
Getting more rare but.. in case cash on delivery is desired it should be measurable:
| Event Code | Description |
|---|---|
| cashOnDeliveryRequested | Cash on delivery amount is due / requested for the shipment |
| cashOnDeliveryFundsCollected | The funds required for cash on delivery have been collected/obtained from the recipient |
| cashOnDeliveryFailed | Cash on delivery collection failed |
| cashOnDeliveryFundsTransferred | The cash on delivery amount collected from the recipient is transferred to the shipper |
Claim
For those carriers who report claims progress through their tracking events. The process of claiming is started when there is a dispute on the service provided by the carrier.
| Event Code | Description |
|---|---|
| claimRequested | Shipper or recipient filed a claim with carrier on service of shipment |
| claimPlanned | carrier planned research for claim |
| claimStarted | carrier started claim procedure |
| claimDelayed | claim procedure is delayed |
| claimDelayedAdditionalInformationRequiredFromShipper | additional information is required from the shipper to continue with the claim procedure |
| claimDelayedAdditionalInformationRequiredFromRecipient | additional information is required from the shipper to continue with the claim procedure |
| claimRejected | claim is rejected by the carrier |
| claimAccepted | claim is accepted by the carrier |
| claimCancelledByShipper | claim is cancelled by shipper |
| claimCancelledByCarrier | claim is cancelled by carrier |
| claimCancelledByRecipient | claim is cancelled by recipient |
| claimReembursed | Funds related to the claim are reembursed by the carrier to the shipper |
Customs
When a shipment passes a customs border, export & import processes can affect the throughput of the shipment.
| Event Code | Description |
|---|---|
| customsAvailable | Goods are available for customs processing |
| customsInProgress | Customs processing is in progress |
| customsDelayedIncorrectOrMissingInformation | Customs procedures are delayed as information about the shipment is missing/incomplete or incorrect |
| customsDelayedIncomplete | Customs procedures are delayed as not all goods are available for processing |
| customsDelayedPendingDutiesTaxesPaymentRecipient | Recipient need to pay duties and/or taxes before shipment can be released |
| customsDelayedPendingDutiesTaxesPaymentShipper | Shipper need to pay duties and/or taxes before shipment can be released |
| customsDelayedCarrierDelayed | Carrier delayed in providing request/information/goods for customs clearance |
| customsDelayedAdditionalInformationRequiredRecipient | Customs procedures are delayed as recipient nees to provide additional information for clearance purposes |
| customsDelayedOther | Customs procedures are delayed |
| customsFailed | Customs processing failed, no customs approval available |
| customsFailedDestroyedByRegulation | Goods failed customs inspection and where destroyed as per government agency instructions |
| customsReleased | Released from customs, goods can continue journey |
Delivery
The most commonly used phase in the tracking process. Here the deliveryCompleted is the key event to indicate the goods are delivered.
| Event Code | Description |
|---|---|
| deliveryPlannedRescheduledOnRequestOfRecipient | Delivery moment of the shipment is rescheduled on request of recipient |
| deliveryPlannedRescheduledOnRequestOfShipper | Delivery moment of the shipment is rescheduled on request of shipper |
| deliveryPlannedRescheduledOnRequestOfCarrier | Delivery moment of the shipment is rescheduled on request of shipper |
| deliveryPlannedRescheduled | Delivery moment of the shipment is rescheduled, no specific indication if carrier/recipient or shipper initiated it |
| deliveryPlannedArrivalNoticeProvided | Delivery moment is communicated to recipient in form of an arrival notice (ASN) |
| deliveryPlannedOther | Delivery planned, no specific information provided |
| deliveryEtaUpdate | Expected date/time of delivery updated, includes new timewindow. Eg Tomorrow between 8:00-12:00, For carrier performance this is not applicable as the reason for etaUpdate should be from another event that happened. |
| deliveryInProgressOutForDelivery | Goods are in their last vehicle towards the receiver. This can have an update eg 10:12-11:12 |
| deliveryInProgressShortDistance | Goods are in their last vehicle towards the receiver, it is a very short distance to the receiver |
| deliveryInProgressArrived | Delivery is in progress, goods arrived at destination but are not available for the recipient |
| deliveryInProgressUnloaded | Delivery is in progress, goods haven been unloaded but are not available to the receipient |
| deliveryInProgress | |
| deliveryCompletedPartly | Delivery completed partly, no specific reason provided why not all goods where delivered |
| deliveryCompletedPartlyMissing | Delivered party, as not all goods where accounted for at delivery |
| deliveryCompletedPartlyDamaged | Recipient refused part of the delivery as that part was damaged, rest was delivered. |
| deliveryCompletedPartlyCustomerPickup | Recipient reported part of the goods where delivered for a shipment where the pickup was arranged by the recipient |
| deliveryCompleted | Delivered, no details provided |
| deliveryCompletedAtNeighbour | Delivered at neighbour |
| deliveryCompletedAtReceiver | Delivered at recipient |
| deliveryCompletedAtCommercialLocation | Delivered in a commercial location (store/office etc..) |
| deliveryCompletedAtPlaceUnattended | Delivered at a place where it was left unattended, no signature received. Eg on frontPorch, garage, side of house etc.. |
| deliveryCompletedWithPermissionToLeaveGoods | Delivered, left on a location without obtaining signature as this was indicated in the order |
| deliveryCompletedManuallyRegistered | Delivered, registered the delivery event manually |
| deliveryCompletedOther | Delivered, other detail provided |
| deliveryCompletedConsgineeIndicatesSurplus | Delivered goods according to request, but recipient indicates too many items have been delivered |
| deliveryCompletedConsigneeIndicatesMissing | Delivered goods according to request, but recipient indicates items missing from what has been deliverd |
| deliveryCompletedDelayed | Shipment delivered with a delay |
| deliveryFailedLocationUnavailable | The delivery location could not be reached (eg roadworks, parade etc..) |
| deliveryFailedContactCarrier | delivery failed, contact the carrier for more information |
| deliveryFailedAbsentRecipient | There was no recipient available at the time of the delivery attempt |
| deliveryFailedRecipientClosed | The recipients location was closed/business closed at the time of the delivery attempt |
| deliveryFailedNoValidRecipient | The delivery failed as there was nobody allowed to receive the goods, eg adult signature required or named delivery only |
| deliveryFailedAccessCodeMissing | To complete delivery, an access code was required. The driver did not have access/knew the correct access code |
| deliveryFailedOther | Delivery failed, a no/other specific information about the delivery failure was provided |
| deliveryFailedAdditionalEquipmentRequired | Delivery failed as additional equipment was required to complete the delivery |
| deliveryFailedRefusedByRecipientRequestedOtherDeliveryDate | Delivery failed as the recipient requested a different delivery date |
| deliveryFailedRefusedByRecipient | Delivery failed as recipient refused to receive the goods |
| deliveryFailedRefusedByRecipientIncorrectContactDetails | Delivery failed as recipient refused the delivery due to incorrect contact details provided |
| deliveryFailedDamaged | Delivery failed as goods where damaged |
| deliveryFailedRefusedByRecipientDamaged | Recipient refused complete shipment as it was damaged |
| deliveryFailedRefusedByRecipientNotOrdered | Receipient refused shipment as the goods where not ordered |
| deliveryFailedRefusedByRecipientMissingDocuments | Recipient refused shipment as the expected documentation was missing |
| deliveryFailedRefusedByRecipientInventory | Recipient refused shipment as they are doing inventory count |
| deliveryFailedRefusedByRecipientLateDelivery | Recipient refused shipment as it missed its requested delivery window |
| deliveryFailedRefusedByRecipientShipmentIncomplete | Recipient refused shipment as it was not delivered complete |
| deliveryFailedRefusedByRecipientIncompleteDueToMissing | Recipient refused shipment as it was not delivered complete, shipment was incomplete because parts are missing |
| deliveryFailedRefusedByRecipientCancelled | Recipient refused shipment as the shipment was cancelled |
| deliveryFailedWaitingTimeExceeded | Delivery failed as driver waiting time exceeded |
| deliveryFailedRecipientMoved | Delivery failed as recipient is no longer available on the requested delivery location, they moved. |
Delivery appointment
A contact moment between the carrier and receiver to agree on the delivery window
| Event Code | Description |
|---|---|
| deliveryAppointmentRequested | Appointment for delivery is requested |
| deliveryAppointmentPlanned | Appointment for delivery is planned/agreed with the recipient, this should include the agreed appointment timewindow |
| deliveryAppointmentFailed | Creating an appointment failed, no specific reason provided |
| deliveryAppointmentFailedMissingContactDetails | Creating an appointment failed due to missing contact details |
| deliveryAppointmentFailedNoResponseFromRecipient | Creating an appointment failed as recipient did not respond/could not be reached |
| deliveryAppointmentRescheduled | Appointment for delivery is rescheduled, this should include the agreed appointment timewindow |
| deliveryAppointmentRescheduledOnRequestOfCarrier | Appointment for delivery is rescheduled on request of carrier |
| deliveryAppointmentRescheduledOnRequestOfRecipient | Appointment for delivery is rescheduled on request of recipient |
| deliveryAppointmentCancelled | Delivery appointment is cancelled |
| deliveryAppointmentCancelledOnRequestOfCarrier | Delivery appointment is cancelled on request of the carrier |
| deliveryAppointmentCancelledOnRequestOfRecipient | Delivery appointment is cancelled on request of the recipient |
Delivery locker
With recipients not always available at home, delivery lockers are a good alternative to deliver the goods.
| Event Code | Description |
|---|---|
| deliveryLockerPlanned | Delivery is planned to a locker, incl planned to arrive |
| deliveryLockerArrivalFailedNoEmptyLockerAvailable | Delivery into locker failed as there is no empty locker available |
| deliveryLockerArrivalFailedDoesNotFitInLocker | Delivery into locker failed as the goods did not fit in an available locker |
| deliveryLockerArrivalFailedOther | Delivery into locker failed, other reason |
| deliveryLockerAvailableForCollection | Goods are available for collection by recipient at delivery locker |
| deliveryLockerAvailableForCollectionReminder | Reminder that goods are available for collection at delivery locker |
| deliveryLockerCollected | Goods collected by recipient at delivery locker |
| deliveryLockerReturnedToSender | Goods returned to sender after it was stored in a delivery locker |
Delivery parcelshops
An equivalent to delivery lockers, parcelshops are a good alternative to deliver the goods. Where lockers are unmanned and often availabe 24-7, the parcelshops provide a manned location where the recipient can collect the goods within given opening hours.
| Event Code | Description |
|---|---|
| deliveryParcelShopPlanned | Goods are planned to be sent to a parcelshop, incl planned to arrive |
| deliveryParcelShopArrived | Goods have arrived at the parcelshop |
| deliveryParcelShopArrivalFailedParcelShopClosed | Goods did not arrive at parcelshop as it was closed |
| deliveryParcelShopArrivalFailedCannotBeReached | Goods did not arrive at parcelshop as it could not be reached, eg festival/roadblocks |
| deliveryParcelShopArrivalFailedOther | Goods did not arrive at parcelshop, other reason |
| deliveryParcelShopAvailableForCollection | Goods are available for collection by recipient at parcelshop |
| deliveryParcelShopAvailableForCollectionReminder | Reminder that goods are available for collection at parcelshop |
| deliveryParcelShopCollected | Goods collected by recipient at parcelshop |
| deliveryParcelShopReturnedToSenderNotCollected | Goods are returned from parcelshop to sender as the goods where not collected within the agreed timeframe |
| deliveryParcelShopReturnedToSenderNoSpaceAvailable | Goods are returned from parcelshop to sender as there is no space to store the goods in parcelshop |
Exception
If there is a delay in the delivery the exception is the most comon way to indicate a delay is imminent.
| Event Code | Description |
|---|---|
| exceptionMissing | Exception, (part of) shipment is missing |
| exceptionMissingAtUnloadingIntermediateHub | (part of) shipment is discovered missing while unloading at one of the hubs |
| exceptionMissingUnderInvestigationCarrier | (part of) shipment is missing and under investigation by the carrier |
| exceptionMissingUnderInvestigationShipper | (part of) shipment is missing and under investigation by the shipper |
| exceptionMissingUnderInvestigationRecipient | (part of) shipment is missing and under investigation by the recipient |
| exceptionMissingLost | (part of) shipment is missing is agreed to be lost |
| ExceptionDamagedinHub | (part of) shipment is damaged in hub |
| ExceptionDamagedinTransit | (part of) shipment is damaged during transit |
| exceptionDamagedUnderInvestigation | (part of) shipment is damaged, rootcause and corrective actions is under investigation, no party indicated |
| exceptionDamagedUnderInvestigationCarrier | (part of) shipment is damaged, rootcause and corrective actions is under investigation by the carrier |
| exceptionDamagedRequiresInputShipper | (part of) shipment is damaged, input of the shipper is required to dermine next action |
| exceptionDamagedRequiresInputReceiver | (part of) shipment is damaged, input of the recipient is required to dermine next action |
| exceptionDamagedReturnToSender | (part of) shipment is damaged, shipment goes return to sender |
| exceptionDamagedDestroyed | Goods where destroyed |
| exceptionDamagedDestroyedOnRequestOfShipper | Goods where destroyed on instruction of the shipper |
| exceptionDamagedDestroyedByRegulation | Goods where destroyed on instruction of govenment agency |
| exceptionDamagedDelivered | Damaged shipment was still deliverd at recipient |
| exceptionDelayedBankHoliday | Delivery of shipment is delayed due to a bank holiday |
| exceptionDelayedAdministrativeRectivication | Delivery delayed as adminstrative rectivications had to be made |
| exceptionDelayedAdditionalEquipmentRequired | Shipment was delayed because for pickup or delivery additional equipment was required |
| exceptionDelayedDeliveryAppointmentRequired | Delivery is delayed because an appointment for delivery is required |
| exceptionDelayedEquipmentFailure | Delay caused by transport equipment failure |
| exceptionDelayedForceMajeure | Delivery is delayed due to unconrolled events |
| exceptionDelayedIncorrectLabelling | Delivery is delayed to incorrect labelling |
| exceptionDelayedIncorrectAddress | Delivery is delayed to incorrect address information |
| exceptionDelayedIncorrectShipmentInformation | Information in the shipment is incorrect and causing a potential delay. Eg invalid service (options) or incorrect dimensions |
| exceptionDelayedIndustrialDispute | An industrial dispute causes a delivery delay |
| exceptionDelayedLackOfTransportCapacity | Shipment is delayed due to a lack of transport capacity |
| exceptionDelayedLackOfUnloadingSpace | Shipment is delayed as it could not be unloaded due to limited space at the unloading area |
| exceptionDelayedMissingDocuments | Shipment is delayed due to missing documents |
| exceptionDelayedMissingDocumentsFromShipper | Shipment is delayed due to miss documents that should have been provided by the shipper |
| exceptionDelayedMissingDocumentsFromCarrier | Shipment is delayed due to miss documents that should have been provided by the carrier |
| exceptionDelayedNotLoadedAsBondedGoods | Goods appear to be bonded but where not loaded as such |
| exceptionDelayedNotLoadedAsDangerousGoods | Goods appear be Dangerous Goods but where not booked and loaded as such |
| exceptionDelayedOversizeOverweight | Shipment is delayed as it is has large dimensions or high weight, requiring different handling as planned |
| exceptionDelayedWrongRouting | Shipment is delayed due to an operational error at carrier side. Eg it has been routed incorrect within the network. |
| exceptionDelayedTemperatureExceeded | Shipment is delayed because the allowed temperature limits where exceeded |
| exceptionDelayedWaitingForEdi | Shipment is being delayed because electronic information about the delivery is not provided yet |
| exceptionDelayedMissedConnection | Shipment delayed due to missed connection |
| exceptionDelayedGeneralTimeConstraint | Shipment is delayed to do various reasons within the carrier network causing a time pressure |
| exceptionDelayedUnknown | Shipment dealyed due to an unknown reason |
| exceptionDelayedOther | Shipment delayed due to a specific other reason, carrier should provide details in description |
| exceptionDelayedAccident | Shipment delayed due to an accident |
| exceptionDelayedContactCarrierMissingInformation | Shipment is delayed, contact with the carrier is required to provide missing information |
| exceptionDelayedContactCarrierByShipper | Shipment is delayed, it is waiting for contact with the shipper |
| exceptionDelayedContactCarrierByRecipient | Shipment is delayed, it is waiting for contact with the recipient |
| exceptionDelayedMissing | Shipment delayed as it cannot be found |
| exceptionDelayedMissingUnderInvestigation | Missing shipment is being investigated |
| exceptionDelayedWeatherConditions | Good where delayed due to sever weather conditions disrupting the carriers operation |
| exceptionDelayedSecurityChecks | Goods where delayed due to security checks performed |
| exceptionDelayedDestroyedHeavilyDamaged | Goods where damaged to a degree that they had to be destroyed |
| exceptionDelayedDestroyedOnRequestOfShipper | Goods where destroyed on request/confirmation of the shipper |
| exceptionReturnToSenderUncollectedFromPickupPoint | Goods returned to sender from pickup point, after not being collected within period |
| exceptionReturnToSenderRefusedAtDelivery | Goods returned to sender as recipient refused to accept the goods |
| exceptionReturnToSenderUnknownAddress | Goods returned to sender as carrier could not find indicated address |
| exceptionReturnToSenderPartially | Part of the goods are returned to sender, rest is kept by receipient |
| exceptionReturnToSenderOther | Goods returned to sender, no specific or other indication why |
| exceptionReturnToSenderDamaged | Goods are returned to sender because they are damaged |
| exceptionReturnToSenderIncident | Goods are returned to sender because they were involved in an incident |
| exceptionReturnToSenderCancelledByShipper | Goods are return to sender because the shipper cancelled the shipment |
| exceptionReturnToSenderCustomsInspectionResult | Goods are returned to sender as something was missing/incorrect during customs inspection |
| exceptionOther | Another exception that did fit to one of the other categories |
Pickup
The phase that contains all activity related to the collection of the goods
| Event Code | Description |
|---|---|
| pickupRequested | default pickup if none of the other pickup phases apply. |
| pickupRequestedCommercial | Pickup at a commercial location, can be a store, warehouse, office etc.. |
| pickupRequestedCustomerPickup | Only used when carrier indicates this is a specific pickup organized by the recipient/customer (so not the shipper) |
| pickupRequestedCustomerPickupDamaged | Customer pickup is requested, where parts of the goods are already known to be damaged |
| pickupRequestedCustomerPickupIncomplete | Customer pickup is requested, where parts of the goods are already known to be missing |
| pickupRequestedResidentialPickup | Only used when carrier specifically indicates this is a residential pickup |
| pickupPlannedScheduled | Pickup has been planned |
| pickupPlannedRescheduledOnRequestOfRecipient | Pickup has been rescheduled on request of the recipient |
| pickupPlannedRescheduledOnRequestOfShipper | Pickup has been rescheduled on request of the shipper |
| pickupPlannedRescheduledOnRequestOfCarrier | Pickup has been rescheduled on request of the carrier |
| pickupPlannedRescheduled | Pickup has been rescheduled |
| pickupPlannedOther | Pickup has been planned |
| pickupArrived | Pickup started, carrier has arrived onsite, loading started |
| pickupCompleted | Pickup completed |
| pickupCompletedIncomplete | Pickup completed, not all adviced goods where loaded |
| pickupCompletedDamaged | Pickup completed, (parts of) the goods are damaged |
| pickupCompletedCustomerPickup | Customer pickup completed |
| pickupFailedLocationClosed | Pickup failed as the pickup location was closed |
| pickupFailedLocationCannotBeReached | Pickup failed as the pickup location could not be reached |
| pickupFailedGoodsNotReady | Pickup failed as the goods where not ready for pickup |
| pickupFailedGoodsLost | Pickup failed as the goods where lost |
| pickupFailedIncompleteInformation | Pickup failed due to implete information provided by the shipper. |
| pickupFailedMissedPickupWindow | Pickup failed as the carrier was not able to make the agreed pickup window |
| pickupFailedOther | Pickup failed |
| pickupDelayed | Pickup delayed |
| pickupDelayedBookedAfterPickupWindow | Pickup delayed as it was booked outside a viable pickup time window. |
| pickupDelayedTraffic | Pickup delayed due to unexpected traffic |
| pickupDelayedWaitingForConsignment | Pickup delayed: carrier is waiting for consignment to be provided |
| pickupDelayedWaitingToBeCompleted | Pickup delayed: carrier is waiting for the shipment to be completed and made ready for shipping |
| pickupCancelledByShipper | Pickup cancelled by shipper |
| pickupCancelledByCarrier | Pickup cancelled by carrier |
| pickupCancelledByRecipient | Pickup cancelled by recipient, typically used in combination with a customer pickup |
| pickupCancelledNoPartyIndicated | Pickup cancelled |
Pickup parcelshop
A variant on the pickup where the shipper (or returnee) brings the goods to a parcelshop and the carrier picks it up from there.
| Event Code | Description |
|---|---|
| pickupParcelShopRequested | Only used when carrier indicates the pickup is meant to go through a parcelshop/pickup point |
| pickupParcelShopCancelled | A requested parcelshop pickup has been cancelled |
| pickupParcelShopArrived | The goods have been delivered at the parcelShop by the shipper and are ready to be collected by the carrier |
| pickupParcelShopCollected | The goods have been collected at the parcelshop by the carrier |
Return
Returns have combinations with the processes pickup/return parcelshop and `delivery, plus a set of its own events. The return phase is the phase where the goods are being returned to the shipper.
| Event Code | Description |
|---|---|
| returnRequested | Goods being returned to the seller of the goods. Eg a defective phone is returned to Apple. |
| returnCollected | Return is collected by carrier |
| returnCancelled | Return is cancelled, no indication who cancelled |
| returnCancelledByCustomer | Return is cancelled by the customer, no need to execute the return anymore |
| returnCancelledByShipper | Return is cancelled by the shipper/account holder |
| returnOther | eg return link expiring soon |
Transit phase
The phase that contains activity of the movement of goods between pickup and delivery location.
| Event Code | Description |
|---|---|
| transitTransport | Transport activity |
| transitEtaUpdate | Update on expected time of arrival |
| transitHubActivity | Activity inside a transportation hub |
| transitHubActivityArrived | Goods have arrived in the hub |
| transitHubActivityDeparted | Goods have departed the hub |
| transitHubActivityDepartedDamaged | Goods left the hub in a damaged state |
| transitHubActivityDepartedPartiallyMissing | Part of the goods left the hub, other part of the goods are missing |
| transitAtDestinationHub | Arrived in destination hub |
| transitHandoverToOtherCarrier | Handed over to other carrier |
Other
If events are received that cannot be classified in any of the other categories, they are classified as other.
| Event Code | Description |
|---|---|
| other | Another event for which no process was specified for yet |
Example flows
Outbound shipment
A shipment departs from a warehouse that has a daily pickup scheduled. Example events could be:
- transitTransport
- transitHubActivity
- deliveryOutForDelivery
- deliveryCompleted
Return shipment through a parcel shop
A shipment departs from a warehouse that has a daily pickup scheduled. Example events could be:
- returnRequested
- pickupParcelShopArrived
- pickupParcelShopCollected
- transitTransport
- deliveryCompleted
Outbound shipment returned by recipient
A shipment departs from a warehouse but contact information is incorrect, so the recipient refuses the shipment. The refused shipment is returned to the sender.
Events could be:
- pickupCompleted
- refusedByRecipientIncorrectContactDetails
- exceptionReturnToSenderRefusedAtDelivery
- deliveryCompleted