Incidencias

Abrir una incidencia

Registra material roto, perdido o dañado.

POST
/api/v1/incidents

Ejemplos de petición

curl https://app.filmo.io/api/v1/incidents \
  --request POST \
  --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 '{
  "title": "Montura dañada en la devolución",
  "type": "damage",
  "scope": "serializedItem",
  "priority": "high",
  "blocksAvailability": true,
  "itemId": "itm_9f3a2b",
  "serializedItemId": "ser_00187",
  "orderId": "ord_00421",
  "description": "La montura llega con holgura; no sujeta el objetivo.",
  "dueDate": "2026-09-20T12:00:00+02:00"
}'
{
  "data": {
    "id": "incident_9f3a2b",
    "identifier": "Example identifier",
    "title": "Example title",
    "description": "Example text.",
    "type": "Example type",
    "scope": "item",
    "status": "Example status",
    "priority": "Example priority",
    "severity": "Example severity",
    "blocksAvailability": true,
    "affectedQuantity": 1,
    "itemId": "item_9f3a2b",
    "serializedItemId": "serialized_item_9f3a2b",
    "spaceId": "space_9f3a2b",
    "vehicleId": "vehicle_9f3a2b",
    "orderId": "order_9f3a2b",
    "projectId": "project_9f3a2b",
    "dueDate": "2026-09-01T08:00:00.000Z",
    "commentCount": 1,
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z"
  }
}

Generado a partir del esquema

Con blocksAvailability: true el material sale del conjunto disponible mientras la incidencia siga abierta; si el artículo se controla por cantidad y no indicas una unidad física concreta, affectedQuantity pasa a ser obligatorio. El coste de la reparación NO forma parte del contrato público. Devuelve la incidencia creada.

Autorizaciones

Clave de API como Bearer, con el permiso de abajo. incidents: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\""

Cuerpo

application/json

Esquema del cuerpo: IncidentCreateBody

titlestringObligatorio

Título corto, el que se muestra en listas y tarjetas.

Límites: longitud mín. 1

typestringObligatorio

Naturaleza de la incidencia.

Opciones disponibles: damage, loss, malfunction, cosmetic, theft, custom

scopestringObligatorio

A qué afecta la incidencia.

Opciones disponibles: item, serializedItem, space, kit, vehicle, custom

statusstring

Estado inicial. Por defecto "draft".

Opciones disponibles: draft, open, waiting, repairing, complete, lost

prioritystring

Prioridad. Por defecto es "none".

Opciones disponibles: urgent, high, medium, low, none

severitystring

Gravedad. Por defecto, "low".

Opciones disponibles: low, high

descriptionstring

Descripción de lo ocurrido.

blocksAvailabilityboolean

true retira el material del conjunto disponible mientras la incidencia esté abierta.

affectedQuantityinteger

Unidades afectadas. Obligatorio al bloquear stock a granel.

Límites: máx. 10000, > 0

itemIdstring

Artículo afectado.

serializedItemIdstring

Unidad física concreta afectada.

variantIdstring

Variante de artículo afectada.

spaceIdstring

Espacio afectado.

vehicleIdstring

Vehículo afectado.

orderIdstring

Pedido en el que se detectó.

projectIdstring

Proyecto asociado.

contactIdsstring[]

Contactos implicados (proveedor, aseguradora, cliente) para que puedan verla.

assigneeStaffIdsstring[]

Personal asignado para resolverla.

subscriberIdsstring[]

Obsoleto: se acepta por compatibilidad, pero se ignora. Las incidencias ya no mantienen una lista de suscriptores.

labelsstring[]

Etiquetas de formato libre de la incidencia.

imagesstring[]

URLs de fotos del daño.

dueDatestring<date-time>

Fecha objetivo de resolución, en ISO 8601 con desplazamiento.

reminderEnabledboolean

Activa el recordatorio interno.

reminderDatestring<date-time>

Fecha del recordatorio, en ISO 8601 con desplazamiento.

parentIncidentIdstring

Incidencia de la que esta es hija.

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: IncidentDto

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

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

dataobject

Material roto, perdido o que funciona mal, con su estado de reparación.

Mostrar atributos hijos
data.idstring

Identificador único de la incidencia.

data.identifierstring

Número de incidencia legible.

data.titlestring

Título corto de la incidencia.

data.descriptionstring | null

Descripción; null si no tiene.

data.typestring

Naturaleza: damage, loss, malfunction, cosmetic, theft o custom.

data.scopestring

A qué afecta: item, serializedItem, space, kit, vehicle o custom.

Opciones disponibles: item, serializedItem, space, kit, vehicle, custom

data.statusstring

Estado del ciclo de vida: draft, open, waiting, repairing, complete o lost.

data.prioritystring

Prioridad: urgent, high, medium, low o none.

data.severitystring

Gravedad declarada.

data.blocksAvailabilityboolean

true cuando la incidencia retira el material del conjunto disponible.

data.affectedQuantityinteger | null

Unidades afectadas en stock a granel; null cuando no aplica.

data.itemIdstring | null

Artículo afectado; null si no aplica.

data.serializedItemIdstring | null

Unidad física afectada; null si no aplica.

data.spaceIdstring | null

Espacio afectado; null si no aplica.

data.vehicleIdstring | null

Vehículo afectado; null si no aplica.

data.orderIdstring | null

Pedido en el que se detectó; null si no procede.

data.projectIdstring | null

Proyecto asociado; null si no aplica.

data.dueDatestring<date-time> | null

Fecha objetivo de resolución en ISO 8601 UTC; null si no tiene.

data.commentCountinteger

Comentarios que tiene la incidencia.

data.createdAtstring<date-time>

Fecha de creación en ISO 8601 UTC.

data.updatedAtstring<date-time>

Fecha de la última modificación en ISO 8601 UTC.

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.
402addon_requiredEl plan de la cuenta no incluye el add-on que necesita esta operación; requiredAddon lo nombra.
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

  • Operaciones

    Incidencia

    Material roto, perdido o que funciona mal, con su estado de reparación.

¿Te ha resultado útil esta página?