Update customer address
Update an existing address with partial data. Only provided fields will be updated.
Partial Updates: This endpoint supports partial updates - only include fields you want to change. Omitted fields will retain their current values.
Default Flag Behavior:
- Setting
is_default_billing: truewill unset the flag on all other addresses - Setting
is_default_shipping: truewill unset the flag on all other addresses - Only one address can be default billing and one can be default shipping at a time
Duplicate Prevention:
If updating address fields would result in a duplicate of another existing address, the update will be rejected with a DUPLICATE_ADDRESS error. This ensures data integrity and prevents confusion in downstream systems.
Validation Status: When address fields are modified, the validation_status may need to be re-verified through tax calculation services.
Authorizations
Body
Update Customer Address Request Schema
Street address line 1 (e.g., building number and street name)
Street address line 2 (e.g., apartment, suite, unit number)
Street address line 3 (additional address information)
City or locality name
State, province, or region
Postal code or ZIP code
Country name (e.g., 'United States')
Two-letter ISO country code (e.g., 'US', 'GB')
Address validation status
Validation data from external connector
Set as default billing address
Set as default shipping address
Response
Successfully updated customer address
Customer Address Response Schema
Address ID
Customer ID
Whether this is the default billing address
Whether this is the default shipping address
Street address line 1 (e.g., building number and street name)
Street address line 2 (e.g., apartment, suite, unit number)
Street address line 3 (additional address information)
City or locality name
State, province, or region
Postal/ZIP code
Country name (e.g., 'United States')
Two-letter ISO country code (e.g., 'US', 'GB')
Address validation status
Validation data from external connector