CONTEÚDO
01. VISÃO GERAL
O Correios é uma empresa de operação logística no Brasil. Seu negócio como operador logístico está disponibilizado no Totvs Omni by Moddo para atender clientes que contrataram seus serviços e que também se utilizam da solução Totvs Omni by Moddo. O conector funciona com o Correios como sendo um operador logístico, transparente à qualquer outro operador integrado ao Correios. Abaixo veremos como parametrizar o conector Correios para o site de um cliente.
02. CONFIGURAÇÃO
- Acesse o Totvs Omni by Moddo.
- Informe User e Password e clique no botão SEND.
- Selecione Configurações > dentro desta opção clique na opção Sites.
- Selecione o Site Principal do Cliente (Vide Conceito de Sites, Lojas e Estrutura de Pedidos) no campo Busca e clique em Alterar.
- Clique em Propriedades de Configuração
- Expanda o grupo Operador Logístico Correios e preencha os parâmetros conforme abaixo:
03. PARÂMETROS
Parâmetros do Conector:
| Nome do Parâmetro | Descrição | Formato do Parâmetro e Exemplos |
|---|---|---|
| correiosbrasil.base.envio.url | URL de acesso aos serviços de criação de entrega do correios. Valor obrigatório. | Formato: URL Exemplo: Normalmente o valor é a URL de produção do correios: https://apps.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente Porém é possível utilizar o ambiente de homologação do mesmo: https://apphom.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente |
| correiosbrasil.base.parcel.codAvisoRecebimento | Indica se irá utilizar o serviço de Aviso de Recebimento para todos os pedidos na criação da entrega no correios. Vide ANEXO 06 - Código do Serviço Adicional do documento Manual_de_Implementacao_do_Web_Service_SIGEP_WEB.pdf | Formato: Caractere Exemplo: S para sim, e N para não. Caso não seja especificado o valor padrão é N |
| correiosbrasil.base.parcel.codMaoPropria | Indica se irá utilizar o serviço de Mão Própria para todos os pedidos na criação da entrega no correios. Vide ANEXO 06 - Código do Serviço Adicional do documento Manual_de_Implementacao_do_Web_Service_SIGEP_WEB.pdf | Formato: Caractere Exemplo: S para sim, e N para não. Caso não seja especificado o valor padrão é N |
| correiosbrasil.base.parcel.declaredvalue | Valor mínimo declarado na PLP do correios. Se o valor do pedido for maior que este valor mínimo é enviado o valor do pedido. Caso contrário é enviado o valor mínimo configurado aqui. | Formato: Numero Caso não seja especificado o valor padrão é 21.00 |
| correiosbrasil.base.parcel.diameter | Valor padrão para o diâmetro do produto a ser utilizado na geração da guia, para o caso do produto não ter diâmetro cadastrado no Omni. O valor correspondente a unidade de medida configurada no parâmetro correiosbrasil.base.parcel.dimensao.unidade | Formato: Numero Exemplo: 0 Caso não seja especificado o valor padrão é 5 |
| correiosbrasil.base.parcel.height | Valor padrão para a altura do produto a ser utilizado na geração da guia, para o caso do produto não ter altura cadastrada no Omni. O valor correspondente a unidade de medida configurada no parâmetro correiosbrasil.base.parcel.dimensao.unidade | Formato: Numero Exemplo: 1 Caso não seja especificado o valor padrão é 2 |
| correiosbrasil.base.parcel.length | Valor padrão para o comprimento do produto a ser utilizado na geração da guia, para o caso do produto não ter comprimento cadastrado no Omni. O valor correspondente a unidade de medida configurada no parâmetro correiosbrasil.base.parcel.dimensao.unidade | Formato: Numero Exemplo: 1 Caso não seja especificado o valor padrão é 16 |
| correiosbrasil.base.parcel.width | Valor padrão para a largura do produto a ser utilizado na geração da guia, para o caso do produto não ter largura cadastrado no Omni. O valor correspondente a unidade de medida configurada no parâmetro correiosbrasil.base.parcel.dimensao.unidade | Formato: Numero Exemplo: 1 Caso não seja especificado o valor padrão é 11 |
| correiosbrasil.base.parcel.peso | Valor padrão para o peso do produto a ser utilizado na geração da guia, para o caso do produto não ter peso cadastrado no Omni. O valor corresponde a unidade de medida configurada no parâmetro correiosbrasil.base.parcel.peso.unidade | Formato: Numero Exemplo: 1 Caso não seja especificado o valor padrão é 500 |
| correiosbrasil.base.parcel.tipoEtiqueta | Modelo da etiqueta a ser gerada. | Formato: Numero Exemplo: 1 Caso não seja especificado o valor padrão é 1 |
| correiosbrasil.base.parcel.tipoPacotePadrao | Valor que indica que o o pacote é um pacote padrão correios.
| Formato: Numero Exemplo: 1 Caso não seja especificado o valor padrão é 002 |
| correiosbrasil.base.user.cartao | Número do Cartão de Postagem vinculado ao contrato do cliente com o correios. (Fornecido pelo Representante Comercial dos Correios) Valor obrigatório. | Formato: Numero |
| correiosbrasil.base.user.cnpj | CNPJ da empresa do contrato do cliente com o correios. (Fornecido pelo Representante Comercial dos Correios) Valor obrigatório. | Formato: Numero |
| correiosbrasil.base.user.codAdmin | Código Administrativo do contrato do cliente com o correios. (Fornecido pelo Representante Comercial dos Correios) Valor obrigatório. | Formato: Numero |
| correiosbrasil.base.user.contract | Código do contrato do cliente com o correios. (Fornecido pelo Representante Comercial dos Correios) Valor obrigatório. | Formato: Numero |
| correiosbrasil.base.user.name | Usuário do cliente para acesso a serviço de criação de entrega do Correios pelo endpoint https://apps.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente (Fornecido pelo Representante Comercial dos Correios) Este não é o usuário da interface web. Valor obrigatório. | Formato: Texto OBS: Este não é o usuário da interface web do correios. |
| correiosbrasil.base.user.password | Senha do usuário do cliente para acesso a serviço de criação de entrega do Correios. (Fornecido pelo Representante Comercial dos Correios) | Formato: Texto Valor obrigatório. |
| correiosbrasil.delivery.cancel | Código do serviço de cancelamento do correios. | Formato: Numero Exemplo: 1 Caso não seja especificado o valor padrão é 1 |
| correiosbrasil.imagem.logo | Nome do arquivo de imagem que contém o logo da empresa que será utilizado na Guia Logística. Se não for passado valor, a guia logística não conterá o logo da empresa. Este arquivo deve ser enviado para a equipe do produto TOTVS Omni para carga no servidor. | Formato: Nome de arquivo de imagem. Normalmente utiliza-se uma imagem pequena (72x72 pixels) no formato .png. |
| correiosbrasil.tipo.entrega.default | Códigos do serviço para o caso em que o pedido não tem definido o nível de serviço (código do serviço de entrega no correios). Valor obrigatório. | Formato: Numero Os serviços que o cliente tem contratado do Correios podem ser obtidos através do serviço buscaCliente do webservice do correios. |
| correiosbrasil.pedido.guia | Indica qual é o número do pedido que será utilizado para gerar a guia logística. Valores:
| Formato: Texto Caso não seja especificado o valor padrão é CANAL |
| correiosbrasil.tracking.user.name | Usuário do cliente para acesso ao serviço de rastreamento de entrega do Correios pelo endpoint http://webservice.correios.com.br:80/service/rastro (Fornecido pelo Representante Comercial dos Correios mediante carta de solicitação) Valor obrigatório para usar no Rastreio. | Formato: Texto OBS: Este não é o usuário da interface web do correios. |
| correiosbrasil.tracking.user.password | Senha do usuário do cliente para acesso a serviço de rastreamento de entrega do Correios. (Fornecido pelo Representante Comercial dos Correios mediante carta de solicitação) Valor obrigatório para usar no Rastreio. | Formato: Texto |
| correiosbrasil.base.parcel.peso.unidade | Unidade de medida para o peso que está no cadastro do produto no Omni. A unidade de medida padrão para o correios é GR (gramas). Caso os produtos cadastrados no Omni estejam em uma unidade diferente, é necessário informar neste campo para que os cálculos de conversão seja realizados. | Formato: Texto Valores possíveis: GR (gramas) ou KG (quilos). Caso não seja especificado o valor padrão é GR |
| correiosbrasil.base.parcel.dimensao.unidade | Unidade de medida para as dimensões que estão no cadastro do produto no Omni. A unidade de medida padrão para o correios é CM (centímetros). Caso os produtos cadastrados no Omni estejam em uma unidade diferente, é necessário informar neste campo para que os cálculos de conversão seja realizados. | Formato: Texto Valores possíveis: M (metros) ou CM (centímetros). Caso não seja especificado o valor padrão é CM |
| correiosbrasil.base.parcel.codServicoExtras | Campo destinado para colocar as abreviações de serviços adicionais para os correios. Esse campo segue a documentação dos correios, a partir da página 44. (Clique Aqui) Deve ser passado os códigos de 2 caraceteres separados por espaço. | Formato: Texto Valores Possíveis:
Exemplo de preenchimento: AR EV VD OBS: Existe um limite de 8 serviços adicionais que podem ser enviados para os correios, então só pode ser adicionado até 8 siglas. |
| correiosbrasil.rest.password | Campo para informar senha gerada para a API Rest dos correios. (Fornecido pelo sistema dos Correios) | Formato: Texto OBS: Campo obrigatório para as consultas de CEP e prazo de entrega, utilizados na geração de pedido junto aos correios, e para o Tracking do pedido |
| correiosbrasil.rest.user.name | Campo para informar o usuário utilizado para a API Rest dos correios. (Fornecido pelo sistema dos Correios) | Formato: Texto OBS: Campo obrigatório para as consultas de CEP e prazo de entrega, utilizados na geração de pedido junto aos correios, e para o Tracking do pedido |
| correiosbrasil.rest.cartao.postagem | Campo para informar cartão de postagem que será utilizado API Rest dos correios. (Fornecido pelo sistema dos Correios) | Formato: Texto OBS: Campo obrigatório para as consultas de CEP e prazo de entrega, utilizados na geração de pedido junto aos correios, e para o Tracking do pedido |
| correiosbrasil.rest.environment | Campo que indica qual URL da API rest será utilizada pelo conector para o site. Deve ser preenchida com os valores "PRO" ou "PRE" para identificar qual ambiente o conector vai utilizar para o site. "PRO" aponta para PRODUÇÃO, "PRE" aponta para HOMOLOGAÇÃO. Obs: O preenchimento desse campo deverá ser com letra maiúscula. Caso não seja passado valor nenhum, assume-se PRE como valor default. | Formato: Texto Valores Possíveis:
Caso não seja especificado o valor padrão é PRE |
04. CACHE
Os módulos do Omni trabalham com cacheamento das informações de parâmetros de conector.
Caso seja necessário alterar um parâmetro e utilizar o novo valor de imediato no conector é necessário a limpeza dos caches dos módulos do Omni.
Neste caso é necessário realizar a chamada de 2 URLs através de uma tab nova no browser (Logado na interface web do Omni):
- Limpeza do cache no Core do Omni: https://adminco.modalia.com/hermesCore/properties/<SITE_ID>
- Limpeza de todo o cache de properties no módulo Logistico: https://adminco.modalia.com/moddo-logistic/cache/properties
Também é possível aguardar o prazo de 1h a 2hs para que a limpeza agendada dos caches aconteça e o conector acesse os novos valores de parâmetro
05. DE x PARA DE STATUS
| EVENTO TOTVS OMNI | REF. EVENTO CORREIOS |
| Pedido Aceitado | Evento que referencia a confirmação da criação do objeto de postagem/coleta. Obs: Totvs Omni recebe o código de rastreio do objeto |
| Em trânsito | Eventos que referenciam carga/pacote em movimento, por exemplo: "Objeto coletado" "Objeto recebido na unidade de distribuição" "Objeto encaminhado" |
| Pedido Entregue | Eventos que referenciam carga/pacote entregues, por exemplo: "Objeto entregue ao destinatário" "Objeto entregue na Caixa de Correios Inteligente" "Entregue" |
| Incidência com mensajeria | Eventos que referenciam uma mensageria/atenção, por exemplo: "Carteiro não atendido - Entrega não realizada" "Cliente mudou-se - Entrega não realizada" "As dimensões do objeto impossibilitam o tratamento e a entrega" Obs: Totvs Omni seguirá consultando/atualizando o tracking do pedido |
| Incidência em transporte | Eventos que referenciam uma mensageria/atenção, por exemplo: "Objeto roubado" "Objeto Sinistrado" "Desistência de postagem pelo remetente" Obs: Totvs Omni parará as consultas/atualizações do tracking do pedido |
06. REFERÊNCIA
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas