Customer Address

Create a customer address

Create a new address for the authenticated customer. Requires Bearer token.

post/customer-addresses

Request

Headers

X-STOREFRONT-KEYstring required

Storefront API Key for authentication. Required for all shop/storefront API requests.

X-Localestring
Example:en

Locale code for localized data (e.g. "en", "fr", "ar"). Defaults to channel's default locale.

X-Channelstring
Example:default

Channel code (e.g. "default"). Defaults to the current channel.

X-Currencystring
Example:USD

Currency code (e.g. "USD", "EUR", "INR"). Defaults to channel's base currency.

Request body

firstNamestring required
lastNamestring required
companyNamestring
vatIdstring
emailstring email required
phonestring required
address1string required
address2string
citystring required
statestring required
postcodestring required
countrystring required
defaultAddressboolean

Set as default address

Example request

{
  "firstName": "John",
  "lastName": "Doe",
  "companyName": "Acme Inc.",
  "vatId": "GB123456789",
  "email": "john@example.com",
  "phone": "1234567890",
  "address1": "123 Main St",
  "address2": "Apt 4B",
  "city": "New York",
  "state": "NY",
  "postcode": "10001",
  "country": "US",
  "defaultAddress": true
}

Response

Address created.

Changes

No recorded changes to this operation across all 13 revisions of this API.