Вы находитесь на странице: 1из 11

Empresa Brasileira de Correios e Telgrafos

Sistema de Rastreamento de Objetos - SRO


GUIA TCNICO PARA IMPLEMENTAO
DO RASTREAMENTO DE OBJETOS VIA XML Verso 1.5
01 de Junho de 2011
Para automatizar o processo de retorno de informaes sobre o rastreamento de objetos,
o cliente pode conectar-se ao servidor do Sistema de Rastreamento de Objetos SRO e
obter detalhes (rastros) dos objetos postados fazendo uso do padro XML (eXtensible
Markup Language) para intercmbio das informaes.
Cada consulta ao sistema fornece informaes sobre o rastreamento de at 50 objetos
por conexo, sem limites de conexes.
O Cliente dever informar os nmeros dos objetos a rastrear atravs de uma conexo
HTTP (HyperText Transfer Protocol), acessando o endereo abaixo para processamento
do formulrio, via mtodo POST:
http://websro.correios.com.br/sro_bin/sroii_xml.eventos
O retorno da solicitao, provido pelo servidor SRO da ECT, ser no formato XML,
conforme descrio a seguir.

CONECTANDO O SERVIDOR DA ECT


Para ter acesso a este servio, o cliente dever:
1. Solicitar junto rea comercial da ECT a disponibilidade do servio;
2. Receber, da rea comercial, a autorizao para execuo do aplicativo,
juntamente com uma identificao de usurio e senha de conexo;
3. Implementar, em seus sistemas, as funcionalidades de conexo com o servidor
SRO. Cada consulta ao servidor SRO dever informar, obrigatoriamente:
Campo

Descrio

Usuario

Identificao do cliente.

Senha

Senha do cliente.

Tipo

Definio de como a lista de


identificadores de
objetos
dever ser interpretada pelo
servidor SRO.

Resultado

Delimitao do escopo da
resposta a ser dada consulta
do rastreamento de cada
objeto.

Valores
Informado pela rea comercial dos Correios na
ativao do servio.
Este campo diferencia letras maisculas e
minsculas (case-sensitive).
Informado pela rea comercial dos Correios na
ativao do servio.
Este campo diferencia letras maisculas e
minsculas (case-sensitive).
L: lista de objetos. O servidor far a consulta
individual de cada identificador informado;
F: intervalo de objetos. O servidor far a consulta
sequencial do primeiro ao ltimo objeto informado,
no sendo necessrio informar os valores
intermedirios.
T: sero retornados todos os eventos do objeto;
U: ser retornado apenas o ltimo evento do objeto.

Empresa Brasileira de Correios e Telgrafos


Sistema de Rastreamento de Objetos - SRO
Identificadores listados um aps o outro, sem
espaos ou outro smbolo separador. Ex:
Objetos

Lista de objetos a pesquisar.


SQ458226057BRRA132678652BR

Abaixo esto as regras para formao da lista de objetos a pesquisar:


1. Todos os identificadores objetos devero ter o formato padro de 13 (treze)
posies. Sendo duas letras para identificao do servio, 8 (oito) caracteres
numricos, 1 (um) dgito verificador e duas letras finais para identificao do pas.
Estes identificadores so informados pelos Correios na postagem da encomenda.
Ex:
SQ458226057BR
2. No poder haver espaos em branco, ou outros caracteres separadores, entre
um objeto e outro. Exemplo: para a pesquisa de 50 objetos ser criada uma string
de 650 caracteres (13 x 50).

RETORNO DAS INFORMAES


As informaes sero retornadas numa mensagem XML conforme o padro abaixo:
Elemento Pai
Versao
Qtd
TipoPesquisa
TipoResultado
Objeto

Evento

Elemento Filho

Numero
Tipo
Status
Data
Hora
Descrio
Comentrio
Local
Cdigo
Cidade
Uf

