Vehículos

Actualizar un vehículo

Actualiza un vehículo (envía solo los campos que cambian).

PATCH
/api/v1/vehicles/{vehicleId}

Ejemplos de petición

curl https://app.filmo.io/api/v1/vehicles/vehi_8f2a1c \
  --request PATCH \
  --header "Authorization: Bearer $FILMO_API_KEY" \
  --header "Idempotency-Key: $(uuidgen 2>/dev/null || cat /proc/sys/kernel/random/uuid)" \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "maintenance",
  "inspectionDate": "2027-03-14T09:00:00+01:00",
  "payloadKg": 1200,
  "dimensions": {
    "lengthCm": 320,
    "widthCm": 175,
    "heightCm": 190,
    "surfaceAreaM2": 5.6
  }
}'
{
  "data": {
    "id": "vehicle_9f3a2b",
    "name": "Example vehicle",
    "status": "active",
    "registrationNumber": "2026-0001",
    "seats": 1,
    "payloadKg": 1,
    "inspectionDate": "2026-09-01T08:00:00.000Z",
    "collectionId": "collection_9f3a2b",
    "collectionName": "Example collection name",
    "showInPlanner": true,
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z"
  }
}

Generado a partir del esquema

Es el endpoint para una integración de flota: estado operativo, matrícula, plazas, carga útil, dimensiones del espacio de carga y fecha de la próxima inspección. El coste por kilómetro y el coste fijo NO forman parte del contrato público. Devuelve el vehículo actualizado.

Autorizaciones

Clave de API como Bearer, con el permiso de abajo. vehicles:write

Cabeceras

Idempotency-Keystring

Identificador único de la petición, elegido por el cliente (sirve un UUID). Entre 1 y 255 caracteres: una cabecera vacía se rechaza con 400 validation_error, porque el cliente se creería protegido. Repetir la misma clave con el MISMO cuerpo en 24 h devuelve la respuesta guardada sin volver a ejecutar, con la cabecera Idempotent-Replay: true. Con un cuerpo DISTINTO devuelve 422. Es la forma segura de reintentar tras un tiempo de espera de red.

Límites: longitud mín. 1, longitud máx. 255

Ejemplo:"9f1c2f4e-3a5b-4f6d-8e7a-0b1c2d3e4f5a"

If-Matchstring

Bloqueo optimista: el ETag que leíste del recurso (o *). Si el recurso ha cambiado desde entonces, la escritura se rechaza con 412 precondition_failed antes de hacer nada; léelo de nuevo y reintenta. Sin la cabecera, la escritura siempre se realiza.

Ejemplo:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Parámetros de ruta

vehicleIdstringObligatorio

Identificador del vehículo.

Límites: longitud mín. 1

Cuerpo

application/json

Esquema del cuerpo: VehicleUpdateBody

namestring

Nombre del vehículo.

Límites: longitud mín. 2

descriptionstring

Descripción o notas del vehículo.

statusstring

Estado del vehículo.

Opciones disponibles: active, maintenance, inactive

registrationNumberstring | null

Número de registro; null lo borra.

seatsinteger | null

Número de plazas; null lo borra.

Límites: mín. 0

payloadKgnumber | null

Carga útil en kilogramos; null la borra.

Límites: mín. 0

dimensionsobject

Dimensiones del espacio de carga.

Mostrar atributos hijos
dimensions.lengthCmnumber

Longitud del espacio de carga en cm.

Límites: mín. 0

dimensions.widthCmnumber

Ancho del espacio de carga en cm.

Límites: mín. 0

dimensions.heightCmnumber

Altura del espacio de carga en cm.

Límites: mín. 0

dimensions.surfaceAreaM2number

Zona de carga en m².

Límites: mín. 0

collectionIdstring | null

Colección a la que pertenece; null lo saca de cualquier colección.

Límites: longitud mín. 1

tagsstring[]

Etiquetas por identificador o nombre. Reemplaza la lista completa.

showInPlannerboolean

Si el vehículo aparece como recurso asignable en el planificador.

inspectionDatestring<date-time> | null

Fecha de la próxima inspección técnica, en ISO 8601 con desplazamiento; null la borra.

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: VehicleDto

Sobre: VehicleResponse. meta.warnings solo aparece cuando la operación está obsoleta.

Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag · Idempotent-Replay

dataobject

Vehículo de la flota. No incluye costes operativos ni ajustes de precios.

Mostrar atributos hijos
data.idstring

Identificador único del vehículo.

data.namestring

Nombre del vehículo.

data.statusstring

Estado operativo: active (disponible), maintenance (en el taller) o inactive (fuera de servicio).

Opciones disponibles: active, maintenance, inactive

data.registrationNumberstring | null

Número de registro; null si no consta.

data.seatsnumber | null

Plazas, incluido el asiento del conductor; null si no consta.

data.payloadKgnumber | null

Carga útil en kilogramos; null si no se ha registrado.

data.inspectionDatestring<date-time> | null

Fecha de la próxima inspección técnica en ISO 8601 UTC; null si no consta.

data.collectionIdstring | null

Identificador de la colección a la que pertenece; null si no está en ninguna.

data.collectionNamestring | null

Ruta de la colección; null si no aplica.

data.showInPlannerboolean

true si aparece en el planificador de la cuenta.

data.createdAtstring<date-time> | null

Fecha de creación en ISO 8601 UTC; null si no consta.

data.updatedAtstring<date-time> | null

Fecha de la última modificación en ISO 8601 UTC; null si no está registrada.

metaobject

Información adicional sobre la respuesta.

Mostrar atributos hijos
meta.warningsobject[]

Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.

Mostrar atributos hijos
meta.warnings.codestring

Código de aviso estable.

Opciones disponibles: deprecated

meta.warnings.messagestring

Para personas: qué está obsoleto, hasta cuándo y qué usar.

meta.warnings.sunsetstring

Día (YYYY-MM-DD) en que la operación deja de estar disponible.

meta.warnings.replacementstring | null

operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.

Errores

EstadoCódigosSignificado
400validation_errorConsulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable.
404not_foundNo existe o queda fuera del alcance de la clave de API.
409conflictEl estado actual del recurso impide la operación, ya hay en curso una petición con esa Idempotency-Key, u otra escritura condicional (If-Match) retuvo el recurso durante más de cinco segundos. errors[0].code indica cuál: in_progress y lock_timeout se resuelven reintentando; invalid_state no, porque el estado del recurso prohíbe la operación.
412precondition_failedLa etiqueta de entidad If-Match no coincide con la representación actual. Vuelve a leer el recurso y reintenta.
422idempotency_key_reusedLa misma clave se usó antes con un cuerpo distinto. Cambia la clave.

401, 403, 429, 500 los puede devolver cualquier operación. Errores

Obsolescencia

Esta operación no está obsoleta. Las obsolescencias se anuncian con la cabecera Deprecation y una fecha de retirada. Política de versiones

¿Te ha resultado útil esta página?