Buy with Prime | Developer Documentation
Documentation

PACKAGE_DELIVERED

📘

Buy with Prime API is now available for early access

Sign up for early access to the Buy with Prime API using the 'Sign Up' button below. The API may change as Amazon receives feedback and iterates on it.

Sign Up

The PACKAGE_DELIVERED event is published when one or more items were delivered to their destination. Typically, this event means that the shopper has received some or all items that they ordered.

This event was previously called DELIVERY_COMPLETED.

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

  • To enable customer service representatives to see that an item was delivered, so that they can give the shopper accurate information if the shopper reaches out by phone or email.
  • To enable developers to update their order management system and all of the downstream systems. Examples of downstream systems are analytics and reporting on business performance, accounting for remitting taxes, customer service representatives helping shoppers who reach out, and so on.

Required permission

To subscribe to this event, your API credentials must have at least Read Order permission. You choose permissions when you generate your API credentials. For details, see Authenticate to the Buy with Prime API.

Schema

Schema for webhook destinations 
{
    "idempotencyKey":"example-idempotency-key",
    "eventDescriptor": "PACKAGE_DELIVERED",
    "resources": [
        "businessProduct/business-product-id/order/order-id/delivery/delivery-id"
    ],
    "eventId":"example-event-id",
    "apiVersion": "2024-11-01",
    "subscriptionId": "example-subscription-id",
    "eventTime":"2025-01-20T12:34:56Z",
    "data": {
        "order": {
            "id": "example-order-id",
            "aliases": [
                {
                    "aliasId": "example-alias-id",
                    "aliasType": "example-alias-type"
                }
            ],
            "packageInformation": {
                "details": [
                    {
                        "id": "example-delivery-information-id",
                        "state": "DELIVERED",
                        "packageTracker": {
                            "packageTrackerIdentifier": {
                                "trackingNumber": "example-tracking-number",
                                "carrierCode": "example-carrier-code"
                            },
                            "trackingUrl": "example-tracking-url"
                        },
                        "packageInformationDetailsFor": {
                            "orderLineItems": [
                                {
                                    "lineItem": {
                                        "id": "example-line-item-id"
                                    }
                                }
                            ]
                        }
                    }
                ]
            }
        }
    }
}
Schema for Amazon EventBridge destinations 
{
    "version": "0",
    "id": "example-event-id",
    "detail-type": "PACKAGE_DELIVERED",
    "source": "aws.partner/buywithprime/partner-event-source-name",
    "account": "example-aws-account-id",
    "time": "2025-01-20T12:34:56Z",
    "region": "us-east-1",
    "resources": [
        "businessProduct/business-product-id/order/order-id/delivery/delivery-id"
    ], 
    "detail": {
        "idempotencyKey":"example-idempotency-key",
        "eventDescriptor": "PACKAGE_DELIVERED",
        "resources": [
            "businessProduct/business-product-id/order/order-id/delivery/delivery-id"
        ],
        "eventId":"example-event-id",
        "apiVersion": "2024-11-01",
        "subscriptionId": "example-subscription-id",
        "eventTime":"2025-01-20T12:34:56Z",
        "data": {
            "order": {
                "id": "example-order-id",
                "aliases": [
                    {
                        "aliasId": "example-alias-id",
                        "aliasType": "example-alias-type"
                    }
                ],
                "packageInformation": {
                    "details": [
                        {
                            "id": "example-delivery-information-id",
                            "state": "DELIVERED",
                            "packageTracker": {
                                "packageTrackerIdentifier": {
                                    "trackingNumber": "example-tracking-number",
                                    "carrierCode": "example-carrier-code"
                                },
                                "trackingUrl": "example-tracking-url"
                            },
                            "packageInformationDetailsFor": {
                                "orderLineItems": [
                                    {
                                        "lineItem": {
                                            "id": "example-line-item-id"
                                        }
                                    }
                                ]
                            }
                        }
                    ]
                }
            }
        }
    }
}

Fields

KeyData typeDescription
versionStringAmazon EventBridge event version.
idStringAmazon EventBridge-generated UUID for an event.
detail-typeStringType schema for the detail of the event, which in this case is PACKAGE_DELIVERED.
sourceStringName of the partner event source in Amazon EventBridge. For details, see Subscribe to Events.
accountStringAWS account ID that hosts the partner event source.
timeStringISO 8601 timestamp that indicates when the event was published.
regionStringAWS region from which the event is published.
resourcesArray of stringsArray of identifiers for the resources that triggered the event, in key-value pair format. Each resource identifier is a string that starts with businessProduct/{businessProductId}/, followed by resource types (keys) and resource IDs (values) separated by slashes. For details about how to interpret resources, see Subscribe to Events.
detailObjectJSON object that contains details about the event. For details, see detail fields.

Detail fields

KeyData typeDescription
idempotencyKeyStringUnique identifier to detect duplicate events.
eventDescriptorStringEvent type that determines the default query.
resourcesArray of stringsArray of identifiers for the resources that triggered the event, in key-value pair format. Each resource identifier is a string that starts with businessProduct/{businessProductId}/, followed by resource types (keys) and resource IDs (values) separated by slashes. This field is the same value as resources at the top level.
eventIdStringUnique identifier for this event. This field is the same value as id at the top level.
apiVersionStringBuy with Prime API version associated with this event.
subscriptionIdStringUnique identifier for an event subscription.
eventTimeStringISO 8601 timestamp that indicates when the event was published. This field is the same value as time at the top level.
dataObjectJSON object that can contain API response data. The PACKAGE_DELIVERED event's data payload contains the package's associated order object.

Handling the event

When you receive this event, you typically parse the included order information found in the data object to fetch delivery information for all line items in the order. Take the following steps:

  1. Parse the resources array of the event to get the delivery ID.
  2. In the data object, navigate to the packageInformation.details array and find the element with the delivery ID that you found in the resources array of the event. The element with the delivery ID contains delivery details and a set of products delivered together to the shopper. Several line items can have the same delivery ID.

If you require information not found in the data object, query the order using the order ID found in the resources array.

Related topics

Updated 20 days ago