SIGEP Web Manual De Implementação Do Service 2018 10 24 Implementacao

User Manual:

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

Download
Open PDF In Browser	View PDF

Manual para Integração via Web Services

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services

Sumário
Introdução ................................................................................................................... 3
1.

Pré-Requisitos ..................................................................................................... 3

Processo de Integração....................................................................................... 3

Web Services SIGEP WEB ................................................................................. 5

3.1 Ambiente de Desenvolvimento e Homologação .................................................... 5
3.2 Ambiente de Produção .......................................................................................... 5
4. Métodos do Web Services do SIGEP WEB............................................................. 6
4.1 Disponibilidade do Serviço entre o CEP da Origem e CEP de Destino ................. 6
4.2 Serviços Disponíveis para o Cartão ...................................................................... 9
4.3 Consulta Endereço via CEP ................................................................................ 10
4.4 Situação do Cartão de Postagem ........................................................................ 11
4.5 Solicitação de Faixa de Etiquetas para Postagem .............................................. 12
4.6 Dígito Verificador de Número da Etiqueta de Postagem ..................................... 14
4.7 Fechamento de Pré-lista de Postagem de Objetos ............................................. 15
4.8 Solicitação de XML da PLP ................................................................................. 28
4.9 Solicitação de Suspensão de Entrega de Encomenda ao Destinatário ............... 31
ANEXO 01 - Rótulo de Endereçamento: ................................................................... 33
ANEXO 02 - Algoritmo Geração do dígito verificador ................................................ 34
ANEXO 03 – Layout 2D – Data Matrix ...................................................................... 35
ANEXO 04 – Validação do XML utilizando o Schema XSD ...................................... 38
ANEXO 05 - Código da Diretoria Regional (tag ) ...................... 39
ANEXO 06 - Código do Serviço Adicional ................................................................ 40
ANEXO 07 – Categoria de serviços e símbolos de encaminhamento ....................... 41
ANEXO 08 – Código Forma de Pagamento (tag ) ................... 42
ANEXO 09 - Exemplo de Tabelas para Armazenamento em Banco de dados ........ 43
ANEXO 10 – Voucher de Postagem ou Lista de Postagem e Aviso de RecebimentoAR ............................................................................................................................. 45
ANEXO 11 - Visão do Processo de Integração ......................................................... 47
ANEXO 12 – Termo De Condições De Prestação De Serviços De Encomendas
Nacionais................................................................................................................... 56
ANEXO 13 – Calculador de preços e prazos de encomendas .................................. 57
Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services

Introdução
Os Correios disponibilizam gratuitamente, para clientes com contrato, um conjunto de
serviço acessíveis via web services que possibilita a integração dos sistemas dos clientes
com o ambiente tecnológico dos Correios.
Este manual descreve os métodos web services da aplicação SIGEP WEB, que propicia
aos clientes o gerenciamento de suas postagens, possibilitando:
 Organização e registro dos objetos em uma única interface integrada aos Correios;
 Pesquisa de serviços disponíveis no cartão de postagem;
 Verificação do status do contrato e cartão de postagem;
 Antecipação do código de registro dos objetos antes mesmo da postagem;
 Geração prévia de lista de objetos para controle das postagens;
 Acesso a informações, tais como: rastreamento dos objetos, consulta de CEP,
abrangência dos serviços, prévia de faturamento em D+1.

1. Pré-Requisitos
Para fazer integração de sistemas com o web services SIGEP WEB, o cliente necessita ter
contrato com os Correios.
Nesse caso, poderá solicitar ao representante comercial dos Correios a autorização de
acesso (usuário e senha) para o contrato e cartão de postagem (mesmo CNPJ).

2. Processo de Integração
Na visão aqui proposta, o processo de integração envolve Correios e Cliente em cinco
etapas:
1. Inicialização:
Nesta etapa, primeiramente o sistema do cliente realiza uma consulta para verificar
e/ou validar a situação do cartão e os serviços disponíveis. Essa ação poderá ser
executada, por exemplo, uma vez ao dia; com isso, evita-se que os objetos sejam
encaminhados para um serviço inexistente no contrato ou então com situação
cadastral pendente.
Após a validação do situação contratual e obtenção dos dados do contrato e do
cartão, a demanda de etiquetas poderá ser requerida. Essa funcionalidade, “Solicitar
etiquetas”, sempre retornará um range de números de acordo com a quantidade
Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services
requisitada. Os números de registros obtidos identificarão os objetos que serão
postados nos Correios, devendo ser utilizados para acompanhar o rastreamento.
O sistema do cliente deverá gerenciar localmente a reserva de faixas de números de
registro das encomendas, que serão consumidas por ele ao longo de um período
pré-definido. Essa é uma recomendação de boas práticas de desenvolvimento da
solução aqui proposta, porém, não há impedimentos técnicos de se fazer a
solicitação do número de registro por pedido.
2. Atendimento Pedido:
Contempla os passos mínimos para preparação física das encomendas por parte do
cliente. Permite a validação de preço, prazo, disponibilidade do serviço para o CEP
destino, além de selecionar a melhor forma de entrega de acordo com a
necessidade. O rótulo a ser impresso deve seguir o padrão proposto neste
documento, ANEXO 01;
3. Pré-postagem:
Fechamento da Pré-lista de Postagem – PLP, dos pedidos anteriormente atendidos.
Estes pedidos serão consolidados diariamente em uma única lista a ser enviada de
forma eletrônica aos Correios. O retorno será um número que identificará a PLP.
Este número é a chave para o recebimento das encomendas nos Correios a ser
disposto no voucher, modelo no ANEXO 10 deste documento. O controle de
expedição da encomendas será por meio do voucher, a ser gerado pelo sistema do
cliente;
4. Postagem:
Apresenta os passos para a postagem das encomendas nos Correios;
5. Acompanhamento:
Esta etapa corresponde ao gerenciamento das encomendas encaminhadas e
postadas nos Correios. Além de obter o rastreamento da encomenda no fluxo postal
até o momento da sua entrega, será possível obter os dados atualizados da aferição
ecaptação do atendimento e o valor precificado no sistema de atendimento dos
Correios, para cada encomenda.
Outra funcionalidade disponível nesta etapa é a suspensão da entrega de uma
encomenda já postada. Conforme disposto no ANEXO 12.

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services
O fluxo com a visão geral do processo de integração consta no ANEXO 11 deste
documento.

