manual de implementacao do web service sigepweb logistica reversa
TRANSCRIPT
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
1/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
1/74
SIGEP WEB
Manual de Implementao de
Web Service Correios
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
2/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
2/74
Sumrio
SIGEP WEBImplementao e acesso ao Web Service....................................... 4
Pr-Requisitos ............................................................................................................. 5
Interface do Web Service SIGEP WEB ....................................................................... 6
Mtodos do Web Service do SIGEP WEB .................................................................. 6
Exemplo de tabelas para armazenamento em banco de dados .................................. 6
Viso Geral do Processo ............................................................................................. 7
Mtodo verificaDisponibilidadeServico() ................................................................... 12
Mtodo buscaCliente() .............................................................................................. 13
Mtodo consultaCEP() .............................................................................................. 14
Mtodo getStatusCartaoPostagem() ......................................................................... 14
Mtodo solicitaEtiquetas() ......................................................................................... 15
Mtodo geraDigitoVerificadorEtiquetas() ................................................................... 17
Mtodo fechaPlpVariosServicos() ............................................................................. 18
Especificao do Leiaute do XML ............................................................................. 23
Mtodo solicitaXmlPLP() ........................................................................................... 29
Web Service de Logstica Reversa ........................................................................ 31
Interface do Web Service de Logstica Reversa ........................................................ 31
Viso Geral do ProcessoLogstica Reversa .......................................................... 32
Mtodos do Web Service Logstica Reversa ............................................................. 35
Confeco de Etiquetas e Relatrios para Impresso .............................................. 47
Lista de Postagem (Voucher): ................................................................................... 47
Chancelas: ................................................................................................................ 48Aviso de Recebimento (AR): ..................................................................................... 48
01 - Rtulo de Postagem (Etiqueta): ......................................................................... 50
02 - Algoritimo Gerao do dgito verificador ............................................................ 51
03Layout 2DData Matrix .................................................................................... 51
04 - Leiaute do arquivo XSDWS Sigep.................................................................. 54
05 - Cdigo da Diretoria Regional (tag ) .................................... 61
06 - Cdigo do Servio Adicional ............................................................................. 62
07 - Algoritmo e-ticket (Autorizao de Postagem) .................................................. 62
08Rastreamento Correios ..................................................................................... 63
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
3/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
3/74
09Cdigo Forma de Pagamento (tag ) ................................. 63
10 - Cdigo Pas Bandeira ........................................................................................ 64
11 - Cdigo do Tipo de Exportador ........................................................................... 64
12 - Cdigo da Natureza da Operao ...................................................................... 64
13 - Cdigo do Porte da Empresa ............................................................................ 64
14 - Cdigo da Unidade de Comercializao ............................................................ 64
15 - Cdigo da Moeda de Negociao ...................................................................... 65
16 - Tabela de Mensagem de Erro Logstica Reversa .............................................. 65
17 - Tabela de Produtos ............................................................................................ 67
18 - Leiaute de chancelas ......................................................................................... 69
18.1 - Chancela PAC ................................................................................................. 6918.2 - Chancela SEDEX ............................................................................................ 70
18.3 - Chancela SEDEX 10 ....................................................................................... 71
18.4 - Chancela SEDEX Hoje .................................................................................... 72
18.5 - Chancela e-SEDEX ......................................................................................... 73
18.6 - Chancela Carta ............................................................................................... 74
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
4/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
4/74
SIGEP WEBImplementao e acesso ao Web Service
Os Correios disponibilizam gratuitamente, para clientes com contrato, um conjunto
de operaes acessveis via Web Service que possibilitam a integrao do Gerenciador
de Postagem dos Correios SIGEP WEB com sistemas proprietrios de cliente,
automatizando de forma personalizada o processo de organizao das postagens da sua
empresa ou rgo.
Esse servio de TI engloba um conjunto de mtodos que permitem automatizar a
prestao de servios qualificados como: SEDEX, Encomenda PAC, e-SEDEX entre
outros.
Na integrao utilizado os padres SOAP (Simple Object Access Protocol) e XML
(eXtended Markup Language), usados para troca de informaes entre sistemas
heterognios. Com a integrao dos sistemas, o processo obtem agilidade e eficincia na
comunicao entre cadeias de produo e ou logstica, pois passa a ser dinmica e
principalmente segura, levando em considerao que no haver interveno humana.
Os principais benefcios alcanados com esta integrao so listados a seguir:
Organizao e registro dos objetos em uma nica interface integrada aos
Correios;
Pesquisa de servios disponveis no carto de postagem;
Verificao do status do contrato e carto de postagem;
Antecipao do nmero de registro dos objetos antes mesmo da carga ser
encaminhada;
Maior celeridade no tratamento de objetos confiados aos Correios;
Gerao de Pr Lista de Postagem (PLP) que ficar aguardando a carga de
encomendas ser entregue na unidade de captao dos Correios;
Gesto unificada no sistema proprietrio do cliente de todos os processos
destinados a postagem: rastreamento ativo, consulta de CEP da base oficial,
pesquisa de abrangncia dos servios, prvia de faturamento em D+1 por
objeto postado, entre outras funcionalidades.
Alm disso, h outros servios tambm disponibilizados pelos Correios, que
podero ser agregados ao sistema do cliente:
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
5/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
5/74
Web Service de Clculo de Preos e Prazos de Encomendas
Proporciona a simulao de preo e prazo de entrega de mltiplos servios.
Os detalhes bem como o manual de implementao, podem ser obtidos no
endereo:http://www.correios.com.br/para-sua-empresa/servicos-para-o-seu-contrato/precos-e-prazos/calculador-remoto-de-precos-e-prazos
WSDL:http://ws.correios.com.br/calculador/CalcPrecoPrazo.asmx?WSDL
Web Service de Rastreamento de Objetos
Os clientes podem efetuar consulta de rastreamento com at 5 mil objetos
por chamada. Um exemplo de utilizao do Web Service est no Anexo 08,neste documento.
WSDL:http://webservice.correios.com.br/service/rastro/Rastro.wsdl
Pr-Requisitos
Para ter acesso a este servio, o cliente necessitar:
Possuir contrato com os Correios;
Solicitar ao representante comercial da ECT permisso de acesso para
utilizao do Web Service atravs de login e senha;
Implementar em seu sistema proprietrio as funcionalidades necessrias
para integrao com os mtodos descritos neste documento a exemplo
da seqncia lgica aqui descrita.
http://www.correios.com.br/para-sua-empresa/servicos-para-o-seu-contrato/precos-e-prazos/calculador-remoto-de-precos-e-prazoshttp://www.correios.com.br/para-sua-empresa/servicos-para-o-seu-contrato/precos-e-prazos/calculador-remoto-de-precos-e-prazoshttp://www.correios.com.br/para-sua-empresa/servicos-para-o-seu-contrato/precos-e-prazos/calculador-remoto-de-precos-e-prazoshttp://www.correios.com.br/para-sua-empresa/servicos-para-o-seu-contrato/precos-e-prazos/calculador-remoto-de-precos-e-prazoshttp://ws.correios.com.br/calculador/CalcPrecoPrazo.asmx?WSDLhttp://ws.correios.com.br/calculador/CalcPrecoPrazo.asmx?WSDLhttp://ws.correios.com.br/calculador/CalcPrecoPrazo.asmx?WSDLhttp://webservice.correios.com.br/service/rastro/Rastro.wsdlhttp://webservice.correios.com.br/service/rastro/Rastro.wsdlhttp://webservice.correios.com.br/service/rastro/Rastro.wsdlhttp://webservice.correios.com.br/service/rastro/Rastro.wsdlhttp://ws.correios.com.br/calculador/CalcPrecoPrazo.asmx?WSDLhttp://www.correios.com.br/para-sua-empresa/servicos-para-o-seu-contrato/precos-e-prazos/calculador-remoto-de-precos-e-prazoshttp://www.correios.com.br/para-sua-empresa/servicos-para-o-seu-contrato/precos-e-prazos/calculador-remoto-de-precos-e-prazos -
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
6/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
6/74
Interface do Web Service SIGEP WEB
A interface poder ser consultada e configurada no ambiente de desenvolvimento
(sistema proprietrio) no seguinte endereo:
Desenvolvimento:
https://apphom.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdl
Para o acesso ao ambiente de desenvolvimento, podero ser utilizados os seguintes
dados para autenticao e testes de implementao:
Usurio Senha Cdigo Administrativo Contrato Cdigo Servio Carto
sigep n5f9t8 08082650 9912208555 ... 0057018901
Obs: Para desenvolvimento, os cdigos de servios podem ser obtidos atravs do mtodo
buscaCliente(), exemplificado em tpico especfico neste manual.
Produo:
https://apps.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdl
Obs: Para produo, devero ser utilizados os parmetros do contrato com os Correios.
Mtodos do Web Service do SIGEP WEB
Os mtodos e elementos necessrios para utilizao do Web Service sero
descritos e exemplificados logo abaixo.
Antes, porm, segue sugesto de esquema de tabelas que o cliente poder criar
para armazenar os dados a serem enviados e depois recebidos do Sistema de
Gerenciamento de Postagens dos Correios SIGEP WEB. Isso facilitar a gesto da
informao dos pedidos e servios de Correios utilizados.
Exemplo de tabelas para armazenamento em banco de dados
https://apphom.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdlhttps://apphom.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdlhttps://apps.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdlhttps://apps.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdlhttps://apps.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdlhttps://apphom.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdl -
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
7/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
7/74
Exemplo de dados do modelo proposto:
Tb_Pedido
Tb_Pedido_Servico
idPedido idServicosECT codigoObjetoECT
1 109819 DL611459289BR1 109819 DL611459292BR
Tb_Servicos_ECT
idServicosECT codigoServicoECT descricaoServicoECT
104625 40096 SEDEX - Contrato
109819 41068 PAC
Tb_Servicos_Cliente
idServicosECT idCliente
109819 1
Tb_Cliente
idCliente cartaoPostagem contrato cnpj
1 0066000000 991220000 701119990001012 0066000001 991220000 70111999000101
Viso Geral do Processo
idPedido notaFiscal
1 123456789
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
8/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
8/74
Na viso aqui proposta, o processo de integrao envolve Correios e Cliente em
cinco etapas:
1. Inicializao: Nesta etapa o cliente consulta os Correios para verificar/validar asituao do contrato/carto, seus servios disponveis e para reservar faixas de
nmeros de registro das encomendas, que sero consumidas pelo cliente ao longo
de um perodo pr-definido, gerenciando localmente os nmeros vlidos. O sistema
do cliente poder controlar o estoque desta numerao de forma automatizada.
Estes nmeros de registro identificam os objetos que sero postados nos Correios
e so chave para o rastreamento;
2. Atendimento Pedido:Contempla os passos mnimos para preparao fsica dasencomendas por parte do cliente. Permite a validao de preo, prazo,
disponibilidade do servio para o CEP destino, alm de selecionar a melhor forma
de entrega de acordo com a necessidade. O rtulo a ser impresso deve seguir o
padro proposto neste documentoAnexo 01;
3. Pr-postagem: Fechamento da Pr-lista de Postagem PLP, dos pedidos
anteriormente atendidos. Estes pedidos sero consolidados diariamente em uma
nica lista a ser enviada de forma eletrnica aos Correios. O retorno ser umnmero que identificar a PLP. Este nmero a chave para o recebimento das
encomendas nos Correios a ser disposto no voucher. O controle de expedio ser
atravs do voucher a ser gerado pelo sistema proprietrio modelo constante
neste documento;
4. Postagem: Apresenta os passos para a postagem das encomendas nos Correios;
5. Acompanhamento da Entrega: Nesta etapa, demonstra o gerenciamento das
encomendas encaminhadas/postadas nos Correios. Alm de obter o rastreamento
da encomenda no fluxo postal at o momento da sua entrega, ser tambm
possvel obter os dados atualizados da aferio/captao do atendimento e o valor
precificado no sistema de atendimento dos Correios, para cada encomenda.
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
9/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
9/74
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
10/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
10/74
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
11/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
11/74
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
12/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
12/74
Mtodo verificaDisponibilidadeServico()
Este mtodo ser responsvel por verificar a disponibilidade de servios em
especifico que no possuem abrangncia nacional (SEDEX 10, SEDEX 12, e-SEDEX).
Assinatura do mtodo:
verificaDisponibilidadeServico(codAdministrativo, numeroServico, cepOrigem, cepDestino, usuario,
senha)
Campo Tipo Descrio Obrigatrio
codAdministrativo String(8) Cdigo Administrativo do contrato do Cliente coma ECT.
Sim
numeroServico String Cdigos dos servios contratados, podendo serseparados por vrgulas., Ex:40215,81019...
Sim
cepOrigem String (8) CEP de Origem sem hfen.Exemplo: 70002900 Sim
cepDestino String (8) CEP de Destino sem hfen Sim
usuario String Usurio autenticador. (Fornecido peloRepresentante Comercial dos Correios)
Sim
senha String Senha de autenticao. (Fornecida peloRepresentante Comercial dos Correios)
Sim
Retorno do mtodo:
Campo Tiporeturn Boolean (true / false)
Exemplo:
Consulta:
00000000402157000290081350120**************
Retorno:
true
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
13/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
13/74
Mtodo buscaCliente()
Este mtodo retorna os servios disponveis no contrato para um determinado
carto de postagem. Este mtodo pode ser utilizado periodicamente para atualizar a
tabela Tb_Servicos_ECT acima descrita.
Assinatura do mtodo:
buscaCliente (idContrato, idCartaoPostagem, usuario, senha)
Campo Tipo Descrio Obrigatrio
idContrato String(10) Nmero do contrato Sim
idCartaoPostagem String (10) Carto de postagem vinculado ao contrato Sim
usuario String Usurio autenticador. (Fornecido peloRepresentante Comercial dos Correios)
Sim
senha String Senha de autenticao. (Fornecida peloRepresentante Comercial dos Correios)
Sim
Exemplo:
Consulta:
00000000000000000000**************
Retorno:
********
****************
40096SEDEX - CONTRATO104625...
10
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
14/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
14/74
Mtodo consultaCEP()
Este mtodo retorna o endereo atualizado da base dos Correios.
Assinatura do mtodo:
consultaCEP(cep)
Campo Tipo Descrio Obrigatrio
Cep String(8) Nmero do cep sem hfen. Sim
Exemplo:
Consulta:
70002900
Retorno:
Asa Norte70002900BrasliaSBN Quadra 1 Bloco A0DF
Mtodo getStatusCartaoPostagem()
Este mtodo retorna o status do carto de postagem. recomendada a pesquisa
peridica para evitar tentativa de postagens com carto cancelando, ocasionando a no
aceitao nos Correios ou atrasando o seu encaminhamento.
Assinatura do mtodo:
getStatusCartaoPostagem (numeroCartaoPostagem, usuario, senha)
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
15/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
15/74
Campo Tipo Descrio Obrigatrio
numeroCartaoPostagem String (10) Carto de Postagem vinculado ao contrato Sim
usuario String Usurio autenticador. (Fornecido peloRepresentante Comercial dos Correios)
Sim
senha String Senha de autenticao. (Fornecida peloRepresentante Comercial dos Correios) Sim
Retorno do mtodo:
Campo Tiporeturn Normal / Cancelado
Exemplo:
Consulta:
0000000000**************
Retorno:
Normal
Mtodo solicitaEtiquetas()
Este mtodo retorna numerao de registro(s) dos Correios para futura postagemde objeto(s). O nmero de registro o identificador do objeto no fluxo postal da ECT,
sendo utilizado como chave para rastreamento.
Com o atendimento da solicitao, o nmero de registro fica reservada para o
CNPJ informado. Quando da preparao do objeto para postagem, cada nmero poder
ser usado para gerao do rtulo de postagem no padro descrito no Anexo 01.
O mtodo contempla o pedido de um ou mais nmeros, por exemplo:
Situao 1: Aps a finalizao de um processo (Ex: Compra de um produto na lojaonline), obter um nmero do registro da encomenda a ser postada.
Situao 2: Aguardar a finalizao de uma lista com n objetos a ser postada ,
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
16/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
16/74
solicitando em seguida, uma faixa de numerao.
Situao 3: Solicitar uma quantidade maior de etiquetas e gerenci-la localmente
de acordo com os servios utilizados, com rotina de controle do estoque das etiquetas,
consumindo a numerao deste estoque. Recomendamos solicitar uma faixa de etiquetasconforme previso de postagem do dia por servio (PAC, SEDEX, etc). Dessa forma
quando se esgotar o estoque de etiquetas para o servio, efetuar nova solicitao. Esse
processo evita a dependncia de solicitao on-line de etiquetas, permitindo um controle
local no sistema cliente.
Para cada tipo de servio dever ser solicitada uma faixa de numerao.
Este mtodo pode ser utilizado sob demanda, quantas vezes o cliente necessitar.Importante: O nmero retornado no contm o dgito verificador. Para obteno
desse dgito, consuma o mtodo geraDigitoVerificadorEtiquetas ou implemente sua
prpria gerao do dgito verificador, conforme especificao e exemplo constantes do
Anexo 02.
Assinatura do mtodo:
solicitaEtiquetas(tipoDestinatario, identificador, idServico, qtdEtiquetas, usuario,senha)
Campo Tipo Descrio Obrigatrio
tipoDestinatario String (1) Identificao com a letra C,de cliente. Sim
identificador String (14) CNPJ da empresa. Ex: 00000000000000 Sim
idServico Long (6) Id do servio, porder ser obtido no mtodo buscaCliente(). Sim
qtdEtiquetas Int Quantidade de etiquetas a serem solicitadas. Permitesolicitar 1 ou n etiquetas.
Sim
usuario String Usurio autenticador. (Fornecido pelo RepresentanteComercial dos Correios)
Sim
senha String Senha de autenticao. (Fornecida pelo RepresentanteComercial dos Correios)
Sim
Retorno do mtodo:
Campo Tipo
return String (Faixa de Numerao de Etiquetas)
Exemplo:
Consulta:
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
17/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
17/74
C*******1046251
**************
Retorno:
DL76023727 BR,DL76023727 BR
Mtodo geraDigitoVerificadorEtiquetas()
Este mtodo retorna o dgito verificador de uma etiqueta ou um array.
Assinatura do mtodo:
geraDigitoVerificadorEtiquetas(etiquetas, usuario, senha)Campo Tipo Descrio Obrigatrio
Etiquetas String(13) Dever ser uma String contendo o espao vazioque ser gravado o digito verificador.Ex: DL61145929 BRPoder ser enviado individualmente ou um array.
Sim
usuario String Usurio autenticador. (Fornecido peloRepresentante Comercial dos Correios)
Sim
senha String Senha de autenticao. (Fornecida peloRepresentante Comercial dos Correios)
Sim
Retorno do mtodo:
Campo Tiporeturn Int(digitoVerificador), Sendo um array o retorno ser indexado na sequncia
enviada.
Exemplo:
Consulta:
DL74668653 BRDL76023727 BR**************
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
18/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
18/74
Retorno:
62
Mtodo fechaPlpVariosServicos()
Este mtodo responsvel por enviar as informaes dos objetos que sero
postados nos Correios. O controle do encaminhamento dos objetos fsicos ser por meio
de uma Pr-Llista de Postagem (Cdigo PLP). Permite o envio de vrios objetos de
diferentes servios, pois o campo listaEtiquetas um array dos objetos constantes no
XML. A seqncia dos objetos contidos no array listaEtiquetas dever ser a mesma do
XML, que tambm enviado por parmetro no momento de acionar o mtodo. Os objetos
informados no array listaEtiquetas no devem conter o dgito verificador. J no XML
obrigatrio informar o dgito verificador da etiqueta.
Os nmeros de objeto devero ser obtidos previamente pelo mtodo
solicitaEtiquetas(). Preferencialmente, essa PLP poder ser enviada na finalizao do
processo de postagem do dia, contemplando todos os objetos a serem expedidos em uma
nica lista. No entanto, possvel que seja fechada mais de uma PLP por dia, caso haja
esta necessidade dentro do processo do cliente. A seguir, informaremos o detalhamento
do mtodo.
Assinatura do mtodo:
fechaPlpVariosServicos(xml, idPlpCliente, cartaoPostagem, listaEtiquetas, usuario,
senha)
Campo Tipo Descrio Obrigatrio
xml String PLP (pr-lista de postagem) em formato XML conformeexemplo abaixo (Exemplo de XML de PLP).
Sim
idPlpCliente Long Cdigo identificador para uso de controle do cliente daPLP enviada aos Correios.
Sim
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
19/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
19/74
cartaoPostagem String (10) Cdigo que autoriza a postagem dos servios nocontrato.
Sim
listaEtiquetas List Lista de objetos enviados via parmetro sem o digitoverificador, por exemplo:List listaEtiquetas = new ArrayList();
listaEtiquetas.add("DL12345677BR");
listaEtiquetas.add("DF12345678BR");
Sim
usuario String Usurio autenticador. (Fornecido pelo RepresentanteComercial dos Correios)
Sim
senha String Senha de autenticao. (Fornecida pelo RepresentanteComercial dos Correios)
Sim
Retorno do mtodo:
Campo Tiporeturn Long (idPlpCliente)
Exemplo:
Consulta:
123******
DL76023727BRPH76023727BR************
Retorno:
1545168
Exemplo do XML da PLP
Postagem2.3
********
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
20/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
20/74
********36********2370PR
PH185560916BR41068
0,0000200
1065
GO1020300,0
025001019
99,00
0022030380
0
Exemplo de codificao do mtodo fechaPlpVariosServicos()PHP
Transcrevemos abaixo um mtodo simples de utilizao do mtodo fechar PLP
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
21/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
21/74
vrios servios. Poder ser adaptado em qualquer plataforma, seguindo esse exemplo do
ambiente de desenvolvimento.
$idPlpCliente = "1L";$cartaoPostagem = "0057018901";/* Retirar o digto verificador dos objetos do array e seguir a mesma sequncia do XML */$listaEtiquetas = array('SO00064196BR', 'SL99922179BR');$params = array('xml' => $xml, 'idPlpCliente' => $idPlpCliente, 'cartaoPostagem' => $cartaoPostagem, 'listaEtiquetas' =>
$listaEtiquetas, 'usuario' => 'sigep' , 'senha' => 'n5f9t8');$result = $clientSoap->fechaPlpVariosServicos($params);
print_r($result);?>
Consideraes importantes para a construo do XML:
1. O XSD que efetua a validao deste XML, poder ser consultado no Anexo
04 deste documento e dever, necessariamente, validar o XML, antes de
fechar a PLP .
2. Utilizar o nos campos texto, para evitar problemas com
caracteres especiais que poderiam corromper o xml (&, %, etc).
https://apphom.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdlhttps://apphom.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdlhttps://apphom.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdlhttps://apphom.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdl -
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
22/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
22/74
3. Ao incluir o arquivo XML no mtodo (fechaPlp ou fechaPlpVariosServicos),
excluir os terminadores de linha, para que o arquivo seja transportado de
forma linear.
4. Para enviar o XML no mtodo fechaPlpVariosServicos ou fechaPlp, retirar odgito verificador do cdigo da etiqueta na assinatura do mtodo.
5. Os dados de contrato, cdigo administrativo e carto de postagem, devem
estar previamente cadastrados e dentro da vigncia. possvel consultar o
status do carto de postagem atravs do mtodo
getStatusCartoPostagem() e obter todos os servios disponveis no
carto atravs do mtodo buscaCliente(). Essa consulta importante para
evitar erros ao enviar uma lista de postagem num carto com data devencimento j expirada.
6. O servio postado deve estar associado ao carto de postagem, informao
obtida atravs do mtodo buscaCliente().
7. O nmero da etiqueta obrigatrio. Apenas objetos registrados podem ser
postados. Desta forma, o cdigo adicional de nmero 025, referente ao
servio adicional Registro, deve sempre ser declarado na tag
para cada objeto postado.8. As etiquetas utilizadas no arquivo devem pertencer ao cliente e a sigla deve
estar associada ao servio a ser postado, informao obtida atravs do
mtodo solicitaEtiquetas(). Ou seja, se no XML a etiqueta informada for do
servio SEDEX, o cdigo do servio deve ser tambm relacionado a este
mesmo servio SEDEX. Esse relacionamento de servio/cdigo poder ser
consultado atravs do mtodo buscaCliente().
9. Todas as TAGS devem ser declaradas no XML, mesmo as no obrigatrias.
Caso no tenham contedo, devem ser declaradas vazias.
10. A homologao da comunicao entre sistema proprietrio e Correios
ocorrer da seguinte forma: Atravs de um nmero de PLP retornado pelo
mtodo fechaPLP dever ser enviado ao representante comercial. O teste
ser efetuado captando esta PLP na unidade de atendimento/operacional
dos Correios, se no houver nenhum erro no sistema de atendimento dos
Correios, a comunicao/homologao estar vlida. Recomendamos antes
de chamar o mtodo fechaPLP, validar o XML no XSD constante do Anexo
04 deste documento.
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
23/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
23/74
11. Haver necessidade da homologao dos rtulos de postagem, ser
efetuado leitura das mquinas dos Correios na unidade de atendimento ou
operacional. Para o teste do rtulo ser necessria a impresso fsica do
cliente e encaminhando ao representante comercial que ir homologar juntoa unidade de atendimento dos Correios. O padro a ser utilizado consta
neste documento no anexo 01.
12. O rtulo dos Correios contempla a etiqueta 2D (DataMatrix). O layout do 2D
consta do Anexo 03.
Especificao do Leiaute do XMLO leiaute dividido nas seguintes tags:
Encoding padro dos Correios para o xml.
a tag principal. Identifica o arquivo como pertencente ao sistema CorreiosLOG.
Identifica qual o tipo do arquivo dentro do sistema CorreiosLOG. Permite a
distino entre os diversos tipos de arquivos que o sistema CorreiosLOG processa. Para
este leiaute, dever ser preenchido: Postagem
Observao: campo obrigatrio
Identifica a verso do leiaute do arquivo XML. A verso deste leiaute a: 2.3
Observao: campo obrigatrio
Tag
Tags Descrio Tipo de dados Observaes
Identifica o registro da PLP Pr Lista de
Postagem que ser retornada atravs do
mtodo fechaPLP e sendo chave para o
atendimento nos Correios dos objetos a serem
postados.
Numrico(10) Preenchimento no
obrigatrio.
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
24/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
24/74
Dever obrigatoriamente ser enviada vazia,
por exemplo:
Valor em reais do total da tarificao dos
objetos da PLP, que ser retornada atravs do
mtodo solicitaXmlPlp quando postada.
Numrico(10,2) Preenchimento no
obrigatrio.
Identifica a unidade de postagem dos
Correios.
Caractere(12) Preenchimento no
obrigatrio.
Nome da unidade de postagem dos Correios. Caractere(30) Preenchimento no
obrigatrio.
Numero do carto do cliente associado PLP.
Ex: 0087654321 (sempre com 10 caracteres
inserir zeros esquerda).
Caractere(10) Preenchimento
Obrigatrio
Tag Identifica o remetente da postagem. Esta Tag dever aparecer somente uma vez
no arquivo. Os dados necessrios para o remetente so:
Tags Des cr io Tip o de dad os Ob ser vaes
Nmero do contrato do cliente Caractere(10) Preenchimento
Obrigatrio.
No pode existir o
caractere - entre os
nmeros.
Nmero da Diretoria Regional do contrato do
cliente, conforme Anexo 05.
Numerico(2) Preenchimento
Obrigatrio.
Cdigo administrativo do cliente Caractere(8) Preenchimento
Obrigatrio
No pode existir o
caractere - entre os
nmeros.
Nome do remetente Caractere(50) Preenchimento
Obrigatrio
Logradouro do remetente.
Recomendado utilizar o mtodo buscaCEP()
Caractere(40) Preenchimento
Obrigatrio
Parte do endereo Caractere(5) Preenchimento
Obrigatrio
Complemento do endereo Caractere(20) Preenchimento no
obrigatrio.
Bairro do remetente Caractere(20) Preenchimento
Obrigatrio
CEP do remetente Numrico(8) Preenchimento
Obrigatrio
99999999
No pode existir o
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
25/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
25/74
caractere - entre os
nmeros.
Cidade do remetente Caractere(30) Preenchimento
Obrigatrio
Unidade de Federao Caractere(2) Preenchimento
Obrigatrio
Telefone do remetente Numrico (12) Preenchimento no
obrigatrio.
99999999999
No pode existir o
caractere - entre os
nmeros
Fax do remetente Numrico (12) Preenchimento no
obrigatrio.
99999999999
No pode existir ocaractere - entre os
nmeros
Email do remetente Caractere (50) Preenchimento no
obrigatrio.
Tag
Valor numrico indicando a forma de pagamento utilizada pelo cliente para realizar
a postagem.Observao: campo no obrigatrio.
Para postagens a faturar enviar a tag vazia, por exemplo:
Tag
Tag delimitadora do objeto que ser postado. Esta tagcontm as caractersticas do
objeto postado. Para postagens de n objetos, esta tag dever ser repetida conforme a
quantidade de objetos desejados.
Tags Des cr io Tip o de dad os Ob ser vaes
Nmero do Objeto na ECT. Importante:
aqui dever constar: nmero do objeto +
digito verificador. Exemplo:
DF123456789BR
Caractere(13) Preenchimento
Obrigatrio
Cdigo de controle do objeto no cliente Caractere(20) Preenchimento
no obrigatrio.
Cdigo do servio da postagem, por
exemplo: 40215, 40096, etc.
Caractere(5) Preenchimento
obrigatrio
Cubagem do Objeto Numrico(9,2) Preenchimentono obrigatrio.
Peso do objeto (em gramas) Numrico(5) Preenchimento
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
26/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
26/74
Obrigatrio.
Reservado para observao do cliente Caractere(255) Preenchimento
no obrigatrio.
Reservado para observao do cliente Caractere(255) Preenchimento
no obrigatrio.
+ Dados do destinatrio Preenchimento
Obrigatrio
+ Dados relevantes a postagem nacional Preenchimento
Obrigatrio
+ Identifica os servios adicionais do
objeto postado
Preenchimento
Obrigatrio
+ Contm as dimenses do objeto (altura,
largura, comprimento e dimetro) e o tipo
do objeto (embalagem)
Preenchimento
Obrigatrio.
Contm a data de efetivao da
postagem.
Preenchimento
no obrigatrio.
Contm o STATUS do processamento
do objeto, dever ser enviado a
informao com valor igual a 0.
Caractere(1) Preenchimento
Obrigatrio.
Contm o numero de comprovante de
postagem.
Numrico(10) Preenchimento
no obrigatrio.
Valor que foi tarifado no Sistema de
Atendimento da Agncia dos Correios.
Numrico(10,2) Preenchimento
no obrigatrio.
Tag
Esta tagcontm os dados do destino da encomenda.
Tags Des cr io Tip o de dad os Obser vaes
Nome do destinatrio Caractere(50) Preenchimento
Obrigatrio.
Telefone do Destinatrio Numrico (12) Preenchimento no
obrigatrio.
99999999999
No pode existir o
caractere - entre os
nmeros
Celular do Destinatrio Numrico (12) Preenchimento no
obrigatrio.
99999999999
No pode existir o
caractere - entre os
nmeros
Email do Destinatrio Caractere(50) Preenchimento no
obrigatrio.
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
27/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
27/74
Logradouro do destinatrio. Recomendado
utilizar o mtodo buscaCEP()
Caractere(50) Preenchimento
Obrigatrio.
Complemento do endereo Caractere(30) Preenchimento no
obrigatrio.
Parte do endereo Caractere(5) Preenchimento
Obrigatrio.
Tag
A tag dever estar dentro da tag e conter os atributos
especficos de uma postagem de objetos nacionais.
Tags Des cr io Tip o de dad os Ob ser vaes
Bairro do destinatrio Caractere(30) PreenchimentoObrigatrio.
Cidade do destinatrio Caractere(30) PreenchimentoObrigatrio.
Sigla da UF do destinatrio Caractere(2) PreenchimentoObrigatrio
CEP do destinatrio Numrico(8) Preenchimento
Obrigatrio 99999999
No pode existir o caractere -
entre os nmeros.
Cdigo do usurio postal Caractere(20) Preenchimento no obrigatrio.
Centro de custo do cliente Caractere(20) Preenchimento no obrigatrio.
Nmero da nota fiscal. Se torna
obrigatrio se o servio for
Encomenda PAC41068
Numrico(7) Preenchimento Obrigatrio para
encomenda PAC.
Srie da nota fiscal. Se torna
obrigatrio se o servio for
Encomenda PAC41068
Caractere(20) Preenchimento Obrigatrio para
encomenda PAC.
Valor da nota fiscal Numrico(9,2) Preenchimento no obrigatrio.
Natureza da nota fiscal Caractere(0) Dever ser enviada sem
preenchimento nenhum.
Descrio do objeto Caractere(20) Preenchimento no obrigatrio.
Valor a cobrar do destinatrio Numrico(9,2) Obrigatrio para o servio na
modalidade a cobrar.
Tag
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
28/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
28/74
A tag dever estar dentro da tag e conter os
seguintes atributos do objeto:
Tags Des cr io Tip o de dad os Ob ser vaes
Cdigo do servio adicional Caractere (3) PreenchimentoObrigatrio.
O servio adicional 025,
referente ao registro, deve
sempre ser informado.
Casos os servios postados
pelo cliente possuam outros
servios adicionais, estes
devem tambm serinformados conforme Anexo
06.
Valor do seguro adicional declarado pelo
cliente.
Numrico (9,2) Se o cdigo do servio
adicional for igual a 019 o
campo obrigatrio
Tag
A tag dever estar dentro da tag e conter os
seguintes atributos:
Tags Descrio Tipo de dados Observao
Contm o cdigo do tipo de objeto
que foi postado (embalagem)
001 - Envelope
002 - Pacote / Caixa
003 - Rolo / Cilindro
Caractere (3) Preenchimento Obrigatrio.
Para 001 No prencher as tags de
dimenses.
Para 002 Preencher as tags: altura,
largura e comprimento.
Para 003Preencher as tags: comprimento
e dimetro.
Altura do objeto (em cm) Inteiro (5) Para:
= 001, preencher com 0
= 002, obrigatrio
= 003, preencher com 0
Largura do objeto (em cm) Inteiro (5) Para:
= 001, preencher com 0 = 002, obrigatrio
= 003, preencher com 0
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
29/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
29/74
Comprimento do objeto (em cm) Inteiro (5) Para:
= 001, preencher com 0
= 002, obrigatrio
= 003, obrigatrio
Dimetro do objeto (em cm) Inteiro (5) Para:
= 001, preencher com 0
= 002, preencher com 0
= 003, obrigatrio
Mtodo solicitaXmlPLP()
Este mtodo retorna o mesmo xml da PLP que foi anteriormente enviada pelo
cliente no fechamento da PLP, sendo atualizado no ato da postagem dos objetos nos
Correios, com informaes aferidas nas seguintes tags:
Tags Descrio Tipo de dados Observao
Valor da tarifao total da PLP. Numrico(10,2)
Cdigo da unidade de postagem
dos Correios
Caractere(12)
Nome da unidade de postagem
dos Correios.
Caractere(30)
Cubagem do Objeto Numrico(9,2)
Peso do objeto (em gramas) Numrico(5)
Altura do objeto (em cm) Inteiro (5)
Largura do objeto (em cm) Inteiro (5)
Comprimento do objeto (em cm) Inteiro (5)
Dimetro do objeto (em cm) Inteiro (5)
Contm a data de efetivao da
postagem.
Contm o STATUS do
processamento do objeto, quando
postado igual a 1.
Caractere(1)
Contm o numero de comprovante
de postagem do sistema de
Atendimento dos Correios.
Numrico(10)
Valor que foi precificado no
Sistema de Atendimento da
Unidade dos Correios para o
objeto.
Numrico(10,2)
Assinatura do mtodo:
solicitaXmlPlp (idPlpMaster, usuario, senha)
Campo Tipo Descrio Obrigatrio
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
30/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
30/74
idPlpMaster Inteiro Nmero da PLP (pr-lista de postagem). Sim
usuario String Usurio autenticador. (Fornecido pelo RepresentanteComercial dos Correios)
Sim
senha String Senha de autenticao. (Fornecida pelo RepresentanteComercial dos Correios)
Sim
Retorno do mtodo:
Campo Tiporeturn Xml
Exemplo:
Consulta:
1234567************
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
31/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
31/74
Web Service de Logstica Reversa
Esse Web Service especifico para Logstica Reversa que possui mtodos
necessrios para integrao entre o sistema proprietrio e os Correios.
Interface do Web Service de Logstica Reversa
A interface do Web Service de Logstica Reversa poder ser consultada e
configurada nos seguintes endereos:
Desenvolvimento:
http://webservicescolhomologacao.correios.com.br/ScolWeb/WebServiceScol?wsdl
Para o acesso ao ambiente de desenvolvimento, podero ser utilizados os
seguintes dados para autenticao e testes de implementao:
Usurio Senha Cd Administrativo Contrato Cd Serv Carto
60618043 8o8otn 08082650 9912208555 41076 0057018901
Produo:
http://webservicescol.correios.com.br/ScolWeb/WebServiceScol?wsdl
necessrio, para acesso ao ambiente em produo, solicitar login e senha,
enviando os seguintes dados abaixo para o gestor do seu contrato com os Correios. O e-mail informado ser definido como login de acesso ao ambiente, ao que recomendamos
que seja um e-mail corporativo.
Nmero Contrato Carto de Postagem Cdigo Administrativo Razo Social E-mail
Obs:O ambiente estar sujeito a evolues. Os clientes integrados sero avisados por e-
mail com antecedncia de no mnimo 30 dias, atravs do mtodo sobreWebService().
J estaro disponveis no ambiente de desenvolvimento, as manutenes com data
programada para entrar em produo.
http://webservicescolhomologacao.correios.com.br/ScolWeb/WebServiceScol?wsdlhttp://webservicescolhomologacao.correios.com.br/ScolWeb/WebServiceScol?wsdlhttp://webservicescol.correios.com.br/ScolWeb/WebServiceScol?wsdlhttp://webservicescol.correios.com.br/ScolWeb/WebServiceScol?wsdlhttp://webservicescol.correios.com.br/ScolWeb/WebServiceScol?wsdlhttp://webservicescolhomologacao.correios.com.br/ScolWeb/WebServiceScol?wsdl -
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
32/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
32/74
Viso Geral do ProcessoLogstica Reversa
Na viso aqui proposta, o processo de integrao envolve Correios, Cliente e
Consumidor em trs etapas:
1. Inicializao:Nesta etapa o cliente consulta os Correios para verificar se h novas
informaes sobre o servio ou ambiente do Web Service, sendo mais um canal de
comunicao de forma automatizada, podendo ser parametrizado como um pr-
alerta no sistema proprietrio. Por meio deste canal sero postadas informaes
sobre versionamento da aplicao, novas funcionalidades ou manutenes
programadas;
2. Postagem do Pedido:Contempla a interao do consumidor com o cliente que
solicita uma autorizao de postagem/coleta. O sistema proprietrio ir processar a
solicitao do consumidor junto aos Correios, que retornar uma autorizao de
postagem/coleta a este consumidor via email e/ou SMS. Neste momento, o
consumidor estar apto para encaminhar sua encomenda de acordo com o servio
autorizado pelo nosso cliente com contrato;
3. Acompanhamento do Pedido: Nesta etapa ser possvel ao clienteacompanhar/gerenciar as autorizaes de postagem/coleta disponibilizadas ao seu
consumidor. Quando o consumidor efetuar a postagem/coleta, o sistema
proprietrio do cliente poder obter a informao do nmero da etiqueta de registro
e efetuar o rastreamento da encomenda no fluxo postal at o momento de sua
entrega.
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
33/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
33/74
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
34/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
34/74
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
35/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
35/74
Mtodos do Web Service Logstica Reversa
Mtodo solicitarRange()
Este mtodo retorna uma faixa de numerao de autorizao de postagem (e-
ticket) a ser gerenciada no sistema proprietrio para o servio de logstica reversa. Para
cada nmero se faz necessrio calcular o dgito verificador, podendo ser consumido o
mtodo calcularDigitoVerificador() ou ainda a sua implementao local, conforme exemplo
do Anexo 07. Recomendado utilizar este mtodo apenas de forma contigencial.
Exemplo:
Consulta:
606180438o8otn080826509912208555AP1
Retorno:
001/05/2013170840031708400315:57
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
36/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
36/74
Mtodo calcularDigitoVerificador()
Este mtodo calcula o dgito verificador da numerao da faixa retornada do
mtodo solicitarRange(). Com o dgito verificador calculado, o nmero (Autorizao de
Postagem / e-ticket) est apto a ser disponibilizado ao cliente para efetuar a postagem
em uma unidade/agncia dos Correios. Recomendado antes da disponibilizao ao
cliente efetuar o processamento atravs do mtodo solicitarPostagemReversa().
Exemplo:
Consulta:
606180438o8otn0808265015733879
Retorno:
001/05/2013616:07157338796
Mtodo solicitarPostagemReversa()
Este mtodo processa o pedido de autorizao de postagem ou coleta de forma
online nos Correios. Poder ser efetuado at 50 solicitaes simultneas em uma nica
chamada, sendo uma lista de coletas_solicitadas.
Obs:Para o tipo C = Coleta, no poder ser utilizado a nmerao obtida pelo
mtodo solicitarRange(), dever ser consumido o mtodo solicitarPostagemReversa(),
sem informar a tag nmero. O servio de coleta domiciliria requer validao da rea de
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
37/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
37/74
abrangncia conforme o parmetro CEP.
Exemplo:
Consulta:
606180438o8otn080826509912208555410760057018901
Centro70002900BrasliaResidencial [email protected] 301Fulano106133331234DF
2102030
Centro80002900CuritibaBloco II41
[email protected] Joo NegroCiclano12514132321234PRN
A
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
38/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
38/74
1000.0051
123443211
Retorno:
0001/05/201316:42
0
01/05/201316:421020301234432117084004406/05/201301A
01
Mtodo cancelarPedido()
Com este mtodo ser possvel efetuar o cancelamento / desistncia de um pedido
de autorizao de postagem e solicitao de coleta disponibilizado ao cliente. O
cancelamento do pedido somente ser possvel se a tag de retorno descricao_status
(mtodo acompanharPedido()) estiver como A Coletar para o servio de coleta ou
Aguardando Objeto na Agnciapara pedidos de Autorizao de Postagem, neste caso
ainda no houve nenhum evento de atendimento desta solicitao.
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
39/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
39/74
Exemplo:
Consulta:
606180438o8otn08082650170840044A
Retorno:
5122864
01/05/2013 16:49170840044Desistncia do Cliente ECT
Mtodo acompanharPedido()
Com esta funcionalidade poder acompanhar o pedido de autorizao de
postagem, quando houver a postagem em uma unidade dos Correios o mtodo retorna o
nmero da etiqueta de registroatravs da tag . Atravs desse nmero
ser possvel acompanhar o rastreamento do objeto, exemplificado no Anexo 08.
Exemplo:
Consulta:
606180438o8otn08082650HC010092315
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
40/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
40/74
Retorno:
5122864
102030
08-03-2013Aguardando Objeto de Entrega14:43:350
10092315
08-03-2013A Coletar14:43:35LE201904855BR
1
C
Descrio das tags de Logstica Reversa
Descrio das Tags do Cabealho
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
41/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
41/74
Nome da Tag Descrio / Observaes Tipo Dados Obrigatrio
Identifica a verso do arquivo XML.Para esta verso dever ser preenchido: 4.0
Fixo Sim
Data para agendar o processamento do arquivo.Se informada o sistema processa o arquivo
apenas na data indicada.
Data(DD/MM/YYY
Y)
No
Data de agendamento de coleta de todos ospedidos do arquivo. O sistema aceita apenasdatas com mais de cinco dias corridos a partir dadata de processamento do arquivo. Casocontrrio o processamento do arquivo inteiro sercancelado.
Data(DD/MM/YYY
Y)
No
Cdigo Administrativo do cliente. Numrico (8) Sim
Nmero do contrato do cliente. Numrico (10) Sim
Cdigo do servio que ser utilizado. O cdigoser fornecido pela ECT.
Numrico(5) Sim
Nmero do carto de postagem do cliente queser usado para a cobrana das taxas do serviorealizado.
Numrico(10) No
Tag Sub-tags que armazenam dados dodestinatrio.
Sub-Tags Sim
+ Nome do Cliente ou Razo Social Caractere(60) Sim
+ Logradouro do cliente Caractere(72) Sim
+ Nmero do endereo do cliente. Caso nopossua preencher com S/N
Caractere(8) Sim
+ Complemento do endereo do cliente Caractere(30) No
+ Bairro Caractere(50) No
+ Uma referncia do local de entrega Caractere(60) No
+ Cidade Caractere(36) Sim
+ Sigla do Estado. Caractere(2) Sim
+ CEP sempre com oito posies.Exemplo: 01000999
Caractere(8) Sim
+ Cdigo de rea do telefone. Caractere(3) No
+ Telefone do cliente Caractere(12) No
+ Este campo no obrigatrio, mas importantepara que o cliente receba informaes sobre
seus pedidos.
Caractere(72) No
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
42/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
42/74
Tagonde so colocados os blocos de tags que armazenam os dados dassolicitaes.
Cada solicitao de coleta ou autorizao de postagem est contida nesta tag.
Descrio das Tags dos Dados da Solicitao.
Sub-tags de Descrio / Observaes Tipo Dados Obrigatrio
Indica se a solicitao de coleta domiciliriaou uma autorizao de postagem.
CA= Coleta domiciliar. Caso no exista coletadomiciliar na localidade o sistema transforma
automaticamente o pedido em uma autorizaode postagem.C = Coleta domiciliria. Caso no exista acoleta no local indicado, o sistema ignora asolicitaoA = Autorizao de Postagem
Caso nenhum valor seja passado nessa tag, osistema entende que uma solicitao decoleta domiciliria.
Caractere(2) Sim
Nmero da Autorizao de Postagem. Usadoquando o cliente j possui uma faixa numricadesse tipo de solicitao. Esse nmero serencaminhado no arquivo de retorno.
Numrico (9) No
Campo para preenchimento livre. um valorpara identificao da solicitao junto ao cliente.Este valor enviado no arquivo de retornogerado aps o processamento.
Caractere (30) No
Coleta domiciliar:Data para agendamento dacoleta. Se informado o pedido fica retido nosistema e a primeira tentativa de coleta feitaapenas na data informada.O sistema aceita apenas datas com mais decinco dias corridos a partir da data deprocessamento do pedido.
Autorizao de Postagem:Indica a quantidadede dias de validade da autorizao.A validade deve ser de no mnimo 5 e nomximo 60 dias. Se no for informada, avalidade da autorizao ser de 10 (dez) diascorridos a partir da data do processamento dopedido.
DataDD/MM/YYYY
Numrico(2)Entre 5 e 60dias.
No
Nmero do carto de postagem para ser usadono faturamento dos valores do servio realizado.Caso seja informado para essa solicitao, a tag do cabealho ser ignorada.
Numrico(10) No
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
43/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
43/74
Somatrio de todos os valores declarados dosobjetos da coleta. Exemplo: 1020.70
Numrico(9.2) No
Cdigos de servios adicionais separados porvrgula.
Caractere(20) No
Descrio / instrues para coleta. Caractere(255) No
Indica se para solicitar Aviso deRecebimento para as encomendascadastradas. Usado apenas para pedidos deAutorizao de Postagem.
BooleanoColocar 1 ou 0
No
Indica que sero impressas vias de checklist.Apenas clientes previamente habilitadospodem utilizar essa opo. Cdigo fornecidopela ECT.
Valor fixo No
Tag Sub-tags que armazenam dados doremetente da coleta ou autorizao depostagem.
- Sim
+ Nome do remetente Caractere(60) Sim+ Logradouro do remetente Caractere(72) Sim+ Nmero do endereo do remetente. Caso no
possua, preencher com S/NCaractere(8) Sim
+ Complemento do endereo Caractere(30) No+ Bairro do remetente Caractere(80) No+ Cidade do remetente Caractere(40) Sim+ UF do remetente Caractere(2) Sim+ Cep do remetente sempre com 8 posies.
Exemplo 01200999.Caractere(8) Sim
+ Uma referncia do endereo do remetente Caractere(60) No+ Cdigo do DDD do remetente Caractere(3) No+ Nmero do telefone do remetente. Este campo
no obrigatrio mas importante para que a
ECT entre em contato com o remetente emcasos de insucesso na coleta.
Caractere(18) No
+ E-mail do remetente. Caso seja preenchido oremetente receber um e-mail informandosobre a coleta ou a autorizao de postagem.
Caractere(72) No
+ Nmero do telefone celular do rementente Caractere(9) No+ Cdigo do DDD do celular do remetente Caractere(3) No+ Caso deseja receber SMS dos status do
objeto (S = Sim, N = No)Caractere(1) No
+ Nmero do CNPJ ou CPF do remetente. Caractere(14) NoTag Contm os blocos de tagsque cadastram
os objetos que sero coletados (coleta
domiciliar) ou postados (autorizao depostagem).Vide observaes no item 4.b.
- Sim
+ Cada objeto cadastrado caracterizado por umbloco que se inicia nesta tag. Vide leiaute noitem 2 - Demonstrao das tags do arquivoXML. Caso esta tag no seja encontrada osistema assume que existe apenas um objeto aser coletado ou postado.
Sub-tags Sim
+ + Tag obrigatria. Apenas confirma o cadastro doobjeto dentro da solicitao.
Valor fixo1
Sim
+ + Campo para preenchimento livre. um valorpara identificao do objeto junto ao cliente.
Este valor enviado no arquivo de retornogerado aps o processamento. Exemplo:Nmero da nota fiscal.
Caractere(30) No
+ + Descrio do objeto que ser coletado Caractere(255) No
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
44/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
44/74
+ + Nmero do objeto para os pedidos de coletasimultnea. O contrato deve aceitar pedidos decoleta simultnea.
Caractere(13) No
+ + Nmero do objeto quando existe uma faixanumrica reservada para o cliente. Esta opo
ainda no utilizada.
Caractere(13) No
Tag Contm os blocos de tags que so utilizadaspara solicitao de produtos junto com acoleta. O contrato do cliente deve serhabilitado previamente para usar essa tag.
- No
+ Cada tipo de produto a ser solicitado caracterizado por um bloco que se inicia nestatag. Vide leiaute no item 2 - Demonstrao dastags do arquivo XML. obrigatrio caso oproduto seja solicitado para esta coleta.
Sub-tags -
+ + Cdigo do produto. Fornecido pela ECT Numrico -+ + Cdigo do tipo de produto. Fornecido pela ECT Numrico -+ + Quantidade de produtos do tipo fornecido. Numrico -
Observaes Importantes
a) Valor Declarado: Caso seja informado, assegura ao cliente o ressarcimento do
valor declarado da mercadoria mais os preos postais pagos, nos casos de
extravio ou danos encomenda, mediante o pagamento de taxa de Seguro
Complementar (Ad Valorem)sobre o valor que exceder o valor do seguroautomtico.
Tags:
: Valor declarado do objeto da solicitao.
b) Cadastro dos Objetos (tag): muito importante que os objetos que
sero coletados ou postados sejam bem discriminados.
Caso a tag no seja utilizada, o sistema obtm o valor da tag .
Havendo divergncia entre a quantidade de objetos informada na solicitao e a
quantidade real no local da coleta ou postagem, a ECT ir tratar o pedido da
seguinte forma:
I) Quantidade de objetos cadastrados MAIOR que a quantidade real:
So coletados todos os objetos e cancelados os demais no sistema.
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
45/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
45/74
II) Quantidade de objetos cadastrados MENOR que a quantidade real:
coletada a quantidade de objetos informada, deixando no local da coleta
os demais.
Mtodo solicitarPostagemSimultanea()
Este mtodo responsvel pela postagem do objeto de ida e pela autorizao de
postagem/coleta do objeto de retorno, ocorrendo a troca simultnea dos objetos.
Esta modalidade de servio permite o envio de um objeto novo para substituir, por
exemplo, um defeituoso.
Ser necessrio na chamada enviar uma etiqueta vlida obtida atravs do Web
Service do SIGEP WEB no mtodo solicitaEtiquetas() e j calculado o digito verificador
atravs do mtodo geraDigitoVerificadorEtiquetas(). Ser necessrio fechar a PLP deste
objeto reverso atravs do mtodo fechaPLP() no ambiente SIGEP WEB da postagem de
ida. Na Tag ser informado a etiqueta como este exemplo, sendo o registro
(etiqueta) o mesmo correspondente ao servio que est sendo utilizado:
DL123456789BR
A postagem de ida ocorrer por meio de uma PLP Pr lista de postagem, e oretorno do mtodo informar o nmero da autorizao de postagemou coleta atravs da
tag podendo solicitar das seguintes maneiras na tag :
C = Coleta Domiciliar A troca do objeto ser efetuada no endereo do
consumidor (remetente do objeto de retorno), para isso ser iniciado uma
entrega x coleta no endereo do mesmo. A tag contem o
nmero de coleta que poder ser acompanhada atravs do mtodo
acompanharPedido(). A tag poder ser acompanhadaatravs do mtodo rastreamento dos Correios quando for efetuado o evento
coleta.
A = Autorizao de Postagem na Agncia A troca do objeto ser efetuada
em uma Agncia Prpria dos Correios mais prxima do endereo do
destinatrio da encomenda de ida (remetente da encomenda de retorno). A
tag contem o nmero da autorizao de postagem, e
poder ser acompanhada pelo mtodo acompanharPedido(). Quando oevento postagem ocorrer, poder ser consultado o status e a etiqueta
atravs do mtodo acompanharPedido(). Para a postagem de ida, poder
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
46/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
46/74
obter a o nmero da etiqueta atravs do Web Service do SIGEP WEB com
base no servio utilizado.
Obs: Antes de postar o objeto de ida, necessrio consumir o mtodosolicitarPostagemSimultanea().
Exemplo:
Consulta:
60618043
8o8otn080826509912208555410760057018901
Centro71901010BrasliaAP 10061Quadra 301Fulano9Residencial XXX6112341369DF
2102030
Centro80002900CuritibaBl [email protected] Joo NegroCiclano1251Ed Sede4112342158PR
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
47/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
47/74
C
1000.00DL619955496BR
Retorno:
0031/05/201308:54
031/05/201308:54102030010092664LE201914606BR03/06/201301
C01
Confeco de Etiquetas e Relatrios para Impresso
Ser necessrio implementar a impresso de alguns relatrios conforme segue
abaixo:
Lista de Postagem (Voucher):
Relatrio que agrupa o quantitativo dos objetos da PLP (que encapsula o xml de
objetos) transmitida aos Correios, devendo uma via acompanhar a carga fsica.
Exemplo de voucher padro dos Correios:
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
48/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
48/74
Chancelas:
So elementos grficos dos rtulos de postagem que identificam o tipo de servio
que est sendo utilizado na encomenda e contm o nome do servio e a marca Correios.
So de uso obrigatrio a serem implementadas nos rtulos de postagem. Podero ser
obtidas por meio do Consultor Comercial informando os servios que sero utilizados.
Alguns dos modelos esto no Anexo 18.
Aviso de Recebimento (AR):
Servio adicional que lhe permite ter em mo o comprovante escrito com a
assinatura de destinatrio.
Exemplo:
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
49/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
49/74
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
50/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
50/74
Anexos
01 - Rtulo de Postagem (Etiqueta):
a etiqueta que contm todas as informaes do objeto, remetente e destinatrio e
que dever ser afixada no prprio objeto. Esse padro se faz necessrio para a triagem
automatizada nos Correios. A documentao de referncia poder ser consultada atravs
do Guia Tcnico para Impresso de Etiquetas.
http://www.correios.com.br/para-sua-empresa/servicos-para-o-seu-
contrato/enderecamento/arquivos/Guiadeenderecamentodeencomendas.pdf
Modelo Padro:
http://www.correios.com.br/para-sua-empresa/servicos-para-o-seu-contrato/enderecamento/arquivos/Guiadeenderecamentodeencomendas.pdfhttp://www.correios.com.br/para-sua-empresa/servicos-para-o-seu-contrato/enderecamento/arquivos/Guiadeenderecamentodeencomendas.pdfhttp://www.correios.com.br/para-sua-empresa/servicos-para-o-seu-contrato/enderecamento/arquivos/Guiadeenderecamentodeencomendas.pdfhttp://www.correios.com.br/para-sua-empresa/servicos-para-o-seu-contrato/enderecamento/arquivos/Guiadeenderecamentodeencomendas.pdfhttp://www.correios.com.br/para-sua-empresa/servicos-para-o-seu-contrato/enderecamento/arquivos/Guiadeenderecamentodeencomendas.pdf -
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
51/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
51/74
02 - Algoritimo Gerao do dgito verificador
Exemplo de Algoritmo em Java:
/* Exemplo de clculo do digito verificador em Java Ex: numeroEtiqueta = "DL07798661BR" */public static String geraEtiquetaComDigitoVerificador(String numeroEtiqueta) {
String prefixo = numeroEtiqueta.substring(0, 2);String numero = numeroEtiqueta.substring(2, 10);String sufixo = numeroEtiqueta.substring(10).trim();String retorno = numero;String dv;Integer[] multiplicadores = {8, 6, 4, 2, 3, 5, 9, 7};Integer soma = 0;
// Preenche nmero com 0 esquerdaif(numeroEtiqueta.length()
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
52/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
52/74
Validador do CEP Destino 1
IDV 2
Etiqueta 13
Servios Adicionais (25, 01, 02, 19, 49, 57) 12
Carto de Postagem 10
Cdigo do Servio 5
Informao de Agrupamento 2
Nmero do Logradouro 5
Complemento do Logradouro 20
Valor Declarado 5
DDD + Telefone Destinatrio 12
Latitude 10
Longitude 10Pipe | 1
Reserva para cliente 30
Complemento do CEP:
Nmero do logradouro.Ex1: 00100Ex2: 01200Ex3: 00000 (Quando a informao for S/N, BR 101, KM 5)
Validador do CEP Destino:
Soma dos 8 dgitos do CEP de destino:Subtrai-se o resultado da soma do mltiplo de 10, imediatamente superior ao resultado.Ex: CEP: 71010050 7+1+0+1+0+0+5+0 = 14Subtrai-se 14 e 20.O validador do CEP do exemplo 6.IDVIdentificador de Dados Variveis:
Identificador do servio que est sendo utilizado.
IDV Identificao da Aplicao Uso do Campo Varivel
51 Encomenda Registro com servio adicional
81 Malotes Registro com servio adicional
Servios Adicionais (AR, MP, DD, VD): Quando no possui o servio adicional deverser preenchido com 00.Ex1: 250102194957Ex2: 250102190000
Ex3: 250000000000 -- Quando no possuir nenhum servio adicional
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
53/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
53/74
Cd. Servio Adicional Descrio01 Aviso de Recebimento02 Mo Prpria Nacional19 Valor Declarado Nacional (Encomendas)
25 Registro Nacional37 Aviso de Recebimento Digital49 Devoluo de Nota Fiscal - SEDEX57 Taxa de Entrega de Encomenda Despadronizada67 Logstica Reversa Simultnea Domiciliria69 Logstica Reversa Simultnea em Agncia
Informao de Agrupamento:(Nmero identificador do agrupamento da PLP)Ex1. PLP: 101515 (Nesta PLP temos sete objetos, sendo: Trs objetos do agrupamentocom identificador 01, Dois objetos sem agrupamentos e dois objetos do agrupamento com
identificador 02).Etiqueta PH297898690BRAgrupamento 01Etiqueta PH297898709BRAgrupamento 01Etiqueta PH297898712BRAgrupamento 01Etiqueta PH297898712BREtiqueta PH297898726BREtiqueta PH297898730BRAgrupamento 02Etiqueta PH297898743BRAgrupamento 02OBS.: A postagem agrupada dever ocorrer quando existir mais de um volume para o
mesmo destinatrio / logradouro no servio de PAC e a numerao dos objetosagrupados ter etiquetas seqncias.
Nmero do Logradouro:Nmero do endereo.
Complemento do Endereo: Informao adicional do endereoEx1: Casa 100 Bl 2Ex2: Ap 1000Ex3: BL II AP 1000Valor Declarado: Nmero inteiro.Ex: 00100Ex: 01000Ex: 10000
DDD + Telefone Destinatrio: Nmero do telefone do destinatrioEx1: 011999253224Para o estado de SP so 9 posies no campo telefone + DDDEx2: 006199253224Para os demais estados conforme exemplo 2Ex3: 000000000000Quando no existe a informaoLatitude: Informao da latitude, ser fornecido pelos Correios via Web Service.
Ex: -15.836518Obs.: Caso no possui a informao preencher com -00.000000
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
54/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
54/74
Longitude: Informao da longitude, ser fornecido pelos Correios via Web Service.Ex: -48.033981Obs.: Caso no possui a informao preencher com -00.000000
04 - Leiaute do arquivo XSDWS Sigep
A seguir demonstramos o leiaute do schema XSD utilizado para validao do XML
que enviado nos mtodos fechaPlp() ou fechaPlpVariosServicos(). Essa validao do
xml poder ser efetuada localmente, j validando o arquivo xml antes mesmo de ser
enviado via parmetro.
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
55/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
55/74
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
56/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
56/74
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
57/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
57/74
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
58/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
58/74
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
59/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
59/74
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
60/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
60/74
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
61/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
61/74
05 - Cdigo da Diretoria Regional (tag )
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
62/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
62/74
Cdigo Descrio Sigla
00001 AC ADMINISTRAAO CENTRAL AC
00003 DRACRE ACR
00004 DRALAGOAS AL
00006 DRAMAZONAS AM
00005 DRAMAP AP
00008 DRBAHIA BA
00010 DRBRASLIA BSB
00012 DRCEAR CE
00014 DR - ESPIRITO SANTO ES
00016 DRGOIS GO
00018 DRMARANHO MA
00020 DR - MINAS GERAIS MG
00022 DR - MATO GROSSO DO SUL MS
00024 DR - MATO GROSSO MT
00028 DRPAR PA
00030 DRPARABA PB
00032 DRPERNAMBUCO PE
00034 DRPIAU PI
00036 DRPARAN PR
00050 DR - RIO DE JANEIRO RJ
00060 DR - RIO GRANDE DO NORTE RN
00026 DRRONDONIA RO00065 DRRORAIMA RR
00064 DR - RIO GRANDE DO SUL RS
00068 DR - SANTA CATARINA SC
00070 DRSERGIPE SE
00074 DR - S O PAULO INTERIOR SPI
00072 DR - S O PAULO SPM
00075 DR- TOCANTINS TO
06 - Cdigo do Servio Adicional
Cdigo Descrio Do Servio Adicional
001 Aviso de Recebimento
002 Mo Prpria
019 Valor Declarado (Ad Valorem)
025 Registro
07 - Algoritmo e-ticket (Autorizao de Postagem)
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
63/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
63/74
Exemplo de Algoritmo em Java:
publicclassDvVerificador {
publicstaticvoidmain(String[] args) {System.out.println(geraEtiquetaComDigitoVerificador("15653850"));
}
// Exemplo e-ticket 15653829 (dv=7)publicstaticString geraEtiquetaComDigitoVerificador(String numeroEtiqueta) {
Integer[] multiplicadores = {8, 6, 4, 2, 3, 5, 9, 7};Integer soma = 0;String dv;
if(numeroEtiqueta.length() != 8) {numeroEtiqueta = "Error";
} else{for(inti = 0; i < 8; i++) {
soma += newInteger(numeroEtiqueta.substring(i, (i + 1))) * multiplicadores[i];}
Integer resto = soma % 11;
if(resto == 0) {dv = "5";
} elseif(resto == 1) {dv = "0";
} else{dv = newInteger(11 - resto).toString();
}numeroEtiqueta += dv;
}returnnumeroEtiqueta;
}}
08Rastreamento Correios
RastreamentoMtodo eventos()
ECTSROLT
101TE123456785AA /* Exemplo com dois objetos */TE123456785AB
09Cdigo Forma de Pagamento (tag )
Codigo Forma_Pagamento
1 Vale Postal
2 Reembolso Postal
3 Contrato de Cmbio
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
64/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
64/74
4 Carto de Crdito
5 Outros
10 - Cdigo Pas Bandeira
Codigo_pais_bandeira Descricao_pais Codigo_pais_ECT
1058 Brasil BR
11 - Cdigo do Tipo de Exportador
Cdigo Exportador
1 Pessoa Jurdica
11 Pessoa Fsica12 Pessoa Fsica domiciliada no exterior sem CPF
13 Pessoa Fsica residente no pas sem CPF
12 - Cdigo da Natureza da Operao
Cdigo Natureza_Operao
1 Pessoa fsica com cobertura cambial
2 Pessoa fsica sem cobertura cambial
3 Pessoa jurdica com cobertura cambial
4 Pessoa fsica sem cobertura cambial
30 Doao em carter de ajuda humanitria
31 Bagagem desacompanhada
41 Bens de carter cultural- Exportao temporria
42 Exportao temporria de material para emprego militar
43 Feiras e exposies
44 Conserto, reparo ou restaurao
45 Outras exportaes temporrias
61 Bens submetidos a regime de admisso temporria
71 Erro de expedio
72 No atendimento de exigncia de controle extrafiscal
73 Indeferimento de regime aduaneiro especial
74 Outros motivos: Portaria MF 306/95
13 - Cdigo do Porte da Empresa
Cdigo Porte_Empresa
1 Micro Empresa
2 Pequena Empresa
3 Outros
14 - Cdigo da Unidade de Comercializao
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
65/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
65/74
Cdigo Unidade_Comercializao
8 Centmetro
2 Grama
9 Milmetro
5 Minuto
6 No Significativo
4 Pagina
3 Palavra
10 Quantidade
1 Quilograma
7 R$-Valor
15 - Cdigo da Moeda de Negociao
Cdigo Moeda
0 Real
16 - Tabela de Mensagem de Erro Logstica Reversa
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
66/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
66/74
Cdigo Descrio do Erro
3 N O PERMITIDO AGENDAR PROCESSAMENTO DE ARQUIVO VIA WEBSERVICE
10 O ARQUIVO J FOI PROCESSADO
103 ARQUIVO COM ERRO DE ESTRUTURA
104 DADOS DE VALIDAO DA COLETA INCOMPLETOS105 CLIENTE N O CONFIGURADO PARA USAR O SISTEMA
107 VERS O INV LIDA DO ARQUIVO XML
108 VALOR DECLARADO N O PODE SER SUPERIOR A R$ 10.000,00
109 DADOS DO CONTRATO INV LIDOS
111 COLETA DOMICILIAR N O DISPON VEL PARA O SERVIO SEDEX 10
1111 COLETA DOMICILIAR N O DISPON VEL PARA ESSA LOCALIDADE
112 SERVIO N O ATENDE O CEP DE DESTINO
113 CEP DO DESTINAT RIO INEXISTENTE
114 CEP DE DESTINO COM FORMATO INV LIDO
115 CEP DE ORIGEM COM FORMATO INV LIDO
117 CEP DO REMETENTE INEXISTENTE
120 SERVIO ESPECIAL (e-SEDEX) N O ABRANGE O CEP DE ORIGEM INFORMADO
122 DADOS DE DESTINAT RIO INCOMPLETO
125 DADOS DE REMETENTE INCOMPLETOS
134 DATA DE AGENDAMENTO INV LIDA. VERIFICAR TAG -AGENDAMENTO
136 N MERO DE ENTREGA INV LIDO
1366 SERVIO DE SIMULT NEA EM AG NCIA N O ATENDIDO NA REGI O DO CEP DO REMETENTE
138 O ARQUIVO N O CONT M PEDIDOS DE COLETA. VERIFICAR TAG -coletas_solicitadas
140 CART O INV LIDO PARA O CONTRATO INFORMADO
142 VALOR INV LIDO PARA O TIPO DE SOLICITA O.VERIFICAR TAG -AG
195 N MERO DE E-TICKET J UTILIZADO
1955 N MERO DE OBJETO J UTILIZADO NESSE ARQUIVO
198 N MERO DE OBJETO INV LIDO OU D GITO VERIFICADOR INCORRETO
1988 FAIXA NUM RICA N O RESERVADA PARA ESSE CLIENTE
19888 N MERO DE OBJETO J UTILIZADO
198888 TIPO DE ETIQUETA INVLIDO
199 O SERVIO ADICIONAL 'AVISO DE RECEBIMENTO' SOMENTE EST DISPON VEL PARA OS PEDIDOS DE
AUTORIZAO DE POSTAGEM
200 C DIGO DE CHECKLIST INV LIDO
201 C DIGO DO PRODUTO INV LIDO
202 SERVIO ESPECIAL SEDEX 10 N O ATENDIDO POR LOG STICA REVERSA DOMICILI RIA
203 VALOR TAG -AR- INV LIDO
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
67/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
67/74
17 - Tabela de Produtos
Cdigo Tipo Descrio da Embalagem
116600403 0 Caixa de Encomenda "B" (16x11x6 cm)
116600055 0 Caixa Encomenda 01 (18x13,5x9 cm)
116600063 0 Caixa Encomenda 02 (27x18x9 cm)
116600071 2 Caixa Encomenda 03 (27x22,5x13,5 cm)
116600080 0 Caixa Encomenda 04 (36x27x18 cm)
116600160 2 Caixa Encomenda 05 (54x36x27 cm)
116600179 0 Caixa Encomenda 06 (36x27x27 cm)
Cdigo Descrio do Erro
204 TAGS -ENTREGA- INCONSISTENTES
206 VALOR DECLARADO INV LIDO
206 TAG -ENVIO.OBJ- INV LIDA.
207 DATA DE PROCESSAMENTO INV LIDA. VERIFICAR TAG -DATA_PROCESSAMENTO-
208 ARQUIVO VAZIO.
209 ARQUIVO COM MAIS DE 300 COLETA
210 SERVIO INDISPON VEL NO MOMENTO
211 VALOR DECLARADO N O PODE SER INFERIOR A R$ 11,00
212 ID DE POSTAGEM INV LIDO
213 VALOR INV LIDO PARA A TAG - QTD_CAIXA -
214 TAG - numero - DEVE SER UTILIZADO SOMENTE NO SERVIO DE AUTORIZA O DE POSTAGEM
215 TAG - identificacao - CPF OU CNPJ INV LIDO.
216 UF INV LIDA.
217 TAG - numeroINV LIDA
218 TAG - cartaoINV LIDA
219 TAG - PRODUTO.CODIGOINV LIDA
220 TAG - PRODUTO.TIPOINV LIDA
221 TAG - PRODUTO.QTDINV LIDA
222 O CEP INFORMADO N O PERTENCE A FAIXA DE ABRANG NCIA DO SERVIO E-SEDEX GRUPO I
223 O CEP INFORMADO N O PERTENCE A FAIXA DE ABRANG NCIA DO SERVIO E-SEDEX GRUPO II
224 TIPO DA SOLICITA O INV LIDA
225 SERVIO INV LIDO
226 QUANTIDADE INV LIDA
227 O N MERO DEVE POSSUIR 8 D GITOS
-1 Cdigo do identificador de acesso ao web service no autorizado.
-3 Tipo de solicitao invlida.
-4 Tipo de busca invlido.
-5 Nmero do pedido invlido ou no localizado na base de dados para o tipo de solicitao informado.
-7 Dados obrigatrios no informados.
-8 No existe informao para o solicitado.
-9 Pedido no pode ser cancelado, pois encontra-se no status
-10 O limite de pedidos deve ser no mximo de 30.
-11 Servio indisponvel no momento.
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
68/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
68/74
116600187 0 Caixa Encomenda 07 (36x28x4 cm)
765000660 0 Envelope Bolha Grande (20x28 cm)
765000652 2 Envelope Bolha Mdio (21x18 cm)
765000644 2 Envelope SEDEX Plstico Grande (40x28 cm)
765000636 0 Envelope SEDEX Plstico Mdio (35,3x25 cm)
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
69/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
69/74
18 - Leiaute de chancelas
18.1 - Chancela PAC
Siglas ou nomes por extenso dos servios
N do contrato; ano de assinatura; DR/origem/postagem
Cliente
.Estaro sempre dispostas no parte superior dos smbolos.
Fonte: Arial normal (caixa alta), corpo 7pt, espaamentosentre-letra e entre-linha=100%
Fonte: Arial negrito (caixa alta e baixa), corpo 9 a 11pt,espaamentos entre-letra e entre-linha=100%
.Estaro sempre dispostas no parte inferior dos smbolos.Identificao dos Correios
A
diagramao pr-definida.
Obs: Quando a DR de origem e postagem for a mesma,utilizar a sigla somente uma vez.
Obs: Utilizar duas linhas (centralizadas) quando necessrio.
A diagramao pr-definida.
Padronizao visual dos smbolos de Contratos Chancelas
Instrues para arte-finalizao -
- ENTREGA NO URGENTE
Servio: ENCOMENDA PAC
1. Para diagramar a Chancela siga as instrues abaixo:
Ateno:
No permitida alteraes na forma da chancela,assim como nas especificaes acima.
N do contrato; ano deassinatura; DR/origem/postagem
Cliente
Fonte: Arial normal (caixa alta),corpo 4pt, espaamentos entre-letra e entre-linha=100%
Fonte: Arial normal (caixa alta ebaixa), corpo 5pt, espaamentosentre-letra e entre-linha=100%
Obs: Quando a DR de origem epostagem for a mesma, utilizar asigla somente uma vez.
Obs: Utilizar duas linhas(centralizadas) quando necessrio.
Negativo:
Ateno:
2. Para arte-finalizao em negativo seguir a mesmadiagramao como no exemplo abaixo:
3. Utilizar a chancela reduzida somente quandonecessrio.
0000/2002-DR/XX/YY
Cliente
Reduo (15X20mm):
(Dimenses 25 x 35mm)
PAC
0000/2002-DR/XX/YY
Cliente
PAC
0000 /2002-D R /X X /Y Y
Cliente
PAC
-
7/25/2019 Manual de Implementacao Do Web Service SIGEPWEB Logistica Reversa
70/74
EMPRESA BRASILEIRA DE CORREIOS E TELGRAFOSECT
SIGEP Web - Manual de Implementao do Web Service
70/74
18.2 - Chancela SEDEX
Siglas ou nomes por extenso dos servios
N do contrato; ano de assinatura; DR/origem/postagem
Cliente
.Estaro sempre dispostas no parte superior dos smbolos.
Fonte: Arial normal (caixa al ta), corpo 7pt, espaamentosentre-letra e entre-linha=100%
Fonte: Arial negrito (caixa alta e baixa), corpo 9 a 11pt,espaamentos entre-letra e entre-linha=100%
.Estaro sempre dispostas no parte inferior dos smbolos.Identificao dos Correios
A
diagramao pr-definida.
Obs: Quando a DR de origem e postagem for a mesma,utilizar a sigla somente uma vez.
Obs: Utilizar duas linhas (centralizadas) quando necessrio.
A diagramao pr-definida.
Padronizao visual dos smbolos de Contratos Chancelas
Instrues para arte-finalizao - Servio Expresso: SEDEX
1. Para diagramar a Chancela siga as instrues abaixo:
Ateno:
No permitida alteraes na forma da chancela,assim como nas especificaes acima.
N do contrato; ano deassinatura; DR/origem/postagem
Cliente
Fonte: Arial normal (caixa alta),corpo 4pt, espaamentos entre-letra e entre-linha=100%
Fonte: Arial normal (caixa alta ebaixa), corpo 5pt, espaamentosentre-letra e entre-linha=100%
Obs: Quando a DR de origem epostagem for a mesma, utilizar asigla somente uma vez.
Obs: Utilizar duas linhas(centralizadas) quando necessrio.
Negativo:
Reduo (eixo maior 20mm; eixo menor 13,2mm):
Ateno:
2. Para arte-finalizao em negativo seguir a mesmadiagramao como no exemplo abaixo:
(Eixo maior 35mm)(Eixo menor 23mm)
3. Utilizar a chancela reduzida somente quandonecessrio.
0000/2002-DR/XX/YY
Cliente
0000/2002-DR/XX/YY
Cliente
0 0 0 0 /2 0 0 2 -DR/XX/YY
Cliente
-
7/25/2