Customer Address Management

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

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.

See craft\commerce\models\Customer (opens new window) to learn about the methods available to retrieve customer address data e.g. craft\commerce\models\Customer::getPrimaryBillingAddress() (opens new window), craft\commerce\models\Customer::getPrimaryShippingAddress() (opens new window) and craft\commerce\models\Customer::getAddressById() (opens new window).

# Get all addresses belonging to the current customer

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

See craft\commerce\models\Address (opens new window) to learn about the fields available on an address.

# Get a specific address belonging to the current customer by its ID

{% set address = craft.commerce.customer.getAddressById(id) %}

# Updating or creating a new customer address

<form method="post">
  <input type="hidden" name="action" value="commerce/customer-addresses/save">
  {{ redirectInput('commerce/customer/addresses') }}
  {{ csrfInput() }}
  <input type="text" name="address[firstName]" value="{{ address is defined ? address.firstName : '' }}">
  <input type="text" name="address[lastName]" value="{{ address is defined ? address.lastName : '' }}">
  <input type="submit" value="Save"/>

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

# Deleting a customer’s address

<form method="post">
  <input type="hidden" name="action" value="commerce/customer-addresses/delete">
  {{ redirectInput('commerce/customer/addresses') }}
  {{ csrfInput() }}
  <input type="hidden" name="id" value="{{ }}"/>
  <input type="submit" value="delete"/>

Deleting an address that is currently applied as the billing or shipping address of the current customer’s cart will result in the addresses on the cart being removed.