Web Services SIGEP WEB

Para a integração com o web services SIGEP WEB, são adotados os padrões SOAP
(Simple Object Access Protocol) e XML (eXtended Markup Language).

3.1 Ambiente de Desenvolvimento e Homologação
Após o desenvolvimento, o cliente deverá fazer os testes de integração do seu sistema com
a plataforma dos Correios. Para essa finalidade, está disponível um ambiente para
desenvolvimento e homologação da integração do sistema do cliente com o web services
SIGEP WEB, onde a interface e deverá ser consultada e configurada no seguinte endereço:
https://apphom.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdl

No quadro a seguir, constam as informações necessárias para a autenticação e testes no
ambiente de desenvolvimento e homologação.
Usuário

Senha

Código

Contrato

Administrativo
sigep

n5f9t8

17000190

Código

Cartão

CNPJ

0067599079

34028316000103

Serviço
9992157880

***

*** Para desenvolvimento e homologação, os códigos de serviços devem ser
consultados por meio do método buscaCliente().

Finalizados os testes o cliente deve encaminhar o XML, a PLP e os rótulos ao
responsável pelo contrato nos Correios para as respectivas validações.

3.2 Ambiente de Produção
Para produção, deverão ser utilizados os parâmetros do contrato celebrado com os
Correios, bem como, os dados de autenticação do cliente e contrato.
Para esse ambiente, a interface do web services deverá ser consultada e configurada no
seguinte endereço:
https://apps.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdl
Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services

4. Métodos do Web Services do SIGEP WEB
Neste item estão descritos os métodos do web services do SIGEP WEB.
Em caso de erro na autenticação dos métodos, o cliente deve entrar em contato com o
representante comercial dos Correios responsável pelo contrato.

Para facilitar a gestão da informação, no ANEXO 09 deste documento, consta uma
sugestão de esquema de tabelas que o cliente poderá implementar para o armazenamento
de dados a serem enviados e recebidos dos SIGEP WEB

4.1 Disponibilidade do Serviço entre o CEP da Origem e CEP de Destino
Por meio desse método, pode ser verificado se um serviço que não possui abrangência
nacional está disponível entre um CEP de Origem e de Destino (Ex: Sedex, PAC, Sedex
10, Sedex 12, Sedex Grandes Formatos e PAC Grandes Formatos).

a) Assinatura do Método:
verificaDisponibilidadeServico (codAdministrativo, numeroServico, cepOrigem, cepDestino,
usuario, senha)

b) Layout do Método:
Campo
codAdministrativo

Tipo de
Dado
String(8)

numeroServico

String(5)

cepOrigem

String (8)

cepDestino

String (8)

usuario

String

senha

String

Descrição/Observação

Obrigatório

Código Administrativo do contrato do
Cliente com os Correios.
Códigos dos serviços contratados. Ex:
40215, 40290, 04162, 04669.
CEP de Origem sem hífen.Exemplo:
70002900
CEP de Destino sem hífen

Sim

Login do usuário para autenticação.
(Fornecido pelo Representante
Comercial dos Correios mediante carta
de solicitação.)
Senha de autenticação. (Fornecida
pelo Representante Comercial dos
Correios mediante carta de solicitação)

Sim

Sim
Sim
Sim

Sim

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services

c) Retorno do Método:
Tag

Tipo de Dado
String - “código do erro#motivo”

d) Exemplo:
Consulta de Serviço entre CEP de Origem e Destino com retorno válido.

17000190
04162
05311900
05311900
sigep
n5f9t8

Retorno:

Consulta de Serviço entre CEP de Origem e Destino com retorno inválido.*

17000190
04669
05311900
05311900
sigep
n5f9t8

Retorno:

-888#Erro ao calcular tarifa no SGPB. ERP-007: CEP de origem nao pode postar para
o CEP de destino informado(-1).

* SGPB – Sistema de Gestão de Preços e Benefícios dos Correios.

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services

e) Códigos e mensagens de erros*
Código de erro
0
-2
-3
-33
-34
-35
-36
-37
-38
-888
001
006
007
008
009
010
011
012
99

Mensagem de erro
Processamento com sucesso
CEP de origem inválido
CEP de destino inválido
Sistema temporariamente fora do ar. Favor tentar mais tarde.
Código Administrativo ou Senha inválidos.
Senha incorreta.
Cliente não possui contrato vigente com os Correios.
Cliente não possui serviço ativo em seu contrato.
Serviço indisponível para este código administrativo.
Erro ao calcular tarifa no SGPB**. ERP-007: CEP de origem nao pode postar para o
CEP de destino informado(-1).
Código de serviço inválido
Localidade de origem não abrange o serviço informado
Localidade de destino não abrange o serviço informado
Serviço indisponível para o trecho informado
CEP inicial pertencente a Área de Risco.
O CEP de destino está temporariamente sem entrega domiciliar. A entrega será
efetuada na agência indicada no Aviso de Chegada que será entregue no endereço do
destinatário.
O CEP de destino está sujeito a condições especiais de entrega pela ECT e será
realizada com o acréscimo de até 7 (sete) dias úteis ao prazo regular.
Serviço temporariamente indisponível para o destino consultado.
Outros erros diversos do .Net

