Árvore de páginas

Versões comparadas

Chave

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

Introdução

Sistemas Envolvidos

Integração

Escopo

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

Layout de Requisição

publishReleasedTrip: Integração SOAP, Assincrona
NomeTipoObrigatórioTamanhoDescriçãoObservações
messageIdNumérico (inteiro)Sim10ID da mensagem de solicitação de liberação de uma viagem do CPL;
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;
ÂncoratripReleaseRequesttripReleaseRequest
tripreleaseRequet
tripreleaseRequest, tipo de dado utilizado nas integrações do TRE

Nome

TipoObrigatórioTamanhoDescriçãoObservações
regionSourceIdAlfanuméricoSim30Identificador da regional;Deve ser uma regional válida;
basketSourceIdAlfanuméricoNã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)Sim10ID da viagem cuja liberação está sendo solicitada pelo CPL;
freightValueNumérico (float)Sim13Valor do frete da viagem;
vehicleIdAlfanuméricoSim255ID do tipo de veículo da viagem;
vehicleDescriptionAlfanuméricoNão255Descrição do tipo de veículo da viagem;
truckLicensePlateAlfanuméricoNão8Placa do caminhão da viagem;Esta placa poderá ser informada pela transportadora ao aceitar a viagem (Partner Collaboration);
truckLicensePlateStateAlfanuméricoNão2Estado da placa do caminhão da viagem;
truckStatusIdAlfanuméricoNão2Identificador da situação do caminhão;0=Desconhecido, 1=Agregado, 2=Frota própria, 3=Frota terceirizada;
truckStatusDescriptionAlfanuméricoNão255Descrição da situação do caminhão;
truckAxlesQuantityNumérico (inteiro)Não10Número de eixos do caminhão;Serão contabilizados os eixos de todos os baús do caminhão;
classificationsclassifications []NãoN/AElemento de agrupamento de todas as classificações de uma viagem;
attributes attributes[]NãoN/AElemento de agrupamento de todas os atributos de uma viagem;
commentsAlfanuméricoNão255Observações da viagem;
loads
loads
load[]SimN/AElemento de agrupamento de todas as cargas de uma viagem;Deverá haver pelo menos 1 carga nesta lista;
Âncoraclassificationsclassificationsclassifications, tipo de dado utilizado nas integrações do TRE

Nome

TipoObrigatórioTamanhoDescriçãoObservações Âncoraclassificationsclassificationsclassifications, tipo de dado utilizado nas integrações do TRE

Nome

TipoObrigatórioTamanhoDescriçãoObservações Âncoraclassificationsclassifications
classifications, tipo de dado utilizado nas integrações do TRE

Nome

TipoObrigatório
TamanhoDescriçãoObservações

Âncora
loads
loads

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

Nome

TipoObrigatórioTamanhoDescriçãoObservações
identifier (load)Numérico (inteiro)Sim10ID da carga da viagem;
serviceTypeIdNumérico (inteiro)Sim1ID do tipo de serviço da carga;Exemplos:

- Full truck load (FTL);
- Less than truck load (LTL);
serviceTypeDescriptionAlfanuméricoSim255Descrição do tipo de serviço da carga;
loadModeNumérico (inteiro)Sim1ID do tipo de carga;1=Estivada; 2=Paletizada; 3=Mista;
modalNumérico (inteiro)Sim1ID do modal da carga;1=Rodoviário; 2=Aquaviário; 3=Ferroviário; 4=Aéreo;
distanceNumérico (float)Sim13Distância da carga;
freightNumérico (float)Sim13Frete da carga;
dispatchLimitTimeData/hora (string)Não29Data limite para o despacho da carga;Última janela de tempo possível para a carga;
stops
(início)Lista
stop[]SimN/AElemento de agrupamento de todas as paradas de uma carga de uma viagem;Deverão haver pelo menos 2 paradas nesta lista;
stop (início)EntidadeSimN/AElemento de agrupamento de uma parada de uma carga de uma viagem;

Âncora
stop
stop

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

Nome

