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

User Manual:

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

Vice-presidência Comercial – Departamento de Negócios de Encomendas e E-Commerce

Revisão 24/10/2018

Manual para Integração via Web Services

SIGEP WEB – Gerenciador de Postagens dos Correios

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

Sumário

Introdução ................................................................................................................... 3

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

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

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 <numero_diretoria>) ...................... 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 <forma_pagamento>) ................... 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 Recebimento-

AR ............................................................................................................................. 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

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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.

SIGEP WEB – Gerenciador de Postagens dos Correios

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

O fluxo com a visão geral do processo de integração consta no ANEXO 11 deste

documento.

3. 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

Administrativo

Contrato

Código

Serviço

Cartão

CNPJ

sigep

n5f9t8

17000190

9992157880

***

0067599079

34028316000103

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

*** 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.

SIGEP WEB – Gerenciador de Postagens dos Correios

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

4. Métodos do Web Services do SIGEP WEB

Neste item estão descritos os métodos do web services do SIGEP WEB.

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

Tipo de

Dado

Descrição/Observação

Obrigatório

codAdministrativo

String(8)

Código Administrativo do contrato do

Cliente com os Correios.

Sim

numeroServico

String(5)

Códigos dos serviços contratados. Ex:

40215, 40290, 04162, 04669.

Sim

cepOrigem

String (8)

CEP de Origem sem hífen.Exemplo:

70002900

Sim

cepDestino

String (8)

CEP de Destino sem hífen

Sim

usuario

String

(Fornecido pelo Representante

Comercial dos Correios mediante carta

de solicitação.)

Sim

senha

String

Senha de autenticação. (Fornecida

pelo Representante Comercial dos

Correios mediante carta de solicitação)

Sim

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.

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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.

<soapenv:Envelope>

<soapenv:Header/>

<soapenv:Body>

<cli:verificaDisponibilidadeServico>

<usuario>sigep</usuario>

</cli:verificaDisponibilidadeServico>

</soapenv:Body>

</soapenv:Envelope>

Retorno:

<S:Envelope>

<S:Body>

<ns2:verificaDisponibilidadeServicoResponse>

</ns2:verificaDisponibilidadeServicoResponse>

</S:Body>

</S:Envelope>

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

<soapenv:Envelope>

<soapenv:Header/>

<soapenv:Body>

<cli:verificaDisponibilidadeServico>

<usuario>sigep</usuario>

</cli:verificaDisponibilidadeServico>

</soapenv:Body>

</soapenv:Envelope>

Retorno:

<S:Envelope>

<S:Body>

<ns2:verificaDisponibilidadeServicoResponse>

<return>-888#Erro ao calcular tarifa no SGPB. ERP-007: CEP de origem nao pode postar para

o CEP de destino informado(-1).</return>

</ns2:verificaDisponibilidadeServicoResponse>

</S:Body>

</S:Envelope>

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

SIGEP WEB – Gerenciador de Postagens dos Correios

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

e) Códigos e mensagens de erros*

Código de erro

Mensagem de erro

Processamento com sucesso

-2

CEP de origem inválido

-3

CEP de destino inválido

-33

Sistema temporariamente fora do ar. Favor tentar mais tarde.

-34

Código Administrativo ou Senha inválidos.

-35

Senha incorreta.

-36

Cliente não possui contrato vigente com os Correios.

-37

Cliente não possui serviço ativo em seu contrato.

-38

Serviço indisponível para este código administrativo.

-888

Erro ao calcular tarifa no SGPB**. ERP-007: CEP de origem nao pode postar para o

CEP de destino informado(-1).

001

Código de serviço inválido

006

Localidade de origem não abrange o serviço informado

007

Localidade de destino não abrange o serviço informado

008

Serviço indisponível para o trecho informado

009

CEP inicial pertencente a Área de Risco.

010

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.

011

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.

012

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.

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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

Tipo de

Dado

Descrição/Observação

Obrigatório

idContrato

String(10)

Número do contrato

Sim

idCartaoPostagem

String (10)

Cartão de postagem vinculado ao

contrato

Sim

usuario

String

(Fornecido pelo Representante

Comercial dos Correios mediante carta

de solicitação)

Sim

senha

String

Senha de autenticação. (Fornecida

pelo Representante Comercial dos

Correios mediante carta de solicitação)

Sim

c) Exemplo:

Consulta:

<soapenv:Envelope>

<soapenv:Header/>

<soapenv:Body>

<cli:buscaCliente>

<usuario>sigep</usuario>

</cli:buscaCliente>

</soapenv:Body>

</soapenv:Envelope>

Retorno:

<S:Envelope>

<S:Body>

<ns2:buscaClienteResponse>

<descricao>SEDEX - CONTRATO</descricao>

...

</cartoesPostagem>

</contratos>

</return>

</ns2:buscaClienteResponse>

</S:Body>

</S:Envelope>

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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:

<soapenv:Envelope>

<soapenv:Header/>

<soapenv:Body>

<cli:consultaCEP>

</cli:consultaCEP>

</soapenv:Body>

</soapenv:Envelope>

Retorno:

<S:Envelope>

<S:Body>

<ns2:consultaCEPResponse>

<bairro>Asa Norte</bairro>

<cidade>Brasília</cidade>

<end>SBN Quadra 1 Bloco A</end>

</return>

</ns2:consultaCEPResponse>

</S:Body>

</S:Envelope>

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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

Descrição/Observação

Obrigatório

String (10)

Número do Cartão de Postagem

vinculado ao contrato

Sim

String

(Fornecido pelo Representante

Comercial dos Correios mediante

carta de solicitação)

Sim

<senha>

String

Senha de autenticação. (Fornecida

pelo Representante Comercial dos

Correios mediante carta de

solicitação)

Sim

c) Retorno do Método:

Tag

Tipo

Normal / Cancelado

d) Exemplo:

Consulta:

<soapenv:Envelope>

<soapenv:Header/>

<soapenv:Body>

<cli:getStatusCartaoPostagem>

<usuario>sigep</usuario>

</cli:getStatusCartaoPostagem>

</soapenv:Body>

</soapenv:Envelope>

Retorno:

<S:Envelope>

<S:Body>

<ns2:getStatusCartaoPostagemResponse>

<return>Normal</return>

</ns2:getStatusCartaoPostagemResponse>

</S:Body>

</S:Envelope>

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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.

É 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.

a) Assinatura do método:

solicitaEtiquetas (tipoDestinatario, identificador, idServico, qtdEtiquetas, usuario, senha)

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.

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 faixa de etiquetas ficará reservada para o CNPJ informado.

SIGEP WEB – Gerenciador de Postagens dos Correios

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

b) Layout do Método:

Campo

Tipo de

Dado

Descrição/Observação

Obrigatório

tipoDestinatario

String (1)

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

Sim

Identificador

String (14)

CNPJ da empresa, informar somente os

números.

Sim

idServico

Long (6)

Id do serviço, porderá ser obtido no método

buscaCliente().

Sim

qtdEtiquetas

Int

Quantidade de etiquetas a serem solicitadas.

Permite solicitar 1 ou “n” números de etiqueta de

registro.

Sim

Usuário

String

Representante Comercial dos Correios mediante

carta de solicitação)

Sim

senha

String

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

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:

<soapenv:Envelope>

<soapenv:Header/>

<soapenv:Body>

<cli:solicitaEtiquetas>

</cli:solicitaEtiquetas>

</soapenv:Body>

</soapenv:Envelope>

Retorno:

<S:Envelope>

<S:Body>

<ns2:solicitaEtiquetasResponse>

</ns2:solicitaEtiquetasResponse>

</S:Body>

</S:Envelope>

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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

Tipo de

Dado

Descrição/Observação

Obrigatório

etiquetas

String(13)

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.

Sim

usuario

String

(Fornecido pelo Representante

Comercial dos Correios mediante carta

de solicitação)

Sim

senha

String

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:

<soapenv:Envelope>

<soapenv:Header/>

<soapenv:Body>

<cli:geraDigitoVerificadorEtiquetas>

<usuario>sigep</usuario>

</cli:geraDigitoVerificadorEtiquetas>

</soapenv:Body>

</soapenv:Envelope>

SIGEP WEB – Gerenciador de Postagens dos Correios

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

Retorno:

<S:Envelope>

<S:Body>

<ns2:geraDigitoVerificadorEtiquetasResponse>

</ns2:geraDigitoVerificadorEtiquetasResponse>

</S:Body>

</S:Envelope>

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.

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.

Vide especificação do layout do XML da PLP (ver alínea “f”

deste item) e exemplo na alínea “e” deste item.

Sim

idPlpCliente

Long (10)

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

Sim

cartaoPostagem

String (10)

Número do Cartão de Postagem, que é o código que

autoriza a postagem dos serviços no contrato.

Sim

listaEtiquetas

List<String>

Lista de objetos enviados via parâmetro sem o dígito

verificador, por exemplo:

List<String> listaEtiquetas = new ArrayList<String>();

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

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.

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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

Representante Comercial dos Correios mediante carta de

solicitação)

Sim

senha

String

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:

<soapenv:Envelope>

<soapenv:Header/>

<soapenv:Body>

<cli:fechaPlpVariosServicos>

<usuario>sigep</usuario>

</cli:fechaPlpVariosServicos>

</soapenv:Body>

</soapenv:Envelope>

Retorno:

<S:Envelope>

<S:Body>

<ns2:fechaPlpResponse>

</ns2:fechaPlpResponse>

</S:Body>

</S:Envelope>

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.

SIGEP WEB – Gerenciador de Postagens dos Correios

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

<?php

$clientSoap = new

SoapClient("https://apphom.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdl");

$xml = "<?xml version=\"1.0\" encoding=\"ISO-8859-

1\"?><correioslog><tipo_arquivo>Postagem</tipo_arquivo><versao_arquivo>2.3</versao_arquivo><plp><id_

plp /><valor_global

/><mcu_unidade_postagem/><nome_unidade_postagem/><cartao_postagem>0067599079</cartao_postagem></plp>

<remetente><numero_contrato>9992157880</numero_contrato><numero_diretoria>10</numero_diretoria><codi

go_administrativo>17000190</codigo_administrativo><nome_remetente><![CDATA[Empresa

Teste]]></nome_remetente><logradouro_remetente><![CDATA[Avenida

Central]]></logradouro_remetente><numero_remetente>2370</numero_remetente><complemento_remetente><![

CDATA[Sala 1205,

12°andar]]></complemento_remetente><bairro_remetente><![CDATA[Centro]]></bairro_remetente><cep_remet

ente>80002900</cep_remetente><cidade_remetente><![CDATA[Curitiba]]></cidade_remetente><uf_remetente>

PR</uf_remetente><telefone_remetente><![CDATA[4130795008]]></telefone_remetente><fax_remetente><![CD

ATA[4191239321]]></fax_remetente><email_remetente><![CDATA[cli@mail.com.br]]></email_remetente></rem

etente><forma_pagamento

/><objeto_postal><numero_etiqueta>SO000641962BR</numero_etiqueta><codigo_objeto_cliente/><codigo_ser

vico_postagem>41068</codigo_servico_postagem><cubagem>0,00</cubagem><peso>2500</peso><rt1/><rt2/><de

stinatario><nome_destinatario><![CDATA[Cliente2]]></nome_destinatario><telefone_destinatario><![CDAT

A[6232339644]]></telefone_destinatario><celular_destinatario><![CDATA[62991239321]]></celular_destin

atario><email_destinatario><![CDATA[cli2@mail.com.br]]></email_destinatario><logradouro_destinatario