*Referência: Manual de Implementação do Calculo Remoto de Precos e Prazos_versao_2.0_05_10_2017-11.pdf (Acesso
ao manual Anexo 13)
** SGPB – Sistema de Gestão de Preços e Benefícios dos Correios.

Atenção: Aos códigos de erro “010” e “011”, são avisos que permitem a utilização do
serviço, desta maneira poderá postar utilizando o serviço escolhido, mas haverá um
retorno de alerta informando condições especiais de entrega.

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services

4.2 Serviços Disponíveis para o Cartão
Este método retorna os serviços disponíveis do contrato para um determinado cartão de
postagem.

a) Assinatura do Método:
buscaCliente (idContrato, idCartaoPostagem, usuario, senha )

b) Layout do Método:
Tag

Descrição/Observação

Obrigatório

idContrato

Tipo de
Dado
String(10)

Número do contrato

Sim

idCartaoPostagem

String (10)

Sim

usuario

String

senha

String

Cartão de postagem vinculado ao
contrato
Login do usuário para autenticação
(Fornecido pelo Representante
Comercial dos Correios mediante carta
de solicitação)
Senha de autenticação. (Fornecida
pelo Representante Comercial dos
Correios mediante carta de solicitação)

Sim

c) Exemplo:
Consulta:

9992157880
0067599079
sigep
n5f9t8

Retorno:

34028316000103

17000190
0067599079

04162
SEDEX - CONTRATO

124849
...

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services

4.3 Consulta Endereço via CEP
Este método retorna o endereço correspondente ao número de CEP informado.
É recomendado validar o endereço para evitar falhas no encaminhamento do objeto.

a) Assinatura do Método:
consultaCEP (cep)

b) Layout do Método:
Campo

Tipo

Descrição

Obrigatório

cep

String(8)

Número do CEP sem hífen.

Sim

c) Exemplo:
Consulta:

70002900

Retorno:

Asa Norte
70002900
Brasília

SBN Quadra 1 Bloco A
0
DF

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services
4.4 Situação do Cartão de Postagem
Este método retorna o situação do cartão de postagem. É recomendada a pesquisa
periódica para evitar tentativa de postagens com cartão suspenso, ocasionando a não
aceitação dos objetos nos Correios.

a) Assinatura do Método:
getStatusCartaoPostagem (numeroCartaoPostagem, usuario, senha)

b) Layout do Método:
Tag

Tipo de
Dado
String (10)

String

Descrição/Observação

Obrigatório

Número do Cartão de Postagem
vinculado ao contrato
Login do usuário para autenticação
(Fornecido pelo Representante
Comercial dos Correios mediante
carta de solicitação)
Senha de autenticação. (Fornecida
pelo Representante Comercial dos
Correios mediante carta de
solicitação)

Sim
Sim

Sim

c) Retorno do Método:
Tag

Tipo
Normal / Cancelado

d) Exemplo:
Consulta:

0067599079
sigep
n5f9t8

Retorno:

Normal

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services
4.5 Solicitação de Faixa de Etiquetas para Postagem
Este método retorna uma faixa (range) de códigos de registro, sem dígito verificador, para
postagem de objetos. O código de registro é também denominado “número de etiquetas de
registro”.
Quando da preparação da encomenda para postagem, cada número de etiqueta deverá ser
usado para a geração do rótulo de endereçamento no padrão citado no ANEXO 01 deste
manual.
Essa funcionalidade sempre irá retornar uma faixa de etiquetas, independente da
quantidade solicitada. Caso for requisitado somente um registro, considere apenas o
primeiro número.
A faixa de etiquetas ficará reservada para o CNPJ informado.

É recomendado que o sistema do cliente gerencie essa faixa numérica de acordo com os
serviços utilizados, com rotina de controle do estoque das etiquetas. Poderá ser solicitada
uma faixa de etiquetas conforme previsão de postagem diária separadamente por serviço,
por exemplo: PAC, Sedex, etc. Esse processo evita a alta dependência entre os sistemas,
diminuindo a quantidade de requisições.

O número retornado não contém o dígito verificador. Para obtenção desse dígito, deve
ser consumido o método geraDigitoVerificadorEtiquetas ou implementada rotina
para o cálculo do dígito verificador, conforme exemplo do ANEXO 02.

a) Assinatura do método:
solicitaEtiquetas (tipoDestinatario, identificador, idServico, qtdEtiquetas, usuario, senha)

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services

b) Layout do Método:
Campo

Descrição/Observação

Obrigatório

tipoDestinatario

Tipo de
Dado
String (1)

Identificação com a letra “C”, de cliente.

Sim

Identificador

String (14)

Sim

idServico

Long (6)

qtdEtiquetas

Int

Usuário

String

senha

String

CNPJ da empresa, informar somente os
números.
Id do serviço, porderá ser obtido no método
buscaCliente().
Quantidade de etiquetas a serem solicitadas.
Permite solicitar 1 ou “n” números de etiqueta de
registro.
Login do usuário autenticador. (Fornecido pelo
Representante Comercial dos Correios mediante
carta de solicitação)
Senha de autenticação. (Fornecida pelo
Representante Comercial dos Correios mediante
carta de solicitação)

Sim
Sim

Sim

c) Retorno do Método:
Tag

Tipo de Dado

String (Faixa de Numeração de Etiquetas).
Obs: O espaço entre o número e o BR corresponde à posição
do DV- Dígito Verificador do código da etiqueta (ver exemplo
a seguir).

d) Exemplo:
Consulta:

C
*******
124849
1
*******
*******

Retorno:

DL76023727 BR,DL76023727 BR

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services
4.6 Dígito Verificador de Número da Etiqueta de Postagem
Este método retorna o DV - Dígito Verificador de um número de etiqueta ou um array.
O algorítimo para geração do DV consta no exemplo do ANEXO 02 deste manual.

a) Assinatura do Método:
geraDigitoVerificadorEtiquetas (etiquetas, usuario, senha)

