Página 1 de 34

TranspoFrete
Manual de Integrações
Versão 7.0
Página 2 de 34

Índice

1. REMESSA – INTEGRAÇÃO VIA WEBSERVICES ........................................ 4

1.1 AUTENTICAÇÃO .................................................................................... 5

1.1.1 OPERAÇÃO GET................................................................................... 5
1.1.2 OPERAÇÃO POST + JSON ..................................................................... 6
1.1.3 OPERAÇÃO POST + JSON COMO PARÂMETRO ........................................... 6
1.2 GERAÇÃO DE PRÉ-NOTAS FISCAIS ............................................................. 6
1.2.1 OPERAÇÃO GET................................................................................... 7
1.2.2 OPERAÇÃO POST + JSON ..................................................................... 8
1.2.3 OPERAÇÃO POST + JSON COMO PARÂMETRO ........................................... 9
1.3 AGENDAMENTO ................................................................................. 10
1.3.1 OPERAÇÃO GET................................................................................. 10
1.3.2 OPERAÇÃO POST + JSON ................................................................... 11
1.3.3 OPERAÇÃO POST + JSON COMO PARÂMETRO ......................................... 11
1.4 CONFIRMAÇÃO DE EMBARQUE ............................................................... 11
1.4.1 OPERAÇÃO GET................................................................................. 13
1.4.2 OPERAÇÃO POST + JSON ................................................................... 13
1.4.3 OPERAÇÃO POST + JSON COMO PARÂMETRO ......................................... 14
1.5 SIMULAÇÃO ...................................................................................... 14
1.5.1 OPERAÇÃO POST + JSON ................................................................... 15
1.6 GERAÇÃO DE CARGAS .......................................................................... 16
1.6.1 OPERAÇÃO POST + JSON ................................................................... 17
1.7 RASTREAMENTO ................................................................................. 18
1.7.1 OPERAÇÃO GET................................................................................. 19
1.7.2 OPERAÇÃO POST + JSON ................................................................... 19
1.8 UPLOAD DE XML ............................................................................... 20
1.8.1 OPERAÇÃO POST .............................................................................. 20
1.9 DOWNLOAD DO PDF DO DANFE ........................................................... 21
1.9.1 OPERAÇÃO GET................................................................................. 21
1.10 DOWNLOAD DO XML DA NOTA FISCAL .................................................. 22
1.10.1 OPERAÇÃO GET............................................................................... 22
1.11 DOWNLOAD DO XML DE EVENTOS ....................................................... 23
Página 3 de 34

1.11.1 OPERAÇÃO GET............................................................................... 23

1.12 DETALHES DA NOTA FISCAL 1 .............................................................. 24
1.12.1 OPERAÇÃO POST + JSON ................................................................. 24

2. REMESSA – INTEGRAÇÃO VIA MÓDULO REMOTO .............................. 29

3. RETORNO – INTEGRAÇÃO VIA MÓDULO REMOTO ............................. 31

3.1 MENSAGEM DE SELEÇÃO DE TRANSPORTADORA .......................................... 32

3.2 MENSAGEM DE ACEITE DE FATURA .......................................................... 32
Página 4 de 34

1. Remessa – Integração via WebServices

WebServices são recursos utilizados na integração de sistemas,
comunicando diferentes aplicações. No TranspoFrete, todas as integrações
de remessa (sentido ERP, TranspoFrete) fazem uso deste recurso.

Neste modelo de integração, não é necessária instalação que quaisquer

aplicativos para comunicação entre o sistema ERP e o TranspoFrete. O
TranspoFrete utiliza a tecnologia REST com as operações GET e POST, ou
seja, não é necessário que o sistema ERP possua suporte ao protocolo
SOAP.

A tecnologia REST faz uso de um padrão de URL para determinar as

chamadas, sendo mais simples e abrangendo uma gama maior de clients.
Chamadas HTTP/HTTPS estão presentes na maioria das plataformas de
desenvolvimento, sendo este o principal motivo da utilização desta
tecnologia.

No TranspoFrete, a integração ocorre em dois passos: inicialmente, se torna

necessária a chamada de um serviço de autenticação, para aquisição do
token de identificação (capítulo 1.1). Na sequência, utilizando do token de
identificação, é efetuada a chamada da operação desejada (capítulo 1.2 e
subsequentes).

A imagem abaixo descreve o processo de integração via WebServices:

1º Passo

Credenciais Credenciais

Internet
Token Token

Sistema ERP

2º Passo

Chamada + Token Chamada + Token

Internet
Resultado Resultado

Sistema ERP
Página 5 de 34

Todas as solicitações via WebService presentes no sistema fazem uso deste

modelo de integração, em dois passos.

1.1 Autenticação
Este método é responsável pelo fornecimento dos tokens de identificação,
a partir das credenciais informadas na chamada do serviço. Para cada
chamada deste método é criada uma nova sessão no sistema, sendo que,
se houver uma nova chamada com o mesmo usuário a sessão anterior é
invalidada.

O token de identificação deverá complementar a chamada de outros

métodos, podendo ser utilizado inclusive em mais de uma chamada.
Contudo, após 15 (quinze) minutos de inatividade a sessão será expirada e
o token de identificação será consequentemente cancelado.

Para este serviço estão disponíveis as operações GET, POST + JSON e POST
+ JSON como parâmetro. Os capítulos subsequentes explanam cada tipo de
operação.

1.1.1 Operação GET

Este é o modelo mais simples de operação, visto que todos os parâmetros

são apontados na própria URL, constituindo o próprio endereço. Os
parâmetros são carregados por ordem e separados por barra, ou seja, o
primeiro parâmetro especifica o login e o segundo parâmetro especifica a
senha.

Existe limitação, por parte do próprio protocolo HTTP, que determina o

número máximo de caracteres para a operação GET. Para este tipo de
operação, a URL não pode ultrapassar 255 caracteres. Esta restrição não
existe para operação POST.

O quadro abaixo apresenta a especificação do método:

Anotação http://frete.transpobrasil.com.br/api/auth/login/usuario/senha
Exemplo http://frete.transpobrasil.com.br/api/auth/login/transpo.user/PaSSw0rd
Retorno em caso de sucesso 29491395A890FF87E9709570559A5633
Retorno em caso de erro de autenticação Usuario ou senha invalidos
Página 6 de 34

1.1.2 Operação POST + JSON

Diferentemente da operação GET, o usuário e senha não são apontados na

URL da chamada, mas sim no corpo da requisição. No corpo da requisição,
o TranspoFrete faz uso da anotação JSON para descrição dos parâmetros.

O quadro abaixo apresenta a especificação do método:

URL: http://frete.transpobrasil.com.br/api/auth/login
Anotação
Content: {"login" : "usuario", "senha" : "senha"}
URL: http://frete.transpobrasil.com.br/api/auth/login
Exemplo
Content: {"login" : "transpo.user", "senha" : "PaSSw0rd"}
Retorno em caso de sucesso 29491395A890FF87E9709570559A5633
Retorno em caso de erro de autenticação Usuario ou senha invalidos

1.1.3 Operação POST + JSON como parâmetro

Esta operação é semelhante à operação POST + JSON, contudo, o conteúdo

do corpo da requisição sofre uma pequena alteração. Ao invés de utilizar a
anotação JSON diretamente, o TranspoFrete faz uso do parâmetro json
para, na sequência, descrever o conteúdo da mensagem.

O quadro abaixo apresenta a especificação do método:

URL: http://frete.transpobrasil.com.br/api/auth/loginParam
Anotação
Content: json={"login" : "usuario", "senha" : "senha"}
URL: http://frete.transpobrasil.com.br/api/auth/loginParam
Exemplo
Content: json={"login" : "transpo.user", "senha" : "PaSSw0rd"}
Retorno em caso de sucesso 29491395A890FF87E9709570559A5633
Retorno em caso de erro de autenticação Usuario ou senha invalidos

1.2 Geração de Pré-Notas Fiscais

Esta operação é responsável pela geração de Pré-Notas Fiscais no sistema.
Para o TranspoFrete, uma Pré-Nota Fiscal pode ser um pedido de venda,
um pedido de compra, ou qualquer outro documento que anteceda a
emissão da Nota Fiscal.
Página 7 de 34

Tem como objetivo principal servir de instrumento para seleção antecipada

da transportadora, em casos em que se deseja simular o frete com
transportadoras diferentes antes da emissão da Nota Fiscal.

O quadro abaixo apresenta as informações necessárias para geração de

uma Pré-Nota Fiscal no TranspoFrete:

Campo Tipo Descrição Obrigatório Observação

numero Numérico Número da Pré-Nota Fiscal Sim
serie Caractere Série da Pré-Nota Fiscal Não
dataEmissao Data Data de emissão da Pré-Nota Fiscal Sim Formato DDMMYYYY
valor Decimal Valor da Pré-Nota Fiscal Sim Formato 0.00
valorProdutos Decimal Valor dos produtos da Pré-Nota Fiscal Não Formato 0.00
peso Decimal Peso nominal total Sim Formato 0.00
substituicaoTributaria Booleano Indicador de substituição tributária Sim S = Sim/TRUE, N = Não/FALSE
Valor da cubagem total da Pré-Nota
cubagem Decimal Não Formato 0.00
Fiscal

destinatario Caractere CPF ou CNPJ do destinatário Sim Sem máscara e com zeros a esquerda

ieDestinatario Caractere Inscrição Estadual do destinatário Não Sem máscara

nomeDestinatario Caractere Razão Social do destinatário Não
Frete CIF = destino, Frete FOB =
cep Numérico CEP do destino ou origem Sim
origem

transporadora Caractere CNPJ da transportadora Não Sem máscara e com zeros a esquerda

codigoProduto CaractereCódigo do produto predominante Não

Quantidade de volumes da Pré-Nota
quantidadeVolumes Numérico Não
Fiscal
tipoOperacao Numérico Indicador de Entrada ou Saída Sim Entrada = 0, Saída = 1
Por conta do emitente = 0, Por conta
modalidadeFrete Numérico Indicador da Modalidade do Frete Sim do destinatário = 1, Por conta de
terceiros = 2, Sem Frete = 9
IA = Incluir e Alterar, C = Cancelar, T =
acao Caractere Indicador da Ação Sim
Transportadora Definida

Os campos sinalizados acima deverão ser informados independentemente

da operação escolhida. Para este serviço estão disponíveis as operações
GET, POST + JSON e POST + JSON como parâmetro. Os capítulos
subsequentes explanam cada tipo de operação.

1.2.1 Operação GET

Este é o modelo mais simples de operação, visto que todos os parâmetros

são apontados na própria URL, constituindo o próprio endereço. Os
parâmetros são carregados por ordem e separados por barra, ou seja, o
primeiro parâmetro especifica o número, o segundo parâmetro especifica
Página 8 de 34

a série, o terceiro parâmetro especifica a data de emissão e assim por

diante.

Existe limitação, por parte do próprio protocolo HTTP, que determina o

número máximo de caracteres para a operação GET. Para este tipo de
operação, a URL não pode ultrapassar 255 caracteres. Esta restrição não
existe para operação POST.

Caso algum parâmetro não obrigatório não pertença à regra de negócio da

empresa, ele não poderá ser suprimido. Nestes casos, deverá ser utilizada
a tabela abaixo:
Campo Tipo Caso não haja valor
serie Caractere "%20"
valorProdutos Decimal "0.00"
cubagem Decimal "0.00"
ieDestinatario Caractere "%20"
nomeDestinatario Caractere "%20"
transporadora Caractere "00000000000000"
codigoProduto Caractere "0"
quantidadeVolumes Numérico "0"

O quadro abaixo apresenta a especificação do método:

http://frete.transpobrasil.com.br/api/prenota/gravarPreNota/numero/serie/dataEmissao/va
lor/valorProdutos/peso/cubagem/destinatario/ieDestinatario/nomeDestinatario/cepDestina
Anotação
tario/transportadora/substituicaoTributaria/codigoProduto/quantidadeVolumes/tipoOperac
ao/modalidadeFrete/acao?token=token

http://frete.transpobrasil.com.br/api/123461/1/05032014/130.99/130.99/14.8/5.8/102966
Exemplo 49000161/1234567890/Teste/89040498/88085485001500/N/1/1/1/1/I?token=29491395A8
90FF87E9709570559A5633
Retorno em caso de sucesso {"status"="GRAVADO"}
Retorno em caso de erro {"status"="ERRO", "mensagem"="Mensagem de erro"}

1.2.2 Operação POST + JSON

Diferentemente da operação GET, as informações da Pré-Nota Fiscal não

são passadas na URL da chamada, mas sim no corpo da requisição. No corpo
Página 9 de 34

da requisição, o TranspoFrete faz uso da anotação JSON para descrição dos

parâmetros.

Nesta operação, caso o parâmetro não seja obrigatório e não pertença à

regra de negócio da empresa, ele poderá ser suprimido.

O quadro abaixo apresenta a especificação do método:

URL: http://frete.transpobrasil.com.br/api/prenota/gravarPreNota?token=token
Anotação
Content: {parametros...}

URL:
http://frete.transpobrasil.com.br/api/prenota/gravarPreNota?token=29491395A890FF87E9
709570559A5633
Content: {"numero" : 123460, "serie" : "1", "dataEmissao" : "05032014", "valor" : 126.56,
Exemplo
"valorProdutos" : 121.50, "peso" : 14.7, "cubagem" : 0.74, "destinatario" :
"10296649000155", "nomeDestinatario" : "G2KA Sistemas LTDA", "cep" : 89026440,
"transportadora" : "88085485001500", "substituicaoTributaria" : "S", "codigoProduto" : "1",
"tipoOperacao" : 1, "modalidadeFrete" : 1, "acao" : "IA"}

Retorno em caso de sucesso {"status"="GRAVADO"}

Retorno em caso de erro {"status"="ERRO", "mensagem"="Mensagem de erro"}

1.2.3 Operação POST + JSON como parâmetro

Esta operação é semelhante à operação POST + JSON, contudo, o conteúdo

do corpo da requisição sofre uma pequena alteração. Ao invés de utilizar a
anotação JSON diretamente, o TranspoFrete faz uso do parâmetro json
para, na sequência, descrever o conteúdo da mensagem.

O quadro abaixo apresenta a especificação do método:

URL: http://frete.transpobrasil.com.br/api/prenota/gravarPreNota?token=token
Anotação
Content: json={parametros...}

URL:
http://frete.transpobrasil.com.br/api/prenota/gravarPreNota?token=29491395A890FF87E9
709570559A5633
Content: json={"numero" : 123460, "serie" : "1", "dataEmissao" : "05032014", "valor" :
Exemplo
126.56, "valorProdutos" : 121.50, "peso" : 14.7, "cubagem" : 0.74, "destinatario" :
"10296649000155", "nomeDestinatario" : "G2KA Sistemas LTDA", "cep" : 89026440,
"transportadora" : "88085485001500", "substituicaoTributaria" : "S", "codigoProduto" : "1",
"tipoOperacao" : 1, "modalidadeFrete" : 1, "acao" : "IA"}

Retorno em caso de sucesso {"status"="GRAVADO"}

Retorno em caso de erro {"status"="ERRO", "mensagem"="Mensagem de erro"}
Página 10 de 34

1.3 Agendamento
Para calculo da Previsão de Entrega de determinada Nota Fiscal, são levados
em consideração: data de embarque, o prazo de entrega cadastrado, dias
de entrega e dias úteis. A Previsão de Entrega é apresentada em alguns
relatórios, BI e rotina de Rastreamento.

Quando existe agendamento de entrega para determinada Nota Fiscal, a

Previsão de Entrega é atualizada, com o objetivo de não prejudicar o
Transportador e consequentemente manter a integridade das informações.
Além da possibilidade de apontamento manual através do TranspoFrete,
existe integração via WebService para apontamento do próprio sistema
ERP.

Para este serviço estão disponíveis as operações GET, POST + JSON e POST
+ JSON como parâmetro. Os capítulos subsequentes explanam cada tipo de
operação.

1.3.1 Operação GET

Este é o modelo mais simples de operação, visto que todos os parâmetros

são apontados na própria URL, constituindo o próprio endereço. Os
parâmetros são carregados por ordem e separados por barra, ou seja, o
primeiro parâmetro especifica a chave de acesso da nota fiscal e o segundo
parâmetro a data de agendamento.

Existe limitação, por parte do próprio protocolo HTTP, que determina o

número máximo de caracteres para a operação GET. Para este tipo de
operação, a URL não pode ultrapassar 255 caracteres. Esta restrição não
existe para operação POST.

O quadro abaixo apresenta a especificação do método:

Anotação http://frete.transpobrasil.com.br/api/agendamento/agendarNota/chave/data?token=token

http://frete.transpobrasil.com.br/api/agendamento/agendarNota/421402003741210001015
Exemplo
50010003217771522405601/25022014?token=29491395A890FF87E9709570559A5633

Retorno em caso de sucesso {"status"="AGENDADO"}

Retorno em caso de erro {"status"="ERRO", "mensagem"="Mensagem de erro"}
Página 11 de 34

1.3.2 Operação POST + JSON

Diferentemente da operação GET, a chave de acesso da nota fiscal e data

de agendamento não são apontados na URL da chamada, mas sim no corpo
da requisição. No corpo da requisição, o TranspoFrete faz uso da anotação
JSON para descrição dos parâmetros.

O quadro abaixo apresenta a especificação do método:

URL: http://frete.transpobrasil.com.br/api/agendamento/agendarNota?token=token
Anotação
Content: {"chave" : "chave_de_acesso", "data" : "data_ddmmaaaa"}

http://frete.transpobrasil.com.br/api/agendamento/agendarNota?token=29491395A890FF87
E9709570559A5633
Exemplo
Content: {"chave" : "42140200374121000101550010003226521624484810", "data" :
"25022014"}
Retorno em caso de sucesso {"status"="AGENDADO"}
Retorno em caso de erro {"status"="ERRO", "mensagem"="Mensagem de erro"}

1.3.3 Operação POST + JSON como parâmetro

Esta operação é semelhante à operação POST + JSON, contudo, o conteúdo

do corpo da requisição sofre uma pequena alteração. Ao invés de utilizar a
anotação JSON diretamente, o TranspoFrete faz uso do parâmetro json
para, na sequência, descrever o conteúdo da mensagem.

O quadro abaixo apresenta a especificação do método:

URL: http://frete.transpobrasil.com.br/api/agendamento/agendarNota?token=token
Anotação
Content: json={"chave" : "chave_de_acesso", "data" : "data_ddmmaaaa"}

URL:
http://frete.transpobrasil.com.br/api/agendamento/agendarNota?token=29491395A890FF87
Exemplo E9709570559A5633
Content: json={"chave" : "42140200374121000101550010003226521624484810", "data" :
"25022014"}
Retorno em caso de sucesso {"status"="AGENDADO"}
Retorno em caso de erro {"status"="ERRO", "mensagem"="Mensagem de erro"}

1.4 Confirmação de embarque

Para uma gestão eficiente dos Prazos de Entrega e Rastreamento no
TranspoFrete, a informação do momento exato em que a mercadoria é
Página 12 de 34

coletada é extremamente necessária. Com este objetivo foi criada a rotina

de Confirmação do Embarque, responsável pelo apontamento do momento
em que as notas fiscais são retiradas pela transportadora.

No caso de Frete Lotação, além de registrar a data em que a carga foi

coletada, a rotina de Confirmação do Embarque efetua a normalização das
Notas Fiscais dentro da carga, ou seja, caso seja embarcada uma Nota Fiscal
a mais ou a menos do que o previsto, o embarque é normalizado no
TranspoFrete.

Por exemplo, caso o embarque tenha sido montado com 5 (cinco) notas
fiscais, mas por motivos externos couberam somente 4 (quatro) no veículo,
o sistema efetuará a normalização do embarque para as 4 (quatro) notas.
Por outro lado, se por ventura existe espaço disponível e houve inclusão de
mais 2 (duas) notas fiscais, o embarque também é ajustado.

O quadro abaixo apresenta as informações necessárias para confirmação

de um embarque no TranspoFrete:
Campo Tipo Descrição Obrigatório Observação
Utilizar em caso de Frete Lotação.
embarque Numérico Número do embarque no TranspoFrete Não No caso de Frete Fracionado não
enviar.

transporadora Caractere CNPJ da transportadora Sim Sem máscara e com zeros a esquerda

data Data Data do embarque Sim Formato DDMMYYYY

Registro agrupador das notas fiscais

notasFiscais Agrupador Sim
que contemplam o embarque

serie Caractere Série da Nota Fiscal Sim

numero Numérico Número da Nota Fiscal Sim
Sem máscara e com zeros a esquerda.
empresa Caractere CNPJ da empresa Não
Não informar para operação GET

Para este serviço estão disponíveis as operações GET, POST + JSON e POST
+ JSON como parâmetro. Os capítulos subsequentes explanam cada tipo de
operação.
Página 13 de 34

1.4.1 Operação GET

Este é o modelo mais simples de operação, visto que todos os parâmetros

são apontados na própria URL, constituindo o próprio endereço. Os
parâmetros são carregados por ordem e separados por barra, ou seja, o
primeiro parâmetro especifica o número do embarque, o segundo
parâmetro especifica o CNPJ da transportadora, o terceiro parâmetro
especifica a data de embarque e assim por diante.

Como não existe estrutura de repetição em uma URL, existe uma anotação
específica para apontar as notas fiscais neste tipo de operação. Após a data
de embarque, o parâmetro que registra as notas fiscais segue o seguinte
padrão: série da nota fiscal, seguido de hífen, seguido do número da nota
fiscal. Para mais de uma nota fiscal, o conjunto anterior deve ser separado
por vírgula. Por fim, o CNPJ da empresa não pode ser informado.

Existe limitação, por parte do próprio protocolo HTTP, que determina o

número máximo de caracteres para a operação GET. Para este tipo de
operação, a URL não pode ultrapassar 255 caracteres. Esta restrição não
existe para operação POST.

O quadro abaixo apresenta a especificação do método:

http://frete.transpobrasil.com.br/api/confirmacaoembarque/confirmarEmbarque/embarqu
Anotação e/transportadora/data/serienf1-numeronf1,serienf2-numeronf2,serienf3-
numeronf3?token=token
http://frete.transpobrasil.com.br/api/confirmacaoembarque/confirmarEmbarque/18/05729
Exemplo 054000106/01042014/1-250802,1-250805,1-
250804?token=29491395A890FF87E9709570559A5633
Retorno em caso de sucesso {"status"="CONFIRMADO"}
Retorno em caso de erro {"status"="ERRO", "mensagem"="Mensagem de erro"}

1.4.2 Operação POST + JSON

Diferentemente da operação GET, os parâmetros não são apontados na URL

da chamada, mas sim no corpo da requisição. No corpo da requisição, o
TranspoFrete faz uso da anotação JSON para descrição dos parâmetros.

O quadro abaixo apresenta a especificação do método:

Página 14 de 34

