Get recipient details for attended deliveries

Learn how to get the recipient details for packages delivered to specific individuals other than the intended recipient.

Prerequisites

To complete this tutorial, you need:

• Authorization from the selling partner for whom you are making calls. For more information, refer to Authorizing Selling Partner API Applications.
• The Amazon Fulfillment role assigned to your developer profile.
• The Amazon Fulfillment role selected in the App registration page for your application.

Retrieve recipient details for attended deliveries

Call the getOrder operation. In the response:

1. Locate the shipment in the shipments array.
2. Locate the package in the packages array.
3. Check the tracking.dropOffLocation object. This object contains two properties: type (string) and attributes (object). The type indicates where the package was delivered, and the attributes property provides recipient details based on delivery type.

Drop point types and associated fields

• FALLBACK_NEIGHBOR_DELIVERY
  • neighborName: Name of the neighbor who received the package
  • houseNumber: Door or unit number of the neighbor
• RECEPTIONIST
  • recipientName: Name of the receptionist who received the package
• LOCKER
  • number: The locker number
  • accessCode: The code to access the locker

Sample response

{
  "packages": [
    {
      "packageId": "PKG-abc123def456",
      "status": "DELIVERED",
      "tracking": {
        "carrier": { "carrierCode": "UPS", "trackingNumber": "1Z999AA101" },
        "dropOffLocation": {
          "type": "FALLBACK_NEIGHBOR_DELIVERY",
          "attributes": {
            "neighborName": "Frank Doe",
            "houseNumber": "142"
          }
        }
      }
    }
  ]
}