← InícioFleetPay / Schema

CotarVpoRequest

Estrutura preservada do contrato versionado da API.

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

VpoPontoParada ↗

origemstringObrigatório

CEP (com ou sem hífen) ou nome da cidade/endereço de partida.

minLength3

maxLength150

destinostringObrigatório

CEP (com ou sem hífen) ou nome da cidade/endereço de chegada.

minLength3

maxLength150

eixosintegerObrigatório

Quantidade total de eixos do veículo comercial ou conjunto.

minimum2

maximum10

placastring | nullOpcional

Placa do veículo comercial (padrão Mercosul ou antigo).

maxLength10

modalidadestring | nullOpcional

Modalidade de rota pretendida (planejada: rota direta otimizada; estendida: rota com tolerância para desvios; customizada: praças específicas).

"planejada" · "estendida" · "customizada"

pontos_paradaarray | nullOpcional

Pontos intermediários da viagem, na ordem em que o veículo passa, entre origem e destino. A operadora não aceita polyline: a rota é traçada por pontos de parada, e cada ponto pode ser uma cidade (cidade, no formato "Cidade, UF") ou um par latitude/longitude em graus decimais (vértices relevantes de um traçado próprio, por exemplo). Se um ponto trouxer cidade e coordenadas, vale a cidade. Use-o para forçar o trajeto por uma rodovia específica ou reproduzir a rota do seu roteirizador. Sem este campo a operadora escolhe o trajeto entre origem e destino.

VpoPontoParada ↗

maxItems20

tipo_rotastring | nullOpcional

Critério da operadora para traçar a rota principal entre os pontos.

"mais_rapida" · "mais_curta"

Definição JSON Completa

{
  "type": "object",
  "required": [
    "origem",
    "destino",
    "eixos"
  ],
  "properties": {
    "origem": {
      "type": "string",
      "minLength": 3,
      "maxLength": 150,
      "description": "CEP (com ou sem hífen) ou nome da cidade/endereço de partida."
    },
    "destino": {
      "type": "string",
      "minLength": 3,
      "maxLength": 150,
      "description": "CEP (com ou sem hífen) ou nome da cidade/endereço de chegada."
    },
    "eixos": {
      "type": "integer",
      "minimum": 2,
      "maximum": 10,
      "description": "Quantidade total de eixos do veículo comercial ou conjunto."
    },
    "placa": {
      "type": "string",
      "maxLength": 10,
      "nullable": true,
      "description": "Placa do veículo comercial (padrão Mercosul ou antigo)."
    },
    "modalidade": {
      "type": "string",
      "enum": [
        "planejada",
        "estendida",
        "customizada"
      ],
      "nullable": true,
      "description": "Modalidade de rota pretendida (`planejada`: rota direta otimizada; `estendida`: rota com tolerância para desvios; `customizada`: praças específicas)."
    },
    "pontos_parada": {
      "type": "array",
      "nullable": true,
      "maxItems": 20,
      "description": "Pontos intermediários da viagem, **na ordem em que o veículo passa**, entre `origem` e `destino`.\nA operadora não aceita polyline: a rota é traçada por pontos de parada, e cada ponto pode ser uma\ncidade (`cidade`, no formato \"Cidade, UF\") **ou** um par `latitude`/`longitude` em graus decimais\n(vértices relevantes de um traçado próprio, por exemplo). Se um ponto trouxer cidade e coordenadas,\nvale a cidade. Use-o para forçar o trajeto por uma rodovia específica ou reproduzir a rota do seu\nroteirizador. Sem este campo a operadora escolhe o trajeto entre origem e destino.\n",
      "items": {
        "$ref": "#/components/schemas/VpoPontoParada"
      }
    },
    "tipo_rota": {
      "type": "string",
      "enum": [
        "mais_rapida",
        "mais_curta"
      ],
      "nullable": true,
      "default": "mais_rapida",
      "description": "Critério da operadora para traçar a rota principal entre os pontos."
    }
  }
}