Sign in

v9

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

Update customer address

Replaces the editable data of an existing address. Sending is_default=true also promotes it to the customer default (demoting the previous one).

patch/api/v1/customers/{customerId}/addresses/{addressId}

Path parameters

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

Customer identifier (UUID).

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

Address 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 updated.

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