Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Introdução

draw.io Diagram
borderfalse
viewerToolbartrue
fitWindowfalse
diagramDisplayName
lboxtrue
revision4
diagramNameTRE_Liberacao_viagem
simpleViewerfalse
width
linksauto
tbstylehidden
diagramWidth480


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

Âncora
publishReleasedTrip
publishReleasedTrip

publishReleasedTrip: Integração SOAP, Assíncrona com a doUnblockReleasedTrip;
NomeTipoObrigatórioTamanhoDescriçãoObservações
messageIdIntegerSim10ID da mensagem de solicitação de liberação de uma viagem;
orderBreakPartsorderBreakPart[]NãoN/AElemento de agrupamento de todas as quebras;

Deverá haver pelo menos 1 quebra nesta lista;

tripReleaseRequeststripReleaseReques[]SimN/AElemento de agrupamento de todas as solicitações de liberações de viagens do;Deverá haver pelo menos 1 solicitação de liberação de viagem nesta lista;

Âncora
orderBreakPart
orderBreakPart

orderBreakPart, tipo de dado utilizado nas integrações do TOL\TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
regionSourceIdStringSim30Identificador da regional;Deve ser uma regional válida;
orderBreakPartIdIntegerSim10IDs das quebras;
orderSourceIdStringSim30ID do pedido de transporte associado à quebra;
orderTypeSourceIdStringSim30Código do tipo do pedido;
orderItemSourceIdStringSim30ID do item do pedido de transporte associado à quebra;
loadIdIntegerSim10ID da carga associada à quebra;
shipmentUnitIdIntegerSim1ID da categoria de invólucro da unidade de embarque;1=Pacote; 2=Granel não unitizável; 3=Pallet; 4=Granel unitizável; 5=Bobina; 6=Skid; 7=Tubo; 8=Feixe de tubos;
quantShipmUnitsFloatSim13Quantidade de unidades de embarque na quebra;Se o item de remessa for enviado com valores fracionados, este campo poderá, em algumas situações, também retornar valores fracionados;
quantProdUnitsFloatSim13Quantidade de unidades do SKU na quebra;
classificationsclassifications []NãoN/AElemento de agrupamento de todas as classificações de uma viagem;
attributes attributes[]NãoN/AElemento de agrupamento de todos os atributos de uma viagem;

Âncora
tripReleaseRequest
tripReleaseRequest

tripreleaseRequest, tipo de dado utilizado nas integrações do TOL\TRE

Nome

TipoObrigatórioTamanhoDescriçãoObservações
regionSourceIdStringSim30Identificador da regional;Deve ser uma regional válida;
basketSourceIdStringNão30ID da cesta onde esta operação foi realizada manualmente pelo usuário;Este campo poderá não ser enviado nos casos em que a liberação foi solicitada de forma automática e não através da tela (nestes casos, não se pode identificar a cesta do usuário);
identifier (trip)IntegerSim10ID da viagem cuja liberação está sendo solicitada ;
freightValueFloatSim13Valor do frete da viagem;
carrierIdStringSim255ID da transportadora da viagem;Não existe no TRE (R2)
vehicleIdStringSim255ID do tipo de veículo da viagem;
vehicleDescriptionStringNão255Descrição do tipo de veículo da viagem;
truckLicensePlateStringNão8Placa do caminhão da viagem;Esta placa poderá ser informada pela transportadora ao aceitar a viagem (Partner Collaboration);
truckLicensePlateStateStringNão2Estado da placa do caminhão da viagem;
truckStatusIdStringNão2Identificador da situação do caminhão;0=Desconhecido, 1=Agregado, 2=Frota própria, 3=Frota terceirizada;
truckStatusDescriptionStringNão255Descrição da situação do caminhão;
truckAxlesQuantityIntegerNão10Número de eixos do caminhão;Serão contabilizados os eixos de todos os baús do caminhão;
trailerstrailer[]NãoN/AElemento de agrupamento de todas as carretas de uma viagem;Não existe no TRE (R2)
classificationsclassifications []NãoN/AElemento de agrupamento de todas as classificações de uma viagem;
attributes attributes[]NãoN/AElemento de agrupamento de todos os atributos de uma viagem;
commentsStringNão255Observações da viagem;
loadsload[]SimN/AElemento de agrupamento de todas as cargas de uma viagem;Deverá haver pelo menos 1 carga nesta lista;