Descrio
Verso do SRO XML
Quantidade de objetos consultados
Lista ou intervalo de objetos
ltimo evento ou todos os eventos
Nmero do objeto enviado
Tipo do evento de retorno (vide lista a seguir)
Status do evento de retorno
Data do evento
Hora do evento
Descrio do evento
Um comentrio adicional sobre o evento
Local onde ocorreu o evento
CEP da unidade ECT
Cidade onde ocorreu o evento
Unidade da Federao

Observaes:

Os tipos e os status dos eventos so descritos no Anexo 1 deste manual, bem


como sugestes de aes a ser tomadas pelo cliente;

Os dados do recebedor s sero apresentados para os eventos de entrega


(tipo=BDE status=01). Pode haver casos em que estes dados no existam e,

Empresa Brasileira de Correios e Telgrafos


Sistema de Rastreamento de Objetos - SRO
portanto, no sero exibidos. Para o evento tipo=BDE status=11, poder, caso
exista, ser exibido o campo comentrio;

Para evitar uma quantidade excessiva de pesquisa, o cliente dever registrar, no


seu banco de dados, todos os objetos que tiveram seu rastreamento concludo.
Para isso, indicamos que todos os objetos que forem retornados com o
evento tipo BDE, BDI e BDR com status 01 esto com o rastro concludo.
No ser mais necessrio envi-los para novas consultas.

O cliente poder optar por gravar, na sua base de dados, todo o retorno relativo ao
objeto rastreado e/ou apenas alguns dos eventos. Por exemplo: somente a
entrega.

Abaixo est um exemplo de uma mensagem XML de retorno:


<?xml version="1.0" encoding="iso-8859-1" ?>
<sroxml>
<versao>1.0</versao>
<qtd>2</qtd>
<TipoPesquisa>Lista de Objetos</TipoPesquisa>
<TipoResultado>Todos os eventos</TipoResultado>
<objeto>
<numero>SQ458226057BR</numero>
<evento>
<tipo>BDE</tipo>
<status>01</status>
<data>05/07/2004</data>
<hora>11:56</hora>
<descricao>Entregue</descricao>
<local>CDD ALVORADA</local>
<codigo>94800971</codigo>
<cidade>ALVORADA</cidade>
<uf>RS</uf>
</evento>
<evento>
<tipo>OEC</tipo>
<status>01</status>
<data>05/07/2004</data>
<hora>09:04</hora>
<descricao>Saiu para entrega</descricao>
<local>CDD ALVORADA</local>
<codigo>94800971</codigo>
<cidade>ALVORADA</cidade>
<uf>RS</uf>
</evento>
</objeto>
</sroxml>

Empresa Brasileira de Correios e Telgrafos


Sistema de Rastreamento de Objetos - SRO
TESTES
Para apoiar o cliente em testes de conexo, fornecemos abaixo um simples cdigo HTML.
Este cdigo poder ser digitado e gravado num arquivo de nome sro_xml.html. Aps a
gravao do arquivo em qualquer pasta, basta ao clicar duas vezes no nome do arquivo e
em seguida no boto Ok.
ATENO: o usurio de teste s poder pesquisar 2 (dois) objetos.
<HTML>
<HEAD>
<TITLE>SRO - Pesquisa Objetos via XML</TITLE>
</HEAD>
<BODY>
<FORM name="frm1" method="post"
action="http://websro.correios.com.br/sro_bin/sroii_xml.eventos">
<input type="text" name="Usuario" value="ECT"><br>
<input type="text" name="Senha" value="SRO"><br>
<input type="text" name="Tipo" value="L"><br>
<input type="text" name="Resultado" value="U"><br>
<input size="60" width="60" type="text" name="Objetos"
value="SQ458226057BRRA132678652BR"><br>
<INPUT type="submit" value="OK">
</FORM>
</BODY>
</HTML>

Outros exemplos esto disponveis no Anexo 2 deste manual.

Empresa Brasileira de Correios e Telgrafos