><![CDATA[Avenida Central2]]></logradouro_destinatario><complemento_destinatario><![CDATA[Qd: 102 A

Lt:

04]]></complemento_destinatario><numero_end_destinatario>865</numero_end_destinatario></destinatario

><nacional><bairro_destinatario><![CDATA[Setor

Industrial]]></bairro_destinatario><cidade_destinatario><![CDATA[Goiânia]]></cidade_destinatario><uf

_destinatario>GO</uf_destinatario><cep_destinatario><![CDATA[74503100]]></cep_destinatario><codigo_u

suario_postal/><centro_custo_cliente/><numero_nota_fiscal>112233</numero_nota_fiscal><serie_nota_fis

cal/><valor_nota_fiscal/><natureza_nota_fiscal/><descricao_objeto><![CDATA[]]></descricao_objeto><va

lor_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>3000,00</valor_declarado></servico_adicional><dimens

ao_objeto><tipo_objeto>002</tipo_objeto><dimensao_altura>50,00</dimensao_altura><dimensao_largura>30

,00</dimensao_largura><dimensao_comprimento>60,00</dimensao_comprimento><dimensao_diametro>0,00</dim

ensao_diametro></dimensao_objeto><data_postagem_sara/><status_processamento>0</status_processamento>

<numero_comprovante_postagem/><valor_cobrado/></objeto_postal><objeto_postal><numero_etiqueta>SL9992

21795BR</numero_etiqueta><codigo_objeto_cliente/><codigo_servico_postagem>40096</codigo_servico_post

agem><cubagem>0,00</cubagem><peso>800</peso><rt1/><rt2/><destinatario><nome_destinatario><![CDATA[Cl

iente3]]></nome_destinatario><telefone_destinatario><![CDATA[6232339644]]></telefone_destinatario><c

elular_destinatario><![CDATA[62991239333]]></celular_destinatario><email_destinatario><![CDATA[cli3@

mail.com.br]]></email_destinatario><logradouro_destinatario><![CDATA[Avenida

Central3]]></logradouro_destinatario><complemento_destinatario><![CDATA[Qd: 102 A Lt:

04]]></complemento_destinatario><numero_end_destinatario>285</numero_end_destinatario></destinatario

><nacional><bairro_destinatario><![CDATA[Central]]></bairro_destinatario><cidade_destinatario><![CDA

TA[Goiânia]]></cidade_destinatario><uf_destinatario>GO</uf_destinatario><cep_destinatario><![CDATA[7

4503100]]></cep_destinatario><codigo_usuario_postal/><centro_custo_cliente/><numero_nota_fiscal>2244

55</numero_nota_fiscal><serie_nota_fiscal/><valor_nota_fiscal/><natureza_nota_fiscal/><descricao_obj

eto><![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_servi

co_adicional><codigo_servico_adicional>019</codigo_servico_adicional><valor_declarado>1000,00</valor

_declarado></servico_adicional><dimensao_objeto><tipo_objeto>002</tipo_objeto><dimensao_altura>40,00

</dimensao_altura><dimensao_largura>50,00</dimensao_largura><dimensao_comprimento>30,00</dimensao_co

mprimento><dimensao_diametro>0</dimensao_diametro></dimensao_objeto><data_postagem_sara/><status_pro

cessamento>0</status_processamento><numero_comprovante_postagem/><valor_cobrado/></objeto_postal></c

orreioslog>";

$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);

SIGEP WEB – Gerenciador de Postagens dos Correios

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

f) Especificação do Layout do XML

O layout é dividido nas seguintes tags:

<?xml version="1.0" encoding="ISO-8859-1" ?>

Encoding padrão dos Correios para o xml.

Observação: campo obrigatório

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

<tipo_arquivo>

Para este layout, deverá ser preenchido com a palavra Postagem

Observação: campo obrigatório

<versao_arquivo>

Identifica a versão do layout do arquivo XML. A versão deste layout é 2.3

Observação: campo obrigatório

Tag <plp>

Tags

Descrição

Tipo de dados

Observações

<id_plp>

Identifica o registro da PLP – Pré-lista de

Postagem que será retornada através do

método fechaPlpVariosServicos e será chave

para o atendimento nos Correios dos objetos

a serem postados.

Deverá obrigatoriamente ser declarada

vazia no XML, por exemplo: <id_plp />

Numérico(11)

É obrigatório o campo ficar

vazio, pois será preenchido

pelo retorno deste método.

<valor_global>

Valor em reais do total da tarificação dos

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

método solicitaXmlPlp, quando postada.

Numérico(10,2)

É obrigatório o campo ficar

vazio, pois será preenchido

pelo retorno deste método

<mcu_unidade_postagem>

Identifica a unidade de postagem dos

Correios.

Caractere(10)

É obrigatório o campo ficar

vazio, pois será preenchido

pelo retorno deste método

<nome_unidade_postagem>

Nome da unidade de postagem dos Correios.

Caractere(30)

É obrigatório o campo ficar

vazio, pois será preenchido

pelo retorno deste método

<cartao_postagem>

Numero do cartão do cliente associado à PLP.

Ex: 0067599079 (Com 10 caracteres,

incluindo os zeros à esquerda).

Caractere(10)

Preenchimento Obrigatório

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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(10)

Preenchimento

Obrigatório.

<numero_diretoria>

Número da Diretoria Regional do contrato do

cliente, conforme ANEXO 05.

Numerico(2)

Preenchimento

Obrigatório.

<codigo_administrativo>

Código administrativo do contrato

Caractere(8)

Preenchimento

Obrigatório

<nome_remetente>

Nome do remetente

Caractere(50)

Preenchimento

Obrigatório

<logradouro_remetente>

Logradouro do remetente.

Recomendado utilizar o método consultaCEP()

Caractere(50)

Preenchimento

Obrigatório

<numero_remetente>

Número do endereço do remetente

Caractere(5)

Preenchimento

Obrigatório

