Artículos

Listar artículos

Devuelve el catálogo de artículos de inventario, paginado por cursor.

Herramienta
filmo_items_list
Acceso: Lectura
  • items:read
  • 120/min
  • Anotación del servidor: Solo lectura
  • Anotación del servidor: Idempotente

Resultado

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_items_list",
    "arguments": {
      "limit": 20
    }
  }
}

generado desde el esquema

Aislamiento estricto por suscripción.

Argumentos

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: hasta 3 campos separados por comas, cada uno con un "-" inicial para descendente (p. ej. "-updatedAt,name"). Campos ordenables: createdAt, updatedAt, name, sku, salePrice, depositValue, serializedItemsCount, collectionName. Por defecto, "-createdAt". 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

querystring

Búsqueda de texto libre (actualmente ILIKE sobre nombre, SKU, sinónimos y códigos de unidades serializadas). La semántica NO es contractual: puede evolucionar sin previo aviso.

Límites: longitud máx. 200

stockTypestring

Filtra por método de cálculo del stock: serialized (por unidades serializadas) o bulk (a granel).

Opciones disponibles: serialized, bulk

stockTypesstring[]

Filtra por stockType, 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.

Opciones disponibles: serialized, bulk

Límites: mín. 1 elementos, máx. 50 elementos

collectionIdstring

Filtra por identificador de la colección a la que pertenece el artículo.

Límites: 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áx. 100

idsstring

Consulta por lotes mediante identificadores separados por comas (entre 1 y 100), pensada para la sincronización.

Límites: longitud máx. 4000

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.

dateFiltersobject

Filtros de fecha por campo. Una fecha sin hora (YYYY-MM-DD) se lee en la zona horaria del negocio; un instante ISO 8601 con desplazamiento se aplica tal cual con gte, lte, gt y lt, mientras que on lo amplía al día completo del negocio que lo contiene. Campos: created, updated.

Mostrar atributos hijos
dateFilters.createdobject

Mostrar atributos hijos
dateFilters.created.gtestring

Desde este día o instante, inclusive.

dateFilters.created.ltestring

Hasta este día o instante, inclusive.

dateFilters.created.gtstring

Estrictamente posterior; una fecha sin hora significa después del final de ese día.

dateFilters.created.ltstring

Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.

dateFilters.created.onstring

Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.

dateFilters.updatedobject

Mostrar atributos hijos
dateFilters.updated.gtestring

Desde este día o instante, inclusive.

dateFilters.updated.ltestring

Hasta este día o instante, inclusive.

dateFilters.updated.gtstring

Estrictamente posterior; una fecha sin hora significa después del final de ese día.

dateFilters.updated.ltstring

Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.

dateFilters.updated.onstring

Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.

Resultado

En un éxito el resultado lleva structuredContent con data y meta. Estos son los atributos de data.

Ver los atributos de data
idstring

Identificador único del artículo.

namestring

Nombre del artículo.

skustring | null

Referencia SKU del artículo; null si no consta.

descriptionstring | null

Descripción del artículo; null si no consta.

orderInfostring | null

Información adicional del pedido (notas de preparación y entrega); null si no consta.

eanstring | null

EAN/código de barras; null si no consta.

itemTypestring

Tipo de artículo: fixed (artículo simple) o variant (artículo con variantes).

Opciones disponibles: fixed, variant

stockCalculationMethodstring

Método de cálculo del stock: bulk (a granel, por cantidad) o serialized (por artículos serializados).

Opciones disponibles: bulk, serialized

collectionIdstring | null

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

collectionNamestring | null

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

imagesstring[]

URLs de las imágenes del artículo.

salePricestring | null

Precio de venta como cadena decimal "1234.50" (ROUND_HALF_UP); null si no tiene.

Límites: patrón ^-?\d+\.\d{2}$

depositValuestring | null

Importe de la fianza como cadena decimal "1234.50" (ROUND_HALF_UP); null si no tiene.

Límites: patrón ^-?\d+\.\d{2}$

minStocknumber | null

Stock mínimo configurado para las alertas; null si no está configurado.

serializedItemsCountnumber

Número de unidades serializadas registradas del artículo.

pricingSettingsobject | null

Configuración de precios de alquiler; null si no está configurada.

Mostrar atributos hijos
pricingSettings.typestring | null

Modo de precio: periodPrice (precio por periodo), fixedPrice (precio fijo) o pricingStructure (estructura de precios); null si el artículo no tiene ninguno configurado.

Opciones disponibles: periodPrice, fixedPrice, pricingStructure

pricingSettings.pricestring | null

Precio base de alquiler como cadena decimal "1234.50" (ROUND_HALF_UP); null si no aplica.

Límites: patrón ^-?\d+\.\d{2}$

pricingSettings.periodstring | null

Unidad de periodo del precio: hour, day, week o month; null si el artículo no tiene ninguna configurada.

Opciones disponibles: hour, day, week, month

insuranceEnabledboolean

Si el artículo admite seguro.

discountEnabledboolean

Si el artículo admite descuentos.

bufferBeforenumber | null

Tiempo de margen reservado antes del alquiler; null si no aplica.

bufferBeforeUnitstring | null

Unidad del margen previo: hora o día; null si no aplica.

Opciones disponibles: hour, day

bufferAfternumber | null

Tiempo de margen reservado después del alquiler; null si no aplica.

bufferAfterUnitstring | null

Unidad del margen posterior: hour o day; null si no aplica.

Opciones disponibles: hour, day

physicalPropertiesobject | null

Propiedades físicas (peso y dimensiones); null si no se han registrado.

Mostrar atributos hijos
physicalProperties.weightnumber | null

Peso del artículo en kilogramos; null si no está registrado.

physicalProperties.widthnumber | null

Ancho del artículo en centímetros; null si no está registrado.

physicalProperties.heightnumber | null

Altura del artículo en centímetros; null si no consta.

physicalProperties.lengthnumber | null

Longitud del artículo en centímetros; null si no consta.

physicalProperties.volumenumber | null

Volumen del artículo en metros cúbicos (m³); null si no está registrado.

physicalProperties.currentnumber | null

Consumo de corriente en amperios; null si no consta.

physicalProperties.powernumber | null

Potencia en vatios; null si no se ha registrado.

variantsobject[]

Variantes del artículo (vacío si el artículo es de tipo fixed).

Mostrar atributos hijos
variants.variantIdstring

Identificador único de la variante.

variants.variantNamestring

Nombre de la variante.

variants.variantPricestring

Precio de alquiler de la variante como cadena decimal "1234.50" (ROUND_HALF_UP).

Límites: patrón ^-?\d+\.\d{2}$

variants.salePricestring | null

Precio de venta de la variante como cadena decimal "1234.50" (ROUND_HALF_UP); null si no tiene.

Límites: patrón ^-?\d+\.\d{2}$

variants.eanstring | null

EAN/código de barras de la variante; null si no consta.

tagsobject[]

Etiquetas asociadas al artículo.

Mostrar atributos hijos
tags.idstring

Identificador único de la etiqueta.

tags.namestring

Nombre de la etiqueta.

customFieldsobject<string, any>

Valores de los campos personalizados por identificador de campo personalizado; las definiciones están en /api/v1/custom-fields.

createdAtstring<date-time>

Fecha de creación en ISO 8601 con desplazamiento.

updatedAtstring<date-time>

Fecha de la última actualización en ISO 8601 con desplazamiento.

Un error es un resultado con isError: true y el problema en content[0].text; no hay structuredContent. Consulta Errores.

Prompts de ejemplo

Busca los artículos de la categoría de cámaras que contengan «cine» en el nombre.

La misma operación por REST

Esta herramienta ejecuta GET /api/v1/items.

  • Artículos

    Listar artículos

    Devuelve el catálogo de artículos de inventario, paginado por cursor.

  • Guías

    Escrituras seguras

    Un asistente que puede escribir también puede escribir lo equivocado. Decide qué herramientas necesitan a una persona, reintenta sin duplicar y sabe qué pone en marcha una escritura.

  • Guías

    Errores

    Un error de herramienta es un resultado con isError: true y el problema en el primer bloque de texto. Ramifica por su code.

¿Te ha resultado útil esta página?