b) Layout do Método:
Campo
etiquetas

Tipo de
Dado
String(13)

usuario

String

senha

String

Descrição/Observação

Obrigatório

Deverá informar uma String.
Ex: “DL61145929 BR”
No espaço vazio, entre o número e o
BR, deverá ser gravado o dígito
verificador que é retornado pelo
método.
Poderá ser enviado individualmente ou
um array.
Login do usuário para autenticação
(Fornecido
pelo
Representante
Comercial dos Correios mediante carta
de solicitação)
Senha de autenticação. (Fornecida pelo
Representante Comercial dos Correios
mediante carta de solicitação)

Sim

c) Retorno do método:
Tag

Tipo de Dado
Int(digitoVerificador), Sendo um array, o retorno será na
mesma ordem da sequência dos códigos de etiquetas
enviados pela requisição.

d) Exemplo:
Consulta:

DL74668653 BR
DL76023727 BR
sigep
n5f9t8

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services
Retorno:

6
2

4.7 Fechamento de Pré-lista de Postagem de Objetos
Esse método possibilita fechar uma Pré-lista de Postagem – PLP com as informações dos
objetos que serão postados.

Antes de enviar os objetos da lista para postagem a PLP deverá ser fechada.

É possível que seja fechada mais de uma PLP por dia, em função da necessidade do
cliente.

É possível o envio de vários objetos de diferentes serviços na mesma PLP, limitado à
1000 (mil) encomendas por PLP.

a) Assinatura do Método:
fechaPlpVariosServicos (xml, idPlpCliente, cartaoPostagem, listaEtiquetas, usuário, senha)

b) Layout do Método:
Campo

Tipo

Descrição

Obrigatório

xml

String

PLP (pré-lista de postagem) em formato XML.

Sim

Vide especificação do layout do XML da PLP (ver alínea “f”
deste item) e exemplo na alínea “e” deste item.
idPlpCliente

Long (10)

Código gerado pelo cliente para identificação da PLP.

Sim

cartaoPostagem

String (10)

Sim

listaEtiquetas

List

Número do Cartão de Postagem, que é o código que
autoriza a postagem dos serviços no contrato.
Lista de objetos enviados via parâmetro sem o dígito
verificador, por exemplo:
List listaEtiquetas = new ArrayList();
listaEtiquetas.add("DL12345677BR");
listaEtiquetas.add("DF12345678BR");
*** Remover o dígito verificador e os espaços, seguindo
a mesma ordem dos objetos enviados no parâmetro xml.

Sim

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services
Obs: 1. O campo listaEtiquetas é um array dos objetos
constantes no XML. A seqüência dos objetos contidos no
array listaEtiquetas deverá ser a mesma do XML, que
também é enviado por parâmetro no momento de acionar
o método. Os objetos informados no array listaEtiquetas
não devem conter o dígito verificador. Já no XML é
obrigatório informar o dígito verificador de cada etiqueta.
2. Os códigos de objeto deverão ser obtidos previamente
pelo método solicitaEtiquetas() por serviço utilizado.
usuario

String

senha

String

Login do usuário para autenticação. (Fornecido pelo
Representante Comercial dos Correios mediante carta de
solicitação)
Senha de autenticação. (Fornecida pelo Representante
Comercial dos Correios mediante carta de solicitação)

Sim

c) Retorno do método:
Tag

Tipo
Long (idPlp) - Número da PLP

d) Exemplo:
Consulta:

102030
0067599079
DL76023727BR
PH76023727BR
sigep
n5f9t8

Retorno:

20563504

e) Exemplo de Codificação do Método fechaPlpVariosServicos()
Transcrevemos um método simples de utilização do método fechar PLP vários serviços,
através da linguagem PHP.
Poderá ser adaptado em qualquer plataforma, seguindo esse exemplo do ambiente de
desenvolvimento.
Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services
Postagem2.30067599079
99921578801017000190237080002900
PRSO000641962BR410680,002500865GO1122330,00250010193000,0000250,0030
,0060,000,000
SL9992
21795BR400960,00800285GO2244
550,00250010191000,0000240,00
50,0030,0000";
$idPlpCliente = "102030";
$cartaoPostagem = "0067599079";
/*
Retirar o digíto verificador dos objetos no array
Seguir a mesma sequência do XML
Remover os espaços dos objetos no parâmetro lista etiquetas
*/
$listaEtiquetas = array('SO00064196BR', 'SL99922179BR');
$params = array('xml' => $xml, 'idPlpCliente' => $idPlpCliente, 'cartaoPostagem' => $cartaoPostagem,
'listaEtiquetas' => $listaEtiquetas, 'usuario' => 'sigep' , 'senha' => 'n5f9t8');
$result = $clientSoap->fechaPlpVariosServicos($params);
print_r($result);
?>

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services

f) Especificação do Layout do XML
O layout é dividido nas seguintes tags:

Encoding padrão dos Correios para o xml.
Observação: campo obrigatório

É a tag principal. Observação: campo obrigatório

Para este layout, deverá ser preenchido com a palavra Postagem
Observação: campo obrigatório

Identifica a versão do layout do arquivo XML. A versão deste layout é 2.3
Observação: campo obrigatório
Tag
Tags

Descrição

Tipo de dados

Observações

Identifica o registro da PLP – Pré-lista de

Numérico(11)

É obrigatório o campo ficar

Postagem que será retornada através do

vazio, pois será preenchido

método fechaPlpVariosServicos e será chave

pelo retorno deste método.

para o atendimento nos Correios dos objetos
a serem postados.
Deverá obrigatoriamente ser declarada
vazia no XML, por exemplo:

Valor em reais do total da tarificação dos

Numérico(10,2)

É obrigatório o campo ficar

objetos da PLP, que será retornada através do

vazio, pois será preenchido

método solicitaXmlPlp, quando postada.

pelo retorno deste método

Identifica

