Vehículos

Comprobar la disponibilidad de la flota

Devuelve, para cada vehículo (toda la flota, o los seleccionados por vehicleIds, tags, collectionId o search), si tiene compromisos que se solapan con la ventana consultada y cuáles, tipificados.

POST
/api/v1/vehicles/availability

Ejemplos de petición

curl https://app.filmo.io/api/v1/vehicles/availability \
  --request POST \
  --header "Authorization: Bearer $FILMO_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "startDate": "2026-09-01T08:00:00Z",
  "endDate": "2026-09-03T20:00:00Z",
  "tags": [
    "tag_furgonetas"
  ]
}'
{
  "data": [
    {
      "resourceId": "resource_9f3a2b",
      "name": "Example resource availability entry",
      "available": true,
      "commitments": [
        {
          "kind": "order",
          "orderId": "order_9f3a2b",
          "orderNumber": "2026-0001",
          "label": "Main",
          "startDate": "2026-09-01T08:00:00.000Z",
          "endDate": "2026-09-01T08:00:00.000Z"
        }
      ]
    }
  ]
}

Generado a partir del esquema

Misma forma de respuesta que la disponibilidad del personal. Un identificador solicitado que no existe vuelve como error por elemento. Consulta idempotente (POST por el cuerpo estructurado). Comparte la cuota de disponibilidad de 30 req/min.

Autorizaciones

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

Cuerpo

application/json

Esquema del cuerpo: VehicleAvailabilityBody

startDatestring<date-time>Obligatorio

Inicio de la ventana a comprobar (ISO 8601 con desplazamiento).

endDatestring<date-time>Obligatorio

Fin de la ventana que se comprueba (ISO 8601 con desplazamiento); debe ser posterior a startDate.

tagsstring[]

Solo los recursos que tengan TODOS estos identificadores de etiqueta.

Límites: mín. 1 elementos, máx. 50 elementos, cada uno: longitud mín. 1, cada uno: longitud máx. 100

collectionIdstring

Solo los recursos de esta colección.

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

vehicleIdsstring[]

Limita la respuesta a estos vehículos (1-100). Un identificador que no existe vuelve como error por elemento.

Límites: mín. 1 elementos, máx. 100 elementos, cada uno: longitud mín. 1, cada uno: longitud máx. 100

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: ResourceAvailabilityEntryDto

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

Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset

dataobject[]

Uno de 1/2: ResourceAvailability
data.resourceIdstring

Identificador del recurso consultado.

data.namestring

Nombre del recurso.

data.availableboolean

true si no hay compromisos, ausencias ni incidencias bloqueantes en la ventana.

data.commitmentsobject[]

Todo lo que ocupa el recurso dentro de la ventana, tipado. Vacío cuando el recurso está libre.

Mostrar atributos hijos
data.commitments.kindstring

order (una línea de un pedido), internal_service (un servicio interno, no vinculado a un pedido), unavailability (una ausencia declarada) o incident (una incidencia bloqueante).

Opciones disponibles: order, internal_service, unavailability, incident

data.commitments.orderIdstring | null

Pedido que ocupa el recurso; null salvo que kind sea order.

data.commitments.orderNumberstring | null

Número de ese pedido; null salvo que kind sea order.

data.commitments.labelstring

Qué ocupa el recurso: el nombre del servicio en los pedidos; una etiqueta genérica en los servicios internos, las ausencias y las incidencias (su título o motivo privado nunca se expone).

data.commitments.startDatestring<date-time>

Inicio del compromiso en ISO 8601 UTC.

data.commitments.endDatestring<date-time>

Fin del compromiso en ISO 8601 UTC.

Uno de 2/2: ResourceAvailabilityErrorEntry
data.resourceIdstring

Identificador que pidió la petición.

data.errorobject

Mostrar atributos hijos
data.error.codestring

El recurso no existe en la cuenta.

Opciones disponibles: not_found

data.error.messagestring

Explicación legible.

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.

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?