Manual De Implementacao Do Web Service SIGEPWEB E Logistica Reversa V1

User Manual:

Open the PDF directly: View PDF PDF.
Page Count: 69

SIGEP WEB
Manual de Implementação de
Web Service
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
2/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
Sumário
SIGEP Web – Implementação de acesso ao Web Service .................................................. 4
Pré-Requisitos ..................................................................................................................... 5
Interface do Web Service ..................................................................................................... 5
Métodos do Web Service do SIGEP Web............................................................................ 6
Tabelas de armazenamento em banco de dados ................................................................ 6
Método verificaDisponibilidadeServico() .............................................................................. 7
Método solicitaEtiquetas() .................................................................................................... 8
Método geraDigitoVerificadorEtiquetas() ........................................................................... 13
Método fechaPlp() ............................................................................................................. 13
Método fechaPlpVariosServicos() ...................................................................................... 15
Leiaute do XML enviado no método fechaPlp() ou fechaPlpVariosServicos() ................... 24
Especificação do Leiaute do XML ...................................................................................... 27
Método buscaContrato() .................................................................................................... 35
Método getStatusCartaoPostagem() ................................................................................. 36
Web Service de Logística Reversa .................................................................................... 37
Interface do Web Service de Logística Reversa ................................................................ 37
Métodos do Web Service Logística Reversa ..................................................................... 37
XML : ................................................................................................................................. 37
Confecção de Etiquetas e Relatórios para Impressão ....................................................... 46
Lista de postagem: ............................................................................................................ 46
Rótulo de Postagem (Etiqueta): ......................................................................................... 48
Chancelas: ......................................................................................................................... 50
Aviso de Recebimento (AR): .............................................................................................. 50
Leiaute do arquivo XSD – WS Sigep ................................................................................. 52
1. Tabelas de códigos para uso no xml (correioslog) ........................................................ 61
1.1. Código Forma de Pagamento (tag <forma_pagamento>) ................................ 61
1.2. Código da Diretoria Regional (tag <numero_diretoria>) ................................... 61
1.2. Código País Bandeira ...................................................................................... 62
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
3/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
1.3. Código do Tipo de Exportador.......................................................................... 62
1.4. Código da Natureza da Operação .................................................................... 62
1.5. Código do Porte da Empresa ........................................................................... 62
1.6. Código da Unidade de Comercialização .......................................................... 63
1.7. Código da Moeda de Negociação .................................................................... 63
1.8. Código do Serviço Adicional ............................................................................ 63
2. Leiaute de chancelas ..................................................................................................... 63
2.1. Chancela PAC .................................................................................................. 63
2.2. Chancela SEDEX ............................................................................................. 65
2.3. Chancela SEDEX 10 ........................................................................................ 66
2.4. Chancela SEDEX Hoje ..................................................................................... 67
2.5. Chancela e-SEDEX .......................................................................................... 68
2.6. Chancela Carta ................................................................................................ 69
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
4/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
SIGEP Web – Implementação de acesso ao Web Service
Os Correios disponibilizam, gratuitamente, para clientes com contrato, um conjunto
de operações acessíveis via Web Service que possibilitam a integração dos sistemas de
gerenciamento de postagens da ECT com sistemas proprietários dos clientes, visando
automatizar de forma personalizada o processo de organização de postagens de sua
empresa ou órgão.
Esse serviço engloba um conjunto de métodos que permitem automatizar a
prestação de serviços qualificados: SEDEX, Encomenda PAC, e-SEDEX e Registrados.
Na integração é utilizado um conjunto de protocolos e padrões (XML, XSD, SOAP e
WSDL) usados para intercâmbio de informações entre aplicações Internet. Ela é indicada
para usuários avançados, que dominam essa tecnologia e que tenham condições de
implementar, por conta própria, em seus sistemas, o acesso ao Web Service.
Os principais benefícios alcançados com essa integração são listados a seguir:
Organização e registro dos objetos a serem postados através de
comunicação via Web Service entre o sistema proprietário do cliente e o
sistema de gerenciamento de postagens dos Correios.
Geração de pré-lista de postagem (PLP) que fica armazenada no sistema
de atendimento da agência dos Correios, aguardando a carga de
encomendas a ser entregue.
Antecipação do número de registro dos objetos antes mesmo da carga ser
encaminhada.
Maior celeridade no tratamento de objetos confiados aos Correios.
Gestão unificada, no sistema proprietário do cliente, de todos os processos
destinados a postagem.
Além disso, outros serviços também disponibilizados pelos Correios, que
poderão ser agregados ao sistema do cliente:
Web Service de Cálculo de Preços e Prazos de Encomendas que
proporciona a simulação dos valores de preços e prazos de entrega no
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
5/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
processo de compra de comércio eletrônico. Os detalhes desse serviço, bem
como o manual de implementação, podem ser obtidos no endereço
www.correios.com.br/webservices.
Sistema de Rastreamento de Objetos via XML os clientes que utilizam o
SRO XML podem se conectar de qualquer lugar da internet ao servidor do
Sistema de Rastreamento de Objetos SRO e obter detalhes (rastros) dos
objetos postados, através da tecnologia XML (eXtensible Markup Language).
Para disponibilização do serviço, é necessário que sejam avaliados alguns
critérios por parte da equipe comercial que atende o cliente.
Pré-Requisitos
Para ter acesso a este serviço, o cliente necessitará:
Possuir contrato com os Correios que contemple um ou mais dos
seguintes serviços:
Sedex: (código: 40096, 40436, 40444);
Sedex 10 (código: 40215);
E-Sedex (código: 81019);
Encomenda PAC (código: 41068);
Carta Comercial a Faturar (código: 10065).
Solicitar ao representante comercial da ECT permissão de acesso para
utilização do Web Service através de login e senha;
Implementar em seu sistema proprietário as funcionalidades necessárias
para integração com os métodos.
Interface do Web Service
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
6/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
A interface poderá ser consultada e configurada no ambiente de desenvolvimento
(sistema proprietário) no seguinte endereço:
http://sigep.correios.com.br/sigep/update/AtendeClienteService.wsdl
Métodos do Web Service do SIGEP Web
Os métodos e elementos necessários para utilização do Web Service do Sigep
Web estão descritos e exemplificados a seguir.
Antes, porém, segue sugestão 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. Isso facilitará o gerenciamento da informação
de pedidos e serviços de Correios utilizados.
Tabelas de armazenamento em banco de dados
Exemplo de dados do modelo proposto:
Tb_Pedido
IdPedido notaFiscal
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
7/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
1 102030
Tb_Objeto_Postal
Id_ObjetoPostal IdPedido codigoServicoPostagem
codigoObjetoPostal
1 1 40096 DL200467764
BR
2 1 40096 DL200467765
BR
3 1 41068 PH200467766
BR
Tb_Servico_ECT
codigoServicoPostagem
idServico descricaoServico
40096 104625 Sedex
41068 109819 PAC
Método verificaDisponibilidadeServico()
Esse método será responsável por verificar a disponibilidade de um serviço em
uma determinada região, sendo necessário para os serviços de SEDEX 10 e e-SEDEX
por não possuírem abrangência nacional.
Assinatura do método:
verificaDisponibilidadeServico(codAdministrativo, numeroServico, cepOrigem,
cepDestino, usuario, senha)
Campo
Tipo
Descrição
codAdministrativo String(9) Código Administrativo do contrato do Cliente com
a ECT. Sim, não poderá existir o
caracter “-” entre os
números
numeroServico String (5) Códigos dos serviços contratados, Ex:
40215, 81019... Sim
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
8/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
cepOrigem String (8) CEP de Origem sem hífen.Exemplo: 05311900 Sim
cepDestino String (8) CEP de Destino sem hífen Sim
usuario String Usuário autenticador. (Fornecido pelo
Representante Comercial dos Correios) Sim
senha String Senha de autenticação. (Fornecida pelo
Representante Comercial dos Correios) Sim
Retorno do método:
Campo
Tipo
return Boolean (true / false)
XML:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:cli="http://cliente.bean.master.sigep.bsb.correios.com.br/">
<soapenv:Header/>
<soapenv:Body>
<cli:verificaDisponibilidadeServico>
<numeroServico>40010</numeroServico>
<cepOrigem>01037010</cepOrigem>
<cepDestino>81350120</cepDestino>
<usuario>user</usuario>
<senha>senha</senha>
</cli:verificaDisponibilidadeServico>
</soapenv:Body>
</soapenv:Envelope>
Método solicitaEtiquetas()
Esse método é responsável por retornar o mero de registro dos Correios para
cada objeto postado. Esse número é o identificador único do objeto no fluxo postal da
ECT. O método contempla o pedido de um ou mais números, por exemplo:
Situação 1: Após a finalização de um processo (Ex: Compra) obter o número do
registro do objeto a ser postado.
Situação 2: Aguardar a finalização de uma lista com “n” objetos a ser postada
solicitando, em seguida, uma faixa de numeração. Para cada tipo de serviço deverá ser
solicitada uma faixa de numeração. Ex: Sedex, PAC, e-Sedex, etc.
Assim, este método pode ser utilizado, de acordo com a necessidade, quantas
vezes o processo do cliente precisar.
Importante: O número retornado o contêm o dígito verificador. Para obtenção
desse dígito poderá ser consumido o método geraDigitoVerificadorEtiquetas ou ser
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
9/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
efetuado uma implementação própria conforme exemplo abaixo.
Assinatura do método:
solicitaEtiquetas(tipoDestinatario, identificador, idServico, qtdEtiquetas, usuario,
senha)
Campo
Tipo
Descrição
tipoDestinatario String (1) Identificação com a letra “C”, de cliente. Sim
identificador String (18) CNPJ da empresa. Ex: 01000000000100 Sim
idServico Long (6) Código do serviço do ERP dos Correios,
conforme tabela abaixo:
Código Serviço idServico
81019 (E-sedex) 104672
41068 (Pac) 109819
40436 (Sedex) 109810
40096 (Sedex) 104625
40444 (Sedex) 109811
40215 (Sedex 10 Envelope) 104707
10065 (Carta) 109480
41009 (Sedex Agrupado) 119461
10138 (Carta Registrada) 116985
Sim
qtdEtiquetas Int Quantidade de etiquetas a serem solicitadas
limitadas em 1000 objetos por PLP. Sim
usuario String Usuário autenticador. (Fornecido pelo
Representante Comercial dos Correios) Sim
senha String Senha de autenticação. (Fornecida pelo
Representante Comercial dos Correios) Sim
Retorno do método:
Campo Tipo
return String (Faixa de Numeração de Etiquetas)
Exemplo de Codificação em C#
Exemp
los de métodos necessários para implementação do solicitaEtiquetas()
//Serviço Para Acesso a Etiqueta de Localização enviando NrPedido e DeliveryMethod
[WebMethod]
public String SolicitaEtiquetaPedido(String NrPedido, String DeliveryMethod)
{
string cs = ConfigurationManager.ConnectionStrings["ConnectionString"].ConnectionString;
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
10/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
CommunityServiceSigepDataContext con = new CommunityServiceSigepDataContext(cs);
String ServiceCode = "";
CorreiosLog ObjSigep = new CorreiosLog();
string GetDeliveryMethod = DeliveryMethod.ToUpper();
string ObterNumeroEtiqueta = string.Empty;
String EtiquetaLocalizaObjeto;
int count;
string[] CodigosRastreamento = null;
if (NrPedido != null && GetDeliveryMethod != null)
{
switch (GetDeliveryMethod)
{
case "7":
AtendeClienteService Esdx = new AtendeClienteService();
var Esedex = Esdx.solicitaEtiquetas("C", "00.000.000/0001-00", 104672, true, 1, true, "login", "senha"); // True
- parâmetro específico da linguagem C#
NumeroEtiqueta = Esedex;
ServiceCode = "81019";
break;
case "6":
AtendeClienteService Pcn = new AtendeClienteService();
var Paccon = Pcn.solicitaEtiquetas("C", "00.000.000/0001-00", 109819, true, 1, true, "login", "senha");
NumeroEtiqueta = Paccon;
ServiceCode = "41068";
break;
case "0":
AtendeClienteService Sdx = new AtendeClienteService();
var Sedex = Sdx.solicitaEtiquetas("C", "00.000.000/0001-00", 109810, true, 1, true, "login", "senha");
NumeroEtiqueta = Sedex;
ServiceCode = "40436";
break;
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
11/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
case
"2":
AtendeClienteService Sdz = new AtendeClienteService();
var SedexDez = Sdz.solicitaEtiquetas("C", "00.000.000/0001-00", 104707, true, 1, true, "login", "senha");
NumeroEtiqueta = SedexDez;
ServiceCode = "40215";
break;
}
string NumerosRastreamentoAR = NumeroEtiqueta;
//Atualmente retorna range - obtendo somente primeira etiqueta usando split
char[] splitchar = { ',' };
CodigosRastreamento = NumerosRastreamentoAR.Split(splitchar);
for (count = 0; count <= CodigosRastreamento.Length - 1; count++)
{
Console.WriteLine(CodigosRastreamento[count]);
}
//REPLACE - etiqueta esta sendo retonada com espaços - DX4654654646 BR
NumeroRastreamento = CodigosRastreamento[0].Replace(" ", "");
Sigep dv = new Sigep();
EtiquetaLocalizaObjeto = dv.NumeroVerificador(NumeroRastreamento);
//Aqui faz inserção e tratamento SIGEP
IntegrationSigep SaveSigep = new IntegrationSigep();
SaveSigep.OrderNumber = NrPedido;
SaveSigep.TrackingTag = EtiquetaLocalizaObjeto;
SaveSigep.ServiceCode = ServiceCode;
con.IntegrationSigeps.InsertOnSubmit(SaveSigep);
con.SubmitChanges();
}
else { throw new Exception("Não foi possivel efetuar a solicitação"); }
return EtiquetaLocalizaObjeto;
}
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
12/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
// Esse número verificador poderá ser obtido também via Web Service no método
geraDigitoVerificadorEtiquetas
public String NumeroVerificador(string NumeroRastreamento)
{
try
{
if (nrEtiqueta != null) ;
string _NumeroRastreamento = NumeroRastreamento.Substring(2, 8);
string _Char = NumeroRastreamento.Substring(0, 2);
int[] intNumeros = { 8, 6, 4, 2, 3, 5, 9, 7 },
result = new int[10];
char[] NumeroRast = _NumeroRastreamento.ToArray();
//efetua soma do Localizador com Números Padrões
for (int x = 0; x < NumeroRast.Length; x++) result[x] = intNumeros[x] * Int16.Parse(NumeroRast[x].ToString());
int resto = (from p in result select p).Sum() % 11;
int dv = 2;//Caso DV não seja igual 0 ou 5 ele faz cálculo do digito verificador
if (resto == 0) { dv = 5; }
if (resto == 1) { dv = 0; }
if (dv != 5 & dv != 0) { dv = 11 - resto; }
FinalLocalizador = _Char + _NumeroRastreamento + dv + "BR";
}
catch (Exception)
{
return "Não foi possivel gerar digito verificador para código" + NumeroRastreamento;
}
return FinalLocalizador;
}
Obs.: Caso o algoritmo de cálculo do dígito verificador da etiqueta seja
implementado, sua lógica pode ser consultada no
Guia Técnico para Impressão de Etiquetas
.
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
13/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
XML:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:cli="http://cliente.bean.master.sigep.bsb.correios.com.br/">
<soapenv:Header/>
<soapenv:Body>
<cli:solicitaEtiquetas>
<tipoDestinatario>C</tipoDestinatario>
<identificador>00000000000104</identificador>
<idServico>104707</idServico>
<qtdEtiquetas>1</qtdEtiquetas>
<usuario>user</usuario>
<senha>senha</senha>
</cli:solicitaEtiquetas>
</soapenv:Body>
</soapenv:Envelope>
Método geraDigitoVerificadorEtiquetas()
Este método retorna o dígito verificador de uma etiqueta ou um array.
Assinatura do método:
geraDigitoVerificadorEtiquetas(etiqueta, usuario, senha)
Campo
Tipo
Descrição
etiqueta String Número retornado do método solicitaEtiquetas(),
vide descrição do método exemplo
solicitaEtiquetaPedido()
Poderá ser enviado individualmente ou um array.
Sim
usuario String Usuário autenticador. (Fornecido pelo
Representante Comercial dos Correios) Sim
senha String Senha de autenticação. (Fornecida pelo
Representante Comercial dos Correios) Sim
Retorno do método:
Campo
Tipo
return Int(digitoVerificador), Sendo um array o retorno será indexado na sequência
enviada.
Método fechaPlp()
Este método, assim como o próximo método a ser especificado, o
fechaPlpVariosServicos(), é responsável por enviar a lista contendo os objetos que serão
postados nos Correios. Esta lista é chamada de Pré-lista de Postagem PLP. Entretanto,
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
14/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
ao contrário do fechaPlpVariosServicos(), o método fechaPlp() só permite o envio de uma
lista com objetos que utilizem o mesmo serviço (ou SEDEX, ou PAC, etc). Os
códigos de objetos dentro da lista deverão estar seqüenciados dentro de um range de
números de objeto previamente obtido pelo método solicitaEtiquetas(). Preferencialmente,
essa PLP deverá ser
dispararada na finalização do processo de postagem do dia, contemplando
todos os objetos a serem expedidos. No entanto, é possível que seja fechada mais de uma PLP por
dia, caso haja esta necessidade dentro do processo do cliente. A seguir, informaremos o
detalhamento do método, um exemplo de codificação e o leiaute do xml que é enviado dentro do
método.
Assinatura do método:
fechaPlp(xml, idPlpCliente, cartaoPostagem, faixaEtiquetas, usuario, senha)
Campo
Tipo
Descrição
xml String PLP (pré-lista de postagem) serializada em XML Sim
idPlpCliente long Código identificador da lista que será retornado
pelos Correios. Deverá ser enviado em branco. o
cartaoPostagem String (10) Código que autoriza a postagem dos serviços no
contrato. Sim
faixaEtiquetas String Informar o range de etiquetas (número inicial e
número final) de postagem dos objetos contidos
no campo XML. Este método permite envio de
PLP contemplando somente um único tipo de
serviço (ou Sedex, ou PAC, etc), em que tenha
sido associada uma faixa sequenciada de
números de objeto.
Ex: DL20046776 BR, DL20046876 BR
Sim
usuario String Usuário autenticador. (Fornecido pelo
Representante Comercial dos Correios) Sim
senha String Senha de autenticação. (Fornecida pelo
Representante Comercial dos Correios) Sim
Retorno do método:
Campo
Tipo
return Long (idPlpCliente)
XML:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:cli="http://cliente.bean.master.sigep.bsb.correios.com.br/">
<soapenv:Header/>
<soapenv:Body>
<cli:fechaPlp>
<!--PLP (pré-lista de postagem) serializada em XML-->
<xml>?</xml>
<!--Código identificador da lista que será retornado pelos Correios. Deverá ser enviado em branco.-->
<idPlpCliente>?</idPlpCliente>
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
15/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
<!--Código que autoriza a postagem dos serviços no contrato.-->
<cartaoPostagem>?</cartaoPostagem>
<!-- Faixa de etiquetas de todos os códigos de objetos que estão contidos no campo XML sem o digito verifcador.-->
<faixaEtiquetas>?</faixaEtiquetas>
<usuario>user</usuario>
<senha>senha</senha>
</cli:fechaPlp>
</soapenv:Body>
</soapenv:Envelope>
Método fechaPlpVariosServicos()
Este método, assim como o método fechaPlp(), é responsável por enviar a lista
contendo os objetos que serão postados nos Correios. Esta lista é chamada de Pré-lista
de Postagem PLP. Entretanto, ao contrário do fechaPlp(), o método
fechaPlpVariosServicos() permite o envio de uma lista com vários objetos não
sequenciados, pois o campo listaEtiquetas é um array. Os números de objeto deverão ser
obtidos previamente pelo método solicitaEtiquetas(). Preferencialmente, essa PLP deverá
ser dispararada na finalização do processo de postagem do dia, contemplando todos os
objetos a serem expedidos. No entanto, é possível que seja fechada mais de uma PLP
por dia, caso haja esta necessidade dentro do processo do cliente. A seguir,
informaremos o detalhamento do método, um exemplo de codificação e o leiaute do xml
que é enviado dentro do método.
Assinatura do método:
fechaPlpVariosServicos(xml, idPlpCliente, cartaoPostagem, listaEtiquetas, usuario,
senha)
Campo
Tipo
Descrição
xml String PLP (pré-lista de postagem) serializada em XML Sim
idPlpCliente Long Código identificador da lista que será retornado pelos
Correios. Deverá ser enviado em branco. Não
cartaoPostagem String (10) Código que autoriza a postagem dos serviços no
contrato. Sim
listaEtiquetas List<String> Lista contendo todos os códigos de objetos que estão
contidos no campo XML sem o digito verifcador. EX:
{“20046776”, “20046877”, “20046878”}
Sim
usuario String Usuário autenticador. (Fornecido pelo Representante
Comercial dos Correios) Sim
senha String Senha de autenticação. (Fornecida pelo Representante
Comercial dos Correios) Sim
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
16/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
Retorno do método:
Campo
Tipo
return Long (idPlpCliente)
Exemplo de Codificação em C#
Exemplos de métodos necessários
para implementação do
fechaPLP
()
//Método Responsável Pelo Envio da PLP ao SIGEP
[WebMethod]
public XmlDocument EnviarPlp()
{
return getXmlPlp().xmldoc;
}
private GetXml getXmlPlp()
{
string file = @"../Schema/PedidoSigep.xml";
string cs = ConfigurationManager.ConnectionStrings["ConnectionString"].ConnectionString;
CommunityServiceSigepDataContext con = new CommunityServiceSigepDataContext(cs);
CorreiosLog CorreiosLogObj = new CorreiosLog();
GetXml retorno = new GetXml();
string CodigoServicoP = string.Empty;
Sigep CodigoCartaoPostagem = new Sigep();
try
{
CorreiosLogObj.tipoArquivo = "Postagem";
CorreiosLogObj.versaoArquivo = 2.3;
CorreiosLogObj.formaPagamento = string.Empty;
Plp Plp = new Plp();
Plp.idplp = string.Empty.TrimEnd();
Plp.valorglobal = string.Empty;
Plp.mcuunidadepostagem = string.Empty;
Plp.nomeunidadepostagem = string.Empty;
//Número cartão 10 caracteres
Plp.cartaopostagem = "0012345678";
CorreiosLogObj.plp = Plp;
Remetente Rmt = new Remetente();
Rmt.NumeroContrato = 9912212345;
Rmt.NumeroDiretoria = 36;
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
17/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
Rmt.CodigoAdministrativo = "01234567";
Rmt.NomeRemetente = "Nome Empresa";
Rmt.LogradouroRemetente = "RUA XX";
Rmt.NumeroRemetente = "151";
Rmt.ComplementoRemetente = string.Empty;
Rmt.BairroRemetente = "Centro";
Rmt.CepRemetente = 81000100;
Rmt.CidadeRemetente = "Cidade";
Rmt.UfRemetente = "UF";
Rmt.TelefoneRemetente = 554112345000;
Rmt.EmailRemetente = string.Empty;
CorreiosLogObj.remetente = Rmt;
//listaPostal
CorreiosLogObj.ListaObjetoPostal = new List<ObjetoPostal>();
CorreiosLogObj.ListaObjetoPostal.AddRange(
(from p in con.IntegrationOrders
join c in con.IntegrationPostLists on p.OrderNumber equals c.PurchOrderFormNum
join d in con.IntegrationPersons on p.PersonEntityCode equals
d.PersonEntityCode
join e in con.IntegrationSigeps on p.TrackingTag equals e.TrackingTag
select new ObjetoPostal()
{
NumeroEtiqueta = p.TrackingTag,
CodigoObjetoCliente = String.Empty,
CodigoServicoPostagem = e.ServiceCode,
Cubagem = "1,3021",
Peso = "1,520",
Rt1 = string.Empty,
Rt2 = string.Empty,
destinatario = (new Destinatario()
{
NomeDestinatario = d.PersonName,
TelefoneDestinatario = 4112340000,
CelularDestinatario = 4112340000,
EmailDestinatario = d.PersonEmail,
LogradouroDestinatario = p.DeliveryStreet,
ComplementoDestinatario = p.DeliveryComplement,
NumeroEndDestinatario = p.DeliveryNumber
}),
nacional = (new Nacional()
{
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
18/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
BairroDestinatario = p.DeliveryDistrictName,
CidadeDestinatario = p.DeliveryCityName,
UfDestinatario = p.DeliveryStateCode,
CepDestinatario = p.DeliveryZipCode,
CodigoUsuarioPostal = string.Empty,
CentroCustoCliente = string.Empty,
NumeroNotaFiscal = c.InvoiceId,
SerieNotaFiscal = c.InvoiceSeries,
ValorNotaFiscal = Convert.ToDecimal(c.InvoiceAmount),
NaturezaNotaFiscal = c.OperationName,
DescricaoObjeto = string.Empty,
ValorCobrar = "0,0",
}),
servico_adicional = string.Empty,
dimensao_objeto = (new DimensaoObjeto()
{
DimensaoAltura = "10,00", //Convert.ToInt64(p.DimensionHeight),
DimensaoLargura = "25,00",//Convert.ToInt64(p.DimensionLength),
DimensaoComprimento = "25,00",//Convert.ToInt64(p.DimensionWidth)
}),
DataPostagemSara = string.Empty,
StatusProcessamento = "0",
NumeroComprovantePostagem = string.Empty,
ValorCobrado = string.Empty
}).ToList());
}
catch (Exception ex)
{
throw new Exception(ex.Message);
}
try
{
Type t = typeof(CorreiosLog);
XmlSerializer serializer = new XmlSerializer(t);
FileStream stream = new FileStream(file, FileMode.Create);
serializer.Serialize(stream, CorreiosLogObj);
stream.Close();
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
19/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
StreamReader sr = new StreamReader(file);
PedidoSigep = sr.ReadToEnd();
PedidoSigep = PedidoSigep.Replace("xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"
xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"", "").Replace("version=\"1.0\"", "version=\"1.0\" encoding=\"iso-8859-1\"");
Sigep TagCode = new Sigep();
string[] ListaEtiquetas = TagCode.ObterListaEtiquetas();
AtendeClienteService Enviar = new AtendeClienteService();
long var1;
bool var2;
Enviar.fechaPlpVariosServicos(PedidoSigep, 2781, true, "0012345678", ListaEtiquetas, "usuario", "senha", out
var1, out var2);
retorno.NumberIdPlpReturn = var1.ToString();
sr.Close();
}
catch (Exception ex)
{
throw new Exception(ex.Message);
}
XmlDocument xmlDocument = new XmlDocument();
xmlDocument.LoadXml(PedidoSigep.ToString());
xmlDocument.Save(file);
retorno.xmldoc = xmlDocument;
return retorno;
}
Class CorreiosLog
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Xml.Serialization;
using System.Xml;
namespace Sigep.App_Code
{
[Serializable]
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
20/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
[XmlRoot("correioslog")]
public class CorreiosLog
{
//Serialize the object
[XmlElement(ElementName = "tipo_arquivo")]
public string tipoArquivo { get; set; }
[XmlElement(ElementName = "versao_arquivo")]
public Double versaoArquivo { get; set; }
[XmlElement(ElementName = "forma_pagamento")]
public String formaPagamento { get; set; }
public Plp plp { get; set; }
public Remetente remetente { get; set; }
[XmlElement(ElementName = "objeto_postal")]
public List<ObjetoPostal> ListaObjetoPostal { get; set; }
public ObjetoPostal objetoPostal { get; set; }
}
public class Plp
{
[XmlElement(ElementName = "id_plp")]
public string idplp { get; set; }
[XmlElement(ElementName = "valor_global")]
public string valorglobal { get; set; }
[XmlElement(ElementName = "mcu_unidade_postagem")]
public string mcuunidadepostagem { get; set; }
[XmlElement(ElementName = "nome_unidade_postagem")]
public string nomeunidadepostagem { get; set; }
[XmlElement(ElementName = "cartao_postagem")]
public String cartaopostagem { get; set; }
}
public class Remetente
{
[XmlElement(ElementName = "numero_contrato")]
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
21/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
public
Int64 NumeroContrato { get; set; }
[XmlElement(ElementName = "numero_diretoria")]
public Int64 NumeroDiretoria { get; set; }
[XmlElement(ElementName = "codigo_administrativo")]
public string CodigoAdministrativo { get; set; }
[XmlElement(ElementName = "nome_remetente")]
public string NomeRemetente { get; set; }
[XmlElement(ElementName = "logradouro_remetente")]
public string LogradouroRemetente { get; set; }
[XmlElement(ElementName = "numero_remetente")]
public string NumeroRemetente { get; set; }
[XmlElement(ElementName = "complemento_remetente")]
public string ComplementoRemetente { get; set; }
[XmlElement(ElementName = "bairro_remetente")]
public string BairroRemetente { get; set; }
[XmlElement(ElementName = "cep_remetente")]
public Int64 CepRemetente { get; set; }
[XmlElement(ElementName = "cidade_remetente")]
public string CidadeRemetente { get; set; }
[XmlElement(ElementName = "uf_remetente")]
public string UfRemetente { get; set; }
[XmlElement(ElementName = "telefone_remetente")]
public Int64 TelefoneRemetente { get; set; }
[XmlElement(ElementName = "fax_remetente")]
public Int64 FaxRemetente { get; set; }
[XmlElement(ElementName = "email_remetente")]
public string EmailRemetente { get; set; }
}
public class ObjetoPostal
{
[XmlElement(ElementName = "numero_etiqueta")]
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
22/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
public
string NumeroEtiqueta { get; set; }
[XmlElement(ElementName = "codigo_objeto_cliente")]
public string CodigoObjetoCliente { get; set; }
[XmlElement(ElementName = "codigo_servico_postagem")]
public string CodigoServicoPostagem { get; set; }
[XmlElement(ElementName = "cubagem")]
public String Cubagem { get; set; }
[XmlElement(ElementName = "peso")]
public String Peso { get; set; }
[XmlElement(ElementName = "rt1")]
public string Rt1 { get; set; }
[XmlElement(ElementName = "rt2")]
public string Rt2 { get; set; }
[XmlElement(ElementName = "data_postagem_sara")]
public string DataPostagemSara { get; set; }
[XmlElement(ElementName = "status_processamento")]
public string StatusProcessamento { get; set; }
[XmlElement(ElementName = "numero_comprovante_postagem")]
public string NumeroComprovantePostagem { get; set; }
[XmlElement(ElementName = "valor_cobrado")]
public string ValorCobrado { get; set; }
[XmlElement(ElementName = "destinatario")]
public Destinatario destinatario { get; set; }
[XmlElement(ElementName = "nacional")]
public Nacional nacional { get; set; }
[XmlElement(ElementName = "servico_adicional")]
public String servico_adicional { get; set; }
[XmlElement(ElementName = "dimensao_objeto")]
public DimensaoObjeto dimensao_objeto { get; set; }
}
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
23/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
public
class
Destinatario
{
[XmlElement(ElementName = "tipo_destinatario")]
public string tipoDestinatario { get; set; }
[XmlElement(ElementName = "nome_destinatario")]
public string NomeDestinatario { get; set; }
[XmlElement(ElementName = "telefone_destinatario")]
public Int64 TelefoneDestinatario { get; set; }
[XmlElement(ElementName = "celular_destinatario")]
public Int64 CelularDestinatario { get; set; }
[XmlElement(ElementName = "email_destinatario")]
public string EmailDestinatario { get; set; }
[XmlElement(ElementName = "logradouro_destinatario")]
public string LogradouroDestinatario { get; set; }
[XmlElement(ElementName = "complemento_destinatario")]
public string ComplementoDestinatario { get; set; }
[XmlElement(ElementName = "numero_end_destinatario")]
public string NumeroEndDestinatario { get; set; }
}
public class Nacional
{
[XmlElement(ElementName = "bairro_destinatario")]
public string BairroDestinatario { get; set; }
[XmlElement(ElementName = "cidade_destinatario")]
public string CidadeDestinatario { get; set; }
[XmlElement(ElementName = "uf_destinatario")]
public string UfDestinatario { get; set; }
[XmlElement(ElementName = "cep_destinatario")]
public string CepDestinatario { get; set; }
[XmlElement(ElementName = "codigo_usuario_postal")]
public string CodigoUsuarioPostal { get; set; }
[XmlElement(ElementName = "centro_custo_cliente")]
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
24/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
public
string CentroCustoCliente { get; set; }
[XmlElement(ElementName = "numero_nota_fiscal")]
public String NumeroNotaFiscal { get; set; }
[XmlElement(ElementName = "serie_nota_fiscal")]
public string SerieNotaFiscal { get; set; }
[XmlElement(ElementName = "valor_nota_fiscal")]
public Decimal ValorNotaFiscal { get; set; }
[XmlElement(ElementName = "natureza_nota_fiscal")]
public string NaturezaNotaFiscal { get; set; }
[XmlElement(ElementName = "descricao_objeto")]
public string DescricaoObjeto { get; set; }
[XmlElement(ElementName = "valor_a_cobrar")]
public string ValorCobrar { get; set; }
}
}
XML enviado no método fechaPlp() ou fechaPlpVariosServicos()
A seguir demonstramos o leiaute do XML utilizado no método fechaPlp() ou no
método fechaPlpVariosServicos() que deverá ser implementado no sistema do cliente e
que contém os dados essenciais para a geração da lista de objetos que serão postados
nos Correios:
<?xml version="1.0" encoding="ISO-8859-1" ?>
<correioslog>
<tipo_arquivo>Postagem</tipo_arquivo>
<versao_arquivo>2.3</versao_arquivo>
<plp>
<id_plp>406123</id_plp>
<valor_global />
<mcu_unidade_postagem/>
<nome_unidade_postagem/>
<cartao_postagem>0063512345</cartao_postagem>
</plp>
<remetente>
<numero_contrato>9912212345</numero_contrato>
<numero_diretoria>36</numero_diretoria>
<codigo_administrativo>12112345</codigo_administrativo>
<nome_remetente> <![CDATA[Com. Importação Ltda]]></nome_remetente>
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
25/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
<logradouro_remetente><![CDATA[Avenida Central]]></logradouro_remetente>
<numero_remetente><![CDATA[2370]]></numero_remetente>
<complemento_remetente><![CDATA[sala 1205,12° andar]]></complemento_remetente>
<bairro_remetente> <![CDATA[Centro]]></bairro_remetente>
<cep_remetente><![CDATA[81151234]]></cep_remetente>
<cidade_remetente><![CDATA[Curitiba]]></cidade_remetente>
<uf_remetente>PR</uf_remetente>
<telefone_remetente><![CDATA[4130712345]]></telefone_remetente>
<fax_remetente><![CDATA[]]></fax_remetente>
<email_remetente> <![CDATA[logistica@mail.com.br]]></email_remetente>
</remetente>
<forma_pagamento />
<objeto_postal>
<numero_etiqueta>PH185512345BR</numero_etiqueta>
<codigo_objeto_cliente/>
<codigo_servico_postagem>41068</codigo_servico_postagem>
<cubagem>0,00</cubagem>
<peso>200</peso>
<rt1/>
<rt2/>
<destinatario>
<nome_destinatario><![CDATA[Com Ltda]]></nome_destinatario>
<telefone_destinatario><![CDATA[6232312345]]> </telefone_destinatario>
<celular_destinatario><![CDATA[]]></celular_destinatario>
<email_destinatario><![CDATA[]]></email_destinatario>
<logradouro_destinatario><![CDATA[Avenida Central]]></logradouro_destinatario>
<complemento_destinatario><![CDATA[Qd: 102 A Lt: 04]]></complemento_destinatario>
<numero_end_destinatario><![CDATA[8065]]></numero_end_destinatario>
</destinatario>
<nacional>
<bairro_destinatario><![CDATA[Setor 1]]></bairro_destinatario>
<cidade_destinatario><![CDATA[Goiânia]]></cidade_destinatario>
<uf_destinatario>GO</uf_destinatario>
<cep_destinatario><![CDATA[74501234]]></cep_destinatario>
<codigo_usuario_postal/>
<centro_custo_cliente/>
<numero_nota_fiscal>102030</numero_nota_fiscal>
<serie_nota_fiscal/>
<valor_nota_fiscal/>
<natureza_nota_fiscal/>
<descricao_objeto><![CDATA[]]></descricao_objeto>
<valor_a_cobrar>0,0</valor_a_cobrar>
</nacional>
<servico_adicional>
<codigo_servico_adicional>025</codigo_servico_adicional>
<codigo_servico_adicional>001</codigo_servico_adicional>
<codigo_servico_adicional>019</codigo_servico_adicional>
<valor_declarado>99,00</valor_declarado>
</servico_adicional>
<dimensao_objeto>
<tipo_objeto>002</tipo_objeto>
<dimensao_altura>20</dimensao_altura>
<dimensao_largura>18</dimensao_largura>
<dimensao_comprimento>30</dimensao_comprimento>
<dimensao_diametro>0</dimensao_diametro>
</dimensao_objeto>
<data_postagem_sara/>
<status_processamento>0</status_processamento>
<numero_comprovante_postagem/>
<valor_cobrado/>
</objeto_postal>
</correioslog>
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
26/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
XML:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:cli="http://cliente.bean.master.sigep.bsb.correios.com.br/">
<soapenv:Header/>
<soapenv:Body>
<cli:fechaPlpVariosServicos>
<xml>?</xml>
<!--PLP (pré-lista de postagem) serializada em XML-->
<idPlpCliente>?</idPlpCliente>
<!--Código identificador da lista que será retornado pelos Correios. Deverá ser enviado em branco.-->
<cartaoPostagem>?</cartaoPostagem>
<!--Código que autoriza a postagem dos serviços no contrato.-->
<listaEtiquetas>?</listaEtiquetas>
<!--Lista contendo todos os códigos de objetos que estão contidos no campo XML sem o digito verifcador.-->
<usuario>user</usuario>
<senha>senha</senha>
</cli:fechaPlpVariosServicos>
</soapenv:Body>
</soapenv:Envelope>
Considerações importantes para a construção do XML:
1. O arquivo XSD que efetua a validação deste XML, consta como anexo ao
final deste documento.
2. Utilizar o <![CDATA[xxx...xxx]]> nos campos texto, para evitar problemas
com caracteres especiais que poderiam corromper o xml (&, %, etc).
3. Ao incluir o arquivo XML no método (fechaPlp ou fechaPlpVariosServicos),
excluir os terminadores de linha, para que o arquivo seja transportado de
forma linear.
4. Para enviar o XML no método fechaPlpVariosServicos ou fechaPlp, retirar o
dígito verificador do código da etiqueta. Sugestão: na chamado do método,
aplicar um string.Remove(12) (usado no Java), para que o caracter seja
removido da chamada, por exemplo, listaObjeto =
["PH088311022BR","DL285948221BR","PH088311019BR"]. Depois é
passar o objeto listaObjeto na própria chamada do método.
5. Os dados de contrato, código administrativo e cartão de postagem, devem
estar previamente cadastrados e dentro da vigência. É possível consultar o
status do cartão de postagem através do todo
getStatusCartãoPostagem(). Essa consulta é importante para evitar erros
ao disparar uma lista de postagem num cartão com data de vencimento
expirada.
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
27/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
6. O serviço postado deve estar associado ao cartão de postagem.
7. O número da etiqueta é obrigatório. Apenas objetos registrados podem ser
postados. Desta forma, o código adicional de número “25”, referente ao
serviço adicional “Registro”, deve sempre ser declarado na tag
<codigo_servico_adicional> para cada objeto postado.
8. As etiquetas utilizadas no arquivo devem pertencer ao cliente e a sigla deve
estar associada ao serviço a ser postado.
9. A tag <internacional> deve ser declarada em postagens de objetos
internacionais, caso contrário deve ser suprimida.
10. As demais tag’s não obrigatórias, caso não tenham conteúdo, devem ser
declaradas vazias.
11. Atualmente, apenas objetos nacionais podem ser postados via arquivo de
postagem.
12. Antes de iniciar o processo em produção, a implementação deverá ser
homologada pela ECT em conjunto com o representante comercial.
13. Qualquer dúvida sobre o layout do arquivo de postagem entrar em contato
com o representante comercial.
Especificação do Leiaute do XML
O leiaute é dividido nas seguintes tags:
<correioslog>
É a tag principal. Identifica o arquivo como pertencente ao sistema CorreiosLOG.
<tipo_arquivo>
Identifica qual o tipo do arquivo dentro do sistema CorreiosLOG. Permite a
distinção entre os diversos tipos de arquivos que o sistema CorreiosLOG processa. Para
este leiaute, deverá ser preenchido: Postagem
Observação: campo obrigatório
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
28/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
<versao_arquivo>
Identifica a versão do leiaute do arquivo XML. A versão deste leiaute é a: 2.3
Observação: campo obrigatório
Tag <plp>
Tags Descrição Tipo de dados Observações
<id_plp>
Identifica o registro da PLP no
SIGEP Master.
Numérico(10) Não obrigatório
<valor_global>
Valor em reais do total da
tarificação dos objetos da PLP.
Numérico(10,2) o obrigatório.
<mcu_unidade_postagem>
Identifica a unidade de postagem
no ERP dos Correios.
Caractere(12) Não obrigatório
<nome_unidade_postagem>
Nome da unidade de postagem
no ERP dos Correios.
Caractere(30) Não obrigatório
<cartao_postagem>
Numero do cartão do cliente
associado à PLP
Caractere(10) Obrigatório
Tag <remetente>
Identifica o remetente da postagem. Esta Tag deverá aparecer somente uma vez
no arquivo. Os dados necessários para o remetente são:
Tags Descrição Tipo de dados Observações
<numero_contrato>
Número do contrato do cliente Caractere(020) Obrigatório
Não pode existir o
caractere “-“ entre os
números.
<numero_diretoria>
Número da Diretoria Regional do
contrato do cliente.
Tabela de códigos em anexo.
Numerico(2) Obrigatório.
<codigo_administrativo>
Código administrativo do cliente Caractere(009) Obrigatório
Não pode existir o
caractere “-“ entre os
números.
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
29/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
<nome_remet
ente>
Nome do remetente Caractere(050) Obrigatório
<logradouro_remetente>
Logradouro do remetente Caractere(040) Obrigatório
<numero_remetente>
Parte do endereço Caractere(06) Obrigatório
<complemento_remetente>
Complemento do endereço Caractere(020) Não obrigatório
<bairro_remetente>
Bairro do remetente Caractere(020) Obrigatório
<cep_remetente>
CEP do remetente Numérico(8) Obrigatório
99999999
Não pode existir o
caractere “-“ entre os
números.
<cidade_remetente>
Cidade do remetente Caractere(030) Não obrigatório
(Será obrigatório
apenas para o serviço
40126)
<uf_remetente>
Unidade de Federação Caractere(002) Obrigatório
<telefone_remetente>
Telefone do remetente Numérico (012) Não obrigatório
99999999999
Não pode existir o
caractere “-“ entre os
números
<fax_remetente>
Fax do remetente Numérico (012) Não obrigatório
99999999999
Não pode existir o
caractere “-“ entre os
números
<email_remetente>
Email do remetente Caractere (050) Não obrigatório
Tag <forma_pagamento>
Valor numérico indicando a forma de pagamento utilizada pelo cliente para realizar
a postagem.
Observação: campo não obrigatório.
Tabela em anexo.
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
30/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
Tag <objeto_postal >
Tag delimitadora do objeto que será postado. Esta tag contém as características do
objeto postado.
Tags Descrição Tipo de dados Observações
<numero_etiqueta>
Número do Objeto na ECT Caractere(013) Obrigatório
<codigo_objeto_cliente>
Código do objeto no cliente Caractere(020) Não obrigatório
<codigo_servico_postagem>
Código do serviço da postagem:
digo
-
Serviço
81019 - E-sedex
41068 - Pac
40436 - Sedex
40096 - Sedex
40444 - Sedex
40215 - Sedex 10
Envelope
40886 - Sedex 10 Pacote
40878 - Sedex Hoje
10065 - Carta
Caractere(005) Obrigatório
<cubagem>
Cubagem do Objeto Numérico(9,4) Não obrigatório
<peso>
Peso do objeto (em gramas) Numérico(5) Obrigatório no
retorno do SARA.
<rt1>
Reservado para observação Caractere(255) Obrigatório
<rt2>
Reservado para observação Caractere(255) Obrigatório
+ <destinatario>
Dados do destinatário Obrigatório
+ <nacional>
Dados relevantes a postagem
nacional
Obrigatório para
objeto nacional
+ <internacional>
Dados relevantes a postagem
internacional
Obrigatório para
objeto
internacional. Para
os objetos
nacionais, esta tag
deverá ser
suprimida
+
<servico_adicional>
Identifica os serviços adicionais
do objeto postado
Obrigatório
+<dimensao_objeto>
Contém as dimensões do objeto
(altura, largura,comprimento e
diâmetro) e o tipo do objeto
(embalagem)
Obrigatório para os
serviços que
exigem
dimensões.
Atualmente 41068,
41017
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
31/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
<data_postagem_sara>
Contém a data de efetivação da
postagem pelo SARA.
Date(YYYYmmdd) Não obrigatório
<status_processamento>
Contém o STATUS do
processamento do objeto.
Caractere(20) Obrigatório.
Conterá o seguinte
Valor:
1 = Postado:
Objetos com a
postagem
confirmada;
<numero_comprovante_postagem>
Contém o numero de
comprovante de postagem.
Numérico(10) Não obrigatório.
<valor_cobrado>
Valor que foi tarifado no Sistema
de Atendimento da Agência dos
Correios.
Numérico(10,2) Não obrigatório.
Tag <destinatario>
Esta tag contém os dados do destino da encomenda.
Tags Descrição Tipo de dados Observações
<nome_destinatario>
Nome do destinatário Caractere(050) Obrigatório.
<telefone_destinatario >
Telefone do Destinatário Numérico (012) Não Obrigatório.
99999999999
Não pode existir o
caractere “-“ entre os
números
<celular_destinatario>
Celular do Destinatário Numérico (012) Não Obrigatório.
99999999999
Não pode existir o
caractere “-“ entre os
números
<email_destinata
rio>
Email do Destinatário Caractere(050) Não obrigatório
<logradouro_destinatario>
Logradouro do destinatário Caractere(050) Obrigatório.
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
32/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
<complemento_destinatario>
Complemento do endereço Caractere(030) Não obrigatório.
<numero_end_destinatario>
Parte do endereço Caractere(06) Obrigatório.
Tag <nacional>
A tag <nacional> deverá estar dentro da tag <objeto_postal> e conterá os atributos
específicos de uma postagem de objetos nacionais.
Tags Descrição Tipo de dados Observações
<bairro_destinatario>
Bairro do destinatário Caractere(030) Obrigatório.
<cidade_destinatario>
Cidade do destinatário Caractere(030) Obrigatório.
<uf_destinatario>
Sigla da UF do destinatário Caractere(002) Obrigatório
<cep_destinatario>
CEP do destinatário Numérico(8) Obrigatório 99999999
Não pode existir o caractere “-“
entre os números.
<codigo_usuario_postal>
Código do usuário postal Caractere(020) Não obrigatório
<centro_custo_cliente>
Centro de custo do cliente Caractere(020) Não obrigatório
<numero_nota_fiscal>
Número da nota fiscal Numérico(9) Opcional.
<serie_nota_fiscal>
Série da nota fiscal Caractere(020) Não obrigatório
<valor_nota_fiscal>
Valor da nota fiscal Numérico(9,2) Não obrigatório
<natureza_nota_fiscal>
Natureza da nota fiscal Caractere(020) Não obrigatório
<descricao_objeto>
Descrição do objeto Caractere(020) Não obrigatório
<valor a cobrar >
Valor a cobrar do destinatário Numérico(9,2) Obrigatório para o serviço
40126
Tag <internacional>
A tag <internacional> deverá estar dentro da tag <objeto_postal> e conterá os
atributos específicos de uma postagem de objetos internacionais. Esta tag somente deve
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
33/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
estar presente para objeto internacional.
Tags Descrição Tipo de dados Observações
<city_destinatario>
Cidade do destinatário Caractere(030) Obrigatório
<post_code_destinatario>
CEP do destinatário Caractere(015) o obrigatório
<nome_pais_destinatario>
País do destinatário Caractere(030) Não obrigatório
<codigo_pais_bandeira_destino>
Código do país bandeira
do destino da postagem
Numérico(4) Obrigatório
TABELA EM ANEXO
<prazo_exportacao_temporaria>
Prazo de exportação
temporária
Numérico(3) Não obrigatório
<codigo_tipo_exportador>
Código do tipo de
exportador
Numérico(2) Não obrigatório
TABELA EM ANEXO
<codigo_natureza_operacao>
Código da natureza da
operação
Numérico(2) Não obrigatório
TABELA EM ANEXO
<codigo_porte_empresa>
Código do porte da
empresa
Numérico(2) Não obrigatório
TABELA EM ANEXO
<caso_nao_entrega>
Armazena o que deve
ser feito, em caso de
não entrega do objeto.
Numérico(1) Obrigatório
0: Devolver ao remetente
1: Tratar como abandonado
<emitir_numero_dse>
Indica se a DSE será
emitida ou não pela
ECT
Numérico(1) Não obrigatório
0: Emissão pela ECT
1: DSE informada pelo
cliente
<numero_dse>
Número da DSE Caractere (011) Não obrigatório
+ <item_alfandega>
Informações para
alfândega
Tag < item_alfandega>
Esta tag deverá estar dentro da tag <internacional> e conterá os atributos
específicos para Alfândega.
Tags Descrição Tipo de dados Observações
<codigo_ncm>
Código do item, segundo
NCM
Caractere(20) o obrigatório
<quantidade_item>
Quantidade de itens Numérico(5) Não obrigatório
<descricao_item>
Descrição do item Caractere(020) Não obrigatório
<codigo_unidade_comercializacao>
Refere-se a unidade de
medida
Numérico(5) Obrigatório
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
34/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
<peso_liquido_item>
Peso liquido do item (em
gramas)
Numérico(5) Não obrigatório
<peso_bruto_item>
Peso bruto do item (em
gramas)
Numérico(5) Não obrigatório
<valor_item_real>
Valor do item em Real Numérico(9,2) Não obrigatório
<valo
r_item_dolar>
Valor do item em Dólar Numérico(9,2) Não obrigatório
<codigo_moeda_negociacao>
Código da moeda de
negociação
Numérico(5) Não obrigatório
TABELA EM ANEXO
Tag <servico_adicional>
A tag <servico_adicional> deverá estar dentro da tag <objeto_postal> e conterá os
seguintes atributos:
Tags Descrição Tipo de dados Observações
<codigo_servico_adicional>
Código do serviço adicional Caractere (002) Obrigatório.
O serviço adicional “25”,
referente ao registro, deve
sempre ser declarado.
Casos os serviços postados
pelo cliente possuam outros
serviços adicionais, estes
devem ser declarados .
TABELA EM ANEXO
<valor_declarado>
Valor declarado do serviço
adicional
Numérico (9,2) Se o código do serviço
adicional for igual a 19 o
campo é obrigatório, caso
contrário esta Tag deverá ser
suprimida
<data_agendamento>
Data do agendamento, quando o
serviço adicional for e-Sedex
Date Se o código do serviço
adicional for igual a 36 o
campo é obrigatório, caso
contrário esta tag deverá ser
suprimida.
Tag <dimensão_objeto>
A tag <dimensao_objeto> deverá estar dentro da tag <objeto_postal> e conterá os
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
35/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
seguintes atributos:
tags
D
escrição
Tipo de dados
observação
<tipo_objeto>
Contém o código do tipo de objeto
que foi postado (embalagem)
001 - Envelope
002 - Pacote / Caixa
003 - Rolo / Cilindro
Numérico (3) Obrigatório.
Obs:
001 – Não informa dimensão
002 – Informa: Altura, largura
e comprimento
003 Informa:
comprimento_diametro
<dimensao_altura>
Altura do objeto (em cm/mm) Numérico (5,1) Não obrigatório.
<dimensao_largura>
Largura do objeto (em cm/mm) Numérico (5,1) Não obrigatório.
<dimensao_comprimento>
Comprimento do objeto (em
cm/mm)
Numérico (5,1) Não obrigatório.
<dimensao_diametro>
Diâmetro do objeto (em cm/mm) Numérico (5,1) Não obrigatório.
Método buscaContrato()
Esse método é responsável por retornar os serviços vinculados ao contrato do
cliente.
Assinatura do método:
buscaContrato(numero, diretoria, usuario, senha)
Campo
Tipo
Descrição
numero String(10) Número do contrato do Cliente com a ECT. Sim
diretoria String (2) Número da Diretoria Regional do contrato do
cliente. Tabela em anexo. Sim
usuario String Usuário autenticador. (Fornecido pelo
Representante Comercial dos Correios) Sim
senha String Senha de autenticação. (Fornecida pelo
Representante Comercial dos Correios) Sim
Retorno do método:
Campo
Tipo
return contratoERP (String)
XML:
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
36/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:cli="http://cliente.bean.master.sigep.bsb.correios.com.br/">
<soapenv:Header/>
<soapenv:Body>
<cli:buscaContrato>
<numero>?</numero>
<diretoria>?</diretoria>
<usuario>?</usuario>
<senha>?</senha>
</cli:buscaContrato>
</soapenv:Body>
</soapenv:Envelope>
Método getStatusCartaoPostagem()
Esse método é responsável por retornar o status do cartão de postagem do cliente.
Assinatura do método:
getStatusCartaoPostagem (numeroCartaoPostagem, usuario, senha)
Campo
Tipo
Descrição
numeroCartaoPostagem String(9) Número do cartão de postagem. Sim
usuario String Usuário autenticador. (Fornecido pelo
Representante Comercial dos Correios) Sim
senha String Senha de autenticação. (Fornecida pelo
Representante Comercial dos Correios) Sim
Retorno do método:
Campo
Tipo
return statusCartao
XML:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:cli="http://cliente.bean.master.sigep.bsb.correios.com.br/">
<soapenv:Header/>
<soapenv:Body>
<cli:getStatusCartaoPostagem>
<numeroCartaoPostagem>?</numeroCartaoPostagem>
<usuario>?</usuario>
<senha>?</senha>
</cli:getStatusCartaoPostagem>
</soapenv:Body>
</soapenv:Envelope>
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
37/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
Web Service de Logística Reversa
Esse Web Service é especifico para Logística Reversa que possui métodos
necessários para integração entre o sistema proprietário e os Correios.
Interface do Web Service de Logística Reversa
A interface do Web Service de Logística Reversa poderá ser consultada e
configurada no ambiente de desenvolvimento (sistema proprietário) no seguinte endereço:
http://webservicescol.correios.com.br/ScolWeb/WebServiceScol?wsdl
Métodos do Web Service Logística Reversa
Método solicitarPostagemReversa()
Esse método será responsável por solicitar pedidos de coleta e autorização de
postagem para o serviço de logística reversa.
XML :
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.scol.correios.com.br/">
<soapenv:Header/>
<soapenv:Body>
<web:solicitarPostagemReversa>
<usuario>user</usuario>
<senha>senha</senha>
<codAdministrativo>00000000</codAdministrativo>
<!-- id_postagem deverá ser único para cada evento de solicitarPostagemReversa -->
<id_postagem>1000</id_postagem>
<contrato>0000000000</contrato>
<codigo_servico>40517</codigo_servico>
<cartao>0000000000</cartao>
<destinatario>
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
38/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
<bairro>Centro</bairro>
<cep>81350120</cep>
<cidade>Curitiba</cidade>
<complemento></complemento>
<ddd></ddd>
<email>email@gmail.com</email>
<logradouro>Rua central</logradouro>
<nome>Fulano</nome>
<numero>10</numero>
<referencia></referencia>
<telefone>33101233</telefone>
<uf>PR</uf>
</destinatario>
<coletas_solicitadas>
<!-- 1:Solicitação de Checklist Celular 4: Solicitação de Checklist Eletrônico-->
<cklist>2</cklist>
<descricao></descricao>
<!-- Controle do cliente que obterá no retorno do xml da solicitação -->
<id_cliente>102030</id_cliente>
<numero></numero>
<produto>
<codigo></codigo>
<qtd></qtd>
<tipo></tipo>
</produto>
<remetente>
<bairro>Centro</bairro>
<cep>80002900</cep>
<cidade>Curitiba</cidade>
<complemento></complemento>
<ddd>41</ddd>
<email>cli@gmail.com</email>
<logradouro>Rua central</logradouro>
<nome>Ciclano</nome>
<numero>10</numero>
<referencia></referencia>
<telefone>33101233</telefone>
<uf>PR</uf>
<identificacao></identificacao>
</remetente>
<!-- C - Coleta / A - Autorização Postagem -->
<tipo>A</tipo>
<valor_declarado></valor_declarado>
<ag></ag>
<ar></ar>
<cartao></cartao>
<obj_col>
<desc></desc>
<entrega></entrega>
<!-- Código que será impresso no rótulo pela unidade -->
<id></id>
<!-- Valor Fixo = 1 -->
<item>1</item>
<num></num>
</obj_col>
<servico_adicional></servico_adicional>
</coletas_solicitadas>
</web:solicitarPostagemReversa>
</soapenv:Body>
</soapenv:Envelope>
Descrição das Tags do Cabeçalho
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
39/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
Sub-tags de <coleta> Descrição / Observações Tipo Dados Obrigatório
<tipo> Indica se a solicitação é de coleta domiciliária e/ou
uma autorização de postagem.
CA = Coleta domiciliar. Caso não exista coleta
domiciliar na localidade o sistema transforma
automaticamente o pedido em uma autorização de
postagem.
C = Coleta domiciliária. Caso não exista a coleta no
local indicado, o sistema ignora a solicitação
A = Autorização de Postagem
Caso nenhum valor seja passado nessa tag, o
sistema entende que é uma solicitação de coleta
domiciliária.
Caractere(002) Sim
<numero> Número da Autorização de Postagem. Usado quando
o cliente possui uma faixa numérica desse tipo de
solicitação. Esse número se encaminhado no
arquivo de retorno.
Numérico (009) Não
<id_cliente> Campo para preenchimento livre. É um valor para
identificação da solicitação junto ao cliente. Este valor
é enviado no arquivo de retorno do gerado após o
processamento.
Caractere (30) Não
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
40/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
<ag> Coleta domiciliar: Data para agendamento da coleta.
Se informado o pedido fica retido no sistema e a
primeira tentativa de coleta é feita apenas na data
informada.
O sistema aceita apenas datas com mais de cinco
dias corridos a partir da data de processamento do
pedido.
Autorização de Postagem: Indica a quantidade de
dias de validade da autorização.
A validade deve ser de no mínimo 5 e no máximo 30
dias. Se não for informada, a validade da autorização
será de 10 (dez) dias corridos a partir da data do
processamento do pedido.
Data
DD/MM/YYYY
Numérico(002)
Entre 5 e 30 dias.
Não
<cartao> Número do cartão de postagem para ser usado no
faturamento dos valores do serviço realizado.
Numérico(011) Sim
<valor_declarado> Somatório de todos os valores declarados dos objetos
da coleta. Exemplo: 520.70
Numérico(9.2) Não
<servico_adicional> Códigos de serviços adicionais separados por vírgula.
Caractere(20) Não
<descricao> Descrição / instruções para coleta.
Caractere(255) Não
<ar> Indica se é para solicitar Aviso de Recebimento para
as encomendas cadastradas. Usado apenas para
pedidos de Autorização de Postagem.
Booleano
Colocar 1 ou 0
Não
<cklist> Indica que serão impressas vias de checklist. Apenas
clientes previamente habilitados podem utilizar essa
opção. Código fornecido pela ECT.
Valor fixo
Não
Tag <remetente> Sub-tags que armazenam dados do remetente da
coleta ou autorização de postagem.
-
Sim
+ <nome> Nome do remetente
Caractere(060) Sim
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
41/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
+ <logradouro> Logradouro do remetente
Caractere(072) Sim
+ <numero> Número do endereço do remetente. Caso não
possua, preencher com “S/N”
Caractere(008) Sim
+ <complemento> Complemento do endereço
Caractere(30) Não
+ <bairro> Bairro do remetente
Caractere(80) Não
+ <cidade> Cidade do remetente
Caractere(40) Sim
+ <uf> UF do remetente
Caractere(02) Sim
+ <cep> Cep do remetente sempre com 8 posições.
Exemplo 01200999.
Caractere(08) Sim
+ <referencia> Uma referência do endereço do remetente
Caractere(60) Não
+ <ddd> digo do DDD do remetente
Caractere(3) Não
+ <telefone> Número do telefone do remetente. Este campo não é
obrigatório mas é importante para que a ECT entre em
contato com o remetente em casos de insucesso na
coleta.
Caractere(18) Não
+ <email> E-mail do remetente. Caso seja preenchido o
remetente receberá um e-mail informando sobre a
coleta ou a autorização de postagem.
Caractere(72) Não
Tag <obj_col> Contém os blocos de tags que cadastram os
objetos que serão coletados (coleta domiciliar) ou
postados (autorização de postagem).
Vide observações no item “4.b”.
-
Sim
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
42/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
+ <obj> Cada objeto cadastrado é caracterizado por um bloco
que se inicia nesta tag. Vide leiaute no item “2 -
Demonstração das tags do arquivo XML”. Caso esta
tag o seja encontrada o sistema assume que existe
apenas um objeto a ser coletado ou postado.
Sub-tags Sim
+ + <item> Tag obrigatória. Apenas confirma o cadastro do
objeto dentro da solicitação.
Valor fixo
“1”
Sim
+ + <id> Campo para preenchimento livre. É um valor para
identificação do objeto junto ao cliente. Este valor é
enviado no arquivo de retorno do gerado após o
processamento. Exemplo: Número da nota fiscal. Essa
informação será impressa no rótulo de postagem na
agência dos Correios.
Caractere(30) Não
+ + <desc> Descrição do objeto que será coletado
Caractere(255) Não
+ + <entrega> Número do objeto para os pedidos de coleta
simultânea. O contrato deve aceitar pedidos de coleta
simultânea.
Caractere(13) Não
+ + <num> Número do objeto quando existe uma faixa numérica
reservada para o cliente. Esta opção ainda não é
utilizada.
Caractere(13) Não
Tag <produto> Contém os blocos de tags que são utilizadas para
solicitação de produtos junto com a coleta. O
contrato do cliente deve ser habilitado previamente
para usar essa tag.
-
Não
+ <desc> Cada tipo de produto a ser solicitado é caracterizado
por um bloco que se inicia nesta tag. Vide leiaute no
item “2 - Demonstração das tags do arquivo XML”. É
obrigatório caso o produto seja solicitado para esta
coleta.
Sub-tags -
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
43/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
+ + <codigo> Código do produto. Fornecido pela ECT
Numérico -
+ + <tipo> Código do tipo de produto. Fornecido pela ECT
Numérico -
+ + <qtd> Quantidade de produtos do tipo fornecido.
Numérico -
Observações Importantes Sobre a Implementação de Logística Reversa
a) Valor Declarado: Caso seja informado, assegura ao cliente o ressarcimento do
valor declarado da mercadoria mais os preços postais pagos, nos casos de
extravio ou danos à encomenda, mediante o pagamento de taxa de Seguro
Complementar sobre o valor que exceder o valor do seguro automático.
Tags:
<valor_declarado>: Quando essa tag é preenchida o valor declarado
informado é dividido entre todos os objetos da solicitação.
Caso a tag <vr_dec> do bloco de declaração do objeto seja preenchido, o
valor informado passa a ser o valor declarado do objeto.
b) Cadastro dos Objetos (tag <obj_col>): É muito importante que os objetos que
serão coletados ou postados sejam bem discriminados.
Exemplo de utilização dessa tag em uma solicitação que possui dois objetos:
<obj_col>
<obj>
<item>1</item>
<id>OS10001</id>
<desc>UM DVD PLAYER</desc>
<entrega><!-- APENAS PARA PEDIDOS DE COLETA SIMULTÂNEA--
></entrega>
<num><!-- TAG AINDA NÃO UTILIZADA--></num>
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
44/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
</obj>
<obj>
<item>1</item>
<id>OS10002</id>
<desc>UM DVD MUSICAL</desc>
<entrega><!-- APENAS PARA PEDIDOS DE COLETA SIMULTÂNEA--
></entrega>
<num><!-- TAG AINDA NÃO UTILIZADA--></num>
</obj>
<obj_col>
Caso a tag <id> não seja utilizada, o sistema pega o valor da tag <id_cliente>.
Havendo divergência entre a quantidade de objetos informada na solicitação
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:
São coletados todos os objetos e cancelados os demais no sistema.
II) Quantidade de objetos cadastrados MENOR que a quantidade real:
É coletada a quantidade de objetos informada, deixando no local da coleta
os demais.
Método acompanharPedido()
Com esse método poderá acompanhar a postagem da autoriação ou e-ticket
disponibilizado ao cliente.
Se houve o evento postagem, o retorno será o número do objeto (registro) nos
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
45/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
Correios. Através desse número poderá efetuar o rastreamento acompanhando a sua
chegada ou entrega no destino.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.scol.correios.com.br/">
<soapenv:Header/>
<soapenv:Body>
<web:acompanharPedido>
<usuario>user</usuario>
<senha>senha</senha>
<codAdministrativo>00000000</codAdministrativo>
<!-- U último / H - tudo -->
<tipoBusca>U</tipoBusca>
<!-- L - Logistica / A - Autorização Postagem -->
<tipoSolicitacao>A</tipoSolicitacao>
<numeroPedido>30000000</numeroPedido>
</web:acompanharPedido>
</soapenv:Body>
</soapenv:Envelope>
Método cancelarPedido()
Com esse método poderá cancelar uma autoriação de postagem ou e-ticket
disponibilizado ao cliente.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.scol.correios.com.br/">
<soapenv:Header/>
<soapenv:Body>
<web:cancelarPedido>
<usuario>user</usuario>
<senha>senha</senha>
<codAdministrativo>00000000</codAdministrativo>
<numeroPedido>300000000</numeroPedido>
<tipo>A</tipo>
</web:cancelarPedido>
</soapenv:Body>
</soapenv:Envelope>
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
46/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
Confecção de Etiquetas e Relatórios para Impressão
Será necessário implementar a impressão de alguns relatórios conforme segue
abaixo:
Lista de postagem:
Relatório que contêm todos os objetos da PLP xml transmitida aos Correios,
devendo uma via acompanhar a carga física. Exemplo:
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
47/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
48/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
Rótulo de Postagem (Etiqueta):
É a etiqueta que contêm todas as informações do objeto, remetente e destinatário e
que deverá ser afixada no próprio objeto. Esse padrão se faz necessário para a triagem
automatizada na ECT. A documentação de referência pode ser obtida
http://www.correios.com.br/voce/enderecamento/enderecamentoEncomendas.cfm,
baixando o Guia Técnico para Impressão de Etiquetas.
http://www.correios.com.br/voce/enderecamento/Arquivos/guia_tecnico_encomendas.pdf
Exemplo (numa folha A4):
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
49/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
50/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
Chancelas:
São elementos gráficos dos rótulos de postagem que identificam o tipo de serviço
que está sendo utilizado na encomenda e contêm o nome do serviço e a marca Correios.
São de uso obrigatório a serem implementadas nos rótulos de postagem. Poderão ser
obtidas por meio do Consultor Comercial informando os serviços que serão utilizados.
Alguns dos modelos estão em anexo.
Aviso de Recebimento (AR):
Serviço adicional que lhe permite ter em o o comprovante escrito com a
assinatura de destinatário. O padrão do leiaute a ser desenvolvido pode ser obtido nesse
link: http://www.correios.com.br/voce/enderecamento/enderecamentoEncomendas.cfm.
Exemplo (numa folha A4):
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
51/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
52/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
Anexos
Leiaute do arquivo XSD – WS Sigep
A seguir demonstramos o leiaute do arquivo XSD utilizado para validação do XML
que é enviado nos métodos fechaPlp() e fechaPlpVariosServicos(). Essa validação do xml
poderá ser efetuada localmente, já validando o arquivo xml.
<?xml version="1.0" encoding="UTF-8"?>
<!-- edited with XMLSpy v2012 rel. 2 (x64) (http://www.altova.com) by rogerio maia (correios) -->
<!--W3C Schema generated by XMLSpy v2012 rel. 2 (x64) (http://www.altova.com)-->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
<xs:element name="versao_arquivo">
<xs:simpleType>
<xs:restriction base="xs:decimal">
<xs:enumeration value="2.3"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="valor_nota_fiscal" type="xs:string"/>
<xs:element name="valor_global" type="xs:string"/>
<xs:element name="valor_declarado">
<xs:simpleType>
<xs:restriction base="xs:string"/>
</xs:simpleType>
</xs:element>
<xs:element name="valor_cobrado" type="xs:string"/>
<xs:element name="valor_a_cobrar">
<xs:simpleType>
<xs:restriction base="xs:string"/>
</xs:simpleType>
</xs:element>
<xs:element name="uf_remetente">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="2"/>
<xs:enumeration value="AC"/>
<xs:enumeration value="AL"/>
<xs:enumeration value="AP"/>
<xs:enumeration value="AM"/>
<xs:enumeration value="BA"/>
<xs:enumeration value="CE"/>
<xs:enumeration value="DF"/>
<xs:enumeration value="ES"/>
<xs:enumeration value="GO"/>
<xs:enumeration value="MA"/>
<xs:enumeration value="MT"/>
<xs:enumeration value="MS"/>
<xs:enumeration value="MG"/>
<xs:enumeration value="PA"/>
<xs:enumeration value="PB"/>
<xs:enumeration value="PR"/>
<xs:enumeration value="PE"/>
<xs:enumeration value="PI"/>
<xs:enumeration value="RJ"/>
<xs:enumeration value="RN"/>
<xs:enumeration value="RS"/>
<xs:enumeration value="RO"/>
<xs:enumeration value="RR"/>
<xs:enumeration value="SC"/>
<xs:enumeration value="SP"/>
<xs:enumeration value="SE"/>
<xs:enumeration value="TO"/>
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
53/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="uf_destinatario">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="2"/>
<xs:enumeration value="AC"/>
<xs:enumeration value="AL"/>
<xs:enumeration value="AP"/>
<xs:enumeration value="AM"/>
<xs:enumeration value="BA"/>
<xs:enumeration value="CE"/>
<xs:enumeration value="DF"/>
<xs:enumeration value="ES"/>
<xs:enumeration value="GO"/>
<xs:enumeration value="MA"/>
<xs:enumeration value="MT"/>
<xs:enumeration value="MS"/>
<xs:enumeration value="MG"/>
<xs:enumeration value="PA"/>
<xs:enumeration value="PB"/>
<xs:enumeration value="PR"/>
<xs:enumeration value="PE"/>
<xs:enumeration value="PI"/>
<xs:enumeration value="RJ"/>
<xs:enumeration value="RN"/>
<xs:enumeration value="RS"/>
<xs:enumeration value="RO"/>
<xs:enumeration value="RR"/>
<xs:enumeration value="SC"/>
<xs:enumeration value="SP"/>
<xs:enumeration value="SE"/>
<xs:enumeration value="TO"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="tipo_arquivo">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="Postagem"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="telefone_remetente">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="20"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="telefone_destinatario">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="24"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="status_processamento">
<xs:simpleType>
<xs:restriction base="xs:byte">
<xs:enumeration value="0"/>
<xs:enumeration value="1"/>
<xs:enumeration value="2"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
54/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
<xs:element name="servico_adicional">
<xs:complexType>
<xs:sequence>
<xs:element ref="codigo_servico_adicional" maxOccurs="4"/>
<xs:element ref="valor_declarado"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="serie_nota_fiscal">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="20"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="rt2">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="255"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="rt1">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="255"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="remetente">
<xs:complexType>
<xs:sequence>
<xs:element ref="numero_contrato"/>
<xs:element ref="numero_diretoria"/>
<xs:element ref="codigo_administrativo"/>
<xs:element ref="nome_remetente"/>
<xs:element ref="logradouro_remetente"/>
<xs:element ref="numero_remetente"/>
<xs:element ref="complemento_remetente"/>
<xs:element ref="bairro_remetente"/>
<xs:element ref="cep_remetente"/>
<xs:element ref="cidade_remetente"/>
<xs:element ref="uf_remetente"/>
<xs:element ref="telefone_remetente"/>
<xs:element ref="fax_remetente"/>
<xs:element ref="email_remetente"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="plp">
<xs:complexType>
<xs:sequence>
<xs:element ref="id_plp"/>
<xs:element ref="valor_global"/>
<xs:element ref="mcu_unidade_postagem"/>
<xs:element ref="nome_unidade_postagem"/>
<xs:element ref="cartao_postagem"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="peso">
<xs:simpleType>
<xs:restriction base="xs:integer">
<xs:maxInclusive value="30000"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
55/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
<xs:element name="objeto_postal">
<xs:complexType>
<xs:sequence>
<xs:element ref="numero_etiqueta"/>
<xs:element ref="codigo_objeto_cliente"/>
<xs:element ref="codigo_servico_postagem"/>
<xs:element ref="cubagem"/>
<xs:element ref="peso"/>
<xs:element ref="rt1"/>
<xs:element ref="rt2"/>
<xs:element ref="destinatario"/>
<xs:element ref="nacional"/>
<xs:element ref="servico_adicional"/>
<xs:element ref="dimensao_objeto"/>
<xs:element ref="data_postagem_sara"/>
<xs:element ref="status_processamento"/>
<xs:element ref="numero_comprovante_postagem"/>
<xs:element ref="valor_cobrado"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="numero_remetente">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="18"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="numero_nota_fiscal">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="9"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="numero_etiqueta">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="13"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="numero_end_destinatario">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="18"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="numero_diretoria">
<xs:simpleType>
<xs:restriction base="xs:byte">
<xs:enumeration value="75"/>
<xs:enumeration value="72"/>
<xs:enumeration value="74"/>
<xs:enumeration value="70"/>
<xs:enumeration value="68"/>
<xs:enumeration value="64"/>
<xs:enumeration value="65"/>
<xs:enumeration value="26"/>
<xs:enumeration value="60"/>
<xs:enumeration value="50"/>
<xs:enumeration value="36"/>
<xs:enumeration value="34"/>
<xs:enumeration value="32"/>
<xs:enumeration value="30"/>
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
56/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
<xs:enumeration value="28"/>
<xs:enumeration value="24"/>
<xs:enumeration value="22"/>
<xs:enumeration value="20"/>
<xs:enumeration value="18"/>
<xs:enumeration value="16"/>
<xs:enumeration value="14"/>
<xs:enumeration value="12"/>
<xs:enumeration value="10"/>
<xs:enumeration value="08"/>
<xs:enumeration value="05"/>
<xs:enumeration value="06"/>
<xs:enumeration value="04"/>
<xs:enumeration value="03"/>
<xs:enumeration value="01"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="numero_contrato">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="20"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="numero_comprovante_postagem" type="xs:string"/>
<xs:element name="nome_unidade_postagem">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="30"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="nome_remetente">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="nome_destinatario">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="natureza_nota_fiscal">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="20"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="nacional">
<xs:complexType>
<xs:sequence>
<xs:element ref="bairro_destinatario"/>
<xs:element ref="cidade_destinatario"/>
<xs:element ref="uf_destinatario"/>
<xs:element ref="cep_destinatario"/>
<xs:element ref="codigo_usuario_postal"/>
<xs:element ref="centro_custo_cliente"/>
<xs:element ref="numero_nota_fiscal"/>
<xs:element ref="serie_nota_fiscal"/>
<xs:element ref="valor_nota_fiscal"/>
<xs:element ref="natureza_nota_fiscal"/>
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
57/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
<xs:element ref="descricao_objeto"/>
<xs:element ref="valor_a_cobrar"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="mcu_unidade_postagem">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="8"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="logradouro_remetente">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="logradouro_destinatario">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="id_plp">
<xs:simpleType>
<xs:restriction base="xs:int"/>
</xs:simpleType>
</xs:element>
<xs:element name="forma_pagamento">
<xs:simpleType>
<xs:restriction base="xs:string">
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="fax_remetente">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="12"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="email_remetente">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="email_destinatario">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="dimensao_objeto">
<xs:complexType>
<xs:sequence>
<xs:element name="tipo_objeto">
<xs:simpleType>
<xs:restriction base="xs:short">
<xs:enumeration value="001"/>
<xs:enumeration value="002"/>
<xs:enumeration value="003"/>
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
58/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element ref="dimensao_altura"/>
<xs:element ref="dimensao_largura"/>
<xs:element ref="dimensao_comprimento"/>
<xs:element ref="dimensao_diametro"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="dimensao_altura">
<xs:simpleType>
<xs:restriction base="xs:int">
<xs:minInclusive value="0"/>
<xs:maxInclusive value="105"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="dimensao_largura">
<xs:simpleType>
<xs:restriction base="xs:int">
<xs:minInclusive value="0"/>
<xs:maxInclusive value="105"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="dimensao_comprimento">
<xs:simpleType>
<xs:restriction base="xs:int">
<xs:minInclusive value="0"/>
<xs:maxInclusive value="105"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="dimensao_diametro">
<xs:simpleType>
<xs:restriction base="xs:int">
<xs:minInclusive value="0"/>
<xs:maxInclusive value="105"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="destinatario">
<xs:complexType>
<xs:sequence>
<xs:element ref="nome_destinatario"/>
<xs:element ref="telefone_destinatario"/>
<xs:element ref="celular_destinatario"/>
<xs:element ref="email_destinatario"/>
<xs:element ref="logradouro_destinatario"/>
<xs:element ref="complemento_destinatario"/>
<xs:element ref="numero_end_destinatario"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="descricao_objeto">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="20"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
59/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
<xs:element name="data_postagem_sara">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="8"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="cubagem">
<xs:simpleType>
<xs:restriction base="xs:string"/>
</xs:simpleType>
</xs:element>
<xs:element name="correioslog">
<xs:complexType>
<xs:sequence>
<xs:element ref="tipo_arquivo"/>
<xs:element ref="versao_arquivo"/>
<xs:element ref="plp" maxOccurs="1"/>
<xs:element ref="remetente"/>
<xs:element ref="forma_pagamento"/>
<xs:element ref="objeto_postal" maxOccurs="1000"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="complemento_remetente">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="30"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="complemento_destinatario">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="30"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="codigo_usuario_postal">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="20"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="codigo_servico_postagem">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="5"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="codigo_servico_adicional" type="xs:short"/>
<xs:element name="codigo_objeto_cliente">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="20"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="codigo_administrativo">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="9"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
60/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
<xs:element name="cidade_remetente">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="30"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="cidade_destinatario">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="30"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="cep_remetente">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="20"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="cep_destinatario">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="20"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="centro_custo_cliente">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="20"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="celular_destinatario">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="12"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="cartao_postagem">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="10"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="bairro_remetente">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="30"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="bairro_destinatario">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="30"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:schema>
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
61/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
1. Tabelas de códigos para uso no xml (correioslog)
1.1. Código Forma de Pagamento (tag <forma_pagamento>)
Codigo
Forma_Pagamento
1 Vale Postal
2 Reembolso Postal
3 Contrato de Câmbio
4 Cartão de Crédito
5 Outros
1.2. Código da Diretoria Regional (tag <numero_diretoria>)
C
ó
digo
Descri
ção
Sigla
00001 AC ADMINISTRAÇAO CENTRAL AC
00003 DR - ACRE ACR
00004 DR - ALAGOAS AL
00006 DR - AMAZONAS AM
00005 DR - AMAPÁ AP
00008 DR - BAHIA BA
00010 DR - BRASÍLIA BSB
00012 DR - CEARÁ CE
00014 DR - ESPIRITO SANTO ES
00016 DR - GOIÁS GO
00018 DR - MARANHÃO MA
00020 DR - MINAS GERAIS MG
00022 DR - MATO GROSSO DO SUL MS
00024 DR - MATO GROSSO MT
00028 DR - PARÁ PA
00030 DR - PARAÍBA PB
00032 DR - PERNAMBUCO PE
00034 DR - PIAUÍ PI
00036 DR - PARANÁ PR
00050 DR - RIO DE JANEIRO RJ
00060 DR - RIO GRANDE DO NORTE RN
00026 DR - RONDONIA RO
00065 DR - RORAIMA RR
00064 DR - RIO GRANDE DO SUL RS
00068 DR - SANTA CATARINA SC
00070 DR - SERGIPE SE
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
62/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
00074 DR - SÃO PAULO INTERIOR SPI
00072 DR - SÃO PAULO SPM
00075 DR- TOCANTINS TO
1.2. Código País Bandeira
Codigo_pais_bandeira
Descricao_pais
Codigo_pais_ECT
1058 Brasil BR
1.3. Código do Tipo de Exportador
Código
Exportador
1 Pessoa Jurídica
11 Pessoa Física
12 Pessoa Física domiciliada no exterior sem CPF
13 Pessoa Física residente no país sem CPF
1.4. Código da Natureza da Operação
Código
Natureza_Operação
1 Pessoa física com cobertura cambial
2 Pessoa física sem cobertura cambial
3 Pessoa jurídica com cobertura cambial
4 Pessoa física sem cobertura cambial
30 Doação em caráter de ajuda humanitária
31 Bagagem desacompanhada
41 Bens de caráter cultural- Exportação temporária
42 Exportação temporária de material para emprego militar
43 Feiras e exposições
44 Conserto, reparo ou restauração
45 Outras exportações temporárias
61 Bens submetidos a regime de admissão temporária
71 Erro de expedição
72 Não atendimento de exigência de controle extrafiscal
73 Indeferimento de regime aduaneiro especial
74 Outros motivos: Portaria MF 306/95
1.5. Código do Porte da Empresa
Código
Porte_Empresa
1 Micro Empresa
2 Pequena Empresa
3 Outros
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
63/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
1.6. Código da Unidade de Comercialização
Código
Unidade_Comercialização
8 Centímetro
2 Grama
9 Milímetro
5 Minuto
6 Não Significativo
4 Pagina
3 Palavra
10 Quantidade
1 Quilograma
7 R$-Valor
1.7. Código da Moeda de Negociação
Código
Moeda
0 Real
1.8. Código do Serviço Adicional
Código
Descrição Do Serviço Adicional
1 Aviso de Recebimento
2 Mão Própria
19 Valor Declarado (Ad Valorem)
25 Registro
2. Leiaute de chancelas
2.1. Chancela PAC
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
64/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
Siglas ou nomes por extenso dos serviços
do contrato; ano de assinatura; DR/origem/postagem
Cliente
.
Estarão sempre dispostas no parte superior dos símbolos.
Fonte: Arial normal (caixa alta), corpo 7pt, espaçamentos
entre-letra e entre-linha=100%
Fonte: Arial negrito (caixa alta e baixa), corpo 9 a 11pt,
espaçamentos entre-letra e entre-linha=100%
.
Estarão sempre dispostas no parte inferior dos símbolos.
Identificação dos Correios
A
diagramação é 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 necessário.
A diagramação é pré-definida.
Padronização visual dos símbolos de Contratos Chancelas
Instruções para arte-finalizão -
- ENTREGA NÃO URGENTE
Serviço: ENCOMENDA PAC
1. Para diagramar a Chancela siga as instruções abaixo:
Atenção:
Não é permitida alterações na forma da chancela,
assim como nas especificações acima.
Nº do contrato; ano de
assinatura; DR/origem/postagem
Cliente
Fonte: Arial normal (caixa alta),
corpo 4pt, espaçamentos entre-
letra e entre-linha=100%
Fonte: Arial normal (caixa alta e
baixa), corpo 5pt, espaçamentos
entre-letra e entre-linha=100%
Obs: Quando a DR de origem e
postagem for a mesma, utilizar a
sigla somente uma vez.
Obs: Utilizar duas linhas
(centralizadas) quando necessário.
Negativo:
Atenção:
2. Para arte-finalização em negativo seguir a mesma
diagramação como no exemplo abaixo:
3. Utilizar a chancela reduzida somente quando
necessário.
0000/2002-DR/XX/YY
Cliente
Redução (15X20mm):
(Dimensões 25 x 35mm)
PAC
0000/2002-DR/XX/YY
Cliente
PAC
0 0 0 0 /2 0 0 2 - DR/X X/YY
Cliente
PAC
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
65/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
2.2. Chancela SEDEX
Siglas ou nomes por extenso dos serviços
do contrato; ano de assinatura; DR/origem/postagem
Cliente
.
Estarão sempre dispostas no parte superior dos símbolos.
Fonte: Arial normal (caixa alta), corpo 7pt, espaçamentos
entre-letra e entre-linha=100%
Fonte: Arial negrito (caixa alta e baixa), corpo 9 a 11pt,
espaçamentos entre-letra e entre-linha=100%
.
Estarão sempre dispostas no parte inferior dos símbolos.
Identificação dos Correios
A
diagramação é 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 necessário.
A diagramação é pré-definida.
Padronização visual dos símbolos de Contratos Chancelas
Instruções para arte-finalização -
Serviço Expresso: SEDEX
1. Para diagramar a Chancela siga as instruções abaixo:
Atenção:
o é permitida alterações na forma da chancela,
assim como nas especificações acima.
Nº do contrato; ano de
assinatura; DR/origem/postagem
Cliente
Fonte: Arial normal (caixa alta),
corpo 4pt, espaçamentos entre-
letra e entre-linha=100%
Fonte: Arial normal (caixa alta e
baixa), corpo 5pt, espaçamentos
entre-letra e entre-linha=100%
Obs: Quando a DR de origem e
postagem for a mesma, utilizar a
sigla somente uma vez.
Obs: Utilizar duas linhas
(centralizadas) quando necessário.
Negativo:
Redução (eixo maior 20mm; eixo menor 13,2mm):
Atenção:
2. Para arte-finalização em negativo seguir a mesma
diagramação como no exemplo abaixo:
(Eixo maior 35mm)
(Eixo menor 23mm)
3. Utilizar a chancela reduzida somente quando
necessário.
0000/2002-DR/XX/YY
Cliente
0000/2002-DR/XX/YY
Cliente
0 0 0 0 /20 0 2 - DR/X X/YY
Cliente
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
66/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
2.3. Chancela SEDEX 10
Siglas ou nomes por extenso dos serviços
do contrato; ano de assinatura; DR/origem/postagem
Cliente
.
Estarão sempre dispostas no parte superior dos símbolos.
Fonte: Arial normal (caixa alta), corpo 7pt, espaçamentos
entre-letra e entre-linha=100%
Fonte: Arial negrito (caixa alta e baixa), corpo 9 a 11pt,
espaçamentos entre-letra e entre-linha=100%
.
Estarão sempre dispostas no parte inferior dos símbolos.
Identificação dos Correios
A
diagramação é 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 necessário.
A diagramação é pré-definida.
Padronização visual dos mbolos de Contratos Chancelas
Instruções para arte-finalização -
Serviço Expresso: SEDEX 10
1. Para diagramar a Chancela siga as instruções abaixo:
Atenção:
o é permitida alterações na forma da chancela,
assim como nas especificações acima.
Nº do contrato; ano de
assinatura; DR/origem/postagem
Cliente
Fonte: Arial normal (caixa alta),
corpo 4pt, espaçamentos entre-
letra e entre-linha=100%
Fonte: Arial normal (caixa alta e
baixa), corpo 5pt, espaçamentos
entre-letra e entre-linha=100%
Obs: Quando a DR de origem e
postagem for a mesma, utilizar a
sigla somente uma vez.
Obs: Utilizar duas linhas
(centralizadas) quando necessário.
Negativo:
Redução (eixo maior 20mm; eixo menor 13,2mm):
Atenção:
2. Para arte-finalização em negativo seguir a mesma
diagramação como no exemplo abaixo:
(Eixo maior 35mm)
(Eixo menor 23mm)
3. Utilizar a chancela reduzida somente quando
necessário.
0000/2002-DR/XX/YY
Cliente
0000/2002-DR/XX/YY
Cliente
0000/2002-DR/XX/YY
Cliente
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
67/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
2.4. Chancela SEDEX Hoje
Siglas ou nomes por extenso dos serviços
Nº do contrato; ano de assinatura; DR/origem/postagem
Cliente
.
Estarão sempre dispostas no parte superior dos símbolos.
Fonte: Arial normal (caixa alta), corpo 7pt, espaçamentos
entre-letra e entre-linha=100%
Fonte: Arial negrito (caixa alta e baixa), corpo 9 a 11pt,
espaçamentos entre-letra e entre-linha=100%
.
Estarão sempre dispostas no parte inferior dos símbolos.
Identificação dos Correios
A
diagramação é 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 necessário.
A diagramação é pré-definida.
Padronizão visual dos mbolos de Contratos Chancelas
Instruções para arte-finalização -
Serviço Expresso: SEDEX Hoje
1. Para diagramar a Chancela siga as instruções abaixo:
Atenção:
o é permitida alterações na forma da chancela,
assim como nas especificações acima.
Nº do contrato; ano de
assinatura; DR/origem/postagem
Cliente
Fonte: Arial normal (caixa alta),
corpo 4pt, espaçamentos entre-
letra e entre-linha=100%
Fonte: Arial normal (caixa alta e
baixa), corpo 5pt, espaçamentos
entre-letra e entre-linha=100%
Obs: Quando a DR de origem e
postagem for a mesma, utilizar a
sigla somente uma vez.
Obs: Utilizar duas linhas
(centralizadas) quando necessário.
Negativo:
Redução (eixo maior 20mm; eixo menor 13,2mm):
Atenção:
2. Para arte-finalização em negativo seguir a mesma
diagramação como no exemplo abaixo:
(Eixo maior 35mm)
(Eixo menor 23mm)
3. Utilizar a chancela reduzida somente quando
necessário.
0000/2002-DR/XX/YY
Cliente
0000/2002-DR/XX/YY
Cliente
0000/2002-DR/XX/YY
Cliente
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
68/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
2.5. Chancela e-SEDEX
Siglas ou nomes por extenso dos serviços
Nº do contrato; ano de assinatura; DR/origem/postagem
Cliente
.
Estarão sempre dispostas no parte superior dos símbolos.
Fonte: Arial normal (caixa alta), corpo 7pt, espaçamentos
entre-letra e entre-linha=100%
Fonte: Arial negrito (caixa alta e baixa), corpo 9 a 11pt,
espaçamentos entre-letra e entre-linha=100%
.
Estarão sempre dispostas no parte inferior dos símbolos.
Identificação dos Correios
A
diagramação é 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 necessário.
A diagramação é pré-definida.
Padronização visual dos mbolos de Contratos Chancelas
Instruções para arte-finalização -
Serviço Expresso: e-SEDEX
1. Para diagramar a Chancela siga as instruções abaixo:
Atenção:
o é permitida alterações na forma da chancela,
assim como nas especificações acima.
do contrato; ano de
assinatura; DR/origem/postagem
Cliente
Fonte: Arial normal (caixa alta),
corpo 4pt, espaçamentos entre-
letra e entre-linha=100%
Fonte: Arial normal (caixa alta e
baixa), corpo 5pt, espaçamentos
entre-letra e entre-linha=100%
Obs: Quando a DR de origem e
postagem for a mesma, utilizar a
sigla somente uma vez.
Obs: Utilizar duas linhas
(centralizadas) quando necessário.
Negativo:
Redução (eixo maior 20mm; eixo menor 13,2mm):
Ateão:
2. Para arte-finalização em negativo seguir a mesma
diagramação como no exemplo abaixo:
(Eixo maior 35mm)
(Eixo menor 23mm)
3. Utilizar a chancela reduzida somente quando
necessário.
0000/2002-DR/XX/YY
Cliente
0000/2002-DR/XX/YY
Cliente
0000/2002-DR/XX/YY
Cliente
EMPRESA BRASILEIRA DE CORREIOS E TELÉGRAFOS – ECT
SIGEP Web - Manual de Implementação do Web Service
69/69
Manual de Implementacao do Web Service SIGEPWEB e Logistica Reversa.doc
2.6. Chancela Carta
Siglas ou nomes por extenso dos serviços
Nº do contrato; ano de assinatura; DR/origem/postagem
Cliente
.
Estarão sempre dispostas no parte superior dos símbolos.
Fonte: Arial normal (caixa alta), corpo 7pt, espaçamentos
entre-letra e entre-linha=100%
Fonte: Arial negrito (caixa alta e baixa), corpo 9 a 11pt,
espaçamentos entre-letra e entre-linha=100%
.
Estará sempre disposta na parte inferior dos símbolos.
Identificação dos Correios
A diagramação é 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 necessário.
A diagramação é pré-definida.
Padronização visual dos símbolos de Contratos Chancelas
Instruções para arte-finalização -
- ENTREGA URGENTE
Serviço: CARTA
1. Para diagramar a Chancela, siga as instruções abaixo:
Atenção:
Nº do contrato; ano de assinatura;
DR/origem/postagem
Cliente
Fonte: Arial normal (caixa alta), corpo
4pt, espamentos entre-letra e
entre-linha=100%
Fonte: Arial negrito (caixa alta e
baixa), corpo 5pt, espaçamentos
entre-letra e entre-linha=100%
Obs: Quando a DR de origem e
postagem for a mesma, utilizar a
sigla somente uma vez.
Obs: Utilizar duas linhas
(centralizadas) quando necessário.
Negativo:
Redução (diâmetro 20mm):
2. Para arte-finalização em negativo, siga a mesma
diagramação do item 1, conforme exemplo abaixo:
(diâmetro 35mm)
3. Utilizar a chancela reduzida somente quando
necessário.
0000/2002-DR/XX/YY
Cliente
0000/2002-DR/XX/YY
Cliente
0 0 0 0 /2 0 0 2 - D R /X X/YY
Cliente
Ateão:
o é permitido alterações na forma da chancela, assim
como nas especificações deste documento, salvo o
disposto abaixo.
A critério do Cliente e para que a chancela fique
proporcional ao tamanho do objeto, suas dimenes
podeo variar no intervalo entre os valores máximos e
mínimos mencionados neste documento.

Navigation menu