← InicioFleetPay / Schema

RoteirizarVpoRequest

Estructura preservada del contrato versionado de la API.

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

origemstringObligatorio

Punto de partida: nombre de la ciudad y UF (ej.: "São Paulo, SP") o código IBGE del municipio con 7 dígitos (ej.: 3550308 o "3550308").

minLength3
maxLength150
destinostringObligatorio

Punto de llegada: nombre de la ciudad y UF (ej.: "Rio de Janeiro, RJ") o código IBGE del municipio con 7 dígitos (ej.: 3304557 o "3304557").

minLength3
maxLength150
eixosintegerObligatorio

Cantidad total de ejes del vehículo comercial o conjunto.

minimum2
maximum10
pontos_paradaarray | nullOpcional

Puntos intermedios del viaje, en el orden en que pasa el vehículo, entre origem y destino. La operadora traza la ruta por esos puntos e identifica las plazas de peaje del itinerario.

maxItems20
tipo_rotainteger | nullOpcional

Preferencia de trayecto de la operadora:

  • 1 - más rápida (predeterminada)
  • 2 - más corta
1 · 2 · null
Definición JSON Original (Descripciones en Portugués)
{
  "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"
    }
  }
}