Âncora
trailer
trailer

trailer, tipo de dado utilizado nas integrações do TOL\TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
trailerLicensePlateStringNão8Placa da carreta da viagem;Esta placa poderá ser informada pela transportadora ao aceitar a viagem (Partner Collaboration);
trailerLicensePlateStateStringNão2Estado da placa da carreta da viagem;

Âncora
loads
loads

load, tipo de dado utilizado nas integrações do TOL\TRE

Nome

TipoObrigatórioTamanhoDescriçãoObservações
identifier (load)IntegerSim10ID da carga da viagem;
serviceTypeIdIntegerSim1ID do tipo de serviço da carga;Full truck load (FTL);
Less than truck load (LTL);
serviceTypeDescriptionStringSim255Descrição do tipo de serviço da carga;
loadModeIntegerSim1ID do tipo de carga;1=Estivada; 2=Paletizada; 3=Mista;
modalIntegerSim1ID do modal da carga;1=Rodoviário; 2=Aquaviário; 3=Ferroviário; 4=Aéreo;
distanceFloatSim13Distância da carga;
freightFloatSim13Frete da carga;
dispatchLimitTimeData/hora (String)Não29Data limite para o despacho da carga;Última janela de tempo possível para a carga;
stopsstop[]SimN/AElemento de agrupamento de todas as paradas de uma carga de uma viagem;Deverão haver pelo menos 2 paradas nesta lista;

Âncora
stop
stop

stop, tipo de dado utilizado nas integrações do TOL\TRE

Nome

TipoObrigatórioTamanhoDescriçãoObservações
identifier (stop)IntegerSim10ID da parada de uma carga de uma viagem;
localitySourceIdStringSim30ID da localidade da parada de uma carga de uma viagem;
transportZoneIdStringSim255ID da zona de transporte da parada de uma carga de uma viagem;
transportZoneDescriptionStringNão50Descrição da zona de transporte da parada de uma carga de uma viagem;


sequenceOnLoadIntegerSim10Sequência da parada de uma carga de uma viagem;
subStopssubStop[]SimN/AElemento de agrupamento de todas as sub-paradas de uma carga de uma viagem;Deverá haver, pelo menos, 1 sub-parada para uma parada;

Âncora
subStop
subStop

subStop, tipo de dado utilizado nas integrações do TOL\TRE

Nome

TipoObrigatórioTamanhoDescriçãoObservações
identifier (sub-stop)IntegerSim10ID da sub-parada de uma carga de uma viagem;
arrivalTimeData/hora (String)Sim29Data planejada de chegada do veículo na sub-parada de uma carga de uma viagem;
startServiceTimeData/hora (String)Sim29

Data planejada de início do carregamento/descarregamento na sub-parada de uma carga de uma viagem;


endServiceTimeData/hora (String)Sim29

Data planejada de término do carregamento/descarregamento na sub-parada de uma carga de uma viagem;


departureTimeData/hora (String)Sim29Data planejada de partida do veículo da sub-parada de uma carga de uma viagem;
dockIdIntegerNão10

ID da doca planejada de carregamento/descarregamento na sub-parada de uma carga de uma viagem;


dockDescriptionStringNão255

Descrição da doca planejada de carregamento/descarregamento na sub-parada de uma carga de uma viagem;


loadedShipmentUnitsSimN/AElemento de agrupamento das unidades de embarque que serão carregadas em uma parada de uma carga de uma viagem;Deverá haver pelo menos 1 unidade de embarque nesta lista;
unloadedShipmentUnitsshipmentUnit[]SimN/AElemento de agrupamento das unidades de embarque que serão descarregadas em uma parada de uma carga de uma viagem;Deverá haver pelo menos 1 unidade de embarque nesta lista;



Âncora
shipmentUnit
shipmentUnit

shipmentUnit, tipo de dado utilizado nas integrações do TOL\TRE

Nome

TipoObrigatórioTamanhoDescriçãoObservações
identifier (shipment unit)IntegerSim10ID da unidade de embarque de uma parada de uma carga de uma viagem;
shipmentUnitCategoryIdIntegerSim1ID da categoria de invólucro da unidade de embarque;1=Pacote; 2=Granel não unitizável; 3=Pallet; 4=Granel unitizável; 5=Bobina; 6=Skid; 7=Tubo; 8=Feixe de tubos;
shipmentUnitDescriptionStringNão20Descrição da categoria de invólucro da unidade de embarque;BULK; BULK_UNIT, PACK; PALLET; DRUM; SKID; TUBE; TUBE_PACK;
shipmentUnitQtyFloatSim13Quantidade de unidades de embarque de uma parada de uma carga de uma viagem;
weightFloatSim13Peso das unidades de embarque de uma parada de uma carga de uma viagem;
volumeFloatSim13Volume das unidades de embarque de uma parada de uma carga de uma viagem;
lengthFloatSim13Comprimento das unidades de embarque de uma parada de uma carga de uma viagem;
widthFloatSim13Largura das unidades de embarque de uma parada de uma carga de uma viagem;
heightFloatSim13Altura das unidades de embarque de uma parada de uma carga de uma viagem;
palletHeightTotalFloatSim13Altura máxima total das unidades de embarque de uma parada de uma carga de uma viagem;
deliveryUnitListdeliveryUnit[]SimN/AEntidade de agrupamento das unidades de entrega de uma parada de uma carga de uma viagem;Deverá haver pelo menos 1 unidade de entrega nesta lista;

Âncora
deliveryUnit
deliveryUnit

deliveryUnit, tipo de dado utilizado nas integrações do TOL\TRE

Nome

TipoObrigatórioTamanhoDescriçãoObservações
identifier (delivery unit)StringSim30ID da unidade de entrega;
orderSourceIdStringSim30ID do pedido de transporte da unidade de entrega;
orderTypeSourceIdStringSim30Código do tipo do pedido;
orderItemSourceIdStringSim30ID do item de pedido de transporte da unidade de entrega;
productSourceIdStringSim30ID do produto da unidade de entrega;
sequenceCompositionIntegerNão10

Sequência da composição do SKU da unidade de entrega (apenas para SKUs que são multi-volume);


quantityFloatSim13Quantidade das unidades de entrega;
priceFloatSim13Preço das unidades de entrega;
deliveryDateData/hora (String)Sim29Data planejada de entrega da unidade de entrega;
integrationSourceStringSim30ID da origem de dados;
classificationsclassifications []NãoN/AElemento de agrupamento de todas as classificações de uma unidade de entrega
attributes attributes[]NãoN/AElemento de agrupamento de todos os atributos de uma unidade de entrega

Âncora
classifications
classifications

classifications, tipo de dado utilizado nas integrações do TOL\TRE

Nome

TipoObrigatórioTamanhoDescriçãoObservações
typeStringSim255Tipo da classificação da viagem;
valueStringSim255Valor da classificação da viagem;

Âncora
attributes
attributes

attributes, tipo de dado utilizado nas integrações do  TOL\TRE

Nome

TipoObrigatórioTamanhoDescriçãoObservações
nameStringSim255Nome do atributo da viagem;
valueStringSim255Valor do atributo da viagem;

Layout de Resposta

publishReleasedTripResponse, tipo de dado utilizado nas integrações do  TOL\TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
publishReleasedTripResponseStringSim1

Mensagem de confirmação de recebimento das solicitações de liberação de viagens;

"S" ou "N";

Catalogo de mensagens

CódigoMensagemDescrição

Anexos

Anexos