Artículos
Listar artículos
Devuelve el catálogo de artículos de inventario, paginado por cursor.
items:readitems:read- 120/min
- Anotación del servidor: Solo lectura
- Anotación del servidor: Idempotente
Resultado
generado desde el esquema
Aislamiento estricto por suscripción.
Argumentos
Tamaño de página (1-500). Por defecto es 50.
Límites: mín. 1, máx. 500
Cursor opaco de la página que se devuelve. Pasa el valor de pagination. de la respuesta anterior; trátalo como opaco.
Límites: longitud máx. 200
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
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
Filtra por método de cálculo del stock: serialized (por unidades serializadas) o bulk (a granel).
Opciones disponibles: serialized, bulk
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
Filtra por identificador de la colección a la que pertenece el artículo.
Límites: longitud máx. 100
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
Consulta por lotes mediante identificadores separados por comas (entre 1 y 100), pensada para la sincronización.
Límites: longitud máx. 4000
Ponlo en true para incluir pagination., el número de resultados que coinciden con los filtros en todas las páginas. Desactivado por defecto.
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 hijosOcultar atributos hijos
Mostrar atributos hijosOcultar atributos hijos
Desde este día o instante, inclusive.
Hasta este día o instante, inclusive.
Estrictamente posterior; una fecha sin hora significa después del final de ese día.
Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.
Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.
Mostrar atributos hijosOcultar atributos hijos
Desde este día o instante, inclusive.
Hasta este día o instante, inclusive.
Estrictamente posterior; una fecha sin hora significa después del final de ese día.
Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.
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
Identificador único del artículo.
Nombre del artículo.
Referencia SKU del artículo; null si no consta.
Descripción del artículo; null si no consta.
Información adicional del pedido (notas de preparación y entrega); null si no consta.
EAN/código de barras; null si no consta.
Tipo de artículo: fixed (artículo simple) o variant (artículo con variantes).
Opciones disponibles: fixed, variant
Método de cálculo del stock: bulk (a granel, por cantidad) o serialized (por artículos serializados).
Opciones disponibles: bulk, serialized
Identificador de la colección a la que pertenece; null si no está en ninguna.
Nombre de la colección a la que pertenece; null si no está en ninguna.
URLs de las imágenes del artículo.
Precio de venta como cadena decimal "1234.50" (ROUND_HALF_UP); null si no tiene.
Límites: patrón ^-?\d+\.\d{2}$
Importe de la fianza como cadena decimal "1234.50" (ROUND_HALF_UP); null si no tiene.
Límites: patrón ^-?\d+\.\d{2}$
Stock mínimo configurado para las alertas; null si no está configurado.
Número de unidades serializadas registradas del artículo.
Configuración de precios de alquiler; null si no está configurada.
Mostrar atributos hijosOcultar atributos hijos
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
Precio base de alquiler como cadena decimal "1234.50" (ROUND_HALF_UP); null si no aplica.
Límites: patrón ^-?\d+\.\d{2}$
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
Si el artículo admite seguro.
Si el artículo admite descuentos.
Tiempo de margen reservado antes del alquiler; null si no aplica.
Unidad del margen previo: hora o día; null si no aplica.
Opciones disponibles: hour, day
Tiempo de margen reservado después del alquiler; null si no aplica.
Unidad del margen posterior: hour o day; null si no aplica.
Opciones disponibles: hour, day
Propiedades físicas (peso y dimensiones); null si no se han registrado.
Mostrar atributos hijosOcultar atributos hijos
Peso del artículo en kilogramos; null si no está registrado.
Ancho del artículo en centímetros; null si no está registrado.
Altura del artículo en centímetros; null si no consta.
Longitud del artículo en centímetros; null si no consta.
Volumen del artículo en metros cúbicos (m³); null si no está registrado.
Consumo de corriente en amperios; null si no consta.
Potencia en vatios; null si no se ha registrado.
Variantes del artículo (vacío si el artículo es de tipo fixed).
Mostrar atributos hijosOcultar atributos hijos
Identificador único de la variante.
Nombre de la variante.
Precio de alquiler de la variante como cadena decimal "1234.50" (ROUND_HALF_UP).
Límites: patrón ^-?\d+\.\d{2}$
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}$
EAN/código de barras de la variante; null si no consta.
Valores de los campos personalizados por identificador de campo personalizado; las definiciones están en /api.
Fecha de creación en ISO 8601 con desplazamiento.
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].; 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.
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasArtí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: truey el problema en el primer bloque de texto. Ramifica por sucode.
¿Te ha resultado útil esta página?