Árvore de páginas

Versões comparadas

Chave

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

Introdução


Sistemas Envolvidos

  • VRPTW
  • 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

  • Ter um identificador de instalação/cliente TOTVS válido.

Layout de Requisição

latitudeDoubleEnumidentifier weightvolumeObjectObjectSegue o mesmo contrato de Locality
NomeTipoObrigatoriedadeTam. Máx.FormatoValor defaultDescriçãoObservações
clientIdentifierStringSimN/AN/AN/AIdentificador da instalação/cliente TOTVS
optionObjectNãoN/AN/AN/AOpções adicionais
localityObjectSimN/AN/AN/ALocalidade da instalaçãoSegue o mesmo contrato de Locality

ordersListSimN/AN/AN/APedidos a serem otimizados
vehiclesListSimN/AN/AN/AVeículos disponíveis para otimização
OPTION
extensionMapNãoN/AN/AN/ACampo para inserir opções adicionais
callBackUrlStringNãoN/AURLN/AURL de callback pós otimização
LOCALITYORDERS
identifieridentifier String
SimN/AN/AN/AIdentificador da localidadedo pedido
weightDouble
SimN/AN/AN/ALatitude da localidadelongitudePeso do pedido
volume
SimN/AN/AN/ALongitude da localidadeoperation

Volume do pedido


originObjectSimN/AN/AN/AFuncionamento simplificadoOpções: IRRESTRIC, COMERCIAL_DAYS
ORDERS
Localidade de origem do pedidoSegue o contrato de Locality
destinationObjectSimN/AN/AN/AIdentificador Localidade de destino do pedidoSegue o contrato de Locality
LOCALITY
identifierStringSimN/AN/AN/APeso do pedidoIdentificador da localidade
latitudeDoubleSimN/AN/AN/A

Volume do pedido

originLatitude da localidade
longitudeDoubleSimN/AN/AN/ALocalidade de origem do pedidoSegue o mesmo contrato de LocalitydestinationLongitude da localidade
operationEnumSimN/AN/AN/ALocalidade de destino do pedidoFuncionamento simplificadoOpções: IRRESTRIC, COMERCIAL_DAYS








VEHICLES
identifierStringSimN/AN/AN/AIdentificador do veículo
weightCapacityDoubleSimN/AN/AN/ACapacidade de peso
volumeCapacityDoubleSimN/AN/AN/ACapacidade de volume

Layout de Resposta

NomeTipoTam. Máx.FormatoValor defaultDescriçãoObservações
successBooleanN/AN/AN/AStatus da otimização
jobIdIntegerN/AN/AN/AO ID gerado da otimizaçãoEm casos de erro, o jobId não será gerado.
messageStringN/AN/AN/AMensagem de sucesso/falha

Catálogo de Erros

CenárioMensagem
Ao enviar um Payload nuloInput is null
Ao enviar o campo "callBackUrl" sem domínio, protocolo ou com caracteres especiais.Invalid callback URL
Ao enviar o Identificador da instalação/cliente TOTVS vazio ou nuloInvalid client identifier
Ao enviar alguma Localidade nulaLocality is null
Ao enviar o Identificador da Localidade vazio ou nuloInvalid Locality identifier
Ao enviar a Latitude da Localidade nulaLocality latitude is null
Ao enviar a Longitude da Localidade nulaLocality longitude is null
Ao enviar o Funcionamento da Localidade nulaLocality operation is null
Ao enviar algum Pedido nuloOrder is null
Ao enviar o Identificador do Pedido vazio ou nuloInvalid Order identifier
Ao enviar o Peso do Pedido negativo ou nuloInvalid order weight
Ao enviar o Volume do Pedido negativo ou nuloInvalid order volume
Ao enviar algum Veículo nuloVehicle is null
Ao enviar o Identificador de Veículo vazio ou nuloInvalid Vehicle identifier
Ao enviar a Capacidade de Volume do Veículo negativa ou nuloInvalid vehicle volume capacity
Ao enviar a Capacidade de Peso do Veículo negativa ou nuloInvalid vehicle weight capacity
Ao enviar Localidades iguais como Origem e DestinoOrigin and Destination Locality are equals


Anexos

View file
nameVRPTW-Input.json
height250