Create Customer Address
Add a new address to the customer's address book.
Endpoint
POST /api/shop/customer-addressesRequest Headers
| Header | Required | Description |
|---|---|---|
Content-Type | Yes | application/json |
X-STOREFRONT-KEY | Yes | Your storefront API key |
Authorization | Yes | Bearer token (customer login required) |
Request Body
json
{
"firstName": "Jane",
"lastName": "Doe",
"companyName": "ANC Corporation",
"vatId": "GB123456789",
"email": "[email protected]",
"phone": "9876543210",
"address1": "456 Oak Ave",
"address2": "Suite 200",
"city": "Los Angeles",
"state": "CA",
"country": "US",
"postcode": "90001",
"defaultAddress": false
}Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
firstName | string | Yes | First name |
lastName | string | Yes | Last name |
companyName | string | No | Company name |
vatId | string | No | VAT identification number |
email | string | Yes | Email address |
phone | string | Yes | Phone number |
address1 | string | Yes | Street address line 1 |
address2 | string | No | Street address line 2 |
city | string | Yes | City |
state | string | Yes | State/Province |
country | string | Yes | Country code |
postcode | string | Yes | Postal code |
defaultAddress | boolean | No | Set as default address |
Response Fields (201 Created)
| Field | Type | Description |
|---|---|---|
address | object | Created address details |
message | string | Success message |
Validation Rules
- All required fields must be provided
- Country/State must be valid
- Phone must be valid format
- Email must be valid format
- Maximum 10 addresses per customer
Use Cases
- Add billing address
- Add shipping address
- Save alternate location
- Store office address
- Store home address

