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 typeEvent reasonDescription
BookingRequestedOrdering / Booking / Despatch advice data has been received by the carrier
BookingAcceptedShipment order is accepted by the carrier through explicit confirmation
BookingRefusedShipment order is refused by the carrier through explicit confirmation
BookingFailedShipment booking failed
BookingCancelledNoActivityShipment booking is cancelled because there was no operational activity executed for the requested shipment
BookingCancelledIncorrectInformationShipment booking is cancelled because information in the booking was incorrect or incomplete
BookingCancelledOtherShipment booking is cancelled, other or no reason specified
BookingChangeRequestedAddressChangeA request is made to change the shipment after it was originally booked
BookingChangeRequestedServiceLeveLChangeA request is made to change services related to the shipment
BookingChangeRequestedIncotermChangeA request is made to change the incoterm of the shipment
BookingChangeRequestedWeightOrDimensionChangeA request is made to update the weights or dimensions of the shipment
BookingChangeRequestedOtherA request is made to update the shipment with other or no reason specified.
BookingChangeAcceptedThe requested change to the shipment is accepted by the carrier, the change still has to be completed
BookingChangeRefusedCannotChangeAnymoreBooking change is refused as the shipment has passed its point-of-no-return
BookingChangeRefusedOtherBooking change is refused with other or no reason specified
BookingChangeFailedThe requested change to the shipment failed
BookingChangeCompletedChanges to the booking where completed succesfully
BookingChangeCancelledThe request to change the shpiment is cancelled
PickupParcelShopRequestedOnly used when carrier indicates the pickup is meant to go through a parcelshop/pickup point
PickupParcelShopCancelledA requested parcelshop pickup has been cancelled
PickupParcelShopArrivedThe goods have been delivered at the parcelShop by the shipper and are ready to be collected
PickupParcelShopCollectedThe goods have been collected at the parcelshop by the carrier
PickupRequesteddefault pickup if none of the other pickup phases apply.
PickupRequestedCommercialPickup at a commercial location, can be a store, warehouse, office etc..
PickupRequestedCustomerPickupOnly used when carrier indicates this is a specific pickup organized by the recipient/customer (so not the shipper)
PickupRequestedCustomerPickupDamagedCustomer pickup is requested, where parts of the goods are already known to be damaged
PickupRequestedCustomerPickupIncompleteCustomer pickup is requested, where parts of the goods are already known to be missing
PickupRequestedResidentialPickupOnly used when carrier specifically indicates this is a residential pickup
PickupPlannedScheduledPickup has been planned
PickupPlannedRescheduledOnRequestOfRecipientPickup has been rescheduled on request of the recipient
PickupPlannedRescheduledOnRequestOfShipperPickup has been rescheduled on request of the shipper
PickupPlannedRescheduledOnRequestOfCarrierPickup has been rescheduled on request of the carrier
PickupPlannedRescheduledPickup has been rescheduled
PickupPlannedOtherPickup has been planned
PickupArrivedPickup started, carrier has arrived onsite, loading started
PickupCompletedPickup completed
PickupCompletedIncompletePickup completed, not all adviced goods where loaded
PickupCompletedDamagedPickup completed, (parts of) the goods are damaged
PickupCompletedCustomerPickupCustomer pickup completed
PickupFailedLocationClosedPickup failed as the pickup location was closed
PickupFailedLocationCannotBeReachedPickup failed as the pickup location could not be reached
PickupFailedGoodsNotReadyPickup failed as the goods where not ready for pickup
PickupFailedGoodsLostPickup failed as the goods where lost
PickupFailedIncompleteInformationPickup failed due to implete information provided by the shipper.
PickupFailedMissedPickupWindowPickup failed as the carrier was not able to make the agreed pickup window
PickupFailedOtherPickup failed
PickupDelayedPickup delayed
PickupDelayedBookedAfterPickupWindowPickup delayed as it was booked outside a viable pickup time window.
PickupDelayedTrafficPickup delayed due to unexpected traffic
PickupDelayedWaitingForConsignmentPickup delayed: carrier is waiting for consignment to be provided
PickupDelayedWaitingToBeCompletedPickup delayed: carrier is waiting for the shipment to be completed and made ready for shipping
PickupCancelledByShipperPickup cancelled by shipper
PickupCancelledByCarrierPickup cancelled by carrier
PickupCancelledByRecipientPickup cancelled by recipient, typically used in combination with a customer pickup
PickupCancelledNoPartyIndicatedPickup cancelled
TransitTransportTransport activity
TransitEtaUpdateUpdate on expected time of arrival
TransitHubActivityActivity inside a transportation hub
TransitHubActivityArrivedGoods have arrived in the hub
TransitHubActivityDepartedGoods have departed the hub
TransitHubActivityDepartedDamagedGoods left the hub in a damaged state
TransitHubActivityDepartedPartiallyMissingPart of the goods left the hub, other part of the goods are missing
TransitAtDestinationHubArrived in destination hub
TransitHandoverToOtherCarrierHanded over to other carrier
CustomsAvailableGoods are available for customs processing
CustomsInProgressCustoms processing is in progress
CustomsDelayedIncorrectOrMissingInformationCustoms procedures are delayed as information about the shipment is missing/incomplete or incorrect
CustomsDelayedIncompleteCustoms procedures are delayed as not all goods are available for processing
CustomsDelayedPendingDutiesTaxesPaymentRecipientRecipient need to pay duties and/or taxes before shipment can be released
CustomsDelayedPendingDutiesTaxesPaymentShipperShipper need to pay duties and/or taxes before shipment can be released
CustomsDelayedCarrierDelayedCarrier delayed in providing request/information/goods for customs clearance
CustomsDelayedAdditionalInformationRequiredRecipientCustoms procedures are delayed as recipient nees to provide additional information for clearance purposes
CustomsDelayedOtherCustoms procedures are delayed
CustomsFailedCustoms processing failed, no customs approval available
CustomsFailedDestroyedByRegulationGoods failed customs inspection and where destroyed as per government agency instructions
CustomsReleasedReleased from customs, goods can continue journey
DeliveryAppointmentRequestedAppointment for delivery is requested
DeliveryAppointmentPlannedAppointment for delivery is planned/agreed with the recipient, typically a date is included
DeliveryAppointmentFailedCreating an appointment failed, no specific reason provided
DeliveryAppointmentFailedMissingContactDetailsCreating an appointment failed due to missing contact details
DeliveryAppointmentFailedNoResponseFromRecipientCreating an appointment failed as recipient did not respond/could not be reached
DeliveryAppointmentRescheduledAppointment for delivery is rescheduled
DeliveryAppointmentRescheduledOnRequestOfCarrierAppointment for delivery is rescheduled on request of carrier
DeliveryAppointmentRescheduledOnRequestOfRecipientAppointment for delivery is rescheduled on request of recipient
DeliveryAppointmentCancelledDelivery appointment is cancelled
DeliveryAppointmentCancelledOnRequestOfCarrierDelivery appointment is cancelled on request of the carrier
DeliveryAppointmentCancelledOnRequestOfRecipientDelivery appointment is cancelled on request of the recipient
DeliveryPlannedRescheduledOnRequestOfRecipientDelivery moment of the shipment is rescheduled on request of recipient
DeliveryPlannedRescheduledOnRequestOfShipperDelivery moment of the shipment is rescheduled on request of shipper
DeliveryPlannedRescheduledOnRequestOfCarrierDelivery moment of the shipment is rescheduled on request of shipper
DeliveryPlannedRescheduledDelivery moment of the shipment is rescheduled, no specific indication if carrier/recipient or shipper initiated it
DeliveryPlannedArrivalNoticeProvidedDelivery moment is communicated to recipient in form of an arrival notice (ASN)
DeliveryPlannedOtherDelivery planned, no specific information provided
DeliveryEtaUpdateExpected 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.
DeliveryInProgressOutForDeliveryGoods are in their last vehicle towards the receiver. This can have an update eg 10:12-11:12
DeliveryInProgressShortDistanceGoods are in their last vehicle towards the receiver, it is a very short distance to the receiver
DeliveryInProgressArrivedDelivery is in progress, goods arrived at destination but are not available for the recipient
DeliveryInProgressUnloadedDelivery is in progress, goods haven been unloaded but are not available to the receipient
DeliveryCompletedPartlyDelivery completed partly, no specific reason provided why not all goods where delivered
DeliveryCompletedPartlyMissingDelivered party, as not all goods where accounted for at delivery
DeliveryCompletedPartlyDamagedRecipient refused part of the delivery as that part was damaged, rest was delivered.
DeliveryCompletedPartlyCustomerPickupRecipient reported part of the goods where delivered for a shipment where the pickup was arranged by the recipient
DeliveryCompletedDelivered, no details provided
DeliveryCompletedAtNeighbourDelivered at neighbour
DeliveryCompletedAtReceiverDelivered at recipient
DeliveryCompletedAtCommercialLocationDelivered in a commercial location (store/office etc..)
DeliveryCompletedAtPlaceUnattendedDelivered at a place where it was left unattended, no signature received. Eg on frontPorch, garage, side of house etc..
DeliveryCompletedWithPermissionToLeaveGoodsDelivered, left on a location without obtaining signature as this was indicated in the order
DeliveryCompletedManuallyRegisteredDelivered, registered the delivery event manually
DeliveryCompletedOtherDelivered, other detail provided
DeliveryCompletedConsgineeIndicatesSurplusDelivered goods according to request, but recipient indicates too many items have been delivered
DeliveryCompletedConsigneeIndicatesMissingDelivered goods according to request, but recipient indicates items missing from what has been deliverd
DeliveryCompletedDelayedShipment delivered with a delay
DeliveryFailedLocationUnavailableThe delivery location could not be reached (eg roadworks, parade etc..)
DeliveryFailedContactCarrierdelivery failed, contact the carrier for more information
DeliveryFailedAbsentRecipientThere was no recipient available at the time of the delivery attempt
DeliveryFailedRecipientClosedThe recipients location was closed/business closed at the time of the delivery attempt
DeliveryFailedNoValidRecipientThe delivery failed as there was nobody allowed to receive the goods, eg adult signature required or named delivery only
DeliveryFailedAccessCodeMissingTo complete delivery, an access code was required. The driver did not have access/knew the correct access code
DeliveryFailedOtherDelivery failed, a no/other specific information about the delivery failure was provided
DeliveryFailedAdditionalEquipmentRequiredDelivery failed as additional equipment was required to complete the delivery
DeliveryFailedRefusedByRecipientRequestedOtherDeliveryDateDelivery failed as the recipient requested a different delivery date
DeliveryFailedRefusedByRecipientDelivery failed as recipient refused to receive the goods
DeliveryFailedRefusedByRecipientIncorrectContactDetailsDelivery failed as recipient refused the delivery due to incorrect contact details provided
DeliveryFailedDamagedDelivery failed as goods where damaged
DeliveryFailedRefusedByRecipientDamagedRecipient refused complete shipment as it was damaged
DeliveryFailedRefusedByRecipientNotOrderedReceipient refused shipment as the goods where not ordered
DeliveryFailedRefusedByRecipientMissingDocumentsRecipient refused shipment as the expected documentation was missing
DeliveryFailedRefusedByRecipientInventoryRecipient refused shipment as they are doing inventory count
DeliveryFailedRefusedByRecipientLateDeliveryRecipient refused shipment as it missed its requested delivery window
DeliveryFailedRefusedByRecipientShipmentIncompleteRecipient refused shipment as it was not delivered complete
DeliveryFailedRefusedByRecipientIncompleteDueToMissingRecipient refused shipment as it was not delivered complete, shipment was incomplete because parts are missing
DeliveryFailedRefusedByRecipientCancelledRecipient refused shipment as the shipment was cancelled
DeliveryFailedWaitingTimeExceededDelivery failed as driver waiting time exceeded
DeliveryFailedRecipientMovedDelivery failed as recipient is no longer available on the requested delivery location, they moved.
DeliveryParcelShopPlannedGoods are planned to be sent to a parcelshop, incl planned to arrive
DeliveryParcelShopArrivedGoods have arrived at the parcelshop
DeliveryParcelShopArrivalFailedParcelShopClosedGoods did not arrive at parcelshop as it was closed
DeliveryParcelShopArrivalFailedCannotBeReachedGoods did not arrive at parcelshop as it could not be reached, eg festival/roadblocks
DeliveryParcelShopArrivalFailedOtherGoods did not arrive at parcelshop, other reason
DeliveryParcelShopAvailableForCollectionGoods are available for collection by recipient at parcelshop
DeliveryParcelShopAvailableForCollectionReminderReminder that goods are available for collection at parcelshop
DeliveryParcelShopCollectedGoods collected by recipient at parcelshop
DeliveryParcelShopReturnedToSenderNotCollectedGoods are returned from parcelshop to sender as the goods where not collected within the agreed timeframe
DeliveryParcelShopReturnedToSenderNoSpaceAvailableGoods are returned from parcelshop to sender as there is no space to store the goods in parcelshop
DeliveryLockerPlannedDelivery is planned to a locker, incl planned to arrive
DeliveryLockerArrivalFailedNoEmptyLockerAvailableDelivery into locker failed as there is no empty locker available
DeliveryLockerArrivalFailedDoesNotFitInLockerDelivery into locker failed as the goods did not fit in an available locker
DeliveryLockerArrivalFailedOtherDelivery into locker failed, other reason
DeliveryLockerAvailableForCollectionGoods are available for collection by recipient at delivery locker
DeliveryLockerAvailableForCollectionReminderReminder that goods are available for collection at delivery locker
DeliveryLockerCollectedGoods collected by recipient at delivery locker
DeliveryLockerReturnedToSenderGoods returned to sender after it was stored in a delivery locker
ReturnRequestedGoods being returned to the seller of the goods. Eg a defective phone is returned to Apple.
ReturnCollectedReturn is collected by carrier
ReturnCancelledReturn is cancelled, no indication who cancelled
ReturnCancelledByCustomerReturn is cancelled by the customer, no need to execute the return anymore
ReturnCancelledByShipperReturn is cancelled by the shipper/account holder
ReturnOthereg return link expiring soon
ReturnParcelShopRequestedGoods being returned to the seller of the goods where initial the consumer returns the product through a parcelShop
ReturnParcelShopAvailableForCollectionGoods have been delivered at the parcelshop by the consumer, they are ready for collection by carrier.
ReturnParcelShopCollectedgoods have been collected by the carrier at the parcelshop
ReturnParcelShopCancelledreturn through a parcelshop is cancelled
CashOnDeliveryRequestedCash on delivery amount is due / requested for the shipment
CashOnDeliveryFundsCollectedThe funds required for cash on delivery have been collected/obtained from the recipient
CashOnDeliveryFailedCash on delivery collection failed
CashOnDeliveryFundsTransferredThe cash on delivery amount collected from the recipient is transferred to the shipper
ExceptionMissingException, (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
ExceptionDamagedInTransit(Part of) shipment got damaged while in transit
ExceptionDamagedInHub(Part of) shipment got damaged while handling in hub
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
ExceptionDamagedDestroyedGoods where destroyed
ExceptionDamagedDestroyedOnRequestOfShipperGoods where destroyed on instruction of the shipper
ExceptionDamagedDestroyedByRegulationGoods where destroyed on instruction of govenment agency
ExceptionDamagedDeliveredDamaged shipment was still deliverd at recipient
ExceptionDelayedBankHolidayDelivery of shipment is delayed due to a bank holiday
ExceptionDelayedAdministrativeRectivicationDelivery delayed as adminstrative rectivications had to be made
ExceptionDelayedAdditionalEquipmentRequiredShipment was delayed because for pickup or delivery additional equipment was required
ExceptionDelayedDeliveryAppointmentRequiredDelivery is delayed because an appointment for delivery is required
ExceptionDelayedEquipmentFailureDelay caused by transport equipment failure
ExceptionDelayedForceMajeureDelivery is delayed due to unconrolled events
ExceptionDelayedIncorrectLabellingDelivery is delayed to incorrect labelling
ExceptionDelayedIncorrectAddressDelivery is delayed to incorrect address information
ExceptionDelayedIncorrectShipmentInformationInformation in the shipment is incorrect and causing a potential delay. Eg invalid service (options) or incorrect dimensions
ExceptionDelayedIndustrialDisputeAn industrial dispute causes a delivery delay
ExceptionDelayedLackOfTransportCapacityShipment is delayed due to a lack of transport capacity
ExceptionDelayedLackOfUnloadingSpaceShipment is delayed as it could not be unloaded due to limited space at the unloading area
ExceptionDelayedMissingDocumentsShipment is delayed due to missing documents
ExceptionDelayedMissingDocumentsFromShipperShipment is delayed due to miss documents that should have been provided by the shipper
ExceptionDelayedMissingDocumentsFromCarrierShipment is delayed due to miss documents that should have been provided by the carrier
ExceptionDelayedNotLoadedAsBondedGoodsGoods appear to be bonded but where not loaded as such
ExceptionDelayedNotLoadedAsDangerousGoodsGoods appear be Dangerous Goods but where not booked and loaded as such
ExceptionDelayedOversizeOverweightShipment is delayed as it is has large dimensions or high weight, requiring different handling as planned
ExceptionDelayedWrongRoutingShipment is delayed due to an operational error at carrier side. Eg it has been routed incorrect within the network.
ExceptionDelayedTemperatureExceededShipment is delayed because the allowed temperature limits where exceeded
ExceptionDelayedWaitingForEdiShipment is being delayed because electronic information about the delivery is not provided yet
ExceptionDelayedMissedConnectionShipment delayed due to missed connection
ExceptionDelayedGeneralTimeConstraintShipment is delayed to do various reasons within the carrier network causing a time pressure
ExceptionDelayedUnknownShipment dealyed due to an unknown reason
ExceptionDelayedOtherShipment delayed due to a specific other reason, carrier should provide details in description
ExceptionDelayedAccidentShipment delayed due to an accident
ExceptionDelayedContactCarrierMissingInformationShipment is delayed, contact with the carrier is required to provide missing information
ExceptionDelayedContactCarrierByShipperShipment is delayed, it is waiting for contact with the shipper
ExceptionDelayedContactCarrierByRecipientShipment is delayed, it is waiting for contact with the recipient
ExceptionDelayedMissingShipment delayed as it cannot be found
ExceptionDelayedMissingUnderInvestigationMissing shipment is being investigated
ExceptionDelayedWeatherConditionsGood where delayed due to sever weather conditions disrupting the carriers operation
ExceptionDelayedSecurityChecksGoods where delayed due to security checks performed
ExceptionDelayedDestroyedHeavilyDamagedGoods where damaged to a degree that they had to be destroyed
ExceptionDelayedDestroyedOnRequestOfShipperGoods where destroyed on request/confirmation of the shipper
ExceptionReturnToSenderUncollectedFromPickupPointGoods returned to sender from pickup point, after not being collected within period
ExceptionReturnToSenderRefusedAtDeliveryGoods returned to sender as recipient refused to accept the goods
ExceptionReturnToSenderUnknownAddressGoods returned to sender as carrier could not find indicated address
ExceptionReturnToSenderPartiallyPart of the goods are returned to sender, rest is kept by receipient
ExceptionReturnToSenderOtherGoods returned to sender, no specific or other indication why
ExceptionReturnToSenderDamagedGoods are returned to sender because they are damaged
ExceptionReturnToSenderIncidentGoods are returned to sender because they were involved in an incident
ExceptionReturnToSenderCancelledByShipperGoods are return to sender because the shipper cancelled the shipment
ExceptionReturnToSenderCustomsInspectionResultGoods are returned to sender as something was missing/incorrect during customs inspection
ExceptionOtherAnother exception that did fit to one of the other categories
ClaimRequestedShipper or recipient filed a claim with carrier on service of shipment
ClaimPlannedcarrier planned research for claim
ClaimStartedcarrier started claim procedure
ClaimDelayedclaim procedure is delayed
ClaimDelayedAdditionalInformationRequiredFromShipperadditional information is required from the shipper to continue with the claim procedure
ClaimDelayedAdditionalInformationRequiredFromRecipientadditional information is required from the shipper to continue with the claim procedure
ClaimRejectedclaim is rejected by the carrier
ClaimAcceptedclaim is accepted by the carrier
ClaimCancelledByShipperclaim is cancelled by shipper
ClaimCancelledByCarrierclaim is cancelled by carrier
ClaimCancelledByRecipientclaim is cancelled by recipient
ClaimReembursedFunds related to the claim are reembursed by the carrier to the shipper
OtherAnother event for which no process was specified for yet