Histórico da Página
Introdução
| draw.io Diagram | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Sistemas Envolvidos
TOTVS Roteirização e Entrega
Sistema Externo: Todos os ERPs que se conectam ou pretendem se conectar com os produtos de planejamento logístico da TOTVS.
Integração
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
| createLocality/updateLocality/deleteLocality: Integração SOAP, Síncrona | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatoriedade | Tamanho | Descrição | Observações |
| regionSourceId | String | Sim | 30 | Identificador da regional; | Deve ser uma regional válida; |
| identifier | String | Sim | 30 | ID da localidade; | O ID da localidade deve ser único; |
| name | String | Sim | 255 | Nome da localidade; | |
| description | String | Não | 1000 | Descrição da localidade; | |
| localityRestrictionSourceId | String | Não | 30 | Identificador da restrição de localidade; | Deve ser uma restrição de localidade válida; Se esta informação não for enviada, será utilizada a restrição de localidade default configurada no CPL; |
| addressCountryAcronym | String | Sim | 2 | Sigla do país da localidade; | Deve ser uma sigla válida; |
| addressStateAcronym | String | Sim | 2 | Sigla do estado da localidade; | Deve ser uma sigla válida; |
| addressCity | String | Sim | 50 | Cidade da localidade; | A cidade apenas será gravada se o estado for fornecido; |
| addressDistrict | String | Não | 50 | Bairro da localidade; | O bairro apenas será gravado se o estado e a cidade forem fornecidos; |
| addressStreet | String | Sim | 200 | Endereço da localidade; | |
| addressNumber | String | Não | 30 | Número do endereço da localidade; | |
| addressComplement | String | Não | 30 | Complemento do endereço da localidade; | |
| addressZipCode | String | Não | 10 | CEP da localidade; | O valor não pode ser inválido; Observação: - É possível configurar na instalação do CPL um tratamento automático para CEPs inválidos enviados na integração; - Há a possibilidade de configurar um CEP padrão no CPL para os casos em que o CEP seja desconhecido; |
| latitude | Float | Não | 13 | Latitude da localidade; | Se este campo for fornecido, a longitude da localidade também deve ser fornecida; o valor deste campo deve estar no intervalo -90,0 a 90,0; Observação: - É possível configurar na instalação do CPL um tratamento automático de geo-codificação; se esta configuração estiver habilitada, após o recebimento de uma localidade, ela será automaticamente geo-codificada; |
| longitude | Float | Não | 13 | Longitude da localidade; | Se este campo for fornecido, a latitude da localidade também deve ser fornecida; o valor deste campo deve estar no intervalo -180,0 a 180,0; Observação: - É possível configurar na instalação do CPL um tratamento automático de geo-codificação; se esta configuração estiver habilitada, após o recebimento de uma localidade, ela será automaticamente geo-codificada; |
| logisticRoleId | Inteiro | Sim | 1 | Papel logístico da localidade (i.e., se é de origem, de destino ou ambos); | 1=Ambos; 2=Destino; 3=Origem; |
| preferredDestinationLocalitySourceId | String | Não | 30 | Identificador da localidade de destino preferencial para esta localidade; | A localidade enviada neste campo não pode ser igual à localidade do campo "identifier (locality)"; Exemplo: - Se os pedidos do cliente (localidade) L1 devem ser entregues na localidade L2, neste caso, o ID da localidade L2 deverá ser enviada no campo preferredDestinationLocalitySourceId da localidade L1; |
| isDestinationHub | Booleano | Não | 1 | Flag indicando se a localidade é um hub de destino; | 1=true; 0=false; apenas localidades que tenham papel logístico "destino" ou "ambos" podem ser hubs de destino; |
| isPassingHub | Booleano | Não | 1 | Flag indicando se a localidade é um hub de passagem; | 1=true; 0=false; apenas localidades que tenham papel logístico "ambos" podem ser hubs de passagem; |
| classifications | classifications [] | Não | N/A | Elemento de agrupamento de todas as classificações de uma localidade; | |
| attributes | attributes[] | Não | N/A | Elemento de agrupamento de todas os atributos de uma localidade; | |
| Â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
| localityResponse, tipo de dado utilizado nas integrações do TOL\TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| result | result[] | Sim | N/A | Elemento de agrupamento de todas as localidades | Deverá haver pelo menos 1 localidade nesta lista; |
| sucess | Boolean | Sim | 1 | Flag de sucesso ou falha | |
| Âncora | ||||
|---|---|---|---|---|
|
| result, tipo de dado utilizado nas integrações do TOL\TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatoriedade | Tamanho | Descrição | Observações |
| errorCodes | string | Não | 30 | Lista de códigos de erros | |
| errorMessage | string | Não | 255 | Mensagens de erros | |
| identifier | string | Não | 30 | Identificador da tabela dos erros | |
| sucess | Boolean | Sim | 1 | Flag de sucesso ou falha | |
Catalogo de mensagens
Âncora catmsg catmsg
| Código | Mensagem | Descrição |
Anexos
| Anexos |
|---|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas