vehicleTypes*

O parâmetro vehicleTypes é um array de objetos, onde cada objeto representará um tipo de veículo. Tipos de veículos são as características dos veículos que serão usados no planejamento, como peso e volume suportados, por exemplo.

A API verificará a capacidade dos veículos para distribuir os pesos e volumes dos produtos de cada operação para a melhor otimização logística.

Parâmetros obrigatórios

name - Texto único com o tipo de veículo. Usado para ser referenciado em Vehicles.
maxVolume - Valor numérico (double) com o volume máximo suportado pelo veículo.
maxWeight - Valor numérico (double) com o peso máximo suportado pelo veículo.
size - Valor numérico (integer) com o tamanho do veículo.

Exemplo com parâmetros obrigatórios

    "vehicleTypes": [
        {
            "name": "VUC",
            "maxVolume": 20,
            "maxWeight": 1200,
            "size": 1
        },
        {
            "name": "3/4",
            "maxVolume": 30,
            "maxWeight": 1500,
            "size": 1
        }
    ],

Parâmetros opcionais

characteristics - Texto livre para descrever características do veículo.
maxSitesNumber - Número inteiro com a quantidade máxima de sites que o veículo visitará por rota.
compartmentsAccessMode - Texto com o modo de acesso ao compartimento de carga do veículo. Valores permitidos: [ALL_COMPARTMENTS, REAR_ACCESS]
compartmentConfigurations - Array com as características do compartimento de carga. Necessário definir o compartmentsAccessMode.
- name - Texto único com o nome do compartimento.
- type - Texto com o tipo do compartimento Valores possíveis: [FIXED, VARIABLE].
- maximumCapacity - Número decimal com a capacidade máxima do compartimento.
- minimumCapacity - (Opcional) Número decimal com a capacidade mínima do compartimento. Obrigatório quando type é VARIABLE e opcional quando type é FIXED.
- increment - (Opcional) Número decimal com o incremento da capacidade do compartimento. Obrigatório quando type é VARIABLE e opcional quando type é FIXED.
- loadingRule - Texto com a regra considerada para o carregamento do compartimento. Valores possíveis: [NONE, IDENTICAL_PACKAGINGS, SINGLE_OPERATION, IDENTICAL_PRODUCTS, IDENTICAL_SITE_PRODUCTS].
- allowedPackagings - Array com os nomes dos pacotes permitidos a serem carregados no compartimento. Deve ser único em um tipo de compartimento.

trip - Indica que além da ordenação dos pontos logísticos, a rota também deve ser retornada.
Todos os parâmetros aceitos pela API Trip são aceitos aqui. Para saber mais consultar: 2.2. Parâmetros da requisição

Exemplo com parâmetros opcionais

Este exemplo mostra como descrever características de dois veículos diferentes: o primeiro uma “Moto” e o segundo um “Carro”. A “Moto” possui capacidade de carga menor porém em seu compartimento pode carregar pacotes de nome "Carga_Resistente". “Carro” possui capacidade de carga maior mas só pode carregar pacotes de nome "Carga_fragil".

Assim podemos detalhar que tipo de pacote/produto um veículo pode carregar e o outro não.

"vehicleTypes": [
    {
        "name": "Moto",
        "maxWeight": 100,
        "maxVolume": 50,
        "size": 30,
        "maxSitesNumber": 24,
        "characteristics": null,
        "compartmentsAccessMode": "REAR_ACCESS",
        "compartmentConfigurations": [
            {
                "name": "compartimentoMoto",
                "compartments": [
                    {
                        "name": "bau_moto",
                        "type": "FIXED",
                        "maximumCapacity": 1000,
                        "loadingRule": "NONE",
                        "allowedPackagings": [
                            "Carga_Resistente"
                        ]
                    }
                ]
            }
        ],
        "trip": {
            "calculationMode": "THE_FASTEST",
            "crossedBorders": {
                "level": "CITY"
            },
            "toll": {
                "vehicleType": "MOTORCYCLE"
            }
        }
    },
    {
        "name": "Carro",
        "maxWeight": 400,
        "maxVolume": 100,
        "size": 30,
        "maxSitesNumber": 24,
        "characteristics": null,
        "compartmentsAccessMode": "REAR_ACCESS",
        "compartmentConfigurations": [
            {
                "name": "compartimentoCarro",
                "compartments": [
                    {
                        "name": "porta_malas",
                        "type": "FIXED",
                        "maximumCapacity": 1000,
                        "loadingRule": "NONE",
                        "allowedPackagings": [
                            "Carga_fragil"
                        ]
                    }
                ]
            }
        ],
        "trip": {
            "calculationMode": "THE_FASTEST",
            "crossedBorders": {
                "level": "CITY"
            },
            "toll": {
                "vehicleType": "CAR"
            }
        }
    }
],