Skip to content

Create Customer address

POST
/customers/{customerId}/address

Creates a new customer address.

Authorizations

BearerAuth
Type
HTTP (bearer)
Example"Bearer ..."

Parameters

Path Parameters

customerId*

External ID of the customerId

Type
string
Required

Request Body

application/json
JSON
{
  
"street": "string",
  
"number": 0,
  
"complement": "string",
  
"zip_code": 0,
  
"neighborhood": "string",
  
"city": "string",
  
"state": "string",
  
"latitude": 0,
  
"longitude": 0,
  
"address_type": "string",
  
"name": "string",
  
"fk_id": "string"
}

Responses

Resource created successfully

application/json
JSON
{
  
"data": {
  
  
"id": 0,
  
  
"street": "string",
  
  
"number": 0,
  
  
"complement": "string",
  
  
"zip_code": 0,
  
  
"neighborhood": "string",
  
  
"city": "string",
  
  
"state": "string",
  
  
"latitude": 0,
  
  
"longitude": 0,
  
  
"address_type": "string",
  
  
"name": "string",
  
  
"fk_id": "string"
  
},
  
"message": "string",
  
"meta": {
  
  
"timestamp": "2026-04-13T17:17:49",
  
  
"version": "1.0.0"
  
}
}

Playground

Authorization
Variables
Key
Value
Body

Samples

Powered by VitePress OpenAPI