API Reference

Vehicle Schema

Objeto de location é um conjunto organizado de informações que descreve detalhadamente os atributos físicos e contextuais de um determinado veículo.

CampoTipoDescriçãoObrigatório
typeStringTipo de veículoSim
nameStringNome do veículoNão
capacitiesArray de integerArray contendo as capacidades do veículo [1]Não
fuel_typeObjetoTipo de combustível utilizadoNão
fuel_type.nameStringNome do combustível do veículoNão
fuel_consumptionIntegerConsumo de combustível do perfil de veículoNão
fuel_costIntegerCusto do combustívelNão
leg_optionStringTipo de viagemNão
constraintsObjetoRestrições de roteirizaçãoNão
constraints.skillsArray de StringsCaracterísticas especiais do veículoNão
constraints.fleet_sizeIntegerQuantidade de veículos disponíveis desse perfilNão
constraints.minimum_fillingIntegerPercentual de ocupação mínimaNão
constraints.maximum_fillingIntegerPercentual de ocupação máximoNão
constraints.maximum_stopsIntegerQuantidade máxima de paradas nas rotas do perfil de veículoNão
constraints.maximum_servicesIntegerQuantidade máxima de serviços nas rotas do perfil de veículoNão
constraints.maximum_travel_timeIntegerNúmero máximo de horas das rotas do perfil de veículoNão
constraints.maximum_travel_distanceIntegerDistância máxima percorrida por rotas do perfil de veículoNão
constraints.maximum_distance_between_stopsIntegerDistância máxima entre uma parada e outraNão
constraints.breaksArray de objetosIntervalos para aquele perfil de veículoNão
constraints.breaks.nameStringTipo do intervaloNão
constraints.breaks.typeStringNome do intervaloNão
constraints.breaks.service_timeIntegerTempo do intervaloNão
constraints.breaks.constraintsArray de objetosObjetos com o início e fim do intervaloNão
constraints.breaks.constraints.window_daily.start_timeStringData de início da inserção do intervaloNão
constraints.breaks.constraints.window_daily.end_timeStringData de fim da inserção do intervaloNão
constraints.breaks.constraints.nameStringNome da paradaNão

Este é o objeto necessário para ser utilizado na criação de uma nova Routing. Abaixo segue um exemplo de uso:

{
    "constraints": {
        "skills": [],
        "fleet_size": 1,
        "minimum_filling": [
            60,
            60,
            60,
            60,
            60,
            60
        ],
        "maximum_filling": [
            100,
            100,
            100,
            100,
            100,
            100
        ],
        "maximum_stops": 10,
        "maximum_services": 99999,
        "maximum_travel_time": 8,
        "maximum_travel_distance": 10000,
        "maximum_distance_between_stops": 10,
        "breaks": [
            {
                "type": "break",
                "service_time": 60,
                "constraints": {
                    "window_daily": [
                        {
                            "start_time": "1970-01-01T14:00:00.000Z",
                            "end_time": "1970-01-01T16:00:00.000Z"
                        }
                    ]
                },
                "name": "Lunch"
            }
        ]
    },
    "leg_option": "roundtrip",
    "capacities": [
        13000,
        50,
        100000,
        100000,
        100000,
        100000
    ],
    "quantity_axle": 3,
    "type": "Truck",
    "name": "Truck",
    "fuel_type": {
        "name": "diesel"
    }
}