Pre-Launch Announcement: Introducing Additional Information in Tracking API and Push Notifications
We are thrilled to introduce additional information to provide finer level of details about tracking a package. These updates would be applied to Get Tracking API and Push Notification features, and is applicable to both on and off-Amazon deliveries.
What is improving?
Amazon Shipping is introducing additional fields and information into the tracking API and Push notifications to provide you with additional details when tracking packages. We are introducing new detail codes to indicate when a package was delivered using a onetime passcode, when it has arrived at the local carrier facility, and when it was rejected using a pin. We are introducing a new event code for when a recipient has rescheduled the delivery date to allow shippers to better understand when changes to the delivery date are due to recipient request. We are also introducing to the push notifications a new field that will provide the latest estimated arrival date for the package.
When it is happening?
The scheduled launch date for the changes is set for Nov 11, 2024.
What is included in this enhancement?
The following changes are going to be available via this enhancement:
1-EventCode:
In order to determine if the recipient has requested a different delivery date, we will begin populating a new event code, “RecipientRequestedAlternateDeliveryTiming”. This will allow shippers to better understand when changes to the delivery date are due to recipient request.
EventCode
The tracking event type.
Type : enum
| Value | Description |
|---|---|
| RecipientRequestedAlternateDeliveryTiming New | Recipient has requested an update to their delivery date. |
| ReadyForReceive | Package has been created and is ready for pickup at the shipper's location. This is a pre-transit status event code. |
| PickupDone | Package has been picked up by the service provider. |
| Delivered | Package has been delivered. When this tracking event occurs with the leg type of "REVERSE" this means that the package has been successfully returned to the shipper. |
| Departed | Package has departed from a particular location in carrier network. |
| DeliveryAttempted | Delivery was attempted, but was unsuccessful. |
| Lost | Package is lost. |
| OutForDelivery | Package is out for delivery. |
| ArrivedAtCarrierFacility | Package is in transit and has been received at a carrier location. |
| Rejected | Package was rejected by the recipient. |
| Undeliverable | Package is undeliverable. |
| PickupCancelled | Pickup scheduled for the package was cancelled. |
| ReturnInitiated | Return label has been generated. |
| AvailableForPickup | Package held for recipient pickup. |
2-DetailCode:
We are expanding the list of possible detail codes that we surface in the tracking response to include when a package was delivered using a onetime passcode, when it has arrived at the final carrier facility, and when it was rejected using a pin.
detailCodes
Type : enum
Contains additional details related to the shipment status.
| Value | Description |
|---|---|
| DeliveredWithOTP New | Shipment was delivered with onetime passcode. OTP is currently only available in: UK, FR, IT, ES, IN. |
| ArrivedAtLocalFacility New | Package arrived at the local facility. |
| RejectedByRecipientWithVerification New | Recipient refused to accept the shipment and provided verification |
| BusinessClosed | Attempted delivery but the business was closed |
| CustomerUnavailable | Attempted delivery but the Recipient was Unavailable |
| PaymentNotReady | Attempted delivery but cash was not available from Recipient |
| OtpNotAvailable | Attempted delivery but the recipient did not have the PIN available |
| DeliveryAttempted | Delivery was attempted |
| UnableToAccess | Attempted delivery but could not access the recipient location |
| UnableToContactRecipient | Attempted delivery but is unable to contact the recipient to coordinate delivery |
| DeliveredToBehindWheelieBin | Shipment delivered behind wheelie bin |
| DeliveredToPorch | Shipment delivered to front porch or front door |
| DeliveredToGarage | Shipment delivered to garage |
| DeliveredToGarden | Shipment delivered to garden |
| DeliveredToGreenhouse | Shipment delivered to greenhouse |
| DeliveredToMailSlot | Shipment delivered to letterbox/Mail slot |
| DeliveredToMailRoom | Shipment delivered to mailroom |
| DeliveredToNeighbor | Shipment delivered and signed for by neighbor |
| DeliveredToRearDoor | Shipment delivered to rear porch or rear door |
| DeliveredToReceptionist | Shipment delivered to reception |
| DeliveredToShed | Shipment delivered to shed |
| Signed | Shipment delivered and signature received |
| Damaged | Shipment was damaged. When paired with "REJECTED" this indicates the Recipient refused to accept the shipment because the shipment was damaged. When paired with "UNDELIVERABLE" it means the shipment was undeliverable due to being damaged and may be returned to the seller. |
| IncorrectItems | Recipient refused to accept the shipment because the shipment contains the incorrect item |
| NotRequired | Recipient refused to accept the shipment because the recipient did not want the shipment |
| Rejected | Recipient refused to accept the shipment |
| CancelledByRecipient | Shipment was cancelled by the recipient. This tag is paired with the rejected Shipment status |
| AddressNotFound | Shipment is undeliverable and is returning to seller because the address was missing or incorrect |
| HazmatShipment | Shipment is non-compliant Hazmat |
| Undeliverable | Shipment is undeliverable and is returning to seller |
3-EstimatedArrivalDate (Push Notifications only):
Previously, shippers using the push notifications would not get any information on the expected delivery date of a package. We are introducing a new field that will provide the latest estimated arrival date for the package, allowing shippers to better understand the current state of their packages journey.
Push Notification payload:
| Name | Description | Schema |
|---|---|---|
| trackingId | Tracking ID for the container for which tracking events are requested. | TrackingId |
| eventTime | The ISO 8601 formatted timestamp of the event. | string (date-time) |
| Status | High-level status of the tracked shipment. | Status (enum) |
| alternateLegTrackingId | The carrier generated reverse identifier for a returned package in a purchased shipment. | AlternateLegTrackingId (string) |
| eventCode | The tracking event type. | EventCode (enum) |
| shipmentType | Indicates whether the event is for the forward or reverse leg. | shipmentType |
| trackingDetailCodes | Contains additional details related to the shipment status. | trackingDetailCodes |
| promisedDeliveryDate New | New The date the package is expected to be delivered. | string (date-time) |
Sample Push Notification Tracking response:
{
"version": "0",
"id": "2d1cf554-e7f0-2362-6b2d-dd36bd4677e2",
"detail-type": "Tracking Detail",
"source": "AmazonShipping",
"account": "434519225125",
"time": "2023-01-23T11:09:42Z",
"region": "eu-west-1",
"resources": [],
"detail": {
"shippingPartyAccountId": "A1QW4MEBU0BWQI",
"trackingId": "test_tracking_id",
"eventTime": "2023-01-16T15:39:23Z",
"status": "InTransit",
"alternateLegTrackingId": "65665589589",
"eventCode": "PickupDone",
"appId": "amzn1.sp.solution.4622520d-ef11-4366-aa17-5ff8bb0b9aea",
"shipmentType": "FORWARD",
"trackingDetailCodes": [
"DeliveredToPorch"
],
"version": 2,
"timeToLive": 1679569781,
"promisedDeliveryDate": "2024-01-23T11:09:42Z"// [New] The estimated delivery date for the package.
}
}
FAQ
1-What action is required from my end?
To leverage these new Enums and the new field, ensure that your mapping is updated to accommodate the additional fields. Make the necessary adjustments in your systems or applications to capture and process the enhanced tracking data.
2-How does a package get rescheduled?
Recipients in Geographies where the reschedule delivery date feature is available can choose to reschedule their delivery date. This is available in the UK, FR, IT, ES. Some last mile delivery providers leveraged by Amazon Shipping may also provide this feature.