Histórico da Página

Introdução

draw.io Diagram

border	false
viewerToolbar	true

fitWindow	false
diagramDisplayName
lbox	true
revision	1
diagramName	TOL_oferta_viagem
simpleViewer	false
width
links	auto
tbstyle	hidden
diagramWidth	342

Sistemas Envolvidos

TOTVS Roteirização e EntregaOtimização Logística
Sistema Externo: Todos os ERPs que se conectam ou pretendem se conectar com os produtos de planejamento logístico da TOTVS.

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 vazio, 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 TRE nesta interface;
As quantidades atualizadas pelo 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
- TRETOL: 6.4.0
- Protheus: ?
- Datasul: ?
Esta integração não demanda instalações ou atualizações adicionais.

Layout de Requisição

Âncora

	publishReleasedTrip
	publishReleasedTrip

Elemento de agrupamento de todas as quebras do TRE;

publishReleasedTrippublishTenderingService: Integração SOAP, Assíncrona com a doUnblockReleasedTrip;síncrona
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
messageId	int	Sim	10	ID da mensagem de solicitação de liberação de uma viagem do TRE; TOL
orderBreakPartstripTenderingNotification	orderBreakParttripTenderingNotification[]	Não	N/A		Deverá haver pelo menos 1 quebra do TRE nesta lista;	tripReleaseRequests	tripReleaseReques[]	Sim	N/A	Elemento de agrupamento de todas as solicitações de liberações de viagens do TRE; TOL	Deverá haver pelo menos 1 solicitação de liberação de viagem nesta lista;

Âncora

	orderBreakParttripTenderingNotificationorderBreakPart
	tripTenderingNotification

orderBreakPart TRE

tripTenderingNotification, tipo de dado utilizado nas integrações do						TOL
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
regionSourceId	string	Sim	30	Identificador da regional;	Deve ser uma regional válida;	orderBreakPartId	int	Sim	10	IDs das quebras do TRE;	orderSourceId	string	Sim	30	ID do pedido de transporte associado à quebra;	orderTypeSourceId	string	Sim	30	Código do tipo do pedido;	orderItemSourceId	string	Sim	30	ID do item do pedido de transporte associado à quebra;	loadId	int	Sim	10	ID da carga associada à quebra;
shipmentUnitId	int	Sim	1	ID 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	float	Sim	13	Quantidade de unidades de embarque na quebra do TRE;	Se o item de remessa for enviado com valores fracionados, este campo poderá, em algumas situações, também retornar valores fracionados;
quantProdUnits	float	Sim	13	Quantidade de unidades do SKU na quebra do TRE;	classifications	classifications []	Não	N/A	Elemento de agrupamento de todas as classificações de uma viagem;	attributes	attributes[]	Não	N/A	Elemento de agrupamento de todas os atributos de uma viagem;

ÂncoratripReleaseRequesttripReleaseRequest

~~trailerstrailer[]Não~~

tripreleaseRequest, 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;
basketSourceId	string	Não	30	ID da cesta onde esta operação foi realizada manualmente pelo usuário no TRE; TOL	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 TRE TOL (nestes casos, não se pode identificar a cesta do usuário);
identifier (trip)	int	Sim	10	ID da viagem cuja liberação está sendo solicitada pelo TRE TOL;
creationDate	Data/hora (string)	Sim	29	Data de criação da viagem
freightValue	float	Sim	13	Valor do frete da viagem;
carrierId	string	Sim	255	ID da transportadora da viagem;	Não existe no TRE (R2)
vehicleId	string	Sim	255	ID do tipo de veículo da viagem;
vehicleDescription	string	Não	255	Descrição do tipo de veículo da viagem;
truckLicensePlate	string	Não	8	Placa do caminhão da viagem;	Esta placa poderá ser informada pela transportadora ao aceitar a viagem (Partner Collaboration);
truckLicensePlateState	string	Não	2	Estado da placa do caminhão da viagem;
truckStatusId	string	Não	2	Identificador da situação do caminhão;	0=Desconhecido, 1=Agregado, 2=Frota própria, 3=Frota terceirizada;
truckStatusDescription	string	Não	255	Descrição da situação do caminhão;
truckAxlesQuantity	int	Não	10	Número de eixos do caminhão;	Serão contabilizados os eixos de todos os baús do caminhão;
tripClassificationSourceId	String	Sim	30	Classificação da viagem
~~N/A~~	~~Elemento de agrupamento de todas as carretas de uma viagem;~~	~~Não existe no TRE (R2)~~	classifications	classifications []	Não	N/A	Elemento de agrupamento de todas as classificações de uma viagem;
attributes	attributes[]	Não	N/A	Elemento de agrupamento de todas os atributos de uma viagem;
comments	string	Não	255	Observações da viagem;
loads	load[]	Sim	N/A	Elemento 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 TRE

NomeTipoObrigatórioTamanhoDescriçãoObservaçõestrailerLicensePlatestringNã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 TREdo TOL
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
identifier (load)	int	Sim	10	ID da carga da viagem;
serviceTypeId	int	Sim	1	ID do tipo de serviço da carga;	Full truck load (FTL); Less than truck load (LTL);
serviceTypeDescription	string	Sim	255	Descrição do tipo de serviço da carga;
loadMode	int	Sim	1	ID do tipo de carga;	1=Estivada; 2=Paletizada; 3=Mista;
modal	int	Sim	1	ID do modal da carga;	1=Rodoviário; 2=Aquaviário; 3=Ferroviário; 4=Aéreo;
distance	float	Sim	13	Distância da carga;
freight	float	Sim	13	Frete da carga;
dispatchLimitTime	Data/hora (string)	Não	29	Data limite para o despacho da carga;	Última janela de tempo possível para a carga;
stops	stop[]	Sim	N/A	Elemento 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 TREdo TOL
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
identifier (stop)	int	Sim	10	ID da parada de uma carga de uma viagem;
localitySourceId	string	Sim	30	ID da localidade da parada de uma carga de uma viagem;
transportZoneId	string	Sim	255	ID da zona de transporte da parada de uma carga de uma viagem;
transportZoneDescription	string	Não	50	Descrição da zona de transporte da parada de uma carga de uma viagem;
sequenceOnLoad	int	Sim	10	Sequência da parada de uma carga de uma viagem;
subStops	subStop[]	Sim	N/A	Elemento 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 TRE TOL
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
identifier (sub-stop)	int	Sim	10	ID da sub-parada de uma carga de uma viagem;
arrivalTime	Data/hora (string)	Sim	29	Data planejada de chegada do veículo na sub-parada de uma carga de uma viagem;
startServiceTime	Data/hora (string)	Sim	29	Data planejada de início do carregamento/descarregamento na sub-parada de uma carga de uma viagem;
endServiceTime	Data/hora (string)	Sim	29	Data planejada de término do carregamento/descarregamento na sub-parada de uma carga de uma viagem;
departureTime	Data/hora (string)	Sim	29	Data planejada de partida do veículo da sub-parada de uma carga de uma viagem;
dockId	int	Não	10	ID da doca planejada de carregamento/descarregamento na sub-parada de uma carga de uma viagem;
dockDescription	string	Não	255	Descrição da doca planejada de carregamento/descarregamento na sub-parada de uma carga de uma viagem;
loadedShipmentUnits	shipmentUnit[]	Sim	N/A	Elemento 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;
unloadedShipmentUnits	shipmentUnit[]	Sim	N/A	Elemento 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 TREdo TOL
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
identifier (shipment unit)	int	Sim	10	ID da unidade de embarque de uma parada de uma carga de uma viagem;
shipmentUnitCategoryId	int	Sim	1	ID 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	string	Não	20	Descrição da categoria de invólucro da unidade de embarque;	BULK; BULK_UNIT, PACK; PALLET; DRUM; SKID; TUBE; TUBE_PACK;
shipmentUnitQty	float	Sim	13	Quantidade de unidades de embarque de uma parada de uma carga de uma viagem;
weight	float	Sim	13	Peso das unidades de embarque de uma parada de uma carga de uma viagem;
volume	float	Sim	13	Volume das unidades de embarque de uma parada de uma carga de uma viagem;
length	float	Sim	13	Comprimento das unidades de embarque de uma parada de uma carga de uma viagem;
width	float	Sim	13	Largura das unidades de embarque de uma parada de uma carga de uma viagem;
height	float	Sim	13	Altura das unidades de embarque de uma parada de uma carga de uma viagem;
palletHeightTotal	float	Sim	13	Altura máxima total das unidades de embarque de uma parada de uma carga de uma viagem;
deliveryUnitList	deliveryUnit[]	Sim	N/A	Entidade 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 TREdo TOL
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
identifier (delivery unit)	string	Sim	30	ID da unidade de entrega;
orderSourceId	string	Sim	30	ID do pedido de transporte da unidade de entrega;
orderTypeSourceId	string	Sim	30	Código do tipo do pedido;
orderItemSourceId	string	Sim	30	ID do item de pedido de transporte da unidade de entrega;
productSourceId	string	Sim	30	ID do produto da unidade de entrega;
sequenceComposition	int	Não	10	Sequência da composição do SKU da unidade de entrega (apenas para SKUs que são multi-volume);
quantity	float	Sim	13	Quantidade das unidades de entrega;
price	float	Sim	13	Preço das unidades de entrega;
deliveryDate	Data/hora (string)	Sim	29	Data planejada de entrega da unidade de entrega;
integrationSource	string	Sim	30	ID da origem de dados;
classifications	classifications []	Não	N/A	Elemento de agrupamento de todas as classificações de uma unidade de entrega
attributes	attributes[]	Não	N/A	Elemento de agrupamento de todas os atributos de uma unidade de entrega

Âncora

	classifications
	classifications

classifications, tipo de dado utilizado nas integrações do TREdo TOL
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
type	string	Sim	255	Tipo da classificação da viagem;
value	string	Sim	255	Valor da classificação da viagem;

Âncora

	attributes
	attributes

attributes, tipo de dado utilizado nas integrações do TREdo TOL
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
name	string	Sim	255	Nome do atributo da viagem;
value	string	Sim	255	Valor do atributo da viagem;

Layout de Resposta

publishReleasedTripResponsepublishTenderedTripResponse, tipo de dado utilizado nas integrações do TREdo TOL
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
publishReleasedTripResponsepublishTenderedTripResponse	string	Sim	1	Mensagem de confirmação de recebimento das solicitações de liberação de viagens do TRE(ACK);da oferta da viagem para	"S" ou "N";

Catalogo de mensagens

Código

Mensagem

Descrição

Anexos

Anexos

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

Introdução

Sistemas Envolvidos

Escopo

Pré-requisitos instalação/implantação/utilização

Layout de Resposta

Catalogo de mensagens

Anexos