17 - Salvar Endereços

cURL

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/Pessoa/SalvarEnderecos \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "dtos": [
    {
      "cep": "<string>",
      "logradouro": "<string>",
      "cidade": "<string>",
      "uf": "<string>",
      "tipoEndereco": 123,
      "tipoResidencia": 123,
      "codigo": "<string>",
      "nroLogradouro": "<string>",
      "bairro": "<string>",
      "complemento": "<string>",
      "enderecoDesde": "2023-11-07T05:31:56Z",
      "enderecoPrincipal": true,
      "enderecoCorrespondencia": true
    }
  ]
}
'

200

{
  "msg": "<string>",
  "hasError": true,
  "messages": [
    {
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "results": [
    {
      "msg": "<string>",
      "hasError": true,
      "messages": [
        {
          "code": "<string>",
          "context": "<string>",
          "description": "<string>",
          "field": "<string>"
        }
      ],
      "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

Por meio deste endpoint o parceiro inclui ou atualiza registros de endereços de um cliente específico. Para que ocorra uma atualização, é necessário o envio do campo código, preenchido com o código do registro na base da BMP, ou então a busca será através do campo CEP

​

Tabela de códigos auxiliares

Mostrar Tabela TipoEndereco

ID	Descrição
1	Residencial
2	Comercial

Mostrar Tabela TipoResidencia

ID	Descrição
1	Alugado
2	Próprio
3	Financiado
4	Casa Funcional

​

Mensagens de erro

A tabela abaixo representa as mensagens de erro que podem ser retornadas ao tentar realizar uma requisição.

Mostrar Mensagens de requisições com erro

O retorno de uma requisição com status HTTP 400 (Bad Request) pode incluir as seguintes mensagens de erro:

No exemplo de retorno ao lado, o campo code representa a coluna Código desta tabela; o campo context representa a coluna Código Detalhado; e o campo message representa a coluna Mensagem.

Categoria	Operação	Ação	Código	Código Detalhado	Mensagem
Pessoa	CreateUpdatePessoaEnderecos	SalvarEnderecos	C0108	V0001	Documento Federal deve ser informado
Pessoa	CreateUpdatePessoaEnderecos	SalvarEnderecos	C0108	V0002	Cliente não encontrado com o documento {documentoCliente}
Pessoa	CreateUpdatePessoaEnderecos	SalvarEnderecos	C0108	V0003	Cliente não cadastrado pelo parceiro de integração
Pessoa	CreateUpdatePessoaEnderecos	SalvarEnderecos	T0608	D0001	Informe o CEP
Pessoa	CreateUpdatePessoaEnderecos	SalvarEnderecos	T0608	D0002	CEP inválido
Pessoa	CreateUpdatePessoaEnderecos	SalvarEnderecos	T0608	D0003	Informe o Logradouro
Pessoa	CreateUpdatePessoaEnderecos	SalvarEnderecos	T0608	D0004	Informe a Cidade
Pessoa	CreateUpdatePessoaEnderecos	SalvarEnderecos	T0608	D0005	Informe o Estado
Pessoa	CreateUpdatePessoaEnderecos	SalvarEnderecos	T0608	D0006	Informe o Tipo de Imóvel
Pessoa	CreateUpdatePessoaEnderecos	SalvarEnderecos	T0608	D0007	Informe o Tipo de Endereço
Pessoa	CreateUpdatePessoaEnderecos	SalvarEnderecos	T0608	D0008	Informe o tempo em que está situado no endereço

Autorizações

Authorization · string · header · obrigatório

Informe o token

Cabeçalhos

IdempotencyKey · string · obrigatório

Corpo

application/jsontext/jsonapplication/*+json

param · object

Show child attributes

dtos · object[] | null

Show child attributes

Resposta

200

text/plain

OK

msg · string | null

hasError · boolean

messages · object[] | null

Show child attributes

results · object[] | null

Show child attributes