Introdução
Sistemas Envolvidos
- TOTVS Otimização Logística / TOTVS Roteirização e Entrega
- Sistema Externo: ERPs que se conectam ou pretendem se conectar com TOL/TRE
Integração
Escopo
Integração assíncrona composta pelos serviços de publicação de viagens e desbloqueio de viagens:
- Se a tag orderBreakParts vier vazia, não existem quebras (splits) para as viagens enviadas na interface;
- Se a tag orderBreakParts vier preenchida, significa que existem viagens nesta interface que possuem quebras (splits); se isto ocorrer, deve-se identificar, dentro desta estrutura, os pedidos de transporte que sofreram quebras através dos seguintes campos:
- o orderSourceId: Este campo é o identificador do pedido de transporte recebido na interface de pedidos; se um pedido de transporte está dentro da estrutura orderBreakParts significa que esta sofreu quebra;
- o orderItemSourceId: Este campo é o identificador do item do pedido de transporte recebido na interface de pedidos;
- Se um item de pedido de transporte está dentro da estrutura orderBreakParts significa que este item (que está dentro do pedido orderSourceId) sofreu quebra;
- O campo loadId que existe dentro da estrutura orderBreakParts serve para associar o pedido de transporte (campos orderSourceId e orderItemSourceId) com a carga gerada pelo TOL\TRE nesta interface;
- As quantidades atualizadas pelo TOL\TRE após as quebras devem ser obtidas nos campos: quantShipmUnits; o quantProdUnits;
Pré-requisitos instalação/implantação/utilização
Versões mínimas
TOL\TRE: 6.4.0
Protheus: ?
Datasul: ?
Esta integração não demanda instalações ou atualizações adicionais.
Layout de Requisição
| doUnblockReleasedTrip: Integração SOAP, Assíncrona com a publishReleasedTrip; | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| unblockReleasedTrips | unblockReleasedTrips[] | Sim | N/A | Elemento de agrupamento de todas as solicitações de desbloqueio de viagens; | |
| unblockReleasedTrip, tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| unblockReleasedTrips | unblockReleasedTrip[] | Sim | N/A | Elemento de agrupamento de todas as solicitações de desbloqueio de viagens; | |
| unblockReleasedTrip, tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| identifier (unblock release trip) | Integer | Sim | 10 | ID da mensagem de solicitação de liberação da viagem; | Este campo deve ser de uma mensagem de solicitação de liberação de viagem válida ou -1 quando ocorrer algum erro no sistema externo ao tentar recriar as viagens do TOL/TRE (neste caso, a requisição feita neste serviço será ignorada pelo TOL/TRE); no caso de erro no sistema externo, o detalhe deste erro pode ser enviado no elemento "ERPMessageResponses"; |
| ERPMessageResponses | eRPMessageResponseList[] | Não | N/A | Entidade de agrupamento das respostas do sistema externo; | |
| orderBreakResponses | Não | N/A | Entidade de agrupamento de uma resposta do sistema externo para uma quebra do TOL/TRE; | Observação: se todas as quebras, menos 1, foram aprovadas, a última será aprovada automaticamente; | |
| tripReleaseResponses | tripReleaseResponseList[] | Sim | N/A | Entidade de agrupamento de uma resposta do sistema externo para as liberações de uma viagem do TOL/TRE; | |
| tripLoadsSourceIds | tripLoadsSourceIdList[] | Sim | N/A | Entidade de agrupamento para envio dos source ids das cargas do sistema externo para o TOL/TRE; | |
| eRPMessageResponseList, tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| ERPMessageResponses | eRPMessageResponse[] | Sim | N/A | Elemento de agrupamento de todas as solicitações de desbloqueio de viagens; | |
| eRPMessageResponse, tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| msg | String | Sim | N/A | Mensagem de resposta do sistema externo; | |
| orderBreakResponses, tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| orderBreakResponses | orderBreakResponse[] | Sim | N/A | Elemento de agrupamento de todas as solicitações de desbloqueio de viagens; | |
| orderBreakResponse , tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| regionSourceId | String | Sim | 30 | Identificador da regional; | Deve ser uma regional válida; |
| breakId | Integer | Sim | 10 | ID da quebra do TOL/TRE; | Este campo deve receber um ID de quebra válido; não se deve re-enviar IDs de quebra que já foram liberados; o sistema externo deverá dar um retorno para todos os breakIds gerados pelo TOL/TRE na interface de liberação de viagem para que esta seja liberada; |
| orderId | String | Sim | 30 | ID do pedido de transporte associado à quebra; | Importante: - Caso o sistema externo deseja que esta quebra seja vinculada a um novo pedido, basta informar o nome do novo pedido neste campo; as unidades relacionadas a esta quebra serão associadas ao novo pedido; os dados do novo pedido serão copiados do pedido original; - Esta alteração do pedido apenas será realizada se o campo status for enviado com o valor "1"; |
| orderItemId | String | Sim | 30 | ID do item do pedido de transporte associado à quebra; | Importante: - Caso o sistema externo deseja que esta quebra seja vinculada a um novo item de pedido, basta informar o nome do novo item pedido neste campo; as unidades relacionadas a esta quebra serão associadas ao novo item de pedido; os dados do novo item de pedido serão copiados do item de pedido original; - Esta alteração do item do pedido apenas será realizada se o campo status for enviado com o valor "1"; - Se o código do item de pedido for alterado mas o código de pedido permanecer o mesmo do pedido original, a mensagem será rejeitada; |
| status | Boolean | Sim | 1 | Status de resposta do sistema externo sobre a quebra do TOL/TRE; | 0=Quebra não realizada; 1=Quebra realizada; |
| msg | String | Não | 500 | Mensagem de resposta do sistema externo sobre a quebra do TOL/TRE; | |
| tripReleaseResponseList, tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| tripReleaseResponseList | tripReleaseResponse[] | Sim | N/A | Elemento de agrupamento de todas as solicitações de desbloqueio de viagens; | |
| tripReleaseResponse, tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| regionSourceId | String | Sim | 30 | Identificador da regional; | Deve ser uma regional válida; |
| tripCode | Integer | Sim | 10 | ID da viagem do TOL/TRE; | Este campo deve receber um ID de viagem válido; não se deve enviar IDs de viagens que já foram liberadas; |
| orderSourceId | String | Sim | 30 | ID do pedido de transporte associado à viagem; | Este campo deve receber um ID de pedido válido para a viagem; |
| itemId | String | Sim | 30 | ID do item do pedido de transporte associado ao pedido da viagem; | Este campo deve receber um ID de item de pedido válido para o pedido da viagem; o sistema externo deverá dar um retorno para todos os itens de pedido existentes na viagem para que esta seja liberada; |
| status | Boolean | Não | 1 | Status de resposta do sistema externo sobre a viagem do TOL/TRE; | 0=Não desbloqueia a viagem; 1=Desbloqueia a viagem; se este campo não for preenchido, ele será considerado como 0; |
| msg | String | Não | 500 | Mensagem de resposta do sistema externo sobre a viagem do TOL/TRE; | |
| tripLoadsSourceIdList, tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| tripLoadsSourceIds | tripLoadsSourceId[] | Sim | N/A | Entidade de agrupamento para envio dos source ids das cargas do sistema externo para o TOL/TRE; | |
| tripLoadsSourceId, tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| regionSourceId | String | Sim | 30 | Identificador da regional; | Deve ser uma regional válida; |
| tripId | Integer | Sim | 10 | ID de uma viagem do TOL/TRE; | |
| loads | load[] | Sim | N/A | Elemento de agrupamento de todas as cargas da viagem; | Quando enviada, esta seção deverá retornar todas as cargas da viagem; |
| load, tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| loadId | Integer | Sim | 10 | ID da carga da viagem no TOL/TRE; | Estes campos são apenas para que se possa ter uma referência do ID de uma carga do sistema externo no TOL/TRE; se o loadId não for válido (ex.: vazio ou um código inexistente no TOL/TRE) ou estiver associada a uma viagem distinta da informada, o TOL/TRE deverá retornar uma mensagem de erro e a requisição deverá ser ignorada; |
| loadSourceId | Integer | Sim | 30 | ID da carga da viagem no sistema externo; | |
Layout de Resposta
| tripLoadsSourceIdList, tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| result | results[] | Sim | N/A | Entidade de agrupamento para envio dos resultados | |
| results, tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| results | result[] | Sim | N/A | Entidade de agrupamento para envio dos resultados | |
| result, tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| errorCodes | errcode[] | Não | N/A | Lista de erros | |
| errorMessage | String | Não | N/A | Mensgem de erro | |
| identifier | String | Sim | N/A | ID da mensagem de solicitação de liberação da viagem; | |
| sucess | String | Sim | 1 | TRUE or FALSE | |
| errcode, tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| value | String | Não | N/A | Código do erro | |
Catalogo de erros
Anexos
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas