Skip to content

Update Customer Address

Update an existing address in the customer's address book.

Endpoint

PUT /api/shop/customers/addresses/{addressId}

URL Parameters

ParameterTypeRequiredDescription
addressIdintegerYesAddress ID to update

Request Headers

HeaderRequiredDescription
Content-TypeYesapplication/json
X-STOREFRONT-KEYYesYour storefront API key
AuthorizationYesBearer token (customer login required)

Request Body

json
{
  "firstName": "Jane",
  "lastName": "Doe",
  "address": "789 Pine Rd",
  "city": "Los Angeles",
  "state": "CA",
  "country": "US",
  "postcode": "90002",
  "phone": "9876543210"
}

Request Parameters

ParameterTypeRequiredDescription
firstNamestringYesFirst name
lastNamestringYesLast name
addressstringYesStreet address
citystringYesCity
statestringYesState/Province
countrystringYesCountry code
postcodestringYesPostal code
phonestringNoPhone number

Response Fields (200 OK)

FieldTypeDescription
addressobjectUpdated address details
messagestringSuccess message

Validation Rules

  • Address must belong to customer
  • All required fields must be provided
  • Country/State must be valid
  • Cannot update other customer's addresses

Use Cases

  • Correct address information
  • Update phone number
  • Change city/state
  • Modify street address
  • Update postal code

Released under the MIT License.