Kits

Obtener un kit

Devuelve un kit por su identificador: nombre, descripción, imagen, colección y etiquetas.

GET
/api/v1/kits/{kitId}

Ejemplos de petición

curl https://app.filmo.io/api/v1/kits/kit_8f2a1c \
  --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"
  }
}

Generado a partir del esquema

NO devuelve los artículos que lo componen: la lectura interna no los garantiza, y publicar un campo que a veces falta es peor que no publicarlo.

Autorizaciones

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

Cabeceras

If-None-Matchstring

Lectura condicional: el ETag de la copia que ya tienes. Si el recurso no ha cambiado, la respuesta es 304 sin cuerpo.

Ejemplo:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Parámetros de ruta

kitIdstringObligatorio

Identificador del kit.

Límites: longitud mín. 1

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: KitDto

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

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

dataobject

Grupo con nombre de artículos que salen juntos.

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.

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
404not_foundNo existe o queda fuera del alcance de la clave de API.

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.

¿Te ha resultado útil esta página?