Introdução
Sistemas Envolvidos
TOTVS Otimização Logística
Sistema Externo: Todos os ERPs que se conectam ou pretendem se conectar com os produtos de planejamento logístico da TOTVS.
Escopo
Pré-requisitos instalação/implantação/utilização
Versões mínimas
TOL: 6.4.0
Protheus: ?
Datasul: ?
Esta integração não demanda instalações ou atualizações adicionais.
Layout de Requisição
| publishExpeditionTrip: Integração SOAP, síncrona | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| messageId | int | Sim | 10 | ID da mensagem, agrupando uma ou mais viagens do TOL que foram expedidas na mesma transação | |
| tripExpeditionNotifications | tripExpeditionNotifications[] | Sim | N/A | Elemento de agrupamento de todas as notificações de expedição de viagens do TOL | Deverá haver pelo menos 1 notificação de expedição de viagem nesta lista; |
| tripExpeditionNotification, 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; |
| basketSourceId | string | Não | 30 | ID da cesta onde esta operação foi realizada manualmente pelo usuário no 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 TOL (nestes casos, não se pode identificar a cesta do usuário); |
| identifier (trip) | int | Sim | 10 | ID da viagem cuja expedição está sendo notificada pelo 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; | |
| 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 | |
| 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; |
| load, tipo de dado utilizado nas integrações do 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; |
| stop, tipo de dado utilizado nas integrações do 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; |
| subStop, tipo de dado utilizado nas integrações do 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 | 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; |
| shipmentUnit, tipo de dado utilizado nas integrações do 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; |
| deliveryUnit, tipo de dado utilizado nas integrações do 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; | |
| productCategorySourceId | string | Sim | 30 | ID da categoria de produto | |
| productCategoryDescription | string | Sim | 255 | Descrição da categoria de produto | |
| 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 | |
| classifications, tipo de dado utilizado nas integrações do 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; | |
| attributes, tipo de dado utilizado nas integrações do 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
| publishExpeditionTripResponse, tipo de dado utilizado nas integrações do TOL | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| publishExpeditionTripResponse | string | Sim | 1 | Mensagem de confirmação de recebimento da oferta da viagem para | "S" ou "N"; |
Catalogo de mensagens
| Código | Mensagem | Descrição |
Anexos
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas