carriers5

channels5

clusters5

customer-addresses3

customers4

delivery-modalities5

delivery-types5

freight-types5

fulfillment-order-shipment-tracking-events1

fulfillment-order-shipments3

fulfillment-order-tracking-events1

fulfillment-orders4

inventory2

inventory-movements1

operators5

order-payments2

orders7

payment-methods3

permissions1

price-lists7

product-categories5

products3

promotions5

state-machines6

statuses5

strategies5

strategy-carriers5

strategy-channels5

strategy-operators5

strategy-price-lists5

webhook-subscriptions6

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

Changes

Changed in 2 of the 9 revisions of this API.24815

Jul 7, 2026a3b4750a505f914See the full diff
- ▲
  added the new required request property
  new-required-request-property
- ▲
  added the new required request property
  new-required-request-property
- ▲
  added the new required request property
  new-required-request-property
- ▲
  added the new required request property
  new-required-request-property
- ▲
  added the new required request property
  new-required-request-property
- ▲
  added the new required request property
  new-required-request-property
- ▲
  added the new required request property
  new-required-request-property
- ▲
  added the new required request property
  new-required-request-property
- ▲
  the request property type changed from object to string
  request-property-type-changed
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 7, 202684194c31ab851581See the full diff
- ▲
  the request property type changed from string to object
  request-property-type-changed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ○
  added the new optional request property
  new-optional-request-property
This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history