Skip to main content

Objeto Address

O objeto address é utilizado em diversas APIs para representar um endereço. A estrutura é padronizada em todos os endpoints.

Estrutura

CampoTipoObrigatórioDescrição
streetstringSimLogradouro.
numberstringSimNúmero do endereço.
complementstringNãoComplemento.
neighborhoodstringSimBairro.
citystringSimCidade.
statestringSimUF (sigla de 2 caracteres).
postal_codestringSimCEP (formato XXXXXXXX, sem hífen).

Exemplo

{
"street": "Rua Example",
"number": "123",
"complement": "Sala 1",
"neighborhood": "Centro",
"city": "São Paulo",
"state": "SP",
"postal_code": "01001000"
}

Endpoints que utilizam este objeto