Sistema de Rastreamento de Objetos - SRO
ANEXO 1 LISTA DE STATUS DE EVENTOS
A maior parte dos eventos informativa e no necessita de aes especficas por parte
do cliente. Os eventos relacionados etapa final da entrega so os mais relevantes e so
destacados na lista completa de eventos abaixo. A ltima coluna sugere o que apresentar
ao usurio do site, seja ele destinatrio ou remetente. Estas mensagens so compatveis
com as informaes exibidas no rastreamento de objetos no site dos Correios:
Tipos

Status

Descrio

Detalhe

O que o cliente deve


fazer
Finalizar a entrega.
No mais
necessrio prosseguir
com o
acompanhamento.
Acompanhar. O
destinatrio dever
buscar o objeto na
agncia.
Acompanhar. O
destinatrio no
buscou o objeto na
agncia durante o
perodo de guarda.

BDE
BDI
BDR

Entregue

Recebido por

BDE
BDI
BDR

Destinatrio
Ausente

Encaminhado para
entrega interna

BDE
BDI
BDR

No
procurado

Recusado

Em tratamento,
aguarde.

Acompanhar

Em devoluo

Motivo: falecido

Acompanhar o
retorno do objeto ao
remetente.

Destinatrio
desconhecido
no endereo

Em tratamento,
aguarde.

Acompanhar

Em tratamento,
aguarde.

Acompanhar

Em tratamento,
aguarde.

Acompanhar

BDE
BDI
BDR
BDE
BDI
BDR
BDE
BDI
BDR
BDE
BDI
BDR
BDE
BDI
BDR
BDE
BDI
BDR
BDE
BDI
BDR
BDE
BDI
BDE
BDI
BDR
BDE
BDI
BDR
BDE
BDI
BDR

7
8

Endereo
insuficiente
para entrega
No existe o
nmero
indicado

Extraviado

Confirmar com a
unidade

Acionar atendimento
dos Correios.

10

Destinatrio
mudou-se

Em tratamento,
aguarde.

Acompanhar

11

Outros

12

Refugado

Consulte a unidade

Acionar atendimento
dos Correios.

19

Endereo
incorreto

Poder haver atraso


ou devoluo ao
remetente

Acompanhar

20

Destinatrio
ausente

Ser realizada uma


nova tentativa de
entrega

Acompanhar

Acompanhar

O que mostrar no
site de resposta

Entregue

Destinatrio ausente
encaminhado para
entrega interna

No procurado

Recusado em
tratamento, aguarde.
Em devoluo
informaes [link para
atendimento].
Destinatrio
desconhecido no
endereo Em
tratamento, aguarde.
Endereo insuficiente
para entrega Em
tratamento, aguarde.
No existe o nmero
indicado Em
tratamento, aguarde.
Por favor, entre em
contato conosco [link
para atendimento].
Destinatrio mudouse Em tratamento,
aguarde.
Nada
Por favor, entre em
contato conosco [link
para atendimento].
Endereo incorreto
Poder haver atraso
ou devoluo.
Destinatrio ausente.
Ser realizada uma
nova tentativa de
entrega.

Empresa Brasileira de Correios e Telgrafos


Sistema de Rastreamento de Objetos - SRO
Tipos
BDE
BDI
BDR

Status

Descrio

Detalhe
O objeto est sendo
devolvido ao
remetente

O que o cliente deve


fazer

O que mostrar no
site de resposta
Destinatrio ausente.
O objeto est sendo
devolvido ao
remetente.
Reintegrado ao fluxo
postal Em
tratamento, aguarde.

21

Destinatrio
ausente

22

Reintegrado

Acompanhar

23

Distribudo ao
remetente

Acompanhar

Distribudo ao
remetente.

24

Disponvel em
Caixa Postal

Acompanhar

Disponvel na caixa
postal.

25

Empresa sem
Expediente

Acompanhar

Empresa sem
expediente.

BDE
BDI
BDR

26

No
procurado

