1. Introdução

A validação do CEP de destino nas cotações de frete permite garantir a integridade dos endereços utilizados no processo logístico, reduzindo erros causados por CEPs inválidos ou inexistentes. A validação será feita com base nos dados oficiais dos Correios, garantindo maior precisão na identificação dos endereços.

Essa funcionalidade possibilita verificar a existência e a compatibilidade dos CEPs diretamente no momento da cotação, possibilitando minimizar falhas operacionais e melhorando a experiência do cliente. Além disso, a configuração será parametrizável por cliente, permitindo flexibilidade na aplicação da validação.


Beneficios:

✅ Redução de Problemas na Entrega – Evita atrasos e dificuldades na logística ao validar os endereços já no momento da cotação.

✅ Melhor Experiência para o Cliente – Garante que o cliente receba opções de frete baseadas em CEPs válidos, evitando frustrações com erros no cálculo.

✅ Melhoria na Relação com Transportadoras – Facilita a comunicação e evita problemas operacionais ao garantir que os CEPs enviados para cotação são válidos.

✅ Maior Confiabilidade nos Prazos de Entrega – Reduz imprevistos causados por erros de endereço, tornando os prazos de entrega mais previsíveis e precisos.

✅ Configuração Flexível – Permite que cada empresa decida se deseja ativar a validação de CEPs, adaptando-se às suas necessidades específicas.

2. Escopo

Validação na Cotação

  • No momento da cotação, a funcionalidade verifica se o CEP informado existe na base oficial dos Correios. Caso o CEP não seja encontrado, um aviso será retornado, indicando sua invalidez, porém a cotação será realizada normalmente caso exista uma tabela de frete configurada para o CEP no OMS. Nessa situação, a funcionalidade gera um aviso (warning), permitindo que as plataformas e a marca utilizem essa informação para otimizar a experiência no e-commerce, como, por exemplo, solicitando ao cliente final uma atualização de cadastro.
  • Uma vez que o CEP for válido pelo correio a resposta da cotação não se altera.

Base de Dados Oficial

  • Utilizamos a base de CEPs dos Correios para referência.
  • Armazenamos essa base de forma otimizada para consultas rápidas.

Otimização com Cache

  • Guardamos os resultados das consultas mais frequentes para agilizar futuras verificações.
  • Mantemos o cache separado da base utilizada na cotação para evitar impactos na performance.
  • Utilizamos o CEP como chave de verificação, armazenando o resultado (válido ou inválido).

Configuração por Cliente

  • Permitir que cada empresa defina se deseja ativar a validação.
  • Armazenar essa configuração em uma base centralizada, garantindo flexibilidade.

3 -Ativação da Configuração

Foi criado um novo endpoint que será responsavel por controlar a ativação da feature, por cliente:  v1/clients/{clientId}

  • Exemplo de Request:

    {
   "clientId": "qa", // Obrigatório
   "zipCodeValidation": true // Obrigatório, validação campo boolean
}
  • Após a configuração, a cotação passa a validar o CEP na base dos Correios e, caso o destinationZipCode seja considerado inválido, um aviso (warning) será incluído na resposta.

4. Exemplo de Cotação

  • Solicitação de Cotação (JSON):
{
    "destinationZipcode": "02010109",
    "clientId": "qa",
    "channelId": "site",
    "groups": {
        "qatest": {
            "items": {
                "skuId-001": {
                    "quantity": 1,
                    "weight": 100,
                    "price": 10
                }
            }
        }
    }
}'
  • Resposta (JSON):
 "warning": {
        "destinationZipcode": "[604] Destination zip code not found in Correio's database"
    }
}


Fora do Escopo

❌ Correção automática de CEPs inválidos.

❌ Identificação de endereços completos a partir do CEP.

❌ Validação de outros dados além do CEP, como número ou complemento do endereço.

❌Bloqueio da cotação se CEP inválido.



  • Sem rótulos