<complemento_remetente>

Complemento do endereço do remetente

Caractere(30)

Preenchimento não

obrigatório.

<bairro_remetente>

Bairro do remetente

Caractere(30)

Preenchimento

Obrigatório

<cep_remetente>

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_remetente>

Cidade do remetente

Caractere(30)

Preenchimento

Obrigatório

<uf_remetente>

Unidade de Federação

Caractere(2)

Preenchimento

Obrigatório

<telefone_remetente>

Telefone do remetente

Numérico (12)

Preenchimento não

obrigatório.

Formato:99999999999,

incluindo o DDD (2

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.

SIGEP WEB – Gerenciador de Postagens dos Correios

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

Tags

Descrição

Tipo de dados

Observações

<fax_remetente>

Fax do remetente

Numérico (12)

Preenchimento não

obrigatório.

Formato:99999999999,

incluindo o DDD (2

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_remetente>

Email do remetente

Caractere (50)

Preenchimento não

obrigatório.

<celular_remetente>

Celular do remetente

Numérico (12)

Preenchimento não

obrigatório.

Formato:99999999999,

incluindo o DDD (2

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 <forma_pagamento>

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: <forma_pagamento />

Ver ANEXO 08 deste manual.

Tag <objeto_postal >

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

<numero_etiqueta>

Código do objeto a ser postado.

Importante: Deverá constar no código

do objeto: Sigla do Tipo Postal (ex: DW)

+ número do objeto + digito verificador +

BR.

Caractere(13)

Preenchimento

Obrigatório

SIGEP WEB – Gerenciador de Postagens dos Correios

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

Tags

Descrição

Tipo de dados

Observações

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.

<codigo_objeto_cliente>

Código de controle do cliente

Caractere(20)

É obrigatório o campo

ficar vazio

<codigo_servico_postagem>

Código do serviço a ser utilizado na

postagem do objeto.

Obs: O código do serviço deve

corresponder ao tipo postal do código do

objeto. Ex: 04162, 04669

Caractere(5)

Preenchimento

obrigatório

Cubagem do Objeto (em centímetros

cúbicos)

Numérico(9,2)

Preencher com o valor

0,00

<peso>

Peso do objeto (em gramas)

Numérico(5)

Preenchimento

Obrigatório.

<rt1>

Reservado para observação do cliente

Caractere(255)

Preenchimento não

obrigatório.

<rt2>

Reservado para o SIGEP WEB

Caractere(255)

É obrigatório o campo

ficar vazio.

+ <destinatario>

Dados do destinatário

Preenchimento

Obrigatório.

+ <nacional>

Dados relevantes a postagem

Preenchimento

Obrigatório.

+ <servico_adicional>

Identifica os serviços adicionais do objeto

ANEXO 06

Preenchimento

Obrigatório.

+ <dimensao_objeto>

Deve conter as dimensões do objeto

(altura, largura, comprimento e diâmetro)

e o tipo do objeto (embalagem)

Preenchimento

Obrigatório.

<data_postagem_sara>

Deve conter a data de efetivação da

postagem.

É obrigatório o campo

ficar vazio.

<status_processamento>

Contém o STATUS do processamento do

objeto, deverá ser enviado a informação

com valor igual a “0”.

Caractere(1)

Preenchimento

Obrigatório.

<numero_comprovante_postagem>

Contém o numero de comprovante de

postagem.

Numérico(10)

É obrigatório o campo

ficar vazio.

<valor_cobrado>

Valor que foi tarifado no Sistema de

Atendimento dos Correios.

Numérico(10,2)

É obrigatório o campo

ficar vazio.

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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(50)

Preenchimento

Obrigatório.

<telefone_destinatario >

Telefone do Destinatário

Numérico (12)

Preenchimento não

obrigatório.

Formato:99999999999,

incluindo o DDD (2

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_destinatario>

Celular do Destinatário

Numérico (12)

Preenchimento não

obrigatório.

Formato:99999999999,

incluindo o DDD (2

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_destinatario>

Email do Destinatário

Caractere(50)

Preenchimento não

obrigatório.

<logradouro_destinatario>

Logradouro do destinatário.

Recomendado utilizar o método

consultaCEP()

Caractere(50)

Preenchimento

Obrigatório.

<complemento_destinatario>

Complemento do endereço

Caractere(30)

Preenchimento não

obrigatório.

<numero_end_destinatario>

Parte do endereço

Caractere(5)

Preenchimento

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.

SIGEP WEB – Gerenciador de Postagens dos Correios

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

Tags

Descrição

Tipo de dados

Observações

<bairro_destinatario>

Bairro do destinatário

Caractere(30)

Preenchimento Obrigatório.

<cidade_destinatario>

Cidade do destinatário

Caractere(30)

Preenchimento Obrigatório.

<uf_destinatario>

Sigla da UF do destinatário

Caractere(2)

Preenchimento Obrigatório

<cep_destinatario>

CEP do destinatário

Caractere(8)

Preenchimento Obrigatório

Formato: 99999999

Não pode existir espaço ou

qualquer caractere (Ex: hífen)

entre os números. Ex:01020030

<codigo_usuario_postal>

Código do usuário postal

Caractere(20)

Preenchimento não obrigatório.

<centro_custo_cliente>

Centro de custo do cliente

Caractere(20)

Preenchimento não obrigatório.

<numero_nota_fiscal>

Número da nota fiscal.

Numérico(7)

Preenchimento obrigatório se

houver nota fiscal.

<serie_nota_fiscal>

Série da nota fiscal.

Caractere(20)

Preenchimento não obrigatório.

<valor_nota_fiscal>

Valor da nota fiscal

Numérico(9,2)

Preenchimento não obrigatório.

<natureza_nota_fiscal>

Natureza da nota fiscal

Caractere(0)

Deverá ser enviada sem

preenchimento nenhum.

<descricao_objeto>

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 <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 (3)

Preenchimento Obrigatório.

O serviço adicional “025”, referente

ao registro, deve sempre ser

informado.

Casos os serviços postados pelo

cliente possuam outros serviços

adicionais, os códigos desses

serviços adicionais devem também

ser informados, ver ANEXO 06.

<valor_declarado>

Valor do seguro adicional declarado pelo

cliente.

Numérico (9,2)

Se o código do serviço adicional for

igual a “019” ou “064” o campo é

obrigatório, observando-se os

limites tarifários.

SIGEP WEB – Gerenciador de Postagens dos Correios

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

Tag <dimensão_objeto>

A tag <dimensao_objeto> deverá estar dentro da tag <objeto_postal> e conterá os

seguintes atributos:

Tags

Descriçã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 / Esférico

Caractere (3)

Preenchimento Obrigatório.

Para 001 – Não prencher as tags de dimensões.

Para 002 – Preencher as tags: altura, largura e

comprimento.

Para 003 – Preencher as tags: comprimento e

diâmetro.

<dimensao_altura>

Altura do objeto (em cm)

Numérico(9,2)

Para:

<tipo_objeto> = 001, preencher com “0”

<tipo_objeto> = 002, obrigatório

<tipo_objeto> = 003, preencher com “0”

<dimensao_largura>

Largura do objeto (em cm)

Numérico(9,2)

Para:

<tipo_objeto> = 001, preencher com “0”

<tipo_objeto> = 002, obrigatório

<tipo_objeto> = 003, preencher com “0”

<dimensao_comprimento>

Comprimento do objeto (em cm)

Numérico(9,2)

Para:

<tipo_objeto> = 001, preencher com “0”

<tipo_objeto> = 002, obrigatório

<tipo_objeto> = 003, obrigatório

<dimensao_diametro>

Diâmetro do objeto (em cm)

Numérico(9,2)

Para:

<tipo_objeto> = 001, preencher com “0”

<tipo_objeto> = 002, preencher com “0”

<tipo_objeto> = 003, obrigatório

g) Exemplo de XML da PLP

<?xml version="1.0" encoding="ISO-8859-1" ?>

<tipo_arquivo>Postagem</tipo_arquivo>

<versao_arquivo>2.3</versao_arquivo>

<plp>

<id_plp />

<valor_global />

<mcu_unidade_postagem/>

<nome_unidade_postagem/>

<cartao_postagem>0067599079</cartao_postagem>

</plp>

<numero_contrato>9992157880</numero_contrato>

<numero_diretoria>10</numero_diretoria>

<codigo_administrativo>17000190</codigo_administrativo>

<nome_remetente><![CDATA[Empresa Teste]]></nome_remetente>

<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[Capão Raso]]></bairro_remetente>

SIGEP WEB – Gerenciador de Postagens dos Correios

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

<cep_remetente><![CDATA[81150050]]></cep_remetente>

<cidade_remetente><![CDATA[Curitiba]]></cidade_remetente>

<uf_remetente>PR</uf_remetente>

<telefone_remetente><![CDATA[4133332222]]></telefone_remetente>

<fax_remetente><![CDATA[]]></fax_remetente>

<email_remetente><![CDATA[teste@email.com]]></email_remetente>

</remetente>

<forma_pagamento />

<objeto_postal>

<numero_etiqueta>PH185560916BR</numero_etiqueta>

<codigo_objeto_cliente/>

<codigo_servico_postagem>04669</codigo_servico_postagem>

<rt1/>

<rt2/>

<nome_destinatario><![CDATA[Fulano]]></nome_destinatario>

<telefone_destinatario><![CDATA[6233332222]]></telefone_destinatario>

<celular_destinatario><![CDATA[61999991111]]></celular_destinatario>

<email_destinatario><![CDATA[]]></email_destinatario>

<logradouro_destinatario><![CDATA[Rua Central]]></logradouro_destinatario>

<complemento_destinatario><![CDATA[Qd: 102]]></complemento_destinatario>

<numero_end_destinatario><![CDATA[8065]]></numero_end_destinatario>

</destinatario>

<bairro_destinatario><![CDATA[Setor Industrial]]></bairro_destinatario>

<cidade_destinatario><![CDATA[Goiânia]]></cidade_destinatario>

<uf_destinatario>GO</uf_destinatario>

<cep_destinatario><![CDATA[74503100]]></cep_destinatario>

<codigo_usuario_postal/>

<centro_custo_cliente/>

<numero_nota_fiscal>1424</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>200,00</valor_declarado>

</servico_adicional>

<dimensao_objeto>

<tipo_objeto>002</tipo_objeto>

<dimensao_altura>20,00</dimensao_altura>

<dimensao_largura>15,00</dimensao_largura>

<dimensao_comprimento>20,00</dimensao_comprimento>

<dimensao_diametro>0,00</dimensao_diametro>

</dimensao_objeto>

<data_postagem_sara/>

<status_processamento>0</status_processamento>

<numero_comprovante_postagem/>

<valor_cobrado/>

</objeto_postal>

</correioslog>

h) Orientações para a construção do XML

1. O XSD que efetua a validação do XML poderá ser consultado no ANEXO 04 deste

documento e deverá necessariamente validar o XML, antes de fechar a PLP.

2. Para cada tag, há uma observação, se na observação informa o preenchimento

obrigatório, é importante que o sistema proprietário valide tal critério.

SIGEP WEB – Gerenciador de Postagens dos Correios

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

3. Utilizar o <![CDATA[ ]]> nos campos texto, para evitar problemas com caracteres

especiais que podem corromper o xml (&, %, >, <, #, etc).

4. 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.

5. Para enviar o XML no método fechaPlpVariosServicos ou fechaPlp, retirar o dígito

verificador e espaços do código da etiqueta na assinatura do método. Também deve

ser seguido a mesma ordem das etiquetas no parâmetro, conforme enviado no XML.

6. 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 método getStatusCartaoPostagem() e obter todos

os serviços disponíveis no cartão através do método buscaCliente(). Essa consulta

é importante para evitar erros ao enviar uma lista de postagem num cartão com data

de vencimento já expirado.

7. O serviço postado deve estar associado ao cartão de postagem, informação obtida

através do método buscaCliente().

8. O número da etiqueta é obrigatório. Apenas objetos registrados podem ser postados.

Desta forma, o código adicional de número “025”, referente ao serviço adicional

“Registro”, deve sempre ser declarado na tag <codigo_servico_adicional> para cada

objeto postado.

9. As etiquetas utilizadas no arquivo devem pertencer ao cliente e a sigla deve estar

associada ao serviço a ser postado, informação obtida através do método

solicitaEtiquetas(). Se no XML a etiqueta informada for do serviço SEDEX, o código

do serviço deve ser também relacionado a este mesmo serviço SEDEX. Esse

relacionamento de serviço/código poderá ser consultado através do método

buscaCliente().

10. Todas as TAGS devem ser declaradas no XML, mesmo as não obrigatórias. Caso

não tenham conteúdo, devem ser declaradas vazias.

11. A homologação da comunicação entre sistema proprietário do cliente e os Correios

ocorrerá da seguinte forma: a) O cliente simulará, no ambiente de homologação, a

elaboração de uma PLP e a utilização do método fechaPlpVariosServicos para

obtenção do número da PLP; b) O cliente enviará ao representante comercial o

número da PLP retornado pelo método fechaPlpVariosServicos; c) O

SIGEP WEB – Gerenciador de Postagens dos Correios

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

representante comercial efetuará o teste de captação dessa PLP no sistema de

atendimento/operacional dos Correios e, se não houver nenhum erro, a

comunicação/homologação estará válida e o cliente poderá iniciar a utilização dos

serviços de pré-postagem em ambiente de produção. Recomendamos que o cliente,

antes de chamar o método fechaPlpVariosServicos, valide o XML usando um

schema XSD.

A validação do XML é 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

é verdadeiro ou não. O XSD está disponível no site

http://www.corporativo.correios.com.br/encomendas/sigepweb/ ou disponível no

ANEXO 04.

12. Haverá necessidade da homologação dos rótulos de endereçamento mediante teste

de leitura pelas máquinas de triagem dos Correios ou na unidade de atendimento.

Para isso, o cliente deverá imprimir um modelo de rótulo para cada serviço que

pretende utilizar e encaminhá-los ao represente comercial, que irá providenciar a

homologação. O endereço do leiaute padrão dos rótulos consta no ANEXO 01.

13. O rótulo dos Correios contempla a codificação 2D (DataMatrix). O layout do 2D

consta do ANEXO 03.

14. A partir do 01/08/2018, a tag rt2, passou de “Reservado para observação do cliente”

para “Reservado para o SIGEP WEB”, esta tag será de uso exclusivo da ECT.