URL:
http://frete.transpobrasil.com.br/api/confirmacaoembarque/confirmarEmbarque?token=to
Anotação
ken
Content: {parametros...}

URL:
http://frete.transpobrasil.com.br/api/confirmacaoembarque/confirmarEmbarque?token=29
491395A890FF87E9709570559A5633
Exemplo
Content: {"embarque" : 18, "transportadora" : "05729054000106", "data" : "01042014",
"notasFiscais" : [{"serie" : "1", "numero" : 250802}, {"serie" : "1", "numero" : 250805},
{"serie" : "1", "numero" : 250804}]}

Retorno em caso de sucesso {"status"="CONFIRMADO"}

Retorno em caso de erro {"status"="ERRO", "mensagem"="Mensagem de erro"}

1.4.3 Operação POST + JSON como parâmetro

Esta operação é semelhante à operação POST + JSON, contudo, o conteúdo

do corpo da requisição sofre uma pequena alteração. Ao invés de utilizar a
anotação JSON diretamente, o TranspoFrete faz uso do parâmetro json
para, na sequência, descrever o conteúdo da mensagem.

O quadro abaixo apresenta a especificação do método:

URL:
http://frete.transpobrasil.com.br/api/confirmacaoembarque/confirmarEmbarque?token=to
Anotação
ken
Content: json={parametros...}

URL:
http://frete.transpobrasil.com.br/api/confirmacaoembarque/confirmarEmbarque?token=29
491395A890FF87E9709570559A5633
Exemplo
Content: json={"embarque" : 18, "transportadora" : "05729054000106", "data" :
"01042014", "notasFiscais" : [{"serie" : "1", "numero" : 250802}, {"serie" : "1", "numero" :
250805}, {"serie" : "1", "numero" : 250804}]}

Retorno em caso de sucesso {"status"="CONFIRMADO"}

Retorno em caso de erro {"status"="ERRO", "mensagem"="Mensagem de erro"}

1.5 Simulação
É possível, através do sistema, efetuar simulações da contratação de fretes.
Como o próprio nome indica, este instrumento possui o objetivo de simular
o frete para determinada nota, embarque ou pedido. Ainda, é possível
efetuar a simulação com base no histórico de movimentação (comparando
tabelas de frete) ou mesmo sem haver movimentação alguma (simulação
aberta).
Página 15 de 34

Para esta última modalidade de simulação, além da rotina em tela

disponível no sistema, é disponível o WebService. O quadro abaixo
apresenta as informações necessárias para simulação no TranspoFrete:
Campo Tipo Descrição Obrigatório Observação
remetente Caractere CPF ou CNPJ do destinatário Sim Sem máscara e com zeros a esquerda
destinatario Caractere CPF ou CNPJ do destinatário Sim Sem máscara e com zeros a esquerda
cepOrigem Numérico CEP de origem Sim Sem máscara
cepDestino Numérico CEP de destino Sim Sem máscara
produto Caractere Código do produto predominante Não
modal Caractere Sigla do modal Não
Data da simulação, para fins de
data Data Sim Formato DD/MM/YYYY
vigência das tabelas de frete
peso Decimal Peso nominal total da simulação Sim Formato 0.00
valor Decimal Valor total da simulação Sim Formato 0.00
cubagem Decimal Cubagem total da simulação Não Formato 0.00
valorProdutos Decimal Valor total dos produtos da simulação Não Formato 0.00
tipoOperacao Numérico Indicador de Entrada ou Saída Sim Entrada = 0, Saída = 1
transportadora Caractere CNPJ da transportadora Não Sem máscara e com zeros a esquerda
modais Lista Lista de modais que serão simulados Não Exemplo: [ROD, EXP]
Abono em dias para adição no prazo
abono Numérico Não
de entrega
Registro agrupador. Repetição dos
Agrupador de produtos, caso existam
produtos Agrupador Não registros subsequentes para cada item
negociações por item
da simulação
Obrigatório caso seja informado o
produto Caractere Código do produto predominante Sim
registro agrupador
Obrigatório caso seja informado o
quantidade Numérico Quantidade de produtos Sim
registro agrupador
Formato 0.00
peso Decimal Peso nominal do item Sim Obrigatório caso seja informado o
registro agrupador
cubagem Decimal Cubagem do item Não Formato 0.00
valor Decimal Valor total da simulação Sim
Obrigatório caso seja informado o
volumes Numérico Quantidade de volumes Sim
registro agrupador

Para este serviço está disponível a operação POST. O capítulo subsequente

explana este tipo de operação.

1.5.1 Operação POST + JSON

Os parâmetros não são apontados na URL da chamada, mas sim no corpo

da requisição. No corpo da requisição, o TranspoFrete faz uso da anotação
JSON para descrição dos parâmetros.

O quadro abaixo apresenta a especificação do método:

Página 16 de 34

URL: http://frete.transpobrasil.com.br/api/calculo/calcularNota?token=token
Anotação
Content: {parametros...}

