Skip to main content

Addresses

Authenticated users can manage a personal address book. Addresses are used during checkout for shipping and billing.

List Addresses​

GET /api/storefront/addresses
Authorization: Bearer <token>

Response:

[
  {
    "id": "guid",
    "firstName": "John",
    "lastName": "Doe",
    "addressLine1": "123 Main St",
    "addressLine2": "Apt 4B",
    "city": "New York",
    "stateProvince": "NY",
    "postalCode": "10001",
    "countryCode": "US",
    "phone": "+1234567890",
    "isDefault": true
  }
]

Create Address​

POST /api/storefront/addresses
Authorization: Bearer <token>
Content-Type: application/json

{
  "firstName": "John",
  "lastName": "Doe",
  "addressLine1": "123 Main St",
  "city": "New York",
  "stateProvince": "NY",
  "postalCode": "10001",
  "countryCode": "US",
  "phone": "+1234567890",
  "isDefault": true
}

Update Address​

PUT /api/storefront/addresses/{addressId}
Authorization: Bearer <token>
Content-Type: application/json

{ ...address fields... }

Delete Address​

DELETE /api/storefront/addresses/{addressId}
Authorization: Bearer <token>

Countries List​

To populate country dropdowns:

GET /api/storefront/countries

Returns all available countries with their codes and names.

Checkout Integration

When building your checkout form, pre-populate the shipping address from the user's default address. Let users select from their saved addresses or enter a new one.