SIGEP WEB – Gerenciador de Postagens dos Correios

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

4.8 Solicitação de XML da PLP

Este método retorna o mesmo xml da PLP que foi anteriormente enviada pelo cliente no

fechamento da PLP, sendo atualizado no ato da postagem dos objetos nos Correios, com

informações aferidas nas seguintes tags:

Tags

Descrição

Tipo de dados

<valor_global>

Valor da tarifação total da PLP.

Numérico(10,2)

<mcu_unidade_postagem>

Código da unidade de postagem dos Correios

Caractere(10)

<nome_unidade_postagem>

Nome da unidade de postagem dos Correios.

Caractere(30)

Cubagem do Objeto

Numérico(9,2)

<peso>

Peso do objeto (em gramas)

Numérico(5)

<dimensao_altura>

Altura do objeto (em cm)

Numérico(9,2)

<dimensao_largura>

Largura do objeto (em cm)

Numérico(9,2)

<dimensao_comprimento>

Comprimento do objeto (em cm)

Numérico(9,2)

<dimensao_diametro>

Diâmetro do objeto (em cm)

Numérico(9,2)

<data_postagem_sara>

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

automaticamente.

Caractere(8)

<status_processamento>

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

igual a “1”.

Caractere(1)

<numero_comprovante_postagem>

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

Atendimento dos Correios.

Numérico(10)

<valor_cobrado>

Valor que foi precificado no Sistema de Atendimento da Unidade dos

Correios para o objeto.

Numérico(10,2)

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

Usuário autenticador. (Fornecido pelo Representante

Comercial dos Correios)

Sim

senha

String

Senha de autenticação. (Fornecida pelo Representante

Comercial dos Correios)

Sim

c) Retorno do Método:

Campo

Tipo

return

Xml

d) Exemplo:

SIGEP WEB – Gerenciador de Postagens dos Correios

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

Consulta:

<soapenv:Envelope>

<soapenv:Header/>

<soapenv:Body>

<cli: solicitaXmlPlp>

<usuario>sigep</usuario>

</cli: solicitaXmlPlp>

</soapenv:Body>

</soapenv:Envelope>

Retorno:

<tipo_arquivo>Postagem</tipo_arquivo>

<versao_arquivo>2.3</versao_arquivo>

<plp>

<id_plp>24022403</id_plp>

<valor_global>3.6</valor_global>

<mcu_unidade_postagem>18484</mcu_unidade_postagem>

<nome_unidade_postagem>AC PRESIDENTE VARGAS</nome_unidade_postagem>

<cartao_postagem>0067599079</cartao_postagem>

</plp>

<numero_contrato>991220855</numero_contrato>

<numero_diretoria>50</numero_diretoria>

<codigo_administrativo>17000190</codigo_administrativo>

