Deleting customer addresses in magento

Deleting customer addresses in magento

July 21, 2026 · Illustrated author avatarBy Stefan Bogdanescu
Deleting customer addresses in magento

Deleting Customer Addresses Programmatically in Magento

Deleting customer addresses programmatically is a common requirement when you need to clean up data or update your database structure. In this post, we’ll guide you through the process of deleting customer addresses using Magento’s built-in API.

Understanding the Problem

You’ve already retrieved the customer addresses as an array using the getAddresses() method:

$recordedAddresses = array();
foreach ($customer->getAddresses() as $address)
{
    $recordedAddresses[] = $address->toArray();
}

This gives you a collection of address objects, but you’re having trouble finding a function to delete them. The documentation is sparse on this topic, which can make it challenging to find the right solution.

Deleting Addresses Programmatically

To delete customer addresses programmatically in Magento 2, we’ll use the \Magento\Customer\Model\AddressManagement class and its deleteById method:

$addressId = $address->getEntityId();
$this->addressManagement->deleteById($customerId, $addressId);

Here’s a step-by-step guide to deleting addresses:

  1. Inject the \Magento\Customer\Model\AddressManagement class in your constructor:
private AddressManagement $addressManagement;

public function __construct(
    ...
    AddressManagement $addressManagement,
    ...
) {
    ...
    $this->addressManagement = $addressManagement;
    ...
}
  1. Retrieve the customer ID and address ID from the $address object:
$customerId = $customer->getId();
$addressId = $address->getEntityId();
  1. Call the deleteById method to delete the desired address:
$this->addressManagement->deleteById($customerId, $addressId);

Deleting Multiple Addresses

If you need to delete multiple addresses for a single customer, you can iterate through the $recordedAddresses[] array and call deleteById inside your loop:

foreach ($recordedAddresses as $addressData) {
    $addressId = $addressData['entity_id'];
    try {
        $this->addressManagement->deleteById($customerId, $addressId);
        Mage::log("Address " . $addressId . " deleted successfully");
    } catch (Exception $e) {
        Mage::log("Error deleting address: " . $e->getMessage());
    }
}

Conclusion

Deleting customer addresses programmatically in Magento 2 requires using the \Magento\Customer\Model\AddressManagement class and its deleteById method. By injecting this class into your code, you can easily delete single or multiple addresses for a specific customer.

Remember to handle exceptions properly when deleting addresses to ensure that any errors are logged correctly without affecting the rest of your application.

For more advanced Magento programming techniques, be sure to check out our comprehensive guide on Magento Development Best Practices at Laravel Company.

Magento 2 Database API Customers

Our network