unidade

postagem

dos

Caractere(10)

Correios.

É obrigatório o campo ficar
vazio, pois será preenchido
pelo retorno deste método

Nome da unidade de postagem dos Correios.

Caractere(30)

É obrigatório o campo ficar
vazio, pois será preenchido
pelo retorno deste método

Numero do cartão do cliente associado à PLP.
Ex:

0067599079

(Com

Caractere(10)

Preenchimento Obrigatório

caracteres,

incluindo os zeros à esquerda).

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services
Tag
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

Número do contrato do cliente

Caractere(10)

Preenchimento
Obrigatório.

Número da Diretoria Regional do contrato do

Numerico(2)

cliente, conforme ANEXO 05.

Código administrativo do contrato

Preenchimento
Obrigatório.

Caractere(8)

Preenchimento
Obrigatório

Nome do remetente

Caractere(50)

Preenchimento
Obrigatório

Logradouro do remetente.

Caractere(50)

Recomendado utilizar o método consultaCEP()

Número do endereço do remetente

Preenchimento
Obrigatório

Caractere(5)

Preenchimento
Obrigatório

Complemento do endereço do remetente

Caractere(30)

Preenchimento

não

obrigatório.

Bairro do remetente

Caractere(30)

Preenchimento
Obrigatório

CEP do remetente

Caractere(8)

Preenchimento
Obrigatório
Formato: 99999999
Não pode existir espaço
ou qualquer caractere
(Ex: hífen) entre os
números

Cidade do remetente

Caractere(30)

Preenchimento
Obrigatório

Unidade de Federação

Caractere(2)

Telefone do remetente

Numérico (12)

Preenchimento
Obrigatório
Preenchimento

não

obrigatório.
Formato:99999999999,
incluindo

DDD

posições) + número
Não pode existir espaço
ou qualquer caractere
(Ex: hífen, parênteses,
barra, sinal de mais)
entre os números.

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services
Tags

Descrição

Tipo de dados

Observações

Fax do remetente

Numérico (12)

Preenchimento

não

obrigatório.
Formato:99999999999,
incluindo

DDD

posições) + número
Não pode existir espaço
ou qualquer caractere
(Ex: hífen, parênteses,
barra, sinal de mais)
entre os números.

Email do remetente

Caractere (50)

Preenchimento

não

obrigatório.

Celular do remetente

Numérico (12)

Preenchimento

não

obrigatório.
Formato:99999999999,
incluindo

DDD

posições) + número
Não pode existir espaço
ou qualquer caractere
(Ex: hífen, parênteses,
barra, sinal de mais)
entre os números.

Tag
Valor numérico indicando a forma de pagamento utilizada pelo cliente para realizar
a postagem.
Observação: A tag é obrigatória.
Para postagens a faturar enviar a tag vazia, por exemplo:
Ver ANEXO 08 deste manual.

Tag
Tag delimitadora do objeto que será postado. Esta tag contém as características do
objeto. Para postagens de “n” objetos, esta tag deverá ser repetida conforme a quantidade
de objetos enviados, limitado em até 1.000 objetos por lista.
Tags

Descrição

Tipo de dados

Observações

Código do objeto a ser postado.

Caractere(13)

Preenchimento

Importante: Deverá constar no código

Obrigatório

do objeto: Sigla do Tipo Postal (ex: DW)
+ número do objeto + digito verificador +
BR.

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services
Tags

Descrição

Tipo de dados

Observações

Caractere(20)

É obrigatório o campo

Exemplo: DW123456785BR
Obs: 1. É obrigatório informar o dígito
verificador de cada código do objeto;
2. Os códigos dos objetos deverão ser
obtidos

previamente

pelo

método

solicitaEtiquetas() por serviço utilizado.

Código de controle do cliente

ficar vazio

Código do serviço a ser utilizado na

Caractere(5)

postagem do objeto.
Obs:

código

Preenchimento
obrigatório

serviço

deve

corresponder ao tipo postal do código do
objeto. Ex: 04162, 04669

Cubagem do Objeto (em centímetros

Numérico(9,2)

cúbicos)

Peso do objeto (em gramas)

Preencher com o valor
0,00

Numérico(5)

Preenchimento
Obrigatório.

Reservado para observação do cliente

Caractere(255)

Preenchimento

não

obrigatório.

Reservado para o SIGEP WEB

Caractere(255)

É obrigatório o campo
ficar vazio.

Dados do destinatário

Dados relevantes a postagem

Identifica os serviços adicionais do objeto

Preenchimento

ANEXO 06

Obrigatório.

Preenchimento
Obrigatório.
Preenchimento
Obrigatório.

Deve conter as dimensões do objeto

Preenchimento

(altura, largura, comprimento e diâmetro)

Obrigatório.

e o tipo do objeto (embalagem)

Deve conter a data de efetivação da

É obrigatório o campo

postagem.

Contém o STATUS do processamento do

ficar vazio.
Caractere(1)

objeto, deverá ser enviado a informação

Preenchimento
Obrigatório.

com valor igual a “0”.

Contém o numero de comprovante de

Numérico(10)

postagem.

Valor que foi tarifado no Sistema de

É obrigatório o campo
ficar vazio.

Numérico(10,2)

Atendimento dos Correios.

É obrigatório o campo
ficar vazio.

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services
Tag

Esta tag contém os dados do destino da encomenda.
Tags

Descrição

Tipo de dados

Observações

Nome do destinatário

Caractere(50)

Preenchimento
Obrigatório.

Telefone do Destinatário

Numérico (12)

Preenchimento

não

obrigatório.
Formato:99999999999,
incluindo

DDD

posições) + número
Não pode existir espaço
ou qualquer caractere
(Ex: hífen, parênteses,
barra, sinal de mais)
entre os números.

Celular do Destinatário

Numérico (12)

Preenchimento

não

obrigatório.
Formato:99999999999,
incluindo

