Kits

Listar kits

Devuelve los kits del catálogo, paginados por cursor: grupos con nombre de artículos que salen juntos, con sus componentes, colección y etiquetas.

GET
/api/v1/kits

Ejemplos de petición

curl https://app.filmo.io/api/v1/kits \
  --header "Authorization: Bearer $FILMO_API_KEY"
{
  "data": [
    {
      "id": "kit_9f3a2b",
      "name": "Example kit",
      "description": "Example text.",
      "image": "Example image",
      "collectionId": "collection_9f3a2b",
      "collectionName": "Example collection name",
      "tags": [
        {
          "id": "tag_9f3a2b",
          "name": "Example tag"
        }
      ],
      "components": [
        {
          "itemId": "item_9f3a2b",
          "itemName": "Example item name",
          "variantId": "variant_9f3a2b",
          "variantName": "Example variant name",
          "quantity": 1,
          "position": 1
        }
      ],
      "createdAt": "2026-09-01T08:00:00.000Z",
      "updatedAt": "2026-09-01T08:00:00.000Z"
    }
  ],
  "pagination": {
    "nextCursor": "eyJvIjoyMH0",
    "hasMore": true,
    "total": 1
  }
}

Generado a partir del esquema

Filtra por colección y por etiqueta (cualquiera de las indicadas). Ordenados por nombre; sort acepta un único campo. Los filtros por fecha de creación y de actualización no están disponibles en este listado.

Autorizaciones

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

Parámetros de consulta

limitintegerpredeterminado:50

Tamaño de página (1-500). Por defecto es 50.

Límites: mín. 1, máx. 500

cursorstring

Cursor opaco de la página que se devuelve. Pasa el valor de pagination.nextCursor de la respuesta anterior; trátalo como opaco.

Límites: longitud máx. 200

sortstring

Orden: un único campo, con un "-" inicial para descendente (p. ej. "-updatedAt"). Campos ordenables: name, createdAt, updatedAt. Por defecto, "name". Los empates se resuelven por id, así que el orden es estable entre páginas, y un cursor queda ligado al orden con el que se emitió.

Límites: longitud máx. 200

collectionIdstring

Filtra por identificador de la colección a la que pertenece el kit.

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

collectionIdsstring[]

Filtra por collectionId, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.

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

tagIdstring

Filtra por identificador de etiqueta: kits que llevan esa etiqueta.

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

tagIdsstring[]

Filtra por tagId, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.

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

includeTotalbooleanpredeterminado:false

Ponlo en true para incluir pagination.total, el número de resultados que coinciden con los filtros en todas las páginas. Desactivado por defecto.

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: KitDto

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

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

dataobject[]

Mostrar atributos hijos
data.idstring

Identificador único del kit.

data.namestring

Nombre del kit.

data.descriptionstring | null

Descripción del kit; null si no tiene.

data.imagestring | null

URL de la imagen principal; null si no tiene.

data.collectionIdstring | null

Colección a la que pertenece; null si no está en ninguna.

data.collectionNamestring | null

Ruta completa de la colección; null si no está en ninguna.

data.tagsobject[]

Etiquetas del kit, con su identificador y nombre.

Mostrar atributos hijos
data.tags.idstring

Identificador único de la etiqueta.

data.tags.namestring

Nombre de la etiqueta.

data.componentsobject[]

Artículos que componen el kit, en orden de visualización.

Mostrar atributos hijos
data.components.itemIdstring

Identificador del artículo; consúltalo en /api/v1/items/{itemId}.

data.components.itemNamestring

Nombre del artículo, tal como se registró al añadirlo al kit.

data.components.variantIdstring | null

Variante del artículo, si se eligió una; null en caso contrario.

data.components.variantNamestring | null

Nombre de esa variante; null si no hay.

data.components.quantitynumber

Cuántas unidades del artículo incluye el kit.

data.components.positionnumber | null

Orden de visualización dentro del kit (base 0); null si no está definido.

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.

paginationobject

Metadatos de paginación por cursor opaco.

Mostrar atributos hijos
pagination.nextCursorstring | null

Cursor opaco de la página siguiente; null cuando no hay más resultados. Pásalo como cursor en la siguiente petición.

pagination.hasMoreboolean

Si existen más resultados después de esta página.

pagination.totalinteger

Número de resultados que coinciden con los filtros en todas las páginas. Solo aparece cuando la petición establece includeTotal=true.

Límites: mín. 0

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.

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

  • Catálogo e inventario

    Kit

    Grupo con nombre de artículos que salen juntos.