Gateway Json Tracking event codes
This contains standardized tracking event codes for the Viya Gateway split into the a type and reason for use in the gateway json tracking event message. The codes are used to communicate status events from carrier towards shipper.
Revision history
- 15-May-2025: Initial version
- 17-Sep-2025: Added all standard codes
Event codes
Event type | Event reason | 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 | |
BookingCancelled | NoActivity | Shipment booking is cancelled because there was no operational activity executed for the requested shipment |
BookingCancelled | IncorrectInformation | Shipment booking is cancelled because information in the booking was incorrect or incomplete |
BookingCancelled | Other | Shipment booking is cancelled, other or no reason specified |
BookingChangeRequested | AddressChange | A request is made to change the shipment after it was originally booked |
BookingChangeRequested | ServiceLeveLChange | A request is made to change services related to the shipment |
BookingChangeRequested | IncotermChange | A request is made to change the incoterm of the shipment |
BookingChangeRequested | WeightOrDimensionChange | A request is made to update the weights or dimensions of the shipment |
BookingChangeRequested | Other | 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 | |
BookingChangeRefused | CannotChangeAnymore | Booking change is refused as the shipment has passed its point-of-no-return |
BookingChangeRefused | Other | 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 | |
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 | |
PickupParcelShopCollected | The goods have been collected at the parcelshop by the carrier | |
PickupRequested | default pickup if none of the other pickup phases apply. | |
PickupRequested | Commercial | Pickup at a commercial location, can be a store, warehouse, office etc.. |
PickupRequested | CustomerPickup | Only used when carrier indicates this is a specific pickup organized by the recipient/customer (so not the shipper) |
PickupRequested | CustomerPickupDamaged | Customer pickup is requested, where parts of the goods are already known to be damaged |
PickupRequested | CustomerPickupIncomplete | Customer pickup is requested, where parts of the goods are already known to be missing |
PickupRequested | ResidentialPickup | Only used when carrier specifically indicates this is a residential pickup |
PickupPlanned | Scheduled | Pickup has been planned |
PickupPlanned | RescheduledOnRequestOfRecipient | Pickup has been rescheduled on request of the recipient |
PickupPlanned | RescheduledOnRequestOfShipper | Pickup has been rescheduled on request of the shipper |
PickupPlanned | RescheduledOnRequestOfCarrier | Pickup has been rescheduled on request of the carrier |
PickupPlanned | Rescheduled | Pickup has been rescheduled |
PickupPlanned | Other | Pickup has been planned |
PickupArrived | Pickup started, carrier has arrived onsite, loading started | |
PickupCompleted | Pickup completed | |
PickupCompleted | Incomplete | Pickup completed, not all adviced goods where loaded |
PickupCompleted | Damaged | Pickup completed, (parts of) the goods are damaged |
PickupCompleted | CustomerPickup | Customer pickup completed |
PickupFailed | LocationClosed | Pickup failed as the pickup location was closed |
PickupFailed | LocationCannotBeReached | Pickup failed as the pickup location could not be reached |
PickupFailed | GoodsNotReady | Pickup failed as the goods where not ready for pickup |
PickupFailed | GoodsLost | Pickup failed as the goods where lost |
PickupFailed | IncompleteInformation | Pickup failed due to implete information provided by the shipper. |
PickupFailed | MissedPickupWindow | Pickup failed as the carrier was not able to make the agreed pickup window |
PickupFailed | Other | Pickup failed |
PickupDelayed | Pickup delayed | |
PickupDelayed | BookedAfterPickupWindow | Pickup delayed as it was booked outside a viable pickup time window. |
PickupDelayed | Traffic | Pickup delayed due to unexpected traffic |
PickupDelayed | WaitingForConsignment | Pickup delayed: carrier is waiting for consignment to be provided |
PickupDelayed | WaitingToBeCompleted | Pickup delayed: carrier is waiting for the shipment to be completed and made ready for shipping |
PickupCancelled | ByShipper | Pickup cancelled by shipper |
PickupCancelled | ByCarrier | Pickup cancelled by carrier |
PickupCancelled | ByRecipient | Pickup cancelled by recipient, typically used in combination with a customer pickup |
PickupCancelled | NoPartyIndicated | Pickup cancelled |
TransitTransport | Transport activity | |
TransitEtaUpdate | Update on expected time of arrival | |
TransitHubActivity | Activity inside a transportation hub | |
TransitHubActivity | Arrived | Goods have arrived in the hub |
TransitHubActivity | Departed | Goods have departed the hub |
TransitHubActivity | DepartedDamaged | Goods left the hub in a damaged state |
TransitHubActivity | DepartedPartiallyMissing | 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 | |
CustomsAvailable | Goods are available for customs processing | |
CustomsInProgress | Customs processing is in progress | |
CustomsDelayed | IncorrectOrMissingInformation | Customs procedures are delayed as information about the shipment is missing/incomplete or incorrect |
CustomsDelayed | Incomplete | Customs procedures are delayed as not all goods are available for processing |
CustomsDelayed | PendingDutiesTaxesPaymentRecipient | Recipient need to pay duties and/or taxes before shipment can be released |
CustomsDelayed | PendingDutiesTaxesPaymentShipper | Shipper need to pay duties and/or taxes before shipment can be released |
CustomsDelayed | CarrierDelayed | Carrier delayed in providing request/information/goods for customs clearance |
CustomsDelayed | AdditionalInformationRequiredRecipient | Customs procedures are delayed as recipient nees to provide additional information for clearance purposes |
CustomsDelayed | Other | Customs procedures are delayed |
CustomsFailed | Customs processing failed, no customs approval available | |
CustomsFailed | DestroyedByRegulation | Goods failed customs inspection and where destroyed as per government agency instructions |
CustomsReleased | Released from customs, goods can continue journey | |
DeliveryAppointmentRequested | Appointment for delivery is requested | |
DeliveryAppointmentPlanned | Appointment for delivery is planned/agreed with the recipient, typically a date is included | |
DeliveryAppointmentFailed | Creating an appointment failed, no specific reason provided | |
DeliveryAppointmentFailed | MissingContactDetails | Creating an appointment failed due to missing contact details |
DeliveryAppointmentFailed | NoResponseFromRecipient | Creating an appointment failed as recipient did not respond/could not be reached |
DeliveryAppointmentRescheduled | Appointment for delivery is rescheduled | |
DeliveryAppointmentRescheduled | OnRequestOfCarrier | Appointment for delivery is rescheduled on request of carrier |
DeliveryAppointmentRescheduled | OnRequestOfRecipient | Appointment for delivery is rescheduled on request of recipient |
DeliveryAppointmentCancelled | Delivery appointment is cancelled | |
DeliveryAppointmentCancelled | OnRequestOfCarrier | Delivery appointment is cancelled on request of the carrier |
DeliveryAppointmentCancelled | OnRequestOfRecipient | Delivery appointment is cancelled on request of the recipient |
DeliveryPlanned | RescheduledOnRequestOfRecipient | Delivery moment of the shipment is rescheduled on request of recipient |
DeliveryPlanned | RescheduledOnRequestOfShipper | Delivery moment of the shipment is rescheduled on request of shipper |
DeliveryPlanned | RescheduledOnRequestOfCarrier | Delivery moment of the shipment is rescheduled on request of shipper |
DeliveryPlanned | Rescheduled | Delivery moment of the shipment is rescheduled, no specific indication if carrier/recipient or shipper initiated it |
DeliveryPlanned | ArrivalNoticeProvided | Delivery moment is communicated to recipient in form of an arrival notice (ASN) |
DeliveryPlanned | Other | 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. | |
DeliveryInProgress | OutForDelivery | Goods are in their last vehicle towards the receiver. This can have an update eg 10:12-11:12 |
DeliveryInProgress | ShortDistance | Goods are in their last vehicle towards the receiver, it is a very short distance to the receiver |
DeliveryInProgress | Arrived | Delivery is in progress, goods arrived at destination but are not available for the recipient |
DeliveryInProgress | Unloaded | Delivery is in progress, goods haven been unloaded but are not available to the receipient |
DeliveryCompletedPartly | Delivery completed partly, no specific reason provided why not all goods where delivered | |
DeliveryCompletedPartly | Missing | Delivered party, as not all goods where accounted for at delivery |
DeliveryCompletedPartly | Damaged | Recipient refused part of the delivery as that part was damaged, rest was delivered. |
DeliveryCompletedPartly | CustomerPickup | Recipient reported part of the goods where delivered for a shipment where the pickup was arranged by the recipient |
DeliveryCompleted | Delivered, no details provided | |
DeliveryCompleted | AtNeighbour | Delivered at neighbour |
DeliveryCompleted | AtReceiver | Delivered at recipient |
DeliveryCompleted | AtCommercialLocation | Delivered in a commercial location (store/office etc..) |
DeliveryCompleted | AtPlaceUnattended | Delivered at a place where it was left unattended, no signature received. Eg on frontPorch, garage, side of house etc.. |
DeliveryCompleted | WithPermissionToLeaveGoods | Delivered, left on a location without obtaining signature as this was indicated in the order |
DeliveryCompleted | ManuallyRegistered | Delivered, registered the delivery event manually |
DeliveryCompleted | Other | Delivered, other detail provided |
DeliveryCompleted | ConsgineeIndicatesSurplus | Delivered goods according to request, but recipient indicates too many items have been delivered |
DeliveryCompleted | ConsigneeIndicatesMissing | Delivered goods according to request, but recipient indicates items missing from what has been deliverd |
DeliveryCompleted | Delayed | Shipment delivered with a delay |
DeliveryFailed | LocationUnavailable | The delivery location could not be reached (eg roadworks, parade etc..) |
DeliveryFailed | ContactCarrier | delivery failed, contact the carrier for more information |
DeliveryFailed | AbsentRecipient | There was no recipient available at the time of the delivery attempt |
DeliveryFailed | RecipientClosed | The recipients location was closed/business closed at the time of the delivery attempt |
DeliveryFailed | NoValidRecipient | The delivery failed as there was nobody allowed to receive the goods, eg adult signature required or named delivery only |
DeliveryFailed | AccessCodeMissing | To complete delivery, an access code was required. The driver did not have access/knew the correct access code |
DeliveryFailed | Other | Delivery failed, a no/other specific information about the delivery failure was provided |
DeliveryFailed | AdditionalEquipmentRequired | Delivery failed as additional equipment was required to complete the delivery |
DeliveryFailed | RefusedByRecipientRequestedOtherDeliveryDate | Delivery failed as the recipient requested a different delivery date |
DeliveryFailed | RefusedByRecipient | Delivery failed as recipient refused to receive the goods |
DeliveryFailed | RefusedByRecipientIncorrectContactDetails | Delivery failed as recipient refused the delivery due to incorrect contact details provided |
DeliveryFailed | Damaged | Delivery failed as goods where damaged |
DeliveryFailed | RefusedByRecipientDamaged | Recipient refused complete shipment as it was damaged |
DeliveryFailed | RefusedByRecipientNotOrdered | Receipient refused shipment as the goods where not ordered |
DeliveryFailed | RefusedByRecipientMissingDocuments | Recipient refused shipment as the expected documentation was missing |
DeliveryFailed | RefusedByRecipientInventory | Recipient refused shipment as they are doing inventory count |
DeliveryFailed | RefusedByRecipientLateDelivery | Recipient refused shipment as it missed its requested delivery window |
DeliveryFailed | RefusedByRecipientShipmentIncomplete | Recipient refused shipment as it was not delivered complete |
DeliveryFailed | RefusedByRecipientIncompleteDueToMissing | Recipient refused shipment as it was not delivered complete, shipment was incomplete because parts are missing |
DeliveryFailed | RefusedByRecipientCancelled | Recipient refused shipment as the shipment was cancelled |
DeliveryFailed | WaitingTimeExceeded | Delivery failed as driver waiting time exceeded |
DeliveryFailed | RecipientMoved | Delivery failed as recipient is no longer available on the requested delivery location, they moved. |
DeliveryParcelShopPlanned | Goods are planned to be sent to a parcelshop, incl planned to arrive | |
DeliveryParcelShopArrived | Goods have arrived at the parcelshop | |
DeliveryParcelShopArrivalFailed | ParcelShopClosed | Goods did not arrive at parcelshop as it was closed |
DeliveryParcelShopArrivalFailed | CannotBeReached | Goods did not arrive at parcelshop as it could not be reached, eg festival/roadblocks |
DeliveryParcelShopArrivalFailed | Other | Goods did not arrive at parcelshop, other reason |
DeliveryParcelShopAvailableForCollection | Goods are available for collection by recipient at parcelshop | |
DeliveryParcelShopAvailableForCollection | Reminder | Reminder that goods are available for collection at parcelshop |
DeliveryParcelShopCollected | Goods collected by recipient at parcelshop | |
DeliveryParcelShopReturnedToSender | NotCollected | Goods are returned from parcelshop to sender as the goods where not collected within the agreed timeframe |
DeliveryParcelShopReturnedToSender | NoSpaceAvailable | Goods are returned from parcelshop to sender as there is no space to store the goods in parcelshop |
DeliveryLockerPlanned | Delivery is planned to a locker, incl planned to arrive | |
DeliveryLockerArrivalFailed | NoEmptyLockerAvailable | Delivery into locker failed as there is no empty locker available |
DeliveryLockerArrivalFailed | DoesNotFitInLocker | Delivery into locker failed as the goods did not fit in an available locker |
DeliveryLockerArrivalFailed | Other | Delivery into locker failed, other reason |
DeliveryLockerAvailableForCollection | Goods are available for collection by recipient at delivery locker | |
DeliveryLockerAvailableForCollection | Reminder | 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 | |
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 | |
ReturnCancelled | ByCustomer | Return is cancelled by the customer, no need to execute the return anymore |
ReturnCancelled | ByShipper | Return is cancelled by the shipper/account holder |
ReturnOther | eg return link expiring soon | |
ReturnParcelShopRequested | Goods being returned to the seller of the goods where initial the consumer returns the product through a parcelShop | |
ReturnParcelShopAvailableForCollection | Goods have been delivered at the parcelshop by the consumer, they are ready for collection by carrier. | |
ReturnParcelShopCollected | goods have been collected by the carrier at the parcelshop | |
ReturnParcelShopCancelled | return through a parcelshop is cancelled | |
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 | |
ExceptionMissing | Exception, (part of) shipment is missing | |
ExceptionMissing | AtUnloadingIntermediateHub | (part of) shipment is discovered missing while unloading at one of the hubs |
ExceptionMissing | UnderInvestigationCarrier | (part of) shipment is missing and under investigation by the carrier |
ExceptionMissing | UnderInvestigationShipper | (part of) shipment is missing and under investigation by the shipper |
ExceptionMissing | UnderInvestigationRecipient | (part of) shipment is missing and under investigation by the recipient |
ExceptionMissing | Lost | (part of) shipment is missing is agreed to be lost |
ExceptionDamaged | InTransit | (Part of) shipment got damaged while in transit |
ExceptionDamaged | InHub | (Part of) shipment got damaged while handling in hub |
ExceptionDamaged | UnderInvestigation | (part of) shipment is damaged, rootcause and corrective actions is under investigation, no party indicated |
ExceptionDamaged | UnderInvestigationCarrier | (part of) shipment is damaged, rootcause and corrective actions is under investigation by the carrier |
ExceptionDamaged | RequiresInputShipper | (part of) shipment is damaged, input of the shipper is required to dermine next action |
ExceptionDamaged | RequiresInputReceiver | (part of) shipment is damaged, input of the recipient is required to dermine next action |
ExceptionDamaged | ReturnToSender | (part of) shipment is damaged, shipment goes return to sender |
ExceptionDamaged | Destroyed | Goods where destroyed |
ExceptionDamaged | DestroyedOnRequestOfShipper | Goods where destroyed on instruction of the shipper |
ExceptionDamaged | DestroyedByRegulation | Goods where destroyed on instruction of govenment agency |
ExceptionDamaged | Delivered | Damaged shipment was still deliverd at recipient |
ExceptionDelayed | BankHoliday | Delivery of shipment is delayed due to a bank holiday |
ExceptionDelayed | AdministrativeRectivication | Delivery delayed as adminstrative rectivications had to be made |
ExceptionDelayed | AdditionalEquipmentRequired | Shipment was delayed because for pickup or delivery additional equipment was required |
ExceptionDelayed | DeliveryAppointmentRequired | Delivery is delayed because an appointment for delivery is required |
ExceptionDelayed | EquipmentFailure | Delay caused by transport equipment failure |
ExceptionDelayed | ForceMajeure | Delivery is delayed due to unconrolled events |
ExceptionDelayed | IncorrectLabelling | Delivery is delayed to incorrect labelling |
ExceptionDelayed | IncorrectAddress | Delivery is delayed to incorrect address information |
ExceptionDelayed | IncorrectShipmentInformation | Information in the shipment is incorrect and causing a potential delay. Eg invalid service (options) or incorrect dimensions |
ExceptionDelayed | IndustrialDispute | An industrial dispute causes a delivery delay |
ExceptionDelayed | LackOfTransportCapacity | Shipment is delayed due to a lack of transport capacity |
ExceptionDelayed | LackOfUnloadingSpace | Shipment is delayed as it could not be unloaded due to limited space at the unloading area |
ExceptionDelayed | MissingDocuments | Shipment is delayed due to missing documents |
ExceptionDelayed | MissingDocumentsFromShipper | Shipment is delayed due to miss documents that should have been provided by the shipper |
ExceptionDelayed | MissingDocumentsFromCarrier | Shipment is delayed due to miss documents that should have been provided by the carrier |
ExceptionDelayed | NotLoadedAsBondedGoods | Goods appear to be bonded but where not loaded as such |
ExceptionDelayed | NotLoadedAsDangerousGoods | Goods appear be Dangerous Goods but where not booked and loaded as such |
ExceptionDelayed | OversizeOverweight | Shipment is delayed as it is has large dimensions or high weight, requiring different handling as planned |
ExceptionDelayed | WrongRouting | Shipment is delayed due to an operational error at carrier side. Eg it has been routed incorrect within the network. |
ExceptionDelayed | TemperatureExceeded | Shipment is delayed because the allowed temperature limits where exceeded |
ExceptionDelayed | WaitingForEdi | Shipment is being delayed because electronic information about the delivery is not provided yet |
ExceptionDelayed | MissedConnection | Shipment delayed due to missed connection |
ExceptionDelayed | GeneralTimeConstraint | Shipment is delayed to do various reasons within the carrier network causing a time pressure |
ExceptionDelayed | Unknown | Shipment dealyed due to an unknown reason |
ExceptionDelayed | Other | Shipment delayed due to a specific other reason, carrier should provide details in description |
ExceptionDelayed | Accident | Shipment delayed due to an accident |
ExceptionDelayed | ContactCarrierMissingInformation | Shipment is delayed, contact with the carrier is required to provide missing information |
ExceptionDelayed | ContactCarrierByShipper | Shipment is delayed, it is waiting for contact with the shipper |
ExceptionDelayed | ContactCarrierByRecipient | Shipment is delayed, it is waiting for contact with the recipient |
ExceptionDelayed | Missing | Shipment delayed as it cannot be found |
ExceptionDelayed | MissingUnderInvestigation | Missing shipment is being investigated |
ExceptionDelayed | WeatherConditions | Good where delayed due to sever weather conditions disrupting the carriers operation |
ExceptionDelayed | SecurityChecks | Goods where delayed due to security checks performed |
ExceptionDelayed | DestroyedHeavilyDamaged | Goods where damaged to a degree that they had to be destroyed |
ExceptionDelayed | DestroyedOnRequestOfShipper | Goods where destroyed on request/confirmation of the shipper |
ExceptionReturnToSender | UncollectedFromPickupPoint | Goods returned to sender from pickup point, after not being collected within period |
ExceptionReturnToSender | RefusedAtDelivery | Goods returned to sender as recipient refused to accept the goods |
ExceptionReturnToSender | UnknownAddress | Goods returned to sender as carrier could not find indicated address |
ExceptionReturnToSender | Partially | Part of the goods are returned to sender, rest is kept by receipient |
ExceptionReturnToSender | Other | Goods returned to sender, no specific or other indication why |
ExceptionReturnToSender | Damaged | Goods are returned to sender because they are damaged |
ExceptionReturnToSender | Incident | Goods are returned to sender because they were involved in an incident |
ExceptionReturnToSender | CancelledByShipper | Goods are return to sender because the shipper cancelled the shipment |
ExceptionReturnToSender | CustomsInspectionResult | 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 | |
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 | |
ClaimDelayed | AdditionalInformationRequiredFromShipper | additional information is required from the shipper to continue with the claim procedure |
ClaimDelayed | AdditionalInformationRequiredFromRecipient | 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 | |
ClaimCancelled | ByShipper | claim is cancelled by shipper |
ClaimCancelled | ByCarrier | claim is cancelled by carrier |
ClaimCancelled | ByRecipient | claim is cancelled by recipient |
ClaimReembursed | Funds related to the claim are reembursed by the carrier to the shipper | |
Other | Another event for which no process was specified for yet |