Skip to content

Create Customer Address

Create a new address for the authenticated customer.

Authentication

This query requires a valid customer authentication token in the Authorization header. Use the Customer Login API to retrieve the token.

Authorization: Bearer <accessToken>

Arguments

NameTypeRequiredDescription
firstNameString✅ YesFirst name
lastNameString✅ YesLast name
companyNameString❌ NoCompany name
vatIdString❌ NoVAT identification number
emailString✅ YesEmail address
phoneString✅ YesPhone number
address1String✅ YesStreet address line 1
address2String❌ NoStreet address line 2
cityString✅ YesCity
stateString✅ YesState/Province
countryString✅ YesCountry code (ISO 3166-1 alpha-2)
postcodeString✅ YesPostal/Zip code
defaultAddressBoolean❌ NoSet as default address

Response

FieldTypeDescription
addUpdateCustomerAddressAddressCreated address object

Validation Rules

  • First name and last name required
  • Complete address required
  • Valid country code must be provided
  • Postal code format depends on country
  • Phone number should be in valid format

Released under the MIT License.