Histórico da Página
Introdução
| draw.io Diagram | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Sistemas Envolvidos
- TPR
- Sistema Externo: Todos os ERPs que se conectam ou pretendem se conectar com os produtos de planejamento logístico TOTVS.
Integração
- Formato de entrada/saída: JSON
Escopo
- Ao enviar um payload válido, será efetuada uma otimização, gerando um jobId para consulta.
Pré-requisitos instalação/implantação/utilização
- Para clientes Protheus versão xxxxxx;
- Para clientes Datasul versão xxxxxx;
- Para clientes externos contratação do trial via TOTVS Store Ter um identificador de instalação/cliente TOTVS válido
- .
Layout de Requisição
| Nome | Tipo | Obrigatoriedade | Tam. Máx. | Formato | Valor default | Descrição | Observações |
| clientIdentifier | String | Sim | N/A | N/A | N/A | Identificador da instalação/cliente TOTVS | |
| option | Object | Não | N/A | N/A | N/A | Opções adicionais | |
| orders | List | Sim | N/A | N/A | N/A | Pedidos a serem otimizados | |
| vehicles | List | Sim | N/A | N/A | N/A | Veículos disponíveis para otimização | |
| OPTION | |||||||
| extension | Map | Não | N/A | N/A | N/A | Campo para inserir opções adicionais | |
| callBackUrl | String | Não | N/A | URL | N/A | URL de callback pós otimização | |
| ORDERS | |||||||
| identifier | Sim | N/A | N/A | N/A | Identificador do pedido | ||
| weight | Sim | N/A | N/A | N/A | Peso do pedido | ||
| volume | Sim | N/A | N/A | N/A | Volume do pedido | ||
| origin | Object | Sim | N/A | N/A | N/A | Localidade de origem do pedido | Segue o contrato de Locality |
| destination | Object | Sim | N/A | N/A | N/A | Localidade de destino do pedido | Segue o contrato de Locality |
| LOCALITY | |||||||
| identifier | String | Sim | N/A | N/A | N/A | Identificador da localidade | |
| latitude | Double | Sim | N/A | N/A | N/A | Latitude da localidade | |
| longitude | Double | Sim | N/A | N/A | N/A | Longitude da localidade | |
| operation | Enum | Sim | N/A | N/A | N/A | Funcionamento simplificado | Opções: UNRESTRICTED, BUSINESS_DAYS |
| VEHICLES | |||||||
| identifier | String | Sim | N/A | N/A | N/A | Identificador do veículo | |
| weightCapacity | Double | Sim | N/A | N/A | N/A | Capacidade de peso | |
| volumeCapacity | Double | Sim | N/A | N/A | N/A | Capacidade de volume | |
Layout de Resposta
| Nome | Tipo | Tam. Máx. | Formato | Valor default | Descrição | Observações |
| success | Boolean | N/A | N/A | N/A | Status da otimização | |
| jobId | Integer | N/A | N/A | N/A | O ID gerado da otimização | Em casos de erro, o jobId não será gerado. |
| message | String | N/A | N/A | N/A | Mensagem de sucesso/falha |
Catálogo de Erros
| Código | Mensagem | Descrição | ||
|---|---|---|---|---|
| TPRRT001 | Input is null | Ao enviar um Payload nuloInput is null | ||
| TPRRT002 | Invalid callback URL | Ao enviar o campo "callBackUrl" sem domínio, protocolo ou com caracteres especiais. | ||
| TPRRT003 | Invalid | callback URLclient identifier | Ao enviar o Identificador da instalação/cliente TOTVS vazio ou nuloInvalid client identifier | |
| TPRRT004 | Locality is null | Ao enviar alguma Localidade nula | ||
| TPRRT005 | Invalid Locality | is nullidentifier | Ao enviar o Identificador da Localidade vazio ou nulo | |
| TPRRT006 | InvalidLocality | identifierlatitude is null | Ao enviar a Latitude da Localidade nula | |
| TPRRT007 | Locality | latitudelongitude is null | Ao enviar a Longitude da Localidade nula | |
| TPRRT008 | Locality | longitudeoperation is null | Ao enviar o Funcionamento da Localidade nulaLocality operation | |
| TPRRT009 | Order is null | Ao enviar algum Pedido nulo | ||
| TPRRT010 | Invalid Order | is nullidentifier | Ao enviar o Identificador do Pedido vazio ou nulo | |
| TPRRT011 | Invalid | Order identifierorder weight | Ao enviar o Peso do Pedido negativo ou nulo | |
| TPRRT012 | Invalid order | weightvolume | Ao enviar o Volume do Pedido negativo ou nuloInvalid order volume | |
| TPRRT013 | Vehicle is null | Ao enviar algum Veículo nulo | ||
| TPRRT014 | Invalid Vehicle | is nullidentifier | Ao enviar o Identificador de Veículo vazio ou nuloInvalid Vehicle identifier | |
| TPRRT015 | Invalid vehicle volume capacity | Ao enviar a Capacidade de Volume do Veículo negativa ou nulo | ||
| TPRRT016 | Invalid vehicle | volumeweight capacity | Ao enviar a Capacidade de Peso do Veículo negativa ou nuloInvalid vehicle weight capacity | |
| TPRRT017 | Origin and Destination Locality are equals | Ao enviar Localidades iguais como Origem e DestinoOrigin and Destination Locality are equals | ||
| TPRRT018 | Duplicated Locality identifier is duplicated in diferentes Localities | Ao enviar localidades com identificadores iguais, mas atributos diferentes.Duplicated Locality identifier is | ||
| TPRRT019 | Duplicated Vehicle identifier is duplicated in diferentes | LocalitiesVehicle | Ao enviar veículoscom identificadores iguais, mas atributos diferentes.Duplicated Vehicle identifier is duplicated in diferentes Vehicle | |
| TPRRT020 | Order identifier is duplicated | Ao enviar dois pedidos com o mesmo identificadorOrder identifier is duplicated | ||
| TPRRT021 | Invalid Vehicles | Ao enviar uma lista vazia de Veículos | ||
| TPRRT022 | Invalid | VehiclesOrders | Ao enviar uma lista vazia de Pedidos | Invalid Orders |
| TPRRT023 | Ao enviar um Pedido com a Localidade de Origem nula | Origin locality of Order {identificador do Pedido enviado} is Null | Ao enviar um Pedido com a Localidade de Destino Origem nula | |
| TPRRT024 | Destination locality of Order {identificador do Pedido enviado} is Null | Ao enviar um Pedido com a Localidade de Destino nula |
Documentações relacionadas
Anexos
| View file | ||||
|---|---|---|---|---|
|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas