Create Address - Documentação DEVMOB

curl --request POST \ --url https://api.example.com/api/v1/customer/addresses \ --header 'Content-Type: application/json' \ --data ' { "label": "Casa", "street": "Rua das Palmeiras", "number": "120", "neighborhood": "Vila Mariana", "city": "Sao Paulo", "state": "SP", "zipCode": "04102000", "country": "BR", "complement": "Apto 42", "lat": -23.5893, "lng": -46.6344, "isDefault": false } '

{ "customerAddressId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "label": "<string>", "street": "<string>", "number": "<string>", "complement": "<string>", "neighborhood": "<string>", "city": "<string>", "state": "<string>", "zipCode": "<string>", "country": "<string>", "lat": 123, "lng": 123, "isDefault": true, "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "createdAt": "2023-11-07T05:31:56Z", "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "updatedAt": "2023-11-07T05:31:56Z", "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "deletedAt": "2023-11-07T05:31:56Z" }

Query Parameters

fields

string

Comma-separated list of fields to include in the response. Supports dot notation.

Body

application/json

Customer address payload.

label

string

required

Address label.

Example:

"Casa"

street

string

required

Street.

Example:

"Rua das Palmeiras"

number

string

required

Number.

Example:

"120"

neighborhood

string

required

Neighborhood.

Example:

"Vila Mariana"

city

string

required

City.

Example:

"Sao Paulo"

state

string

required

State.

Example:

"SP"

zipCode

string

required

Zip code.

Example:

"04102000"

country

string

required

Country.

Example:

"BR"

complement

string | null

Complement.

Example:

"Apto 42"

lat

number | null

Latitude.

Example:

-23.5893

lng

number | null

Longitude.

Example:

-46.6344

isDefault

boolean

Whether this address should become the default.

Example:

false

Response

Created

Endereço vinculado ao customer, com um endereço padrão por perfil

customerAddressId

string<uuid>

required

Identificador único

customerId

string<uuid>

required

Referência ao customer

label

string

required

Rótulo do endereço (ex.: "Casa", "Trabalho")

street

string

required

Logradouro

number

string

required

Número

complement

string | null

required

Complemento

neighborhood

string

required

Bairro

city

string

required

Cidade

state

string

required

Estado

zipCode

string

required

CEP

country

string

required

País

lat

number

required

Latitude

lng

number

required

Longitude

isDefault

boolean

required

Indica se é o endereço padrão. Default: false

createdBy

string<uuid> | null

required

Usuário que criou o registro, quando aplicável

createdAt

string<date-time>

required

Data de criação

updatedBy

string<uuid> | null

required

Usuário que fez a última atualização, quando aplicável

updatedAt

string<date-time>

required

Data da última atualização

deletedBy

string<uuid> | null

required

Usuário que removeu o registro, quando aplicável

deletedAt

string<date-time> | null

required

Data de remoção lógica