Como configurar a Integração com os Correios (Sigep3)
- O módulo Correios Sigep3 conecta sua loja Magento 1 openmage diretamente ao sistema dos Correios, permitindo solicitar etiquetas, imprimir documentos de postagem e notificar seus clientes com o código de rastreamento — tudo sem sair do painel da loja.
- Elimina a necessidade de acessar sites externos para gerar etiquetas ou preencher dados manualmente. Todo o processo é feito dentro do admin do Magento.
- É útil para qualquer lojista que utiliza os serviços dos Correios (PAC, SEDEX, SEDEX 10, Carta Registrada, entre outros) e deseja agilizar a operação de envio dos pedidos.
- Também permite testar a integração em um ambiente de testes (Homologação), sem gerar etiquetas reais e sem custo.
Tutorial em vídeo
[Inserir player do vídeo aqui quando disponível]
Passo a passo por escrito
Acessar as configurações do módulo
1. Acesse o painel de configuração do módulo
No admin da sua loja, navegue até Sistema → Configuração → Vendas → Configurações de Entrega → Integração Webservice Correios - Sigep V.4.
Resultado esperado: A tela de configuração do módulo será exibida, com diversas seções de campos para preenchimento.
Configurações gerais
2. Habilite o módulo
No campo Habilitar, selecione Sim.
Resultado esperado: Os demais campos de configuração ficarão disponíveis para edição.
Enquanto o módulo estiver desabilitado, nenhuma funcionalidade estará disponível — a aba de etiquetas não aparecerá nos pedidos e o menu de PLPs não estará acessível.
3. Selecione o ambiente
No campo Ambiente, escolha a opção desejada:
- Produção — para operação real, com geração de etiquetas válidas.
- Homologação — para testes, sem custo e sem postagem real. Neste modo, credenciais de teste são aplicadas automaticamente.
Resultado esperado: O módulo passará a se comunicar com o ambiente selecionado.
Ao alternar de Homologação para Produção (ou vice-versa), salve as configurações para que o sistema gere um novo código de acesso válido para o ambiente correto.
4. Configure a unidade de peso dos produtos
No campo Medida de Peso, selecione a unidade utilizada no cadastro dos seus produtos:
- Gramas — se seus produtos estão cadastrados em gramas (ex: 500 = 500g).
- Quilogramas — se seus produtos estão cadastrados em quilogramas (ex: 0,5 = 500g).
Resultado esperado: O módulo converterá corretamente o peso ao solicitar etiquetas.
Se esta configuração estiver incorreta, o peso enviado aos Correios será errado. Por exemplo, um produto de 500g configurado como "Quilogramas" será interpretado como 500kg. Isso pode causar erros na solicitação de etiquetas ou recusas por excesso de peso.
5. Ajuste as demais configurações gerais conforme a sua operação
Os campos abaixo permitem personalizar o comportamento do módulo. Preencha conforme a necessidade da sua loja:
- Imprimir Etiquetas com PLP Aberta — selecione Sim se deseja permitir a impressão de etiquetas antes de fechar a lista de postagem. Por padrão, a impressão só é liberada após o fechamento.
- Selecionar Serviço automaticamente — selecione Sim para que o módulo pré-selecione o serviço dos Correios com base na transportadora do pedido.
- Valor declarado por padrão — selecione Sim para que o campo de valor declarado já venha preenchido automaticamente com o valor do pedido ao solicitar uma etiqueta.
- Criar Envio Automaticamente — selecione Sim para que o módulo crie automaticamente o registro de envio (com código de rastreamento) ao fechar a lista de postagem.
- Notificar cliente por email ao criar envio — selecione Sim para que o cliente receba um e-mail com o código de rastreamento quando o envio for criado.
- Status do pedido ao fechar a PLP — selecione o status que o pedido deve receber automaticamente ao fechar a lista de postagem (ex: "Completo", "Enviado").
-
Método de envio do Correios — informe o código da transportadora dos Correios configurada na sua loja (ex:
correios_sedex). Esse campo é utilizado pela seleção automática de serviço. - Desativar estimativa de preço e prazo — selecione Sim se não deseja que o módulo consulte o preço e prazo estimados ao abrir o formulário de etiqueta.
- Imprimir etiqueta imediatamente após gerar — selecione Sim para que a tela de impressão abra automaticamente logo após a solicitação de uma etiqueta.
Resultado esperado: Cada campo ajustará o comportamento do módulo conforme a opção selecionada.
As opções Criar Envio Automaticamente e Notificar cliente por email funcionam em conjunto. Para que o cliente receba o e-mail de rastreamento, ambas precisam estar habilitadas.
Credenciais de acesso à API dos Correios
6. Preencha as credenciais de acesso
Informe os dados de acesso ao serviço dos Correios:
- Usuário API Rest — o login de acesso fornecido pelo portal Meu Correios.
- Código de acesso da API Rest — a senha ou código de acesso fornecido pelo portal Meu Correios.
Resultado esperado: Os campos ficarão preenchidos e prontos para autenticação.
Essas credenciais devem ser exatamente as mesmas cadastradas no portal Meu Correios. Credenciais incorretas impedirão o funcionamento de todas as funcionalidades do módulo.
7. Salve as configurações para gerar o código de acesso
Clique no botão Salvar Configuração no topo da página.
Resultado esperado: Após salvar, os seguintes campos serão preenchidos automaticamente (são campos somente leitura):
- Token API Rest — o código de acesso gerado pelo sistema dos Correios.
- Expiração do token API Rest — a data e hora em que o código expira.
- Ambiente do Token — o ambiente (Produção ou Homologação) para o qual o código foi gerado.
- Correios ID — o identificador da sua conta nos Correios.
O código de acesso é renovado automaticamente pelo módulo quando expira. Caso suspeite de problemas de autenticação, basta salvar as configurações novamente para forçar uma nova geração.
8. Habilite o modo de depuração (opcional)
Se precisar investigar algum problema, ative o campo Debug API Rest selecionando Sim. Isso fará com que o módulo registre informações detalhadas sobre as comunicações com os Correios em um arquivo de registro.
Resultado esperado: As comunicações com os Correios serão registradas para análise pelo suporte técnico.
Mantenha o modo de depuração desativado durante a operação normal, pois ele pode gerar um grande volume de registros.
Dados do contrato e remetente
9. Preencha os dados do remetente
Informe os dados da sua empresa. Esses dados serão impressos nas etiquetas como informações do remetente e devem ser exatamente os mesmos cadastrados no portal Meu Correios:
- Cartão Postagem — o número do cartão de postagem associado ao seu contrato (somente números).
- Razão Social — a razão social da empresa.
- Remetente / Nome fantasia — o nome que aparecerá nas etiquetas como remetente.
- CEP — o CEP de origem da sua empresa (somente números). Este CEP também é usado como base para cálculos de frete.
- Rua, Numero, Complemento, Bairro, Cidade — o endereço completo.
- UF — o estado.
- Telefone — somente números.
- E-mail — e-mail de contato do remetente.
Resultado esperado: Os campos ficarão preenchidos. O campo Número Contrato e o campo CNPJ serão preenchidos automaticamente ao atualizar os serviços (próximo passo).
Dados incorretos de contrato e remetente causarão falhas nas solicitações de etiqueta. Verifique cuidadosamente se as informações coincidem com o cadastro no portal Meu Correios.
Importar os serviços do contrato
10. Clique no botão "Atualizar Serviços"
Ainda na tela de configuração, localize e clique no botão Atualizar Serviços.
Resultado esperado: O módulo se conectará aos Correios e importará automaticamente todos os serviços disponíveis para o seu contrato (PAC, SEDEX, SEDEX 10, Carta Registrada, etc.). Os campos somente leitura CNPJ e Numero da Diretoria também serão preenchidos automaticamente.
Execute esse processo sempre que houver alteração nos serviços do seu contrato junto aos Correios (inclusão ou remoção de serviços).
Mapeamento de endereço do destinatário
11. Configure o mapeamento de endereço
O cadastro de clientes da loja armazena o endereço em até 4 linhas. O módulo precisa saber qual linha corresponde a cada dado. Configure os campos abaixo de acordo com o formato utilizado pelo checkout da sua loja:
- Linha de endereço - rua — selecione a linha que contém o nome da rua (padrão: 1).
- Linha de endereço - número — selecione a linha que contém o número (padrão: 2).
- Linha de endereço - complemento — selecione a linha que contém o complemento (padrão: 3).
- Linha de endereço - bairro — selecione a linha que contém o bairro (padrão: 4).
Resultado esperado: O módulo extrairá corretamente os dados de endereço dos pedidos ao solicitar etiquetas.
Se o mapeamento estiver incorreto, o módulo lerá os dados de endereço nas posições erradas, causando erros na solicitação de etiquetas. Verifique sempre esse mapeamento durante a configuração inicial, conferindo com o formato de endereço utilizado no checkout da sua loja.
Embalagens
12. Cadastre as embalagens utilizadas
No campo Tipos de Caixa, cadastre as embalagens que você utiliza nos envios. Para cada embalagem, preencha:
- Nome — um nome de identificação (ex: "Caixa Pequena", "Envelope Padrão").
- Tipo — Caixa, Envelope ou Rolo.
- Altura — em centímetros (número inteiro).
- Largura — em centímetros (número inteiro).
- Comprimento — em centímetros (número inteiro).
- Diâmetro — em centímetros. Informe 0 para caixas e envelopes. Preencha apenas para embalagens do tipo Rolo.
Resultado esperado: As embalagens cadastradas ficarão disponíveis para seleção ao solicitar etiquetas nos pedidos.
As dimensões mínimas aceitas pelos Correios são: 2 cm (altura) × 11 cm (largura) × 16 cm (comprimento). Ao atualizar os serviços, o módulo verifica e corrige automaticamente as dimensões caso estejam abaixo dos limites.
Logo e DANFE Simplificada
13. Configure a logo e a DANFE Simplificada (opcional)
- Logo para etiquetas — faça o upload de uma imagem com a logo da sua empresa. Ela será exibida nos documentos impressos (etiquetas, declarações, etc.). Use uma imagem quadrada, com fundo branco ou transparente, nos formatos JPEG ou PNG.
- Danfe Simplificada — selecione Sim para habilitar o formato "DANFE Simplificada" como opção de impressão na tela do pedido.
Resultado esperado: A logo aparecerá nos documentos impressos e, se habilitada, a opção de DANFE Simplificada estará disponível.
Salvar todas as configurações
14. Salve as configurações
Após preencher todos os campos, clique em Salvar Configuração no topo da página.
Resultado esperado: Uma mensagem de "Configuração salva com sucesso" será exibida no topo da tela. Todas as configurações estarão ativas.
Pronto! A configuração inicial do módulo Correios Sigep3 está concluída. Agora você pode começar a solicitar etiquetas diretamente nos pedidos.
Como usar no dia a dia
Solicitar uma etiqueta
1. Abra o pedido desejado
Acesse Vendas → Pedidos e clique no pedido para o qual deseja gerar uma etiqueta.
Resultado esperado: A tela de detalhes do pedido será exibida.
2. Acesse a aba Sigep3
Na tela do pedido, clique na aba Sigep3.
Resultado esperado: O formulário de solicitação de etiqueta será exibido, com os campos de serviço, embalagem, peso e demais opções.
3. Preencha os dados da etiqueta
Preencha os campos do formulário:
- Serviço — selecione o serviço desejado (PAC, SEDEX, etc.). Se a seleção automática estiver habilitada, o campo já virá preenchido.
- Embalagem — selecione a embalagem cadastrada que será utilizada.
- Peso — informe o peso do pacote. A unidade segue a configuração definida no campo Medida de Peso.
- Número NF-e — informe o número da nota fiscal eletrônica do pedido (se aplicável).
- Valor Declarado — marque se deseja contratar o adicional de valor declarado. Se a opção Valor declarado por padrão estiver habilitada, o campo já virá preenchido com o valor do pedido.
- AR (Aviso de Recebimento) — marque se deseja contratar o adicional de aviso de recebimento.
- MP (Mão Própria) — marque se deseja contratar o adicional de entrega exclusiva ao destinatário.
Resultado esperado: O formulário ficará preenchido e pronto para envio.
Se a estimativa de preço e prazo estiver habilitada, ao selecionar o serviço, o módulo consultará automaticamente o valor estimado e o prazo de entrega com base no CEP de destino. Serviços indisponíveis para aquele CEP serão desabilitados na lista.
4. Clique em "Solicitar Etiqueta"
Após preencher os dados, clique no botão Solicitar Etiqueta.
Resultado esperado: A etiqueta será gerada com sucesso e o código de rastreamento (ex: SQ123456789BR) aparecerá na tela. A etiqueta será automaticamente adicionada a uma lista de postagem (PLP) aberta.
O módulo valida o endereço do destinatário antes de solicitar a etiqueta. Se houver algum problema (CEP incompleto, rua muito longa, bairro ausente, etc.), uma mensagem de erro será exibida. Nesse caso, verifique se o mapeamento de endereço está correto e se os dados do cliente estão completos no pedido.
Gerenciar as Pré-Listas de Postagem (PLPs)
5. Acesse a tela de PLPs
Resultado esperado: A lista de todas as PLPs será exibida, com indicação de status (Aberta ou Fechada).
6. Feche a PLP para envio
Selecione a PLP que deseja fechar e clique no botão Fechar PLP.
Ao fechar a PLP:
- Os dados serão enviados e validados junto aos Correios.
- Se a opção Criar Envio Automaticamente estiver habilitada, o registro de envio será criado em cada pedido com o código de rastreamento.
- Se a opção Notificar cliente por email estiver habilitada, o cliente receberá o e-mail com o rastreamento.
- O status dos pedidos será atualizado conforme a configuração.
Resultado esperado: A PLP passará para o status "Fechada" e os pedidos vinculados serão atualizados.
É possível fazer um fechamento parcial: selecione apenas alguns itens da PLP para fechar. Os itens não selecionados serão movidos automaticamente para uma nova PLP aberta. Verifique a lista de PLPs após o fechamento parcial para acompanhar a nova PLP criada.
Imprimir etiquetas e documentos
7. Imprima as etiquetas e documentos de postagem
Após o fechamento da PLP (ou antes, se a configuração Imprimir Etiquetas com PLP Aberta estiver habilitada), utilize os botões de impressão disponíveis. Os formatos disponíveis são:
- Etiqueta Rolo 10×15 e Etiqueta Rolo 10×12 — para impressoras de etiquetas.
- Etiqueta A4 — para impressão em folha A4 comum.
- AR (Aviso de Recebimento) — formulário de AR para assinatura na entrega.
- Declaração de Conteúdo — documento que descreve o conteúdo da remessa.
- PLP e PLP Voucher — documentos da lista de postagem para apresentar na agência dos Correios.
- DANFE Simplificada — se habilitada nas configurações.
Resultado esperado: O documento será gerado em formato PDF e exibido para impressão.
Bloquear entrega de um objeto
8. Bloqueie a entrega de um objeto (quando necessário)
Caso precise impedir a entrega de um objeto já postado, acesse a tela de PLPs, localize o item desejado e utilize a opção de bloqueio de objeto.
Resultado esperado: O módulo enviará a solicitação de bloqueio aos Correios. O item será marcado com a data do bloqueio.
O bloqueio depende do status do objeto nos Correios. Se o objeto já estiver em rota final de entrega, o bloqueio pode não ser possível.
Validação e testes
Teste 1 — Solicitar etiqueta com sucesso
Ação: Com o módulo configurado e os serviços importados, abra um pedido com endereço de entrega válido. Acesse a aba Sigep3, selecione um serviço, uma embalagem, informe o peso e clique em Solicitar Etiqueta.
Resultado esperado: A etiqueta será gerada com sucesso e o código de rastreamento aparecerá na tela. O item será adicionado a uma PLP aberta, visível em Vendas → Sigep3 → PLPs.
Teste 2 — Testar em ambiente de Homologação
Ação: Altere o campo Ambiente para Homologação e salve as configurações. Repita o processo de solicitação de etiqueta em um pedido qualquer.
Resultado esperado: A etiqueta será gerada normalmente, mas em ambiente de teste — sem custo e sem postagem real. Isso permite validar toda a configuração antes de iniciar a operação em Produção.
Teste 3 — Verificar mapeamento de endereço incorreto
Ação: Solicite uma etiqueta para um pedido. Se o módulo retornar uma mensagem de erro sobre endereço inválido (ex: "logradouro excede o limite de caracteres" ou "número não informado"), vá até a configuração de Mapeamento de Endereço do Destinatário e verifique se as linhas estão apontando para os dados corretos.
Se não funcionar, verifique:
- Se o mapeamento de rua, número, complemento e bairro corresponde ao formato do checkout da loja.
- Se o endereço do cliente no pedido está completo (CEP com 8 dígitos, cidade e UF preenchidos).
- Se o campo Medida de Peso está configurado corretamente.
- Se as credenciais de acesso estão corretas e o código de acesso não expirou (salve as configurações para renovar).
Pronto! Dessa forma realizamos a configuração da Integração com os Correios (Sigep3) em sua loja virtual Magento 1.
Observações importantes
- Carta Registrada: aceita no máximo 1.000g de peso. Se o peso do pacote for superior, o módulo bloqueará a solicitação. Esse é o limite estabelecido pelos Correios.
- Cancelamento de etiquetas: o módulo não cancela etiquetas nos Correios. Se excluir um item de uma PLP, a remoção será apenas dentro da loja. Para cancelar a etiqueta de fato, acesse diretamente o portal Meu Correios.
- Fechamento parcial de PLP: ao fechar uma PLP apenas com parte dos itens, os itens restantes são movidos para uma nova PLP aberta criada automaticamente. Verifique a lista de PLPs após o fechamento para acompanhar.
- Ambiente de Homologação: utiliza credenciais de teste automáticas. O código de acesso gerado neste ambiente não funciona em Produção, e vice-versa.
Referências e relacionados
- Documentação de configuração de transportadoras no Magento 1
- Documentação de emissão de NF-e ou alguma outra coisa
- Acesse o portal Meu Correios
Caso tenha ficado alguma dúvida entre em contato com nosso time de suporte através do chat online dentro da sua loja virtual ou através do e-mail web@tryideas.com.br