BDE
BDI
BDR

27

Pedido no
solicitado

Acompanhar o
retorno do objeto ao
remetente.

BDE
BDI
BDR

28

Mercadoria
avariada

Acionar atendimento
dos Correios.

BDE
BDR

31

Extraviado

BDE
BDI
BDR

32

Entrega
programada

BDE
BDI
BDR
BDE
BDI
BDR
BDE
BDI
BDR
BDE
BDI
BDR

BDE
BDI
BDR
BDE
BDI
BDR
BDE
BDI
BDR
BDE
BDI
BDR

33

34

Devolvido ao
remetente

Consultar a unidade

Documenta
o no
fornecida pelo
destinatrio
Logradouro
com
numerao
irregular - Em
Pesquisa

Acompanhar

Acompanhar o
retorno do objeto ao
remetente.

Acionar atendimento
dos Correios.

No procurado O
objeto est sendo
devolvido ao
remetente.
Pedido no solicitado
O objeto est sendo
devolvido ao
remetente.
Por favor, entre em
contato conosco [link
para atendimento].
Por favor, entre em
contato conosco [link
para atendimento].

Acompanhar

Entrega programada.

Acompanhar

Documentao no
fornecida pelo
Destinatrio.

Acompanhar

Logradouro com
numerao irregular Em verificao,
aguarde.

35

Log. Reversa
Simultnea

Nova tentativa

Acompanhar

36

Log. Reversa
Simultnea

Devoluo da
Entrega

Acompanhar

BDI

40

Devolvido ao
Remetente

Importao no
autorizada

Acompanhar

BDE
BDI
BDR

41

Aguardando
parte do lote

Acompanhar

Logstica reversa
simultnea nova
tentativa.
Logstica reversa
simultnea
devoluo da entrega.
Devolvido ao
remetente
Importao no
autorizada.
Aguardando parte do
lote.

Empresa Brasileira de Correios e Telgrafos


Sistema de Rastreamento de Objetos - SRO
Tipos
BDE
BDI
BDR

Status
42

Descrio
Devolvido ao
remetente
Objeto
apreendido
por autoridade
competente
Falta
documento
para liberao
para retirada
interna

BDE
BDR

43

BDI
BDR

44

BDE
BDI
BDR

45

Resduo de
Mesa

46

Entrega no
efetuada

47

Erro de
lanamento

BDE
BDR

BDE
BDR

Detalhe

O que o cliente deve


fazer

Lote incompleto

Acompanhar o
retorno do objeto ao
remetente.

Devolvido ao
remetente Lote
incompleto.

Consultar a unidade

Acionar atendimento
dos Correios.

Por favor, entre em


contato conosco [link
para atendimento].

Consultar a unidade

Acionar atendimento
dos Correios.

Por favor, entre em


contato conosco [link
para atendimento].

Recebido na unidade
de distribuio

Acompanhar

Recebido na unidade
de distribuio.

Acompanhar

Entrega no efetuada.

Acompanhar

A sada do carteiro foi


cancelada. Ser
retomada o mais
breve possvel.

A entrega domiciliar
no pode ser
realizada por motivo
de fora maior.
Falha no lanamento
da encomenda na
lista de objetos
entregues ao carteiro.
A situao ser
regularizada pelos
Correios.
Endereo sem
distribuio
domiciliria e com
entrega interna no
autorizada pelo
remetente.

BDR
BDI

48

Posta
Restante no
Autorizada

BDE
BDR

50

Roubo a
Carteiro

Consultar a unidade

Acionar atendimento
dos Correios.

BDE
BDI
BDR

51

Roubo a
Veculo

Consultar a unidade

Acionar atendimento
dos Correios.

BDI
BDR

52

Roubo a
Unidade

Consultar a unidade

Acionar atendimento
dos Correios.

69

Extraviado

Consulte a unidade

Acionar atendimento
dos Correios.

Conferido

1
1

