Listar endereços de uma conta
Para obter informações sobre endereços cadastrados, você pode:
- Lista endereços de uma conta
- Busca um endereço especifico
Passos para Integrar
- Realizar autenticação na API.
- Realizar a consulta das informações.
Lista endereços de uma conta
Para obter informações sobre os diversos endereços vinculados a uma conta, envie uma requisição com o ID da conta para o endpoint correspondente.
curl -X 'GET' \
'https://kubernetes-prod.celcoin.dev/api/accounts/1/address' \
-H 'accept: application/json' \
-H 'Bearer: {TOKEN}'
Sucesso 200
{
"version": "1.0.0",
"status": 200,
"body": [
{
"enderecoId": 59,
"tipoEndereco": "R",
"endereco": "Rua 15",
"numero": "13",
"bairro": "Farolândia",
"cidade": "Aracaju",
"estado": "SE",
"pais": "BRA",
"cep": "49100000",
"enderecoCorrespondencia": false,
"complemento": "Próximo a praça",
"dataCriacao": "2024-06-04T13:29:31.000000Z",
"dataAtualizacao": "2024-06-04T15:22:37.000000Z",
"ativo": false
}
]
}
| Campo | Tipo | Descrição |
|---|---|---|
| endercoId | int | Id do endereço gerado na criação da conta ou criação do endereço |
| tipoEndereco | char | Indica o Logradouro do endereço, R - Rua, A - Avenida |
| endereco | string (50) | Nome da rua ou avenida |
| numero | string (10) | Numero do local |
| bairro | string (20) | Bairro em que se encontra o endereço |
| cidade | string (20) | Cidade em que se encontra o endereço |
| estado | string (2) | Estado em que se encontra o endereço |
| pais | string (3) | Pais em que se encontra o endereço |
| cep | string (10) | Código de Endereçamento Postal |
| enderecoCorrespondencia | boolean | Indica se é o endereço que o cliente deve receber os cartões |
| complemento | string (30) | Complemento da localização |
| dataCriacao | string (50) | Data em que foi cadastrado este endereço |
| dataAtualizacao | string (50) | Data da ultima atualização do endereço |
| ativo | boolean | Se este endereço permanece ativo ou desativado |
Buscar um endereço em específico
Para obter informações de um endereço específico, envie uma requisição com o ID do endereço para o endpoint correspondente.
curl -X 'GET' \
'https://kubernetes-prod.celcoin.dev/api/accounts/1/address/1' \
-H 'accept: application/json' \
-H 'Bearer: {TOKEN}'
Sucesso 200
{
"version": "1.0.0",
"status": 200,
"body": {
"enderecoId": 59,
"tipoEndereco": "R",
"endereco": "Rua 15",
"numero": "13",
"bairro": "Farolândia",
"cidade": "Aracaju",
"estado": "SE",
"pais": "BRA",
"cep": "49100000",
"enderecoCorrespondencia": false,
"complemento": "Próximo a praça",
"dataCriacao": "2024-06-04T13:29:31.000000Z",
"dataAtualizacao": "2024-06-04T15:22:37.000000Z",
"ativo": false
}
}
| Campo | Tipo | Descrição |
|---|---|---|
| endercoId | int | Id do endereço gerado na criação da conta ou criação do endereço |
| tipoEndereco | char | Indica o Logradouro do endereço, R - Rua, A - Avenida |
| endereco | string (50) | Nome da rua ou avenida |
| numero | string (10) | Numero do local |
| bairro | string (20) | Bairro em que se encontra o endereç |
| cidade | string (20) | Cidade em que se encontra o endereço. |
| estado | string (2) | Estado em que se encontra o endereço |
| pais | string (3) | Pais em que se encontra o endereço |
| cep | string (10) | Código de Endereçamento Postal |
| enderecoCorrespondencia | boolean | Indica se é o endereço que o cliente deve receber os cartões |
| complemento | string (30) | Complemento da localização |
| dataCriacao | string (50) | Data em que foi cadastrado este endereço |
| dataAtualizacao | string (50) | Data da ultima atualização do endereço |
| ativo | boolean | Se este endereço permanece ativo ou desativado |
Updated about 14 hours ago