TOTVS Roteirização e Entregas

Árvore de páginas

Versões comparadas

Versão antiga 18

changes.mady.by.user Julio Vinicius Oliveira dos Santos

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Julio Vinicius Oliveira dos Santos

Gravado em

Chave

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

Introdução

draw.io Diagram
borderfalse
viewerToolbartrue
fitWindowfalse
diagramDisplayName
lboxtrue
revision

3

4
diagramNameTRE

Liberacaa

_

de

Liberacao_viagem
simpleViewerfalse
width
linksauto
tbstylehidden
diagramWidth480


Sistemas Envolvidos

Integração

  • TOTVS Otimização Logística / TOTVS Roteirização e Entrega
  • Sistema Externo: ERPs que se conectam ou pretendem se conectar com TOL/TRE

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;
    viagens.

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
messageId
Numérico (inteiro)
IntegerSim10ID da mensagem de solicitação de liberação de uma viagem
do CPL
;
orderBreakPartsorderBreakPart[]NãoN/AElemento de agrupamento de todas as quebras
do CPL
;

Deverá haver pelo menos 1 quebra

do CPL

nesta lista;

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

Âncora
orderBreakPart
orderBreakPart

orderBreakPart
: Integração SOAP, Assincrona
, tipo de dado utilizado nas integrações do TOL\TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
regionSourceId
Alfanumérico
StringSim30Identificador da regional;Deve ser uma regional válida;
orderBreakPartId
Numérico (inteiro)
IntegerSim10IDs das quebras
do CPL
;
orderSourceId
Alfanumérico
StringSim30ID do pedido de transporte associado à quebra;
orderTypeSourceId
Alfanumérico
StringSim30Código do tipo do pedido;
orderItemSourceId
Alfanumérico
StringSim30ID do item do pedido de transporte associado à quebra;
loadId
Numérico (inteiro)
IntegerSim10ID da carga associada à quebra;
shipmentUnitId
Numérico (inteiro)
IntegerSim1ID 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;
quantShipmUnits
Numérico (float)
FloatSim13Quantidade de unidades de embarque na quebra
do CPL
;Se o item de remessa for enviado com valores fracionados, este campo poderá, em algumas situações, também retornar valores fracionados;
quantProdUnits
Numérico (float)
FloatSim13Quantidade de unidades do SKU na quebra
do CPL
;
classificationsclassifications []NãoN/AElemento de agrupamento de todas as classificações de uma viagem;
attributes attributes[]NãoN/AElemento de agrupamento de
todas
todos os atributos de uma viagem;

Âncora
tripReleaseRequest
tripReleaseRequest

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

Nome

TipoObrigatórioTamanhoDescriçãoObservações
regionSourceId
Alfanumérico
StringSim30Identificador da regional;Deve ser uma regional válida;
basketSourceId
Alfanumérico
StringNão30ID da cesta onde esta operação foi realizada manualmente pelo usuário
no CPL
;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
do CPL
(nestes casos, não se pode identificar a cesta do usuário);
identifier (trip)
Numérico (inteiro)
IntegerSim10ID da viagem cuja liberação está sendo solicitada
pelo CPL
;
freightValue
Numérico (float)
FloatSim13Valor do frete da viagem;
carrierId
Alfanumérico
StringSim255ID da transportadora da viagem;Não existe no TRE (R2)
vehicleId
Alfanumérico
StringSim255ID do tipo de veículo da viagem;
vehicleDescription
Alfanumérico
StringNão255Descrição do tipo de veículo da viagem;
truckLicensePlate
Alfanumérico
StringNão8Placa do caminhão da viagem;Esta placa poderá ser informada pela transportadora ao aceitar a viagem (Partner Collaboration);
truckLicensePlateState
Alfanumérico
StringNão2Estado da placa do caminhão da viagem;
truckStatusId
Alfanumérico
StringNão2Identificador da situação do caminhão;0=Desconhecido, 1=Agregado, 2=Frota própria, 3=Frota terceirizada;
truckStatusDescription
Alfanumérico
StringNão255Descrição da situação do caminhão;
truckAxlesQuantity
Numérico (inteiro)
IntegerNã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
todas
todos os atributos de uma viagem;
comments
Alfanumérico
StringNã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
do TOL\TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
trailerLicensePlate
Alfanumérico
StringNão8Placa da carreta da viagem;Esta placa poderá ser informada pela transportadora ao aceitar a viagem (Partner Collaboration);
trailerLicensePlateState
Alfanumérico
StringNã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)
Numérico (inteiro)
IntegerSim10ID da carga da viagem;
serviceTypeId
Numérico (inteiro)
IntegerSim1ID do tipo de serviço da carga;Full truck load (FTL);
Less than truck load (LTL);
serviceTypeDescription
Alfanumérico
StringSim255Descrição do tipo de serviço da carga;
loadMode
Numérico (inteiro)
IntegerSim1ID do tipo de carga;1=Estivada; 2=Paletizada; 3=Mista;
modal
Numérico (inteiro)
IntegerSim1ID do modal da carga;1=Rodoviário; 2=Aquaviário; 3=Ferroviário; 4=Aéreo;
distance
Numérico (float)
FloatSim13Distância da carga;
freight
Numérico (float)
FloatSim13Frete da carga;
dispatchLimitTimeData/hora (
string
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)
Numérico (inteiro)
IntegerSim10ID da parada de uma carga de uma viagem;
localitySourceId
Alfanumérico
StringSim30ID da localidade da parada de uma carga de uma viagem;
transportZoneId
Alfanumérico
StringSim255ID da zona de transporte da parada de uma carga de uma viagem;
transportZoneDescription
Alfanumérico
StringNão50Descrição da zona de transporte da parada de uma carga de uma viagem;