<nome_remetente><![CDATA[Correios - SEAD/GETER]]]]>><![CDATA[</nome_remetente>

<logradouro_remetente><![CDATA[Avenida Teste]]]]>><![CDATA[</logradouro_remetente>

<numero_remetente><![CDATA[3077]]]]>><![CDATA[</numero_remetente>

<complemento_remetente><![CDATA[15º Andar]]]]>><![CDATA[</complemento_remetente>

<bairro_remetente><![CDATA[Cidade Nova]]]]>><![CDATA[</bairro_remetente>

<cep_remetente><![CDATA[20210030]]]]>><![CDATA[</cep_remetente>

<cidade_remetente><![CDATA[Rio de Janeiro]]]]>><![CDATA[</cidade_remetente>

<uf_remetente>RJ</uf_remetente>

<telefone_remetente><![CDATA[2112345678]]]]>><![CDATA[</telefone_remetente>

<fax_remetente/>

<email_remetente/>

</remetente>

<forma_pagamento/>

<objeto_postal>

<numero_etiqueta>RU012345678BR</numero_etiqueta>

<codigo_objeto_cliente/>

<codigo_servico_postagem>10987</codigo_servico_postagem>

<rt1/>

<rt2/>

<nome_destinatario><![CDATA[Destinatário Teste]]]]>><![CDATA[</nome_destinatario>

<telefone_destinatario/>

<celular_destinatario/>

<email_destinatario/>

<logradouro_destinatario><![CDATA[Rua Teste]]]]>><![CDATA[</logradouro_destinatario>

<complemento_destinatario><![CDATA[Loja 123]]]]>><![CDATA[</complemento_destinatario>

<numero_end_destinatario><![CDATA[345]]]]>><![CDATA[</numero_end_destinatario>

</destinatario>

<bairro_destinatario><![CDATA[Centro]]]]>><![CDATA[</bairro_destinatario>

<cidade_destinatario><![CDATA[Rio de Janeiro]]]]>><![CDATA[</cidade_destinatario>

<uf_destinatario>RJ</uf_destinatario>

<cep_destinatario><![CDATA[20210900]]]]>><![CDATA[</cep_destinatario>

<codigo_usuario_postal/>

<centro_custo_cliente/>

<numero_nota_fiscal>0</numero_nota_fiscal>

<serie_nota_fiscal/>

<valor_nota_fiscal/>

<natureza_nota_fiscal/>

<descricao_objeto/>

<valor_a_cobrar>0,0</valor_a_cobrar>

</nacional>

SIGEP WEB – Gerenciador de Postagens dos Correios

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

<servico_adicional>

<codigo_servico_adicional>25</codigo_servico_adicional>

<codigo_servico_adicional>1</codigo_servico_adicional>

</servico_adicional>

<dimensao_objeto>

<tipo_objeto>1</tipo_objeto>

<dimensao_altura>0,00</dimensao_altura>

<dimensao_largura>0,00</dimensao_largura>

<dimensao_comprimento>0,00</dimensao_comprimento>

<dimensao_diametro>0,00</dimensao_diametro>

</dimensao_objeto>

<data_captacao>13/06/2016 17:17:01</data_captacao>

<data_postagem_sara>20160613</data_postagem_sara>

<status_processamento>1</status_processamento>

<numero_comprovante_postagem>1234567980</numero_comprovante_postagem>

<valor_cobrado>3.6</valor_cobrado>

</objeto_postal>

</correioslog>]]>

</return>

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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.

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

Código de controle do cliente da PLP enviada aos

Correios.

Sim

tipoBloqueio

String(15)

Para o tipo de bloqueio deve ser informado

(FRAUDE_BLOQUEIO)

Sim

acao

String(22)

Deverá ser informado no campos ação

(DEVOLVIDO_AO_REMETENTE)

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

b) Retorno do método:

Campo

Tipo

return

String -“Registro gravado”

c) Exemplo:

Consulta:

<soapenv:Envelope>

<soapenv:Header/>

<soapenv:Body>

<cli:bloquearObjeto>

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.

SIGEP WEB – Gerenciador de Postagens dos Correios

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

<tipoBloqueio>FRAUDE_BLOQUEIO</tipoBloqueio>

<acao>DEVOLVIDO_AO_REMETENTE</acao>

</cli:bloquearObjeto>

</soapenv:Body>

</soapenv:Envelope>

Retorno:

<soap:Envelope>

<soap:Body>

<ns2:bloquearObjetoResponse>

<return>Registro gravado</return>

</ns2:bloquearObjetoResponse>

</soap:Body>

</soap:Envelope>

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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/guia-

tecnico-de-enderecamento-de-encomendas/at_download/file

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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 à esquerda

if(numeroEtiqueta.length() < 12){

retorno = "Error…";

}else if(numero.length() < 8 && numeroEtiqueta.length() == 12){

String zeros = "";

int diferenca = 8 - numero.length();

for(int i=0; i<diferenca; i++){

zeros += "0";

}

retorno = zeros + numero;

}else{

retorno = numero.substring(0, 8);

}

for(int i=0; i<8; i++){

soma += new Integer(retorno.substring(i, (i+1))) * multiplicadores[i];

}

Integer resto = soma % 11;

if(resto == 0){

dv = "5";

}else if(resto == 1){

dv = "0";

}else{

dv = new Integer(11 - resto).toString();

}

retorno += dv;

retorno = prefixo + retorno + sufixo;

return retorno;

}

SIGEP WEB – Gerenciador de Postagens dos Correios

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

ANEXO 03 – Layout 2D – Data Matrix

Tamanho: 32 x 32

ITEM

CARACTERES

CEP destino

Complemento do CEP

CEP Origem

Complemento do CEP

Validador do CEP Destino

IDV

Etiqueta

Serviços Adicionais (ver tabela a seguir)

Cartão de Postagem

Código do Serviço

Informação de Agrupamento

Número do Logradouro

Complemento do Logradouro

Valor Declarado

DDD + Telefone Destinatário

Latitude

Longitude

Pipe “|”

Reserva para cliente

Complemento do CEP:

Número do logradouro.

