PACKAGE_TRACKER_MILESTONE_CHANGED

📘

Important

The Buy with Prime API is offered as a preview and might change as we receive feedback and iterate on the interfaces. We are sharing this early documentation to help you learn about the Buy with Prime API as we write and iterate on the content.

The PACKAGE_TRACKER_MILESTONE_CHANGED event is published when a milestone of a Buy with Prime tracking number is updated. A milestone represents an event that occurs during the delivery process for the associated tracking number.

For details on the schema and fields of an event, see Event Interface.

The following examples are ways that you might use this event:

  • To enable customers to see on various touch points (for example, merchant order history, Amazon order history, Buy with Prime order details) that package tracking information has been updated.
  • To enable developers to write code to signal the internal notification system to send notifications to customers upon package tracking milestone updates.
  • To enable customer service agents to see that package tracking information was updated so that they can give the customer updated information if the customer reaches out by phone or email.
  • To enable developers to write code to signal the order management system to build a timeline view of all the events occurred for the package.

Required permission

To subscribe to this event, your API credentials must have at least View Package Tracker Data permission. You choose permissions when you generate your API credentials.

Handling the event

When you receive this event, you typically query the Order interface to get the package information. For Order interface examples, see Query a Buy with Prime Order.

Related topics