Encaminhado
Estornado
Devolvido a
pedido do
Cliente
Com entrega
agendada
Mal
encaminhado

BDE
BDI
BDR
CAR
CD
CMR
CO
CUN
DO
EST
FC

FC

FC

O que mostrar no
site de resposta

Acompanhar

Endereo sem
distribuio
domiciliria e com
entrega interna no
autorizada pelo
remetente.
Por favor, entre em
contato conosco [link
para atendimento].
Por favor, entre em
contato conosco [link
para atendimento].
Por favor, entre em
contato conosco [link
para atendimento].
Por favor, entre em
contato conosco [link
para atendimento].

Acompanhar

Nada

Encaminhado para
Evento errado

Acompanhar
Acompanhar

Nada
Nada

Em tratamento,
aguarde.

Acompanhar

Nada

Acompanhar

Nada

Acompanhar

Nada

Em tratamento,
aguarde.
Em tratamento,
aguarde.

Empresa Brasileira de Correios e Telgrafos


Sistema de Rastreamento de Objetos - SRO
Tipos

Status

Descrio

FC

Mal
endereado

FC

Reintegrado

FC

FC

IDC

IE

IT

LDI

LDI
LDI

2
8

OEC

PAR

15

PMT

PO

Postado - dh

RO

RO

99

TR

Encaminhado
Encaminhado(
estornado)
Trnsito

Restrio
Lanamento
Externo
Empresa sem
Expediente
Indenizado
Irregularidade
na expedio
Passagem
interna
Aguardando
retirada
Caixa Postal
Fiscalizao
Saiu para
entrega
Conferido
Partiu em
meio de
transporte

Detalhe
Em tratamento,
aguarde.
Em tratamento,
aguarde.

O que o cliente deve


fazer

O que mostrar no
site de resposta

Acompanhar

Nada

Acompanhar

Nada

Em tratamento,
aguarde.

Acompanhar

Nada

Em tratamento,
aguarde.

Acompanhar

Nada

Acompanhar

Nada

Acompanhar

Nada

Acompanhar

Nada

Acompanhar

Nada

Acompanhar
Acompanhar

Nada
Nada

Acompanhar

Nada

Recebido/destino

Acompanhar

Nada

Encaminhado para

Acompanhar

Nada

Acompanhar

Nada

Acompanhar

Nada

Acompanhar

Nada

Acompanhar

Nada

Em tratamento

Endereo:

Postagem depois do
horrio
Em trnsito para
Em trnsito para

Os tipos dos eventos correspondem a mecanismos de controle internos dos Correios,


sendo desnecessrio ao cliente o entendimento de seus detalhes:
Tipo
BDE
BDI
BDR
CAR
CD
CMR
CO
CUN
DO
EST
FC
IDC
IE
IT

Significado
Baixa de distribuio externa
Baixa de distribuio interna
Baixa Corretiva
Conferncia de lista de registro
Conferncia de nota de despacho
Conferncia de lista de registro
Coleta de objetos
Conferncia de lista de registro
Expedio de nota de despacho
Estorno
Funo complementar
Indenizao de objetos
Comunicao de irregularidade de expedio
Passagem interna de objetos

Empresa Brasileira de Correios e Telgrafos


Sistema de Rastreamento de Objetos - SRO
LDI
OEC
PAR
PMT
PO
RO
TR

Lista de distribuio interna


Lista de objetos entregues ao carteiro
Conferncia Unidade Internacional
Partida meio de transporte
Postagem (exceo)
Expedio de lista de registro
Trnsito

Empresa Brasileira de Correios e Telgrafos