Ex1: 00100

Ex2: 01200

Ex3: 00000 (Quando a informação for “S/N”, “BR 101”, “KM 5”)

Validador do CEP Destino:

Soma dos 8 dígitos do CEP de destino:

Quando o resultado não for uma soma de múltiplos de 10, subtrai-se o resultado da soma

do múltiplo de 10, imediatamente superior ao resultado.

SIGEP WEB – Gerenciador de Postagens dos Correios

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

Ex: CEP: 71010050  7+1+0+1+0+0+5+0 = 14

Subtrai-se 14 e 20.

O validador do CEP do exemplo é 6.

Quando o resultado da soma for múltiplos de 10, subtrai-se por ele mesmo.

Ex2: CEP: 05311000  0+5+3+1+1+0+0+0= 10

Subtrai-se 10 – 10.

O validador do CEP do exemplo é 0.

IDV – Identificador de Dados Variáveis:

Identificador do serviço que está sendo utilizado.

IDV

Identificação da Aplicação

Uso do Campo Variável

Encomenda

Registro com serviço adicional

Malotes

Registro com serviço adicional

Serviços Adicionais: É obrigatório informar o código 25 de serviço adicional. Para as

demais posições, quando não possuir o serviço adicional, deverá ser preenchido com 00.

Ex1: 250102194957 – Possui os seguintes serviços adicionais: 25, 01, 02, 19, 49 e 57

Ex2: 250102190000 – Possui os seguintes serviços adicionais: 25, 01, 02, 19. As demais

posições estã preenchidas com 00.

Ex3: 250000000000 -- Quando não possuir nenhum serviço adicional.

Cód. Serviço Adicional

Descrição

001

Aviso de Recebimento

002

Mão Própria Nacional

017

Eleição

019

Valor Declarado Nacional Premium e Expresso

025

Registro Nacional

057

Grandes Formatos (GF)

064

Valor Declarado Nacional Standard

Informação de Agrupamento: (Número identificador do agrupamento da PLP)

Ex1. PLP: 101515 (Nesta PLP temos sete objetos, sendo: Três objetos do agrupamento

com identificador 01, Dois objetos sem agrupamentos e dois objetos do agrupamento com

identificador 02).

Etiqueta PH297898690BR – Agrupamento 01

Etiqueta PH297898709BR – Agrupamento 01

Etiqueta PH297898712BR – Agrupamento 01

Etiqueta PH297898712BR

Etiqueta PH297898726BR

Etiqueta PH297898730BR – Agrupamento 02

SIGEP WEB – Gerenciador de Postagens dos Correios

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

Etiqueta PH297898743BR – Agrupamento 02

OBS.: A postagem agrupada deverá ocorrer quando existir mais de um volume para o

mesmo destinatário / logradouro no serviço de PAC e a numeração dos objetos

agrupados terá etiquetas seqüências.

Número do Logradouro: Número do endereço.

Complemento do Endereço: Informação adicional do endereço

Ex1: Casa 100 Bl 2

Ex2: Ap 1000

Ex3: BL II AP 1000

Valor Declarado: Número inteiro.

Ex: 00100

Ex: 01000

Ex: 10000

DDD + Telefone Destinatário: Número do telefone do destinatário

Ex1: 011999253224

Ex2: 000000000000 – Quando não existe a informação

Latitude: Resevado para futura implementação. Preencher com -00.000000

Longitude: Resevado para futura implementação. Preencher com -00.000000

SIGEP WEB – Gerenciador de Postagens dos Correios

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

ANEXO 04 – Validação do XML utilizando o Schema XSD

A validação do XML que será colocada dentro da tag <xml> 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

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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

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

SIGEP WEB – Gerenciador de Postagens dos Correios

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

ANEXO 06 - Código do Serviço Adicional

Cód.

Serviço

Adicional

Sigla

Descrição

001

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

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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

Categoria

Descrição

Símbolo de encaminhamento

Premium

SEDEX Hoje

SEDEX 10

SEDEX 12

Expresso

SEDEX

Standard

PAC

SIGEP WEB – Gerenciador de Postagens dos Correios

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

ANEXO 08 – Código Forma de Pagamento (tag <forma_pagamento>)

Codigo

Forma_Pagamento

Vale Postal

Reembolso Postal

Contrato de Câmbio

Cartão de Crédito

Outros

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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

Tb_Pedido_Servico

idPedido

idServicosECT

codigoObjetoECT

124849

TE123456785AA

124884

TE123456785AB

idPedido

notaFiscal

123456789

SIGEP WEB – Gerenciador de Postagens dos Correios

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

Tb_Servicos_ECT

idServicosECT

codigoServicoECT

descricaoServicoECT

124849

04162

SEDEX

124884

04669

PAC

Tb_Servicos_Cliente

idServicosECT

idCliente

124884

Tb_Cliente

idCliente

cartaoPostagem

contrato

cnpj

0066000000

9912200000

70111999000101

0066000001

9912200001

71111999000101

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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:

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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.

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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.

SIGEP WEB – Gerenciador de Postagens dos Correios

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

Validação do Cartão de Postagem:

SIGEP WEB – Gerenciador de Postagens dos Correios

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

Validação do CEP:

Verificando se a disponibilidade do serviço:

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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.

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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.

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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 o uso do CDATA dentro da tag <xml>, tal como:

<xml><![CDATA[<?xml version="1.0" encoding="ISO-8859-1" ?><correioslog>...

</correioslog>]]></xml>

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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.

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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/rastreamento-

de-objetos/manual_rastreamentoobjetosws.pdf/at_download/file

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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.

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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 em http://www.correios.com.br/a-a-

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

SIGEP WEB – Gerenciador de Postagens dos Correios

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

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-e-

prazos/manual-de-implementacao-do-calculo-remoto-de-precos-e-prazos/at_download/file

***

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

Navigation menu

Versions of this User Manual:

Views

Navigation