← InícioFleetPay / Schema

RoteirizarVpoRequest

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.

origemstringObrigatório

Ponto de partida: nome da cidade e UF (ex: "São Paulo, SP") ou código IBGE do município com 7 dígitos (ex: 3550308 ou "3550308").

minLength3
maxLength150
destinostringObrigatório

Ponto de chegada: nome da cidade e UF (ex: "Rio de Janeiro, RJ") ou código IBGE do município com 7 dígitos (ex: 3304557 ou "3304557").

minLength3
maxLength150
eixosintegerObrigatório

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

minimum2
maximum10
pontos_paradaarray | nullOpcional

Pontos intermediários da viagem, na ordem em que o veículo passa, entre origem e destino. A operadora traça a rota por esses pontos e identifica as praças de pedágio do itinerário.

maxItems20
tipo_rotainteger | nullOpcional

Preferência de trajeto da operadora:

  • 1 - mais rápida (padrão)
  • 2 - mais curta
1 · 2 · null
Definição JSON Completa
{
  "type": "object",
  "required": [
    "origem",
    "destino",
    "eixos"
  ],
  "properties": {
    "origem": {
      "type": "string",
      "minLength": 3,
      "maxLength": 150,
      "description": "Ponto de partida: nome da cidade e UF (ex: `\"São Paulo, SP\"`) ou código IBGE do município com 7 dígitos (ex: `3550308` ou `\"3550308\"`).\n"
    },
    "destino": {
      "type": "string",
      "minLength": 3,
      "maxLength": 150,
      "description": "Ponto de chegada: nome da cidade e UF (ex: `\"Rio de Janeiro, RJ\"`) ou código IBGE do município com 7 dígitos (ex: `3304557` ou `\"3304557\"`).\n"
    },
    "eixos": {
      "type": "integer",
      "minimum": 2,
      "maximum": 10,
      "description": "Quantidade total de eixos do veículo comercial ou conjunto."
    },
    "pontos_parada": {
      "type": [
        "array",
        "null"
      ],
      "maxItems": 20,
      "description": "Pontos intermediários da viagem, **na ordem em que o veículo passa**, entre `origem` e `destino`.\nA operadora traça a rota por esses pontos e identifica as praças de pedágio do itinerário.\n",
      "items": {
        "$ref": "#/components/schemas/VpoPontoParada"
      }
    },
    "tipo_rota": {
      "type": [
        "integer",
        "null"
      ],
      "enum": [
        1,
        2,
        null
      ],
      "description": "Preferência de trajeto da operadora:\n\n- `1` - mais rápida (padrão)\n- `2` - mais curta\n"
    }
  }
}