← InicioFleetPay / API

Registrar un vehículo

Parámetros, estructura de datos y respuestas del contrato versionado.

POST/fiscal/veiculos
createVehicleBase de Pruebas: https://api.fleetpay.site/v1

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

Autenticación

[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.

Parámetros

No hay parámetros declarados para esta operación.

Cuerpo de la Solicitud

Obligatorio

application/json

platestringObligatorio
pattern"^[A-Z]{3}[0-9][A-Z0-9][0-9]{2}$"
plate_statestring | nullOpcional
minLength2
maxLength2
renavamstring | nullOpcional
pattern"^\\d{11}$"
tare_kgnumber | nullOpcional
minimum0
capacity_kgnumber | nullOpcional
minimum0
capacity_m3number | nullOpcional
minimum0
axlesnumber | nullOpcional
minimum0
maximum255
body_typenumber | nullOpcional
minimum0
maximum255
wheel_typenumber | nullOpcional
minimum0
maximum255
owner_typestring | nullOpcional
"own" · "third"
owner_documentstring | nullOpcional
maxLength14
owner_namestring | nullOpcional
maxLength120
owner_rntrcstring | nullOpcional
maxLength8
default_driver_user_idinteger | nullOpcional
minimum1

Respuestas

201 Respuesta HTTP

Vehículo registrado.

application/json

Headers

X-Request-Id

Identificador de correlación de la llamada.

401 Respuesta HTTP

Clave de API FleetPay ausente o no válida.

application/json

Headers

X-Request-Id

Identificador de correlación de la llamada.

403 Respuesta HTTP

Ámbito fiscal deshabilitado en la clave, o clave sin transportista activo.

application/json

Headers

X-Request-Id

Identificador de correlación de la llamada.

422 Respuesta HTTP

Payload inválido, requisito pendiente o regla de negocio.

application/json

Headers

X-Request-Id

Identificador de correlación de la llamada.

429 Respuesta HTTP

Límite por transportista excedido.

application/json

Headers

X-Request-Id

Identificador de correlación de la llamada.

Retry-After

Segundos hasta un nuevo intento.

500 Respuesta HTTP

Fallo interno sin detalles de las integraciones operativas.

application/json

Headers

X-Request-Id

Identificador de correlación de la llamada.

Definición Completa de la Operación
{
  "tags": [
    "Veículos"
  ],
  "summary": "Cadastrar veículo",
  "operationId": "createVehicle",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/VehicleCreateInput"
        }
      }
    }
  },
  "responses": {
    "201": {
      "$ref": "#/components/responses/VehicleCreated"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/Forbidden"
    },
    "422": {
      "$ref": "#/components/responses/ValidationOrBusinessRuleFailed"
    },
    "429": {
      "$ref": "#/components/responses/RateLimited"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    }
  },
  "method": "POST",
  "path": "/fiscal/veiculos",
  "parameters": []
}