URL: http://frete.transpobrasil.com.br/api/
calculo/calcularNota?token=29491395A890FF87E9709570559A5633
Content: { "remetente": "75293662000449", "destinatario": "10572515000110",
Exemplo
"cepOrigem": "89072205", "cepDestino": "49160000", "produto": "018-01844502411",
"modal": "ROD", "data": "26/03/2015", "peso": 77.0, "cubagem": 200.0, "valor": 4830.0,
"valorProdutos": 4830.0, "tipoOperacao": 0 }
{"transportadoras":[{"peso":null,"status":"CALCULADO","valor":67.87,"pesoCubado":null,"n
ome":"EXPRESSO SAO MIGUEL
LTDA","cnpj":"00428307000864","movimentos":[{"codigo":"fretepeso","valor":29.23,"obser
vacao":"São Miguel - Geral, De SC3 para SC1 (Sem pedágio) [Tipo: Kilo/Unidade, Mínimo:
29,23]","descricao":"Frete Peso"},{"codigo":"icms","valor":11.54,"observacao":"Alíquota
utilizada de SC para SC: 17.0%, base:
56,33","descricao":"ICMS"},{"codigo":"advalorem","valor":16.65,"observacao":"São Miguel -
Geral [Percentual: 0,50%, Valor excedente: 3330,00]","descricao":"Ad
Valorem"},{"codigo":"gris","valor":4.35,"observacao":"São Miguel - Geral [Percentual: 0,09%
Valor Mínimo:
1,95]","descricao":"GRIS"},{"codigo":"fretepeso","valor":6.1,"observacao":"São Miguel -
Geral, De SC3 para SC1 (Sem pedágio) [Tipo: Kilo/Unidade, Peso Excedente: 27,00, Valor por
quilo: 0,23 X 27,000000]","descricao":"Frete
Retorno em caso de sucesso Peso"},{"codigo":"total","valor":67.87,"observacao":null,"descricao":"Total do
Frete"}]},{"peso":null,"status":"CALCULADO","valor":59.43,"pesoCubado":null,"nome":"TRA
NSPORTADORA PLIMOR
LTDA","cnpj":"88085485001500","movimentos":[{"codigo":"advalorem","valor":33.81,"obse
rvacao":null,"descricao":"Ad Valorem"},{"codigo":"taxas","valor":2.93,"observacao":"Plimor
- Geral [Valor Final:
2,9300]","descricao":"Taxas"},{"codigo":"gris","valor":9.66,"observacao":"Plimor - Geral
[Percentual: 0,20% Valor Mínimo:
2,93]","descricao":"GRIS"},{"codigo":"total","valor":59.43,"observacao":null,"descricao":"Tot
al do Frete"},{"codigo":"icms","valor":10.1,"observacao":"Alíquota utilizada de SC para SC:
17.0%, base:
49,33","descricao":"ICMS"},{"codigo":"pedagio","valor":2.93,"observacao":"Plimor - Geral
[Tipo: Por Ton/Fração, Frações: 1, Mínimo:
2,93]","descricao":"Pedágio"}]}],"status":"CALCULADO"}
Retorno em caso de erro {"status"="ERRO", "mensagem"="Mensagem de erro"}

1.6 Geração de Cargas

Esta operação é responsável pela geração de cargas no sistema. Uma carga
pode estar relacionada com uma ou mais Notas Fiscais ou Pré-Notas Fiscais.

Tem como objetivo servir de instrumento para seleção antecipada da

transportadora, em casos em que se deseja simular o frete com
transportadoras diferentes antes da emissão da Nota Fiscal, ou ainda,
receber as cargas do sistema de gestão já roteirizadas.

O quadro abaixo apresenta as informações necessárias para geração de

uma Carga no TranspoFrete:
Campo Tipo Descrição Obrigatório Observação
cnpjUnidade Caractere CNPJ da unidade ou filial Sim Sem máscara e com zeros a esquerda
cepOrigem Numérico CEP de origem da carga Sim
cepDestino Numérico CEP de destino da carga Sim
cnpjTransporadora Caractere CNPJ da transportadora Não Sem máscara e com zeros a esquerda
Página 17 de 34

dataColeta Data Data da coleta Não Formato DD-MM-YYYY

dataPrevisaoEntraga Data Data da previsão de entrega Não Formato DD-MM-YYYY
situacaoEmbarque Numérico Situação do embarque ou carga Sim
0 – Carga fracionada, 1 – Carga
tipoEmbarque Numérico Tipo do embarque ou carga Sim
fechada
VALOR – Seleção automática da
transportadora com menor valor de
frete
criterioCalculo Critério para seleção automática da PRAZO – Seleção automática da
Caractere Não
transportadora transportadora com menor prazo
CLASSIFICACAO – Seleção da
transportadora com melhor
classificação para determinada rota
0 – Embarque criado, 1 – Embarque
observação Caractere Observação da carga Não fechado.
Somente para carga fechada.
Código do modal (ver com
modal Numérico Não
TranspoBrasil)
Registro agrupador dos documentos
documentos Agrupador Sim
que contemplam a carga
Tipo do documento associado (Pré-Nota
tipoDocumento Numérico Sim 0 – Nota Fiscal, 1 – Pré-Nota Fiscal
Fiscal ou Nota Fiscal)
cnpjEmissor Caractere CNPJ do emissor do documento Sim Sem máscara e com zeros a esquerda
cnpjRementente Caractere CPF ou CNPJ do remetente Sim Sem máscara e com zeros a esquerda
cnpjDestinatario Caractere CPF ou CNPJ do destinatário Sim Sem máscara e com zeros a esquerda
cepOrigem Numérico CEP de origem da carga Sim
cepDestino Numérico CEP de destino da carga Sim
numeroDocumento Numérico Número do documento Sim
serie Caractere Série do documento Sim
chaveAcesso Caractere Chave de acesso do documento Não
valor Decimal Valor da Pré-Nota Fiscal Sim Formato 0.00
valorTotalProdutos Decimal Valor dos produtos da Pré-Nota Fiscal Não Formato 0.00
pesoNominal Decimal Peso nominal total Não Formato 0.00
Valor da cubagem total da Pré-Nota
valorCubado Decimal Não Formato 0.00
Fiscal
tipoOperacao Numérico Indicador de Entrada ou Saída Sim Entrada = 0, Saída = 1
Por conta do emitente = 0, Por conta
modalidadeFrete Numérico Indicador da Modalidade do Frete Sim do destinatário = 1, Por conta de
terceiros = 2, Sem Frete = 9

Os campos sinalizados acima deverão ser informados independentemente

da operação escolhida. Para este serviço está disponível a operação POST +
JSON. Os capítulos subsequentes explanam cada tipo de operação.

1.6.1 Operação POST + JSON

Os parâmetros não são apontados na URL da chamada, mas sim no corpo

da requisição. No corpo da requisição, o TranspoFrete faz uso da anotação
JSON para descrição dos parâmetros.

O quadro abaixo apresenta a especificação do método:

Página 18 de 34

URL: http://frete.transpobrasil.com.br/api /carga/gravarCarga?token=token

Anotação
Content: {parametros...}

URL:
http://frete.transpobrasil.com.br/api/prenota/gravarPreNota?token=29491395A890FF87E9
709570559A5633
Content: {
"cnpjUnidade": "10587689000156",
"cepOrigem": 89150000,
"cepDestino": 89035300,
"cnpjTransportadora": "05729054000106",
"dataColeta": "03-06-2014",
"dataPrevisaoEntraga": null,
"situacaoEmbarque": 0,
"tipoEmbarque": 0,
"documentos": [{
"tipoDocumento": 1,
Exemplo
"cnpjEmissor": "10587689000156",
"cnpjRemetente": "10587689000156",
"cnpjDestinatario": "10587689000156",
"cepOrigem": 89150000,
"cepDestino": 89150000,
"numeroDocumento": 111111,
"serie": "A",
"chaveAcesso": "354564654654656545646546556",
"valor": 100.0,
"modalidadeFrete": 0,
"tipoOperacao": 0,
"valorTotalProdutos": 100.00
}]
}
Retorno 1 (criterioCalculo não informado):
{"status"="GRAVADO"}

Retorno 2 (critérioCálculo informado):

{
"transportadoras": [{
"peso": null,
"status": "CALCULADO",
Retorno em caso de sucesso "valor": 67.87,
"pesoCubado": null,
"nome": "EXPRESSO SAO MIGUEL LTDA",
"cnpj": "00428307000864",
"movimentos":[ ...]
}],
"status": "CALCULADO"
}

Retorno em caso de erro {"status"="ERRO", "mensagem"="Mensagem de erro"}

1.7 Rastreamento
Esta operação é responsável pelo resgate de todas as ocorrências de
entrega geradas em uma determinada carga. Tem como objetivo servir de
instrumento para o rastreamento de determinado frete, por aplicações
terceiras ou portais de clientes.

O quadro abaixo apresenta as informações necessárias para o resgate das

ocorrências:
Página 19 de 34

Operação Campo Tipo Descrição Obrigatório Observação

numeroNFe Caractere CNPJ da unidade ou filial Sim Sem máscara e com zeros a esquerda
POST + serieNFe Numérico CEP de origem da carga Sim
JSON CNPJ do emissor, sem máscara e com os
cnpjEmissor Numérico CNPJ da transportadora Sim
zeros não significativos a esquerda
GET chaveAcesso Caractere Chave de acesso da Nota Fiscal Sim Sem máscara e com zeros a esquerda
GET codigoRastreio Caractere Código de rastreio Sim

Para operação POST + JSON, deverão ser utilizados os parâmetros

numeroNFe, serieNFe e cnpjEmissor. Para a operação GET, poderá ser
utilizado o parâmetro chaveAcesso ou codigoRastreio. Os capítulos
subsequentes explanam cada tipo de operação.

1.7.1 Operação GET

Este é o modelo mais simples de operação, visto que todos os parâmetros

são apontados na própria URL, constituindo o próprio endereço. Os
parâmetros são carregados por ordem e separados por barra. Desta forma
o código de rastreio ou chave de acesso da Nota Fiscal Eletrônica deve ser
informado logo após o endereço do WebService.

Existe limitação, por parte do próprio protocolo HTTP, que determina o

número máximo de caracteres para a operação GET. Para este tipo de
operação, a URL não pode ultrapassar 255 caracteres. Esta restrição não
existe para operação POST.

O quadro abaixo apresenta a especificação do método:

Anotação http://frete.transpobrasil.com.br/api/tracking/notaFiscal/chave_acesso?token=token

http://frete.transpobrasil.com.br/api/tracking/notaFiscal/
Exemplo 42141100374121000101550010004030201614734280?token=
A268EEE5179FFF2F8B46D80C3A3F0D18
{"eventos":[{"observacao":"ENTREGA OCORREU EM 03/12/14 17:00 E FOI RECEBIDO POR
BARBOSA","data":"03/12/2014
Retorno em caso de sucesso
10:05:00","codigoOcorrencia":"01","descricaoOcorrencia":"","nomeOcorrencia":"ENTREGUE
","codigoObservacao":"00"}],"status":"OK"}
Retorno em caso de erro {"status"="ERRO", "mensagem"="Mensagem de erro"}

1.7.2 Operação POST + JSON

Os parâmetros não são apontados na URL da chamada, mas sim no corpo

da requisição. No corpo da requisição, o TranspoFrete faz uso da anotação
JSON para descrição dos parâmetros.

O quadro abaixo apresenta a especificação do método:

Página 20 de 34

URL: http://frete.transpobrasil.com.br/api/tracking/notaFiscal?token=token
Anotação
Content: {parametros...}

URL:
http://frete.transpobrasil.com.br/api/tracking/notaFiscal?token=29491395A890FF87E97095
Exemplo
70559A5633
Content: {"numeroNFe" : 1234567, "serieNFe" : "1", "cnpjEmissor" : "10572515000110"}
{"eventos":[{"observacao":"ENTREGA OCORREU EM 03/12/14 17:00 E FOI RECEBIDO POR
BARBOSA","data":"03/12/2014
Retorno em caso de sucesso
10:05:00","codigoOcorrencia":"01","descricaoOcorrencia":"","nomeOcorrencia":"ENTREGUE
","codigoObservacao":"00"}],"status":"OK"}
Retorno em caso de erro {"status"="ERRO", "mensagem"="Mensagem de erro"}

1.8 Upload de XML

Esta operação é responsável pela carga de um arquivo XML, podendo ser
um arquivo XML de Nota Fiscal Eletrônica, um arquivo XML de
Conhecimento de Frete ou mesmo um arquivo XML de cancelamento. Tem
como objetivo servir de alternativa a empresas que não possuem condições
de transmitir os arquivos XML por e-mail.

Para este serviço está disponível somente a operação POST.

1.8.1 Operação POST

Os parâmetros não são apontados na URL da chamada, mas sim no corpo

da requisição. No corpo da requisição serão transmitidos os bytes do
respectivo arquivo XML.

O quadro abaixo apresenta a especificação do método:

URL: http://frete.transpobrasil.com.br/api/importacaoXML/upload?token=token
Anotação
Content: {conteúdo...}

URL:
http://frete.transpobrasil.com.br/api/importacaoXML/upload?token
Exemplo
=29491395A890FF87E9709570559A5633
Content: {edd3q4r43t5g54g45g54ggergrwegg3g....}

Retorno em caso de sucesso {"status"="GRAVADO"}

Retorno em caso de erro {"status"="ERRO", "mensagem"="Mensagem de erro"}

Abaixo exemplo de código fonte construído em Java, para integração do

upload de XML:
protected void enviarArquivoPost(String path, String nomeArquivo, InputStream stream)
{
Página 21 de 34

try {
System.out.println("Enviando arquivo " + nomeArquivo);
MultipartEntityBuilder builder = MultipartEntityBuilder.create();
builder.setMode(HttpMultipartMode.BROWSER_COMPATIBLE);
builder.addBinaryBody(ARQUIVO, stream,
ContentType.create("application/zip"), nomeArquivo);
HttpEntity entity = builder.build();

HttpPost post = new HttpPost(SERVER_ADDRESS + path + TOKEN_PARAM + TOKEN);

post.setEntity(entity);

CloseableHttpClient client = HttpClientBuilder.create().build();

CloseableHttpResponse execute = client.execute(post);
System.out.println(execute);

} catch (IOException e) {
e.printStackTrace();
}
}

1.9 Download do PDF do DANFE

Esta operação é responsável pela visualização do PDF do DANFE. Tem como
objetivo possibilitar que sistemas terceiros acessem a base de dados do
transpoFrete, e visualizem o PDF da Nota Fiscal Eletrônica.

É importante ressaltar que o DANFE gerado é um padrão TranspoBrasil, ou

seja, é gerado dinamicamente com base no XML da Nota Fiscal Eletrônica.
Ainda, quando houver uma carta de correção será impressa uma página
adicional no DANFE, com o conteúdo da correção.

Para este serviço está disponível somente a operação GET.

1.9.1 Operação GET

Este é o modelo mais simples de operação, visto que todos os parâmetros

são apontados na própria URL, constituindo o próprio endereço. Os
parâmetros são carregados por ordem e separados por barra. Desta forma
o código de rastreio ou chave de acesso da Nota Fiscal Eletrônica deve ser
informado logo após o endereço do WebService.

Existe limitação, por parte do próprio protocolo HTTP, que determina o

número máximo de caracteres para a operação GET. Para este tipo de
operação, a URL não pode ultrapassar 255 caracteres. Esta restrição não
existe para operação POST.
Página 22 de 34

O quadro abaixo apresenta a especificação do método:

Anotação http://frete.transpobrasil.com.br/api/nota/buscarDanfe/chave_acesso?token=token

http://webservices.transpofrete.com.br/api/nota/buscarDanfe/41160862182092000206550
Exemplo
080000119921557609604?token=A110AA3DD5FBD6D4ED65D3FC96822121

Retorno em caso de sucesso PDF do DANFE

{
"RemoteException": {
"exception": "BusinessException",
Retorno em caso de erro "javaClassName": "com.transpobrasil.exception.BusinessException",
"message": "Nota fiscal não encontrada"
}
}

1.10 Download do XML da Nota Fiscal

Esta operação é responsável pelo download do XML. Tem como objetivo
possibilitar que sistemas terceiros acessem a base de dados do
transpoFrete, e baixem o arquivo XML da Nota Fiscal Eletrônica.

Para este serviço está disponível somente a operação GET.

1.10.1 Operação GET

Este é o modelo mais simples de operação, visto que todos os parâmetros

são apontados na própria URL, constituindo o próprio endereço. Os
parâmetros são carregados por ordem e separados por barra. Desta forma
o código de rastreio ou chave de acesso da Nota Fiscal Eletrônica deve ser
informado logo após o endereço do WebService.

Existe limitação, por parte do próprio protocolo HTTP, que determina o

número máximo de caracteres para a operação GET. Para este tipo de
operação, a URL não pode ultrapassar 255 caracteres. Esta restrição não
existe para operação POST.

O quadro abaixo apresenta a especificação do método:

http://frete.transpobrasil.com.br/
Anotação
api/downloadXML/downloadNFe/chave_acesso?token=token
http://webservices.transpofrete.com.br/
Exemplo api/downloadXML/downloadNFe/41160862182092000206550080000119921557609604?to
ken=A110AA3DD5FBD6D4ED65D3FC96822121
Retorno em caso de sucesso XML da NF-e
{
Retorno em caso de erro
"RemoteException": {
Página 23 de 34

"exception": "BusinessException",
"javaClassName": "com.transpobrasil.exception.BusinessException",
"message": "Nota fiscal não encontrada"
}
}

1.11 Download do XML de Eventos

Esta operação é responsável pelo download do XML de eventos (carta de
correção). Tem como objetivo possibilitar que sistemas terceiros acessem a
base de dados do transpoFrete, e baixem o arquivo XML de eventos da Nota
Fiscal Eletrônica.

Para este serviço está disponível somente a operação GET.

1.11.1 Operação GET

Este é o modelo mais simples de operação, visto que todos os parâmetros

são apontados na própria URL, constituindo o próprio endereço. Os
parâmetros são carregados por ordem e separados por barra. Desta forma
o código de rastreio ou chave de acesso da Nota Fiscal Eletrônica deve ser
informado logo após o endereço do WebService.

Existe limitação, por parte do próprio protocolo HTTP, que determina o

número máximo de caracteres para a operação GET. Para este tipo de
operação, a URL não pode ultrapassar 255 caracteres. Esta restrição não
existe para operação POST.

O quadro abaixo apresenta a especificação do método:

http://frete.transpobrasil.com.br/
Anotação
api/downloadXML/downloadNFeEventos/chave_acesso?token=token
http://webservices.transpofrete.com.br/api/downloadXML/
Exemplo downloadNFeEventos/41160862182092000206550080000119921557609604?token=A110A
A3DD5FBD6D4ED65D3FC96822121
Retorno em caso de sucesso XML da NF-e
{
"RemoteException": {
"exception": "BusinessException",
Retorno em caso de erro "javaClassName": "com.transpobrasil.exception.BusinessException",
"message": "Nota fiscal não encontrada"
}
}
Página 24 de 34

1.12 Detalhes da Nota Fiscal 1

Esta operação é responsável por fornecer os detalhes de uma ou mais notas
fiscais, passando como parâmetro observações de informações do
contribuinte e também o CNPJ do destinatário. Como retorno, se tem a lista
de notas que contemplam os critérios informados, juntamente com dados
de remetente, destinatário, produtos e informações de entregas.

Para este serviço está disponível somente a operação POST + JSON.

1.12.1 Operação POST + JSON

Os parâmetros não são apontados na URL da chamada, mas sim no corpo

da requisição. No corpo da requisição, o TranspoFrete faz uso da anotação
JSON para descrição dos parâmetros.

O quadro abaixo apresenta a especificação do método:

URL:
http://webservices.transpofrete.com.br/api/nota/buscarNotaFiscalInformacaoContribuinte?
Anotação
token=token
Content: {parametros...}
URL:
http://webservices.transpofrete.com.br/api/nota/buscarNotaFiscalInformacaoContribuinte?
token=93252AC3C2598BF076891F43797481D4
Content: {
"cnpjDestinatario": "62182092001016",
Exemplo
"informacoesContribuinte": [{
"chave": "DOCNUMSAP",
"valor": "00587438"
}]
}
{
"notas": [
{
"numero": 60340,
"serie": "5",
"chave": "35160962182092001288550050000603401935396904",
"dataEmissao": "22/09/2016",
"situacao": "TRANSPORTADA",
"cepOrigem": 18160000,
"cepDestino": 6400000,
"pesoNominal": 15979,
"valor": 808665,
Retorno em caso de sucesso "tipoOperacao": "SAIDA",
"CFOP": 5151,
"codigoNaturezaOperacao": "Transferencia producao estabelecimento",
"naturezaOperacao": "2",
"descricaoNaturezaOperacao": "Frete de Transferência",
"unidade": {
"cnpj": "62182092001288",
"nome": "ARYSTA LIFESCIENCE BR IND QUIM AGR"
},
"remetente": {
"nome": "ARYSTA LIFESCIENCE BR IND QUIM AGR",
"cnpj": "62182092001288",
"logradouro": null,
Página 25 de 34

"bairro": null,
"cep": 18160000
},
"destinatario": {
"nome": "ARYSTA LIFESCIENCE BR IND QUIM AGR",
"cnpj": "62182092001016",
"logradouro": null,
"bairro": null,
"cep": 6421400
},
"transportadora": {
"nome": "MURICI VENTURA TRANSPORTES - ME",
"cnpj": "08890922000123"
},
"informacoesContribuinte": [
{
"TF_CNPJ_ENTREGA": "0"
},
{
"DOCNUMSAP": "00587438"
},
{
"TF_SER_PNF_REF": "1"
},
{
"CTG_NF": "G1"
},
{
"TF_NUM_PNF_REF": "0080235082"
},
{
"TF_CUBAGEM_TOTAL": "0"
},
{
"CATEGORIA": "Nota Fiscal Issue"
}
],
"produtos": [
{
"produto": "DINAMIC 2X5 KG",
"CFOP": 5151,
"quantidade": 200,
"cubagem": null,
"valor": 11154,
"volumes": null
},
{
"produto": "DINAMIC 2X5 KG",
"CFOP": 5151,
"quantidade": 1240,
"cubagem": null,
"valor": 69154.8,
"volumes": null
},
{
"produto": "DINAMIC 2X5 KG",
"CFOP": 5151,
"quantidade": 840,
"cubagem": null,
"valor": 46846.8,
"volumes": null
},
{
"produto": "DINAMIC 2X5 KG",
"CFOP": 5151,
"quantidade": 800,
"cubagem": null,
"valor": 44616,
"volumes": null
},
{
Página 26 de 34

"produto": "DINAMIC 2X5 KG",

"CFOP": 5151,
"quantidade": 1250,
"cubagem": null,
"valor": 69712.5,
"volumes": null
},
{
"produto": "DINAMIC 2X5 KG",
"CFOP": 5151,
"quantidade": 1250,
"cubagem": null,
"valor": 69712.5,
"volumes": null
},
{
"produto": "DINAMIC 2X5 KG",
"CFOP": 5151,
"quantidade": 400,
"cubagem": null,
"valor": 22308,
"volumes": null
},
{
"produto": "DINAMIC 2X5 KG",
"CFOP": 5151,
"quantidade": 1050,
"cubagem": null,
"valor": 58558.5,
"volumes": null
},
{
"produto": "DINAMIC 2X5 KG",
"CFOP": 5151,
"quantidade": 1250,
"cubagem": null,
"valor": 69712.5,
"volumes": null
},
{
"produto": "DINAMIC 2X5 KG",
"CFOP": 5151,
"quantidade": 1240,
"cubagem": null,
"valor": 69154.8,
"volumes": null
},
{
"produto": "DINAMIC 2X5 KG",
"CFOP": 5151,
"quantidade": 1250,
"cubagem": null,
"valor": 69712.5,
"volumes": null
},
{
"produto": "DINAMIC 2X5 KG",
"CFOP": 5151,
"quantidade": 1240,
"cubagem": null,
"valor": 69154.8,
"volumes": null
},
{
"produto": "DINAMIC 2X5 KG",
"CFOP": 5151,
"quantidade": 1250,
"cubagem": null,
"valor": 69712.5,
"volumes": null
},
Página 27 de 34

{
"produto": "DINAMIC 2X5 KG",
"CFOP": 5151,
"quantidade": 1240,
"cubagem": null,
"valor": 69154.8,
"volumes": null
}
],
"ocorrencias": [
{
"dataOcocrrencia": "22/09/2016",
"numeroEvento": "00",
"ocorrencia": "Processo de Transporte já Iniciado",
"ocorrenciaTransporte": "00",
"observacao": "",
"conhecimento": 10767750618,
"tipoLancamento": null,
"valor": null,
"abonoPrazo": null
},
{
"dataOcocrrencia": "22/09/2016",
"numeroEvento": "01",
"ocorrencia": "ENTREGUE",
"ocorrenciaTransporte": "01",
"observacao": "",
"conhecimento": 10767750618,
"tipoLancamento": null,
"valor": null,
"abonoPrazo": null
}
],
"preConhecimentos": [
{
"dataPrevisaoEntrega": "22/09/2016",
"tipo": "NORMAL",
"situacao": "TRANSPORTADO",
"dataEntrega": "22/09/2016",
"oid": 10767750618
}
]
}
],
"status": "CONFIRMADO"
}
{
"RemoteException": {
"exception": "BusinessException",
Retorno em caso de erro "javaClassName": "com.transpobrasil.exception.BusinessException",
"message": "Nota fiscal não encontrada"
}
}

1.13 Alteração de transportadora

Esta operação é responsável por realizar a alteração de transportadora de
uma determinada carga, passando como parâmetro o CNPJ da nova
transportadora, o CNPJ da transportadora antiga e a chave da acesso da
Nota Fiscal Eletrônica.
Página 28 de 34

Para este serviço está disponível somente a operação POST + JSON.

1.13.1 Operação POST + JSON

Os parâmetros não são apontados na URL da chamada, mas sim no corpo

da requisição. No corpo da requisição, o TranspoFrete faz uso da anotação
JSON para descrição dos parâmetros.

O quadro abaixo apresenta a especificação do método:

URL: http://webservices.transpofrete.com.br/api/
Anotação carga/alterarTransportadora?token=token
Content: {parametros...}
URL:
http://webservices.transpofrete.com.br/api/ carga/alterarTransportadora?token
=93252AC3C2598BF076891F43797481D4
Content: {
Exemplo
"cnpjNovaTransportadora" : "75293662000104",
"cnpjTransportadora" :"06045328000100",
"chaveAcesso" : "42160275293662000104550020000824111571511329"
}
Retorno em caso de sucesso {"status"="GRAVADO"}
Retorno em caso de erro {"status"="ERRO", "mensagem"="Mensagem de erro"}
Página 29 de 34

2. Remessa – Integração via Módulo

Remoto
Para os casos em que não é possível invocar WebServices através de REST,
por limitações na tecnologia do sistema ERP, limitações de infraestrutura,
ou por própria opção da empresa, existe possibilidade de personalização da
integração de Remessa (sentido TranspoFrete, ERP).

Para estes fins, existe possibilidade de utilização do Módulo Remoto

TranspoFrete. O Módulo Remoto TranspoFrete efetua a comunicação entre
o sistema de gestão e o TranspoFrete, sendo possível programar o formato
da leitura das informações.

A imagem abaixo descreve o processo de integração via Módulo Remoto:

Mensagem Internet

Mensagem

Remessa Remessa

Sistema ERP Módulo Remoto TranspoFrete

O sistema ERP gera a Remessa de informações, de acordo com o formato

especificado e programado no Módulo Remoto TranspoFrete. Por sua vez,
o Módulo Remoto TranspoFrete efetua a chamada do WebService
correspondente, finalizando a integração.

Os processos cobertos são os seguintes:

Página 30 de 34

a) Geração de Pré-Notas Fiscais: capítulo 1.2;

b) Agendamento: capítulo 1.3;
c) Confirmação do Embarque: capítulo 1.4.
Página 31 de 34

3. Retorno – Integração via Módulo

Remoto
O sistema TranspoFrete é comercializado na modalidade SAAS, sendo que
a aplicação está hospedada em um DataCenter sob o domínio da
TranspoBrasil Sistemas. Como os sistemas de gestão comummente estão
localizados em ambientes distintos, se faz necessário a utilização do
Módulo Remoto TranspoFrete para comunicação entre o TranspoFrete e o
sistema ERP.

O Módulo Remoto TranspoFrete possui o objetivo de efetuar a

comunicação de retorno (sentido TranspoFrete, ERP) de todas as
notificações da solução. Ainda, como cada sistema de gestão possui
mecanismos próprios de integração, é possível programar o formato do
retorno de acordo com a necessidade da empresa.

A imagem abaixo descreve o processo de integração via Módulo Remoto:

Mensagem

Mensagem Internet

Amazon SQS Queue

Mensagem

Retorno Retorno

Sistema ERP Módulo Remoto TranspoFrete

Página 32 de 34

O TranspoFrete gera a notificação e alimenta o servidor de mensagens

(Amazon SQS Queue). O Módulo Remoto TranspoFrete efetua a leitura o
servidor de mensagens, de tempos em tempos, transmitindo a informação
para o ERP no formato especificado e programado.

3.1 Mensagem de seleção de transportadora

Na rotina de consulta e edição de Pré-Notas Fiscais, é possível selecionar a
melhor transportadora para carregar as mercadorias. O TranspoFrete
efetua a simulação para cada Pré-Nota Fiscal, apresentando a melhor
transportadora para a rota determinada.

No momento da seleção da transportadora é gerada uma mensagem, que

possui o objetivo de notificar o sistema de gestão acerca da transportadora
escolhida.

As informações disponibilizadas na mensagem são as seguintes:

a) Número: número da Pré-Nota Fiscal;

b) Série: série da Pré-Nota Fiscal;
c) Empresa: CNPJ da empresa;
d) Transportadora: CNPJ da transportadora;
e) Previsão de Entrega: data da previsão de entrega;
f) Embarque: Número do embarque, caso seja um Frete Lotação;
g) Transportadora de Redespacho: CNPJ da transportadora de
redespacho (segundo nível), caso haja algum redespacho para esta
Pré-Nota Fiscal.

