Event Types

📘

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.

You can subscribe to receive the following Buy with Prime events.

For details about how to subscribe to events, see Steps to Subscribe to Buy with Prime Events.

EventWhen Event is Published
BUYABILITY_CHANGEDAn item that was previously eligible for Buy with Prime is no longer eligible for Buy with Prime, or vice versa.
INVENTORY_CHANGEDAn item's inventory level changes or an item has an error that requires merchant action.
PACKAGE_DELIVEREDOne or more items were delivered to their destination.
PACKAGE_DELIVERY_CANCELLEDOne or more items were successfully cancelled from the specified order.
PACKAGE_DELIVERY_IN_TRANSITOne or more items in the specified order were shipped.
PACKAGE_TRACKER_MILESTONE_CHANGEDA milestone of a Buy with Prime tracking number was updated. A milestone represents an event that occurs during the delivery process for the associated tracking number.
PERSONAL_DATA_DELETION_TASK_COMPLETEDA data deletion request completed.
PERSONAL_DATA_DELETION_TASK_FAILEDA data deletion request failed.
PERSONAL_DATA_RETRIEVAL_TASK_COMPLETEDA data retrieval request completed. The data is ready for you to download.
PERSONAL_DATA_RETRIEVAL_TASK_FAILEDA data retrieval request failed.
REFUND_REQUESTEDThere is a request to issue a refund for one or more items.
RETURN_COMPLETEDA return that was initiated earlier was successfully completed.
RETURN_PACKAGE_DELIVEREDA returned Buy with Prime item was delivered to the fulfillment center.
RETURN_PACKAGE_DELIVERY_FAILEDA returned Buy with Prime item failed to be delivered to the fulfillment center.
RETURN_PACKAGE_IN_TRANSITA returned Buy with Prime item was dropped off at the carrier location.
RETURN_ITEM_GRADEDThe grading of a returned Buy with Prime item at the fulfillment center is complete.
RETURN_STARTEDA return of one or more purchased items was successfully initiated.

Related topics