TipoObrigatórioTamanhoDescriçãoObservações
Uma parada pode 1 ou mais sub-paradas;
identifier (stop)Numérico (inteiro)Sim10ID da parada de uma carga de uma viagem;
localitySourceIdAlfanuméricoSim30ID da localidade da parada de uma carga de uma viagem;
transportZoneIdAlfanuméricoSim255ID da zona de transporte da parada de uma carga de uma viagem;
transportZoneDescriptionAlfanuméricoNão50Descrição da zona de transporte da parada de uma carga de uma viagem;
sequenceOnLoadNumérico (inteiro)Sim10Sequência da parada de uma carga de uma viagem;
subStops
(início)Lista
subStop[]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;
subStop (início)EntidadeSimN/A

Âncora
subStop
subStop

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

Nome

TipoObrigatórioTamanhoDescriçãoObservações
Elemento de agrupamento de uma sub-parada de uma carga de uma viagem;
identifier (sub-stop)Numérico (inteiro)Sim10ID 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;
dockIdNumérico (inteiro)Não10

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


dockDescriptionAlfanuméricoNão255

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


loadedShipmentUnits (início)
Lista
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
;shipmentUnit (início)EntidadeNãoN/A

Elemento de agrupamento de uma unidade de embarque de uma parada de uma carga de uma viagem;

identifier (shipment unit)Numérico (inteiro)Sim10ID da unidade de embarque de uma parada de uma carga de uma viagem
;
shipmentUnitCategoryIdNumérico (inteiro)Sim1ID 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;
shipmentUnitDescriptionAlfanuméricoNão20Descrição da categoria de invólucro da unidade de embarque;BULK; BULK_UNIT, PACK; PALLET; DRUM; SKID; TUBE; TUBE_PACK;
shipmentUnitQtyNumérico (float)Sim13Quantidade de unidades de embarque de uma parada de uma carga de uma viagem;
weightNumérico (float)Sim13Peso das unidades de embarque de uma parada de uma carga de uma viagem;
volumeNumérico (float)Sim13Volume das unidades de embarque de uma parada de uma carga de uma viagem;
lengthNumérico (float)Sim13Comprimento das unidades de embarque de uma parada de uma carga de uma viagem;
widthNumérico (float)Sim13Largura das unidades de embarque de uma parada de uma carga de uma viagem;
heightNumérico (float)Sim13Altura das unidades de embarque de uma parada de uma carga de uma viagem;
palletHeightTotalNumérico (float)Não13Altura máxima total das unidades de embarque de uma parada de uma carga de uma viagem;
deliveryUnitList (início)ListaSimN/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;
deliveryUnit (início)EntidadeSimN/A

Entidade de agrupamento de uma unidade de entrega de uma parada de uma carga de uma viagem;


identifier (delivery unit)AlfanuméricoSim30ID da unidade de entrega;
orderSourceIdAlfanuméricoSim30ID do pedido de transporte da unidade de entrega;
orderTypeSourceIdAlfanuméricoSim30Código do tipo do pedido;
orderItemSourceIdAlfanuméricoSim30ID do item de pedido de transporte da unidade de entrega;
sequenceCompositionNumérico (inteiro)Não10

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


quantityNumérico (float)Sim13Quantidade das unidades de entrega;
priceNumérico (float)Sim13Preço das unidades de entrega;
deliveryDateData/hora (string)Sim29Data planejada de entrega da unidade de entrega;
integrationSourceAlfanuméricoSim30ID 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 os atributos de uma unidade de entrega
deliveryUnit (fim)EntidadeSimN/A

Entidade de agrupamento de uma unidade de entrega de uma parada de uma carga de uma viagem;


deliveryUnitList (fim)ListaSimN/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;
shipmentUnit (fim)EntidadeNãoN/A

Elemento de agrupamento de uma unidade de embarque de uma parada de uma carga de uma viagem;


loadedShipmentUnits (fim)
Lista
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;
unloadedShipmentUnits
(início)
shipmentUnit[]
Lista
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 TRE

Nome

TipoObrigatórioTamanhoDescriçãoObservações
shipmentUnit (início)EntidadeNãoN/A

Elemento de agrupamento de uma unidade de embarque de uma parada de uma carga de uma viagem;