DDD

posições) + número
Não pode existir espaço
ou qualquer caractere
(Ex: hífen, parênteses,
barra, sinal de mais)
entre os números.

Email do Destinatário

Caractere(50)

Logradouro do destinatário.

Caractere(50)

Preenchimento

não

obrigatório.

Recomendado

utilizar

método

Preenchimento
Obrigatório.

consultaCEP()

Complemento do endereço

Caractere(30)

Preenchimento

não

obrigatório.

Parte do endereço

Caractere(5)

Preenchimento
Obrigatório.

Tag
A tag deverá estar dentro da tag e conterá os atributos
específicos de uma postagem de objetos nacionais.

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services
Tags

Descrição

Tipo de dados

Observações

Bairro do destinatário

Caractere(30)

Preenchimento Obrigatório.

Cidade do destinatário

Caractere(30)

Preenchimento Obrigatório.

Sigla da UF do destinatário

Caractere(2)

Preenchimento Obrigatório

CEP do destinatário

Caractere(8)

Preenchimento

Obrigatório

Formato: 99999999
Não

pode

existir

espaço

qualquer caractere (Ex: hífen)
entre os números. Ex:01020030

Código do usuário postal

Caractere(20)

Preenchimento não obrigatório.

Centro de custo do cliente

Caractere(20)

Preenchimento não obrigatório.

Número da nota fiscal.

Numérico(7)

Preenchimento

obrigatório

houver nota fiscal.

Série da nota fiscal.

Caractere(20)

Preenchimento não obrigatório.

Valor da nota fiscal

Numérico(9,2)

Preenchimento não obrigatório.

Natureza da nota fiscal

Caractere(0)

Deverá

ser

enviada

sem

preenchimento nenhum.

Descrição do objeto

Caractere(20)

Preenchimento não obrigatório.

Valor a cobrar do destinatário

Numérico(9,2)

Obrigatório para o serviço na
modalidade a cobrar.

Tag

A tag deverá estar dentro da tag e conterá os
seguintes atributos:

Tags

Descrição

Tipo de dados

Valor da tarifação total da PLP.

Numérico(10,2)

Código da unidade de postagem dos Correios

Caractere(10)

Nome da unidade de postagem dos Correios.

Caractere(30)

Cubagem do Objeto

Numérico(9,2)

Peso do objeto (em gramas)

Numérico(5)

Altura do objeto (em cm)

Numérico(9,2)

Largura do objeto (em cm)

Numérico(9,2)

Comprimento do objeto (em cm)

Numérico(9,2)

Diâmetro do objeto (em cm)

Numérico(9,2)

Contém a data de efetivação da postagem. Obs: Preenchido

Caractere(8)

automaticamente.

Contém o STATUS do processamento do objeto, quando postado

Caractere(1)

igual a “1”.

Contém o numero de comprovante de postagem do sistema de

Numérico(10)

Atendimento dos Correios.

Valor que foi precificado no Sistema de Atendimento da Unidade dos

Numérico(10,2)

Correios para o objeto.

a) Assinatura do Método:
solicitaXmlPlp (idPlpMaster, usuario, senha)

b) Layout do Método:
Campo

Tipo

Descrição

Obrigatório

idPlpMaster

Inteiro

Número da PLP (pré-lista de postagem).

Sim

usuario

String

Sim

senha

String

Usuário autenticador. (Fornecido pelo Representante
Comercial dos Correios)
Senha de autenticação. (Fornecida pelo Representante
Comercial dos Correios)

Sim

c) Retorno do Método:
Campo
return

Tipo
Xml

d) Exemplo:
Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services
Consulta:

11234567
sigep
n5f9t8

Retorno:

Postagem
2.3

24022403
3.6
18484
AC PRESIDENTE VARGAS
0067599079

991220855
50
17000190
>
>
>
>
>
>
>
RJ
>

RU012345678BR

10987
0,00
15

>
>
>

>
>
RJ
>

0,0

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services

25
1

1
0,00
0,00
0,00
0,00

13/06/2016 17:17:01
20160613
1
1234567980
3.6

]]>

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services
4.9 Solicitação de Suspensão de Entrega de Encomenda ao Destinatário
Esse método possibilita o envio de uma solicitação de suspensão da entrega de uma
encomenda ao destinatário. A encomenda receberá uma flag indicando que sua entrega
deve ser suspensa e, assim que identificada pela unidade de distribuição, a encomenda
será encaminhada para devolução ao remetente. Somente o detentor do contrato que gerou
a Pré-lista de Postagem para aquele objeto poderá realizar a suspensão. Uma vez enviada,
não é possível solicitar o cancelamento da solicitação.
Ao utilizar esse método, o CONTRATANTE concorda com o TERMO DE
CONDIÇÕES DE PRESTAÇÃO DE SERVIÇOS DE ENCOMENDAS NACIONAIS,
constante no Anexo 12 deste manual.

a) Assinatura do método:
bloquearObjeto (numeroEtiqueta, idPlp, tipoBloqueio, acao, usuario, senha)

Campo

Tipo

Descrição

Obrigatório

numeroEtiqueta

String(13)

Deverá informar uma String.
Ex: “PJ236077302BR”

Sim

idPlp

Long

Sim

tipoBloqueio

String(15)

acao

String(22)

usuario

String

senha

String

Código de controle do cliente da PLP enviada aos
Correios.
Para o tipo de bloqueio deve ser informado
(FRAUDE_BLOQUEIO)
Deverá
ser
informado
no
campos
ação
(DEVOLVIDO_AO_REMETENTE)
Usuário autenticador. (Fornecido pelo Representante
Comercial dos Correios)
Senha de autenticação. (Fornecida pelo Representante
Comercial dos Correios)

Sim
Sim
Sim
Sim

b) Retorno do método:
Campo
return

Tipo
String -“Registro gravado”