sequenceOnLoad
Numérico (inteiro)
IntegerSim10Sequê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
do TOL\TRE

Nome

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

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


endServiceTimeData/hora (
string
String)Sim29

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


departureTimeData/hora (
string
String)Sim29Data planejada de partida do veículo da sub-parada de uma carga de uma viagem;
dockId
Numérico (inteiro)
IntegerNão10

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


dockDescription
Alfanumérico
StringNão255

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


loadedShipmentUnits

shipmentUnit[]

SimN/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
do TOL\TRE

Nome

TipoObrigatórioTamanhoDescriçãoObservações
identifier (shipment unit)
Numérico (inteiro)
IntegerSim10ID da unidade de embarque de uma parada de uma carga de uma viagem;
shipmentUnitCategoryId
Numérico (inteiro)
IntegerSim1ID 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;
shipmentUnitDescription
Alfanumérico
StringNão20Descrição da categoria de invólucro da unidade de embarque;BULK; BULK_UNIT, PACK; PALLET; DRUM; SKID; TUBE; TUBE_PACK;
shipmentUnitQty
Numérico (float)
FloatSim13Quantidade de unidades de embarque de uma parada de uma carga de uma viagem;
weight
Numérico (float)
FloatSim13Peso das unidades de embarque de uma parada de uma carga de uma viagem;
volume
Numérico (float)
FloatSim13Volume das unidades de embarque de uma parada de uma carga de uma viagem;
length
Numérico (float)
FloatSim13Comprimento das unidades de embarque de uma parada de uma carga de uma viagem;
width
Numérico (float)
FloatSim13Largura das unidades de embarque de uma parada de uma carga de uma viagem;
height
Numérico (float)
FloatSim13Altura das unidades de embarque de uma parada de uma carga de uma viagem;
palletHeightTotal
Numérico (float)
FloatSim13Altura 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
do TOL\TRE

Nome

TipoObrigatórioTamanhoDescriçãoObservações
identifier (delivery unit)
Alfanumérico
StringSim30ID da unidade de entrega;
orderSourceId
Alfanumérico
StringSim30ID do pedido de transporte da unidade de entrega;
orderTypeSourceId
Alfanumérico
StringSim30Código do tipo do pedido;
orderItemSourceId
Alfanumérico
StringSim30ID do item de pedido de transporte da unidade de entrega;
productSourceId
Alfanumérico
StringSim30ID do produto da unidade de entrega;
sequenceComposition
Numérico (inteiro)
IntegerNão10

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


quantity
Numérico (float)
FloatSim13Quantidade das unidades de entrega;
price
Numérico (float)
FloatSim13Preço das unidades de entrega;
deliveryDateData/hora (
string
String)Sim29Data planejada de entrega da unidade de entrega;
integrationSource
Alfanumérico
StringSim30ID 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
todas
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
type
Alfanumérico
StringSim255Tipo da classificação da viagem;
value
Alfanumérico
StringSim255Valor da classificação da viagem;

Âncora
attributes
attributes

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

Nome

TipoObrigatórioTamanhoDescriçãoObservações
Nome
TipoObrigatórioTamanhoDescrição
name
Alfanumérico
StringSim255Nome do atributo da viagem;
value
Alfanumérico
StringSim255Valor do atributo da viagem;

Layout de Resposta

publishReleasedTripResponse, tipo de dado utilizado nas integrações
do
do  TOL\TRE
NomeTipo
ObrigatoriedadeTam. Máx.FormatoValor default
ObrigatórioTamanhoDescriçãoObservações
publishReleasedTripResponse
Alfanumérico
StringSim1
N/AN/A

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

do CPL (ACK)

;

"S" ou "N";

Catalogo de

erros

mensagens

CódigoMensagemDescrição

Anexos

Anexos