Histórico da Página
Introdução
draw.io Diagram | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
|
|
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;
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: Integração SOAP, Assíncrona com a doUnblockReleasedTrip; | |||||
---|---|---|---|---|---|
Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
messageId |
Integer | Sim | 10 | ID da mensagem de solicitação de liberação de uma viagem |
; | ||||
orderBreakParts | orderBreakPart[] | Não | N/A | Elemento de agrupamento de todas as quebras |
; | Deverá haver pelo menos 1 quebra |
nesta lista; | ||||
tripReleaseRequests | tripReleaseReques[] | Sim | N/A | Elemento 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, tipo de dado utilizado nas integrações |
---|
do TOL\TRE | |||||
---|---|---|---|---|---|
Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
regionSourceId |
String | Sim | 30 | Identificador da regional; | Deve ser uma regional válida; |
orderBreakPartId |
Integer | Sim | 10 | IDs das quebras |
; | |
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 |
Integer | Sim | 10 | ID da carga associada à quebra; | |
shipmentUnitId |
Integer | 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 |
; | 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 |
; | |||||
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 |
todos os atributos de uma viagem; |
Âncora | ||||
---|---|---|---|---|
|
tripreleaseRequest, tipo de dado utilizado nas integrações |
---|
do TOL\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 |
; | 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) |
Integer | Sim | 10 | ID da viagem cuja liberação está sendo solicitada |
; | |
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 |
Integer | Não | 10 | Número de eixos do caminhão; | Serão contabilizados os eixos de todos os baús do caminhão; | |
trailers | trailer[] | Não | 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 |
todos 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, tipo de dado utilizado nas integrações |
---|
do TOL\TRE | |||||
---|---|---|---|---|---|
Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
trailerLicensePlate |
String | Não | 8 | Placa da carreta da viagem; | Esta placa poderá ser informada pela transportadora ao aceitar a viagem (Partner Collaboration); |
trailerLicensePlateState |
String | Não | 2 | Estado da placa da carreta da viagem; |
Âncora | ||||
---|---|---|---|---|
|
load, tipo de dado utilizado nas integrações do TOL\TRE | |||||
---|---|---|---|---|---|
Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
identifier (load) |
Integer | Sim | 10 | ID da carga da viagem; | |
serviceTypeId |
Integer | 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 |
Integer | Sim | 1 | ID do tipo de carga; | 1=Estivada; 2=Paletizada; 3=Mista; |
modal |
Integer | 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, tipo de dado utilizado nas integrações do TOL\TRE | |||||
---|---|---|---|---|---|
Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
identifier (stop) |
Integer | 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 |
Integer | 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, tipo de dado utilizado nas integrações |
---|
do TOL\TRE | |||||
---|---|---|---|---|---|
Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
identifier (sub-stop) |
Integer | 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 |
Integer | 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 | 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, tipo de dado utilizado nas integrações |
---|
do TOL\TRE | |||||
---|---|---|---|---|---|
Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
identifier (shipment unit) |
Integer | Sim | 10 | ID da unidade de embarque de uma parada de uma carga de uma viagem; | |
shipmentUnitCategoryId |
Integer | 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, tipo de dado utilizado nas integrações |
---|
do TOL\TRE | |||||
---|---|---|---|---|---|
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 |
Integer | 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 |
todos os atributos de uma unidade de entrega |
Âncora | ||||
---|---|---|---|---|
|
classifications, tipo de dado utilizado nas integrações do TOL\TRE | |||||
---|---|---|---|---|---|
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, tipo de dado utilizado nas integrações |
---|
do TOL\TRE | |||||
---|---|---|---|---|---|
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
publishReleasedTripResponse, tipo de dado utilizado nas integrações |
---|
do TOL\TRE | |||||
---|---|---|---|---|---|
Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
publishReleasedTripResponse |
String | Sim | 1 | Mensagem de confirmação de recebimento das solicitações de liberação de viagens |
; | "S" ou "N"; |
Catalogo de
errosmensagens
Código | Mensagem | Descrição |
Anexos
Anexos |
---|