Sistema de Rastreamento de Objetos - SRO
ANEXO 2 EXEMPLOS DE CONSULTAS
Qualquer linguagem de desenvolvimento com suporte a XML poder ser usada para
busca e traduo do retorno do rastreamento em XML.
Exemplo de conexo com VBScript
'Cria objeto de conexo
dim httpOb
set httpOb = Server.CreateObject("Microsoft.XMLHTTP")
'Abre conexo com o servidor do SRO especificando o arquivo de entrada
httpOb.Open "POST","http://websro.correios.com.br/sro_bin/sroii_xml.eventos", false, "", ""
'Se a conexo for aberta, estabelece o cabealho e envia o cdigo dos objetos
httpOb.setRequestHeader "Content-Type","application/x-www-form-urlencoded"
httpOb.Send "usuario=ECT&senha=SRO&tipo=L&Resultado=U&
objetos=SQ458226057BRRA132678652BRSX142052885BR
'Armazena a resposta do servidor
xml_out = httpOb.responseText
'Esvazia o objeto de conexo
set httpObj = nothing
'Fim da conexo

Exemplo de uma conexo com JAVAScript


// Cria objeto de conexo
var httpOb = Server.CreateObject("Microsoft.XMLHTTP");
var URL = http://websro.correios.com.br/sro_bin/sroii_xml.eventos;
// Abre conexo com o servidor do SRO especificando o arquivo de entrada
httpOb.Open("POST",URL, false, "", "");
//Se a conexo for aberta, estabelece o cabealho e envia o cdigo dos objetos
httpOb.setRequestHeader("Content-Type","application/x-www-form-urlencoded");
httpOb.Send "usuario=ECT&senha=SRO&tipo=L&Resultado=T&
objetos=SQ458226057BRRA132678652BRSX142052885BR
//Armazena a resposta do servidor
xml_out = httpOb.responseWrite;

Empresa Brasileira de Correios e Telgrafos


Sistema de Rastreamento de Objetos - SRO
Exemplo de uma conexo via aplicao Visual Basic
Para este tipo de conexo poder ser usado a OCX (Active Object Component) Inet ou o
prprio objeto DOM fornecido por Microsoft XML 3.0.
Dim objetos as string
Objetos = SQ458226057BRRA132678652BRSX142052885BR relao de objetos
Inet1.Execute "http://websro.correios.com.br/sro_bin/sroii_xml.eventos", _
"POST", _
"usuario=ECT&senha=SRO&tipo=L&resultado=T&objetos=" & objetos, _
"Content-Type: application/x-www-form-urlencoded"
While Inet1.StillExecuting
DoEvents
Wend
Private Sub Inet1_StateChanged(ByVal State As Integer)
Dim pToken As String
Dim pResp As String
If State = icResponseCompleted Then
Do
pToken = Inet1.GetChunk(1024, icString)
pResp = pResp & pToken
Loop While Len(pToken) <> 0
Call AnalisaResposta(pResp) os dados de rastreamento viro em pResp
End If
End Sub

Exemplo de uma conexo em JAVA


import
import
import
public

java.io.*;
java.net.*;
java.sql.*;
class GravaXML {

public void SaveXML(String mfile){


try {
File fileXML = new File(mfile);
String xmlin = MontaBusca();
URL url = new URL("http://websro.correios.com.br/sro_bin/sroii_xml.eventos ");
URLConnection connection = url.openConnection();
connection.setDoOutput(true);
connection.setUseCaches(false);
connection.setRequestProperty("Content-Type","application/x-www-form-urlencoded")
connection.setAllowUserInteraction(false);
PrintStream outStream = new PrintStream(connection.getOutputStream());
outStream.println("usuario=ECT&senha=SRO&tipo=L&resultado=T&objetos=" + xmlin);
outStream.close();
DataInputStream inStream = new DataInputStream(connection.getInputStream());
String inputLine;
FileWriter f = new FileWriter(fileXML);
while ((inputLine = inStream.readLine()) != null) {
f.write(inputLine);
}
f.close();
inStream.close();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
private String MontaBusca(){
String Objetos = ;
// dever ser feito uma pesquisa no banco de dados do Cliente e preencher a string
// objetos com o nmero dos objetos a serem pesquisados.
return Objetos;
}
}

Вам также может понравиться