Sign in

v9

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-071292691.1 MB
customer-addresses

Create customer address

Adds an address to the customer addresses array. The first address becomes the default automatically; toggling is_default promotes the new address and demotes the previous default.

post/api/v1/customers/{customerId}/addresses

Path parameters

customerIdstring uuid required
Example:01920000-0000-7000-8000-000000000000

Customer identifier (UUID).

Request body

complementstring nullable
is_defaultboolean
type'SHIPPING' | 'BILLING' | 'OTHER' required
zip_codestring required
streetstring required
numberstring required
districtstring required
citystring required
statestring required
countrystring required

Response

Address created.

idstring required
type'SHIPPING' | 'BILLING' | 'OTHER' required
zip_codestring required
streetstring required
numberstring required
complementstring nullable required
districtstring required
citystring required
statestring required
countrystring required
is_defaultboolean required
source'MANUAL' | 'ERP' required
created_atstring required
updated_atstring required