v1

latestOpenAPI 3.0.32026-07-24398641.3 MB

Items

items__getItems

Obtiene la lista de ítems registrados en la aplicación con filtros opcionales. Usar el parámetro "fields" para incluir datos adicionales cuando el contexto de la conversación lo requiera (e.g. inventory para consultas de stock, images para catálogos, editable/deletable para tareas de gestión).

post/tools/items__getItems

Request body

limitinteger

Cantidad máxima de ítems a retornar. Por defecto 30.

startinteger

Offset para paginación (número de ítems a omitir).

metadataboolean

Si es true, la respuesta incluye { metadata: { total }, data: [...] } en lugar del array directo.

querystring

Texto libre para buscar ítems por nombre o descripción.

type'simple' | 'kit' | 'variantParent' | 'variant' | 'surtido'

Filtrar ítems por tipo.

status'active' | 'inactive'

Filtrar ítems por estado.

namestring

Filtrar ítems por nombre exacto.

referencestring

Filtrar ítems por referencia o código SKU.

idItemCategorystring

Filtrar ítems por ID de categoría de ítem.

idWarehousestring

Filtrar ítems por ID de bodega.

order_fieldstring

Campo por el cual ordenar los resultados.

order_direction'ASC' | 'DESC'

Dirección del ordenamiento.

fieldsstring

Campos adicionales a retornar, separados por coma. Valores posibles: itemVariants, variantAttributes, subitems, editable, deletable, settingsOnShop, remissionedQuantity, negativeSale, source, simpleSale, inventory, images, attachments, productKey, tariffHeading, kitWarehouse, idGlobal.

mode'advanced' | 'simple'

Modo de respuesta: simple retorna un conjunto reducido de campos.

Example request

{
  "limit": 30,
  "query": "Camiseta",
  "type": "simple",
  "status": "active",
  "name": "Camiseta azul",
  "reference": "SKU-001",
  "idItemCategory": "1",
  "idWarehouse": "2",
  "order_field": "name",
  "order_direction": "ASC",
  "fields": "inventory,images,editable,deletable,idGlobal",
  "mode": "simple"
}

Response

Lista de ítems registrados.