Customer Address Management

This document is for a version of Craft Commerce that is no longer supported. Please refer to the latest version →

• On this Page

  • Get all addresses belonging to the current customer.
  • Updating or creating a new a customers address
  • Deleting a customers address

When a customer checks out with a new address, the address is added to their address book.

If the customer is a guest, they have no need to manage an address book.

Customers can only add and remove addresses from the front-end while they are logged in.

Get all addresses belonging to the current customer.

{% addresses = craft.commerce.customer.addresses %}
{% for address in addresses %}
  {address.firstName}<br/>
  ...
{% endfor %}

See the Address model page to learn about the fields available on an address.

Updating or creating a new a customers address

<form method="post">
  <input type="hidden" name="action" value="commerce/customerAddresses/save">
  <input type="hidden" name="redirect" value="commerce/customer/addresses">
  <input type="text" name="address[firstName]" value="{{ address ? address[firstName] : '' }}">
  <input type="text" name="address[lastName]" value="{{ address ? address[lastName] : '' }}">
  ...
  <input type="submit" value="Save"/>
</form>

Including an address[id] param with a valid address ID that belongs to the current customer will update that address.

Deleting a customers address

<form method="post">
  <input type="hidden" name="action" value="commerce/customerAddresses/delete">
  <input type="hidden" name="redirect" value="commerce/customer/addresses">
  <input type="hidden" name="id" value="{{ address.id }}"/>
  <input type="submit" value="delete"/>
</form>

If you delete an address that is currently applied as the billing or shipping address of the current customers cart, will result in the addresses on the cart being removed.