Package tracking push notifications
Package tracking push notifications
The package tracking push notification provides real-time tracking updates for Amazon Business orders. Notifications are automatically sent to your webhook endpoint when package tracking status changes occur. You can use the data in this notification to build event-based notification systems, such as email alerts. Each notification also includes all the data necessary to call the Package Tracking API, allowing you to pull more detailed information about each package. For more information, see Package tracking overview.
Package tracking notifications are sent for Amazon Business orders that are placed from external systems, such as using Ordering API and Punchout. Package tracking notifications are not sent for orders placed directly from the Amazon Business website.
Push notification reference
Each push notification contains the following details:
| Name | Description |
|---|---|
orderId | The unique identifier of an order. |
trackingId | The unique tracking identifer of the shipment. |
shipmentId | The unique identifier for a shipment. |
packageId | The unique identifier of the package. |
poNumber | The purchase order number used to retrieve associated orders. |
eventTimeStampInEpochMillis | The event time stamp in epoch milliseconds. |
deliveryStatus | The current delivery status of the package. |
detailedTrackingStatus | The detailed tracking status of the package. |
The deliveryStatus and detailedTrackingStatus can display the following combinations of values. Each detailedTrackingStatus event triggers a notification.
detailedTrackingStatus values | deliveryStatus values |
|---|---|
PACKAGE_DEPARTED_FROM_FC_SHIPPER_SELLER | SHIPPED |
PACKAGE_ARRIVED_AT_CARRIER_FACILITY - (CityName) | SHIPPED |
PACKAGE_LEFT_FROM_CARRIER_FACILITY - (CityName) | SHIPPED |
PACKAGE_OUT_FOR_DELIVERY | OUT_FOR_DELIVERY |
PACKAGE_DELIVERED_TO_CUSTOMER | DELIVERED |
PACKAGE_ESTIMATED_DELIVERY_DATE_CHANGED | DELAYED |
PACKAGE_AVAILABLE_FOR_PICKUP | DELIVERED |
Note that the city name is optional in the
PACKAGE_ARRIVED_AT_CARRIER_FACILITY - (CityName)andPACKAGE_LEFT_FROM_CARRIER_FACILITY - (CityName)detailed tracking status values. If the city name is not provided by the shipment carrier, the notification will not include the city name.
{
"orderId":"111-7245942-7232256",
"trackingId":"9361289724456641938913",
"shipmentId":"433631239441301",
"packageId":"1",
"poNumber":"NWMD-NWMD01446",
"eventTimeStampInEpochMillis":1763581440000,
"deliveryStatus":"SHIPPED",
"detailedTrackingStatus":"PACKAGE_ARRIVED_AT_CARRIER_FACILITY - BHIWANDI"
}
Receiving notifications
Prerequisites
Before proceeding, ensure you have the following:
- An Amazon Business account. For more information, see Onboarding Step 1.
- An HTTPS webhook URL endpoint to receive the notifications.
Subscribe to notifications
To receive package tracking push notifications, complete the following steps:
- Determine the account identifier you’d like to use to retrieve notifications. The identifier determines the level at which you receive notifications:
| Identifier | Notification level |
|---|---|
| Amazon Business group ID | Receive notifications for all orders placed using the specified group. |
| Amazon Business account ID | Receive notifications for all orders placed using your Amazon Business account. |
| Application ID | Receive notifications for all orders associated with an Amazon Business API application ID in Solution Provider Portal (SPP). |
- Provide the following details to your Amazon Business technical contact:
- Your chosen identifier
- Your webhook URL endpoint
Once you provide these details, Amazon Business will enable your account to receive notifications. Once enabled, you will start receiving notifications whenever a package tracking event occurs. For package tracking event specifications, see Push notification reference.
Notifications are sent for any package tracking events that occur after onboarding, including events for shipments that are already currently in progress.
Updated about 11 hours ago