Web service Portolog: Alteração de DL-e
Serviço web que processa os pedidos de alteração das informações básicas bem como da inclusão/alteração dos dados das cargas e do transporte de documentos logísticos.
Atenção:
A inclusão/alteração dos dados das cargas e do transporte só será possível em DL-es de natureza IMPORTACAO, CABOTAGEM_DESTINO e SAIDA_CARGA. As demais naturezas de operação atualizam suas cargas e os dados de transporte através de um documento de origem separado conforme webservice de informação de documento de origem.
Atores que podem utilizar o Serviço:
- Operador Portuário
- Terminal Portuário
- Ponto de Controle
Endpoint do Serviço:
POST url_base/psp-portolog-rest/api/dle/altera/v1.00
Content-Type:
application/xml ou application/json
Parâmetros da Requisição de Alteração de DL-e:
Dados Gerais:
| Nome | Descrição | Tipo | Tamanho | Local | Observações |
|---|---|---|---|---|---|
| versao | versão do arquivo de alteração de DL-e | String(Obrigatório) | 4 | body | Versão Atual: 1.00 |
| cnpjEmissor | CNPJ do Sistema Externo que está solicitando a alteração do DL-e | String(Obrigatório) | 14 | body |
Informações Básicas dos DL-es:
| Nome | Descrição | Tipo | Tamanho | Local | Observações |
|---|---|---|---|---|---|
| seq | Sequencial para identificar o registro dentro do arquivo. Deve ser único para possibilitar o relacionamento no arquivo de retorno do processamento. | Numeric(Obrigatório) | - | body | |
| numeroDle | Número do DL-e a ser alterado | Numeric(Obrigatório) | 12 | body | |
| terminalPorto | CNPJ do terminal de destino do transporte | String(Opcional) | 14 | body | |
| previsaoAcesso | Data/Hora Prevista de Acesso ao Porto/Terminal | Data/Hora(Opcional) | 19 | body | Formato: AAAA-MM-DD T HH:mm:ss |
| previsaoAtracacao | Data/Hora Prevista de Atracação da Embarcação | Data/Hora(Opcional) | 19 | body | Formato: AAAA-MM-DD T HH:mm:ss |
| pontoControle | Código do Ponto de Controle de Puxada de Carga do DL-e | String(Opcional) | 7 | body | Domínio: Vide campo "observação" logo abaixo. |
| cnpjEmpresaDestino | CNPJ da Empresa de Destino do DL-e | String(Opcional) | 14 | body | Campo preenchido somente para DL-es de natureza IMPORTACAO, CABOTAGEM_DESTINO OU SAIDA_CARGA. |
Observação:
Para acesso às informações dos códigos de pontos de controle de puxada de carga que atendem ao seu terminal, favor consultar através do acesso à tela do Portolog, no menu "Serviços" e item de menu "Informações para Integração" selecionando o tipo "Ponto de Controle". Os códigos dos pontos de puxada serão iniciados sempre com "PI".
Lista de Itens de Carga(Opcional e informado Somente para DL-es de IMPORTACAO, CABOTAGEM_DESTINO e SAIDA_CARGA):
| Nome | Descrição | Tipo | Tamanho | Local | Observações |
|---|---|---|---|---|---|
| numeroDuv | Número do DUV(Documento Único Virtual) associado ao item de carga. | Numeric(Opcional) | 12 | body | |
| numeroManifesto | Número do Manifesto de Carga associado ao item de carga. | String(Opcional) | 13 | body | |
| numeroConhecimento | Número do Conhecimento de Embarque associado ao item de carga. | String(Opcional) | 18 | body | |
| numeroMercante | Número do Conhecimento do Mercante associado ao item de carga. | Numeric(Opcional) | 15 | body | |
| codigoConteiner | Código/Identificação do conteiner | Numeric(Opcional) | 11 | body | (*) Campo Obrigatório quando tipoCarga for CONTEINER ou CONTEINER VAZIO. |
| numeroChassi | Número do chassi do veículo. | String(Opcional) | 17 | body | (*) Campo Obrigatório quando o tipoCarga for VEICULO. |
| codigoNCM | Código NCM(Mercadoria). | String(Opcional) | 15 | body | (*) Campo Obrigatório quando o tipoCarga for CARGA_SOLTA ou GRANEL. |
| nomeMarca | Nome da Marca (Mercadoria). | String(Opcional) | 60 | body | (*) Campo Obrigatório quando o tipoCarga for CARGA_SOLTA. |
| qtVolumesTransportados | Quantidade de volumes transportados. | Numeric(Opcional) | 6 | body | (*) Campo obrigatório caso o o DL-e já tenha sido sequenciado. |
| pesoBrutoTransportado | Peso Bruto Transportado em Kg. | Numeric(Opcional) | 15,3 | body | Exemplo: 99999.999 (*) Campo obrigatório caso o o DL-e já tenha sido sequenciado. |
| descGranel | Descrição do Granel. | String(Opcional) | 60 | body | (*) Campo Obrigatório quando o tipoCarga for GRANEL. |
Atenção:
1. O sistema sempre sobrescreve no DL-e todas as informações encaminhadas no arquivo de alteração. Desta forma, caso o usuário já tenha adicionado uma carga ao DL-e e queira incluir uma nova carga, deverá informar ambas as cargas no arquivo de alteração(A carga já existente e a nova carga a ser incluída).
2. O sistema permite que sejam informadas dentro do arquivo de alteração várias cargas com o mesmo valor do campo "Código NCM", porém não permite que seja informada mais de uma carga com o mesmo valor dos campos "Identificação do Contêiner" e "Número do Chassi".
3 Somente será possível informar itens de carga de uma das fontes, associadas a um DUV ou não associadas a um DUV, e nunca as duas ao mesmo tempo.
Dados do Transporte(Opcional e informado Somente para DL-es de IMPORTACAO, CABOTAGEM_DESTINO e SAIDA_CARGA):
| Nome | Descrição | Tipo | Tamanho | Local | Observações |
|---|---|---|---|---|---|
| placa | Número da Placa do Transporte. | String(Opcional) | 7 | body | |
| cpf | CPF do Motorista do Transporte. | String(Opcional) | 11 | body | |
| nome | Nome do Motorista do Transporte. | String(Opcional) | 60 | body |
Observação:
1. Os campos da sessão "Informações Básicas dos DL-es" poderão ser alterados somente quando o estado do DL-e for "DL-e Criado". A única exceção é o campo "Ponto de Controle" que poderá ser alterado até o sequenciamento do DL-e, ou seja, até o estado "Acesso ao Porto Confirmado".
2. Os campos da sessão "Dados do Transporte" poderão ser alterados somente quando o estado do DL-e for "DL-e Criado".
3. Os campos da sessão "Lista de Itens de Carga" poderão ser alterados até mesmo após a finalização do DL-e.
4. Quando se tratar de um DL-e de natureza DIFERENTE de IMPORTACAO, CABOTAGEM_DESTINO ou SAIDA_CARGA, e na requisição de alteração forem informados os campos das sessões "Lista de Itens de Carga" e "Dados do Transporte", os mesmos serão desconsiderados no momento do processamento desta requisição.
Resposta da Requisição:
Dados Gerais:
| Nome | Descrição | Tipo | Observação |
|---|---|---|---|
| versao | Versão do Arquivo de Retorno de Processamento de Alteração de DL-e | String(Obrigatório) | Versão Atual: 1.00 |
| dataProcessamento | Data/Hora do Registro de Processamento de Alteração de DL-e | Data/Hora(Obrigatório) |
Dados dos Registros:
| Nome | Descrição | Tipo | Observação |
|---|---|---|---|
| seq | Sequencial do registro dentro do arquivo | Numeric(Obrigatório) | |
| mensagem | Mensagem de confirmação ou erro no processamento do registro de alteração de DL-e | String(Obrigatório) | |
| numeroDle | Número do DL-e Alterado. | Numeric(Opcional) | (*) Campo exibido somente se a alteração do DL-e for efetivada com sucesso. |
Exemplos de Arquivos XML/JSON:
Exemplo de JSON do arquivo de alteração de DL-e:
{
"versao":"1.00",
"cnpjEmissor":"46591057000103",
"DLe": [
{
"seq":"0",
"numeroDle": 25102019,
"terminalPorto":"46591057000103",
"previsaoAcesso":"2019-12-15T13:00:00",
"pontoControle":"PI00027",
"cnpjEmpresaDestino":"22222222222"
},
{
"seq":"1",
"numeroDle": 25112019,
"terminalPorto":"46591057000103",
"previsaoAcesso":"2020-02-08T18:30:00",
"previsaoAtracacao":"2020-02-08T18:40:00",
"pontoControle":"PI00009",
"itens": {
"item": [
{
"codigoConteiner":"111",
"qtVolumesTransportados":"10",
"pesoBrutoTransportado":"50.000"
}
]
},
"transporte":
{
"placa":"TES0001",
"motorista":
{
"cpf":"22222222222",
"nome":"João Bosco"
}
}
}
]
}
Exemplo de retorno de JSON com a resposta da requisição:
{
"dataProcessamento" : "2019-11-13T14:50:51.945-03:00",
"versao":"1.00",
"dleProc" : [
{
"mensagem" : [ "[IN0208] Registro processado com sucesso" ],
"numeroDle" : 5012019,
"seq" : 0
}
]
}
Exemplo de retorno de JSON com resposta de erro:
{
"dataProcessamento" : "2019-11-13T14:50:51.945-03:00",
"versao":"1.00",
"dleProc" : [
{
"mensagem" : [ "[ER0251] O DL-e informado é inexistente." ],
"seq" : 0
},
{
"mensagem" : [ "[ER0206] O ponto de puxada não pode mais ser alterado." ],
"seq" : 1
}
]
}
Exemplo de XML do arquivo de alteração de DL-e:
<?xml version="1.0" encoding="UTF-8"?>
<loteAlteracaoDLe versao="1.00" xmlns="http://www.portosempapel.gov.br/dle" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.portosempapel.gov.br/dle alteracaoDle_v1.00.xsd ">
<cnpjEmissor>04291660000120</cnpjEmissor>
<DLe seq="0">
<numeroDle>2052020</numeroDle>
<terminalPorto>04291660000120</terminalPorto>
<previsaoAcesso>2020-02-09T12:30:00</previsaoAcesso>
<previsaoAtracacao>2020-02-09T12:40:00</previsaoAtracacao>
<pontoControle>PI00001</pontoControle>
<itens>
<item>
<codigoNCM>20001108</codigoNCM>
<qtVolumesTransportados>100</qtVolumesTransportados>
<pesoBrutoTransportado>10000.500</pesoBrutoTransportado>
<descGranel>Soja</descGranel>
</item>
</itens>
<transporte>
<placa>DIE7151</placa>
<motorista>
<cpf>33333333333</cpf>
<nome>José da Silva</nome>
</motorista>
</transporte>
</DLe>
</loteAlteracaoDLe>
Exemplo de retorno de XML com a resposta da requisição:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<loteAlteracaoDLeProc xmlns="http://www.portosempapel.gov.br/dle" versao="1.00">
<dataProcessamento>2020-01-15T13:54:51.466-03:00</dataProcessamento>
<dleProc seq="0">
<mensagem>[IN0208] Registro processado com sucesso</mensagem>
<numeroDle>612020</numeroDle>
</dleProc>
</loteAlteracaoDLeProc>
Exemplo de retorno de XML com resposta de erro:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<loteAlteracaoDLeProc xmlns="http://www.portosempapel.gov.br/dle" versao="1.00">
<dataProcessamento>2020-01-15T13:52:43.478-03:00</dataProcessamento>
<dleProc seq="0">
<mensagem>[ER0204] Não foi possível processar a solicitação pois o DL-e já se encontra na situação Acesso ao Porto Efetivado</mensagem>
</dleProc>
</loteAlteracaoDLeProc>