Esta mensagem será alimentada no servidor de mensagens (Amazon SQS

Queue), sendo consumida pelo Módulo Remoto TranspoFrete e integrada
consequentemente no sistema ERP.

3.2 Mensagem de aceite de fatura

O TranspoFrete efetua a importação de Faturas das transportadoras,
através dos arquivos de EDI. Nestas faturas estão relacionados todos os
conhecimentos que fazem parte da cobrança, visto que o TranspoFrete
efetua a validação dos documentos para fins de auditoria.
Página 33 de 34

Caso esta fatura seja aceita, ou seja, se a empresa estiver de acordo com os
valores cobrados, é gerada uma mensagem com os dados da fatura
possibilitando integração no sistema de gestão.

As informações disponibilizadas na mensagem são as seguintes:

a) Número: número da fatura;

b) Série: série da fatura;
c) Data de geração: data em que a fatura foi importada no sistema;
d) Data de emissão: data em que a fatura foi emitida pela
transportadora;
e) Data de vencimento: data de vencimento da fatura;
f) Data limite: data limite de pagamento da fatura;
g) Valor: valor bruto da fatura;
h) Valor do ICMS: valor do ICMS total;
i) Valor dos juros por dia: valor dos juros por dia;
j) Valor do desconto: valor do desconto total;
k) Empresa: CNPJ da empresa;
l) Transportadora: CNPJ da transportadora;
m) UF da transportadora: UF da transportadora;
n) Nome do banco: Nome do banco da fatura;
o) Número da agência: Número da agência;
p) Dígito verificador da agência: Dígito verificador da agência;
q) Número da conta corrente: Número da conta corrente;
r) Dígito verificador da conta corrente: Dígito verificador da conta
corrente;
s) Tipo: tipo da cobrança;
t) Tipo de documento: nota fiscal fatura ou romaneio;
u) Situação: aceita, rejeitada ou gerada.
v) Relação de conhecimentos: relação de conhecimentos de transporte
da fatura. Para cada conhecimento:
a. Chave: chave de acesso do CT-e;
b. Número: número do CT-e;
c. Série: série do CT-e;
d. Data de emissão: data de emissão do CT-e;
e. Destinatário: CNPJ do destinatário;
f. UF do destinatário: UF do destinatário;
g. Valor total: valor total do frete;
h. Valor do ICMS: valor total do ICMS;
i. Base de Cálculo do ICMS: base de cálculo do ICMS;
j. Alíquota de ICMS: alíquota de ICMS;
Página 34 de 34

k. Emissor: CNPJ do emissor;

l. Relação de notas fiscais: relação de notas fiscais do
conhecimento. Para cada nota fiscal:
i. Chave: chave de acesso da NF-e;
ii. Número: número da nota fiscal;
iii. Série: série da nota fiscal;
iv. Operação: entrada ou saída;
v. CFOP: CFOP predominante;
vi. Produto: código do produto predominante.

Esta mensagem será alimentada no servidor de mensagens (Amazon SQS

Queue), sendo consumida pelo Módulo Remoto TranspoFrete e integrada
consequentemente no sistema ERP.