Create customer address
Create a new address for a customer.
Address Deduplication: Addresses are automatically deduplicated using a content hash. If you create an address with the same data as an existing address, the system will update the existing address’s default flags instead of creating a duplicate.
Default Address Behavior:
- Setting
is_default_billing: truewill unset the flag on any other address - Setting
is_default_shipping: truewill unset the flag on any other address - A single address can be both default billing and default shipping
Address Validation:
New addresses are created with validation_status: pending. Address validation can be triggered separately through integrated tax calculation services (e.g., Avalara).
Country Code: Use ISO 3166-1 alpha-2 country codes (e.g., US, CA, GB, DE).
Authorizations
Path Parameters
Body
Request schema for creating/updating customer addresses. Extends the existing Address schema with default billing/shipping flags. customer_id comes from URL params, not request body.
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 created 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