c) Exemplo:
Consulta:

SG037892748BR

80790

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services
FRAUDE_BLOQUEIO

DEVOLVIDO_AO_REMETENTE

******

Retorno:

Registro gravado

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services

ANEXO 01 - Rótulo de Endereçamento:
Rótulo de Endereçamento é o formulário impresso que contem todas as informações do
encomenda que será confiada aos Correios.
Nele constam o número de registro para rastreamento (número da Etiqueta), dados do
remetente e destinatário e informações do serviço contratado. Deverá ser afixado na
embalagem da encomenda para sua correta identificação e possibilitar, portanto, a sua
entrega.
Além disso, a padronização desse rótulo é necessária para facilitar a triagem automatizada
da encomenda no fluxo postal dos Correios.
Para mais detalhes consulte o Guia Técnico de Endereçamento de Encomendas dos
Correios:
https://correios.com.br/precisa-de-ajuda/como-enderecar-cartas-e-encomendas/guiatecnico-de-enderecamento-de-encomendas/at_download/file

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services

ANEXO 02 - Algoritmo Geração do dígito verificador
Exemplo de Algoritmo em Java:
/* Exemplo de cálculo do digito verificador em Java – Ex: numeroEtiqueta = "DL07798661BR" */
public static String geraEtiquetaComDigitoVerificador(String numeroEtiqueta) {
String prefixo = numeroEtiqueta.substring(0, 2);
String numero = numeroEtiqueta.substring(2, 10);
String sufixo = numeroEtiqueta.substring(10).trim();
String retorno = numero;
String dv;
Integer[] multiplicadores = {8, 6, 4, 2, 3, 5, 9, 7};
Integer soma = 0;
// Preenche número com 0 à
if(numeroEtiqueta.length()
retorno = "Error…";
}else if(numero.length() <
String zeros = "";
int diferenca = 8 -

esquerda
< 12){
8 && numeroEtiqueta.length() == 12){
numero.length();

for(int i=0; i dos métodos fechaPlp()
ou fechaPlpVariosServicos() é importante para verficar se as tags estão de acordo com o
que foi solicitado neste manual. No entanto, é apenas uma forma de diminuir um possível
erro no momento da postagem. O Schema só irá validar se o conteúdo da tag está dentro
do que foi solicitado neste manual, mas não servirá para validar se o conteúdo enviado no
XML é um dado válido.
Faça o download do XSD no endereço:
http://www.corporativo.correios.com.br/encomendas/sigepweb/doc/SIGEPWEB_VA
LIDADOR_XML_V2.XSD

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services

ANEXO 05 - Código da Diretoria Regional (tag )
Código

Descrição

Sigla

CS – Correios Sede

SE – ACRE

ACR

SE – ALAGOAS

SE – AMAZONAS

SE – AMAPÁ

SE – BAHIA

SE – BRASÍLIA

BSB

SE – CEARÁ

SE - ESPIRITO SANTO

SE – GOIÁS

SE – MARANHÃO

SE - MINAS GERAIS

SE - MATO GROSSO DO SUL

SE - MATO GROSSO

SE – PARÁ

SE – PARAÍBA

SE – PERNAMBUCO

SE – PIAUÍ

SE – PARANÁ

SE - RIO DE JANEIRO

SE - RIO GRANDE DO NORTE

SE – RONDONIA

SE – RORAIMA

SE - RIO GRANDE DO SUL

SE - SANTA CATARINA

SE – SERGIPE

SE - SÃO PAULO INTERIOR

SPI

SE - SÃO PAULO

SPM

SE- TOCANTINS

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services

ANEXO 06 - Código do Serviço Adicional
Cód.
Serviço
Adicional
001

Sigla

Descrição

Aviso de Recebimento

002

Mão Própria Nacional

017

Eleição – uso exclusivo em período Eleitoral e deve ser utilizado
somente por clientes que tem como objetivo realizar postagens
relacionadas as Eleições e devem utilizar os serviços de carta
registrada, Sedex e PAC. No rótulo deve ser impressa a descrição
“Eleições – art. 239 da lei 4.737/65”. Este serviço adicional será
utilizado pela ECT para fins de análise e monitoramento.
Segue exemplo:

019

Valor Declarado Nacional Premium e Expresso. Para os serviços
Premium e Expresso, sendo o valor mínimo a declarar R$ 18,50 e
valor máximo R$ 10.000,00

025

Registro Nacional

035

Carta Registrada com Valor Declarado

057

Grandes Formatos (GF)

064

Valor Declarado Nacional Standard. Sendo o valor mínimo a
declarar R$ 18,50 e valor máximo R$ 3.000,00

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services

ANEXO 07 – Categoria de serviços e símbolos de encaminhamento
Categoria

Descrição

Símbolo de encaminhamento

SEDEX Hoje
Premium

SEDEX 10
SEDEX 12

Expresso

SEDEX

Standard

PAC

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services

ANEXO 08 – Código Forma de Pagamento (tag )
Codigo

Forma_Pagamento
1

Vale Postal

Reembolso Postal

Contrato de Câmbio

Cartão de Crédito

Outros

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services

ANEXO 09 - Exemplo de Tabelas para Armazenamento em Banco de
dados
Para facilitar a gestão das informações geradas a partir da integração com esse web
services, a título de sugestão, a seguir consta um esquema de tabelas que o cliente poderá
criar em seu sistema para armazenar os dados a serem enviados e recebidos do web
services SIGEP WEB.

Exemplo de dados do modelo proposto:
Tb_Pedido
idPedido

notaFiscal

123456789

Tb_Pedido_Servico
idPedido

idServicosECT

codigoObjetoECT

124849

TE123456785AA

124884

TE123456785AB

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services
Tb_Servicos_ECT
idServicosECT

codigoServicoECT

descricaoServicoECT

124849

04162

SEDEX

124884

04669

PAC

Tb_Servicos_Cliente
idServicosECT

idCliente

124884

Tb_Cliente
idCliente
1
2

cartaoPostagem
0066000000
0066000001

contrato
9912200000
9912200001

cnpj
70111999000101
71111999000101

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services

ANEXO 10 – Voucher de Postagem ou Lista de Postagem e Aviso de
Recebimento-AR
O cliente poderá optar por imprimir o Voucher ou Lista de Postagem para acompanhar os
objetos postais quando do atendimento por meio de coleta domiciliária ou quando ele
mesmo entregá-los na unidade de atendimento e não aguardar presencialmente. Para
atendimentos presencias nas unidades de atendimento poderão ser apresentadas apenas
os objetos postais para a conclusão da postagem.

1- Voucher de Postagem:
É o relatório resumo do quantitativo dos objetos da PLP, conforme exemplo:

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services

2- Lista de Postagem:
É o relatório detalhado que consta todos os objetos postais da PLP, conforme exemplo:
Formato A4 – Retrato

3- Aviso de Recebimento (AR):
É o formuláro que ratifica a contratação do serviço adicional que possibilita a
comprovação física de recebimento do destinatário.

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services

ANEXO 11 - Visão do Processo de Integração
Visão Macro do processo de pré-postagem até o acompanhamento da encomenda no
fluxo postal dos Correios.

Para gerar a Pré-lista de Postagem (PLP) o cliente deve validar os dados que está enviando
para os Correios. Nas próximas imagens, mostramos os processos de validação, envio e
acompanhamento dos objetos.

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services
Validação do Cartão de Postagem:

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services
Validação do CEP:

Verificando se a disponibilidade do serviço:

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services
Criação de etiquetas:

Será de responsabilidade do cliente a requisição da quantidade de etiquetas, desta forma,
o uso deve ser consciente. O uso incorreto poderá prejudicar o consumo de outros usuários
do serviço de pré-postagem.

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services
Enviando os dados de Pré-Postagem:
Para enviar os dados de pré-postagem utiliza-se o método fechaPlpVariosServicos, este
método habilita a etiqueta nos sistemas dos Correios permitindo a postagem.

O processo de validação pelo XSD é somente estrutural, ou seja, não valida se o dado
enviado está correto, mas somente se as TAG obedecem a formatação.
O rótulo ou os relatórios, devem ser construídos pelo cliente que está desenvolvendo a
aplicação, seguindo o padrão recomendado pelos Correios, que é o Guia Técnico de
Endereçamento de Encomendas, vide anexo 01.

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services
Subprocesso “Produzir o XML com os dados de pré-postagem” (imagem anterior):
Este subprocesso tem a finalidade de mostrar a montagem do XML dentro da PLP,
lembrando que o método fechaPlpVariosServicos é um XML que está enviando outro XML,
portanto,

necessário

tal

como:

version="1.0" encoding="ISO-8859-1" ?>...

]]>

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services
Processo de Pós-postagem:

Método solicitaXmlPLP
Para consultar os dados da postagem, através do método solicitaXmlPLP, é possível obter
os dados de postagem.

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services
Método consultaSRO_NEW:
Método que consulta o rastreamento da encomenda.

Realizar a pesquisa diretamente no Web Services do Sistema de Rastreamento de Objetos
(SRO) dos Correios, permite um retorno mais rápido. Então a recomendação é utilizar o
WS do SRO.

Para acessar o WS do rastreamento: http://www.correios.com.br/a-a-z/pdf/rastreamentode-objetos/manual_rastreamentoobjetosws.pdf/at_download/file
Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services
Método bloquearObjeto:
O método de bloqueio dependerá do retorno de outros sistemas. Assim sendo se a
encomenda for postada corretamente o método conseguirá sinalizar a suspensão de
entrega com sucesso.

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services

ANEXO 12 – Termo De Condições De Prestação De Serviços De
Encomendas Nacionais
Ao implementar e utilizar o método web services de Solicitação de Suspensão de Entrega
de Encomenda ao Destinatário, o detentor do contrato com os Correios concorda com todas
as disposições do TERMO DE CONDIÇÕES DE PRESTAÇÃO DE SERVIÇOS DE
ENCOMENDAS

NACIONAIS,

disponível

http://www.correios.com.br/a-a-

z/pdf/termo-de-condicoes-de-prestacao-de-servicos-de-encomendas-nacionais/.

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

SIGEP WEB – Gerenciador de Postagens dos Correios
Manual para Integração via Web Services

ANEXO 13 – Calculador de preços e prazos de encomendas
O calculador de preços e prazos de encomendas dos Correios é destinado aos clientes que
possuem contrato de SEDEX e PAC, que necessitam calcular, no seu ambiente e de forma
personalizada, o preço e o prazo de entrega de uma encomenda. Para o cálculo acordado
em contrato os clientes deverão necessariamente informar em cada consulta o código
administrativo, a senha e o código de um ou mais serviços inerentes ao seu contrato.
Consulte o manual: http://www.correios.com.br/a-a-z/pdf/calculador-remoto-de-precos-eprazos/manual-de-implementacao-do-calculo-remoto-de-precos-e-prazos/at_download/file

***

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce
Revisão 24/10/2018

Source Exif Data:

File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.5
Linearized                      : No
Page Count                      : 57
Language                        : pt-BR
Tagged PDF                      : Yes
Title                           : SIGEP Web - Manual de Implementação do Web Service
Author                          : Luiza Guedes
Creator                         : Microsoft® Word 2013
Create Date                     : 2018:10:24 14:11:05-03:00
Modify Date                     : 2018:10:24 14:11:05-03:00
Producer                        : Microsoft® Word 2013

EXIF Metadata provided by EXIF.tools

SIGEP Web Manual De Implementação Do Service 2018 10 24 Implementacao

Navigation menu

Versions of this User Manual:

Views

Navigation