← HomeFleetPay / Schema

RoteirizarVpoRequest

Structure preserved from the versioned API contract.

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

origemstringRequired

Starting point: city name and UF (e.g. "São Paulo, SP") or 7-digit municipality IBGE code (e.g. 3550308 or "3550308").

minLength3
maxLength150
destinostringRequired

Destination point: city name and UF (e.g. "Rio de Janeiro, RJ") or 7-digit municipality IBGE code (e.g. 3304557 or "3304557").

minLength3
maxLength150
eixosintegerRequired

Total axle count of the commercial vehicle or vehicle combination.

minimum2
maximum10
pontos_paradaarray | nullOptional

Intermediate waypoints of the trip, in the order the vehicle visits them, between origem and destino. The operator plots the route through these points and identifies the toll plazas along the itinerary.

maxItems20
tipo_rotainteger | nullOptional

Operator route preference:

  • 1 - fastest (default)
  • 2 - shortest
1 · 2 · null
Original JSON Definition (Portuguese Descriptions)
{
  "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"
    }
  }
}