identifier (shipment unit)Numérico (inteiro)Sim10ID da unidade de embarque de uma parada de uma carga de uma viagem;
shipmentUnitCategoryIdNumérico (inteiro)Sim1ID 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;
shipmentUnitDescriptionAlfanuméricoNão20Descrição da categoria de invólucro da unidade de embarque;BULK; BULK_UNIT, PACK; PALLET; DRUM; SKID; TUBE; TUBE_PACK;
shipmentUnitQtyNumérico (float)Sim13Quantidade de unidades de embarque de uma parada de uma carga de uma viagem;
weightNumérico (float)Sim13Peso das unidades de embarque de uma parada de uma carga de uma viagem;
volumeNumérico (float)Sim13Volume das unidades de embarque de uma parada de uma carga de uma viagem;
lengthNumérico (float)Sim13Comprimento das unidades de embarque de uma parada de uma carga de uma viagem;
widthNumérico (float)Sim13Largura das unidades de embarque de uma parada de uma carga de uma viagem;
heightNumérico (float)Sim13Altura das unidades de embarque de uma parada de uma carga de uma viagem;
palletHeightTotalNumérico (float)Sim13Altura máxima total das unidades de embarque de uma parada de uma carga de uma viagem;
deliveryUnitList
(início)Lista
deliveryUnit[]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;
deliveryUnit (início)ListaSimN/AEntidade de agrupamento de uma unidade de entrega de uma parada de uma carga de uma viagem;

Âncora
deliveryUnit
deliveryUnit

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

Nome

TipoObrigatórioTamanhoDescriçãoObservações
identifier (delivery unit)AlfanuméricoSim30ID da unidade de entrega;
orderSourceIdAlfanuméricoSim30ID do pedido de transporte da unidade de entrega;
orderTypeSourceIdAlfanuméricoSim30Código do tipo do pedido;
orderItemSourceIdAlfanuméricoSim30ID do item de pedido de transporte da unidade de entrega;
productSourceIdAlfanuméricoSim30ID do produto da unidade de entrega;
sequenceCompositionNumérico (inteiro)Não10

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


quantityNumérico (float)Sim13Quantidade das unidades de entrega;
priceNumérico (float)Sim13Preço das unidades de entrega;
deliveryDateData/hora (string)Sim29Data planejada de entrega da unidade de entrega;
integrationSourceAlfanuméricoSim30ID 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 os atributos
de uma unidade de entregadeliveryUnit (fim)ListaSimN/A

Entidade de agrupamento de uma unidade de entrega de uma parada de uma carga de uma viagem;

deliveryUnitList (fim)ListaSimN/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;shipmentUnit (fim)EntidadeNãoN/A

Elemento de agrupamento de uma unidade de embarque de uma parada de uma carga de uma viagem;

unloadedShipmentUnits (fim)ListaSimN/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;subStop (fim)EntidadeSimN/AElemento de agrupamento de uma sub-parada de uma carga de uma viagem;subStops (fim)ListaSimN/AElemento de agrupamento de todas as sub-paradas de uma carga de uma viagem;Deverá haver, pelo menos, 1 sub-parada para uma parada;stop (fim)EntidadeSimN/AElemento de agrupamento de uma parada de uma carga de uma viagem;stops (fim)ListaSimN/AElemento de agrupamento de todas as paradas de uma carga de uma viagem;Deverão haver pelo menos 2 paradas nesta lista;
Âncoraclassificationsclassifications
classifications, tipo de dado utilizado nas integrações do TRE

Nome

TipoObrigatórioTamanhoDescriçãoObservações

Âncora
classifications
classifications

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

Nome

TipoObrigatórioTamanhoDescriçãoObservações
typeAlfanuméricoSim255Tipo da classificação da viagem;
valueAlfanuméricoSim255Valor da classificação da viagem;

Âncora
attributes
attributes

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

Nome

TipoObrigatórioTamanhoDescriçãoObservações

Nome

TipoObrigatórioTamanhoDescrição
nameAlfanuméricoSim255Nome do atributo da viagem;
valueAlfanuméricoSim255Valor do atributo da viagem;

Layout de Resposta

Catalogo de erros

Anexos

Anexos