---
title: "Listado de items"
method: GET
path: "/items"
tags: ["Ítems"]
---

# Listado de items

`GET /items`

## Request

- Base URL: `https://api.alegra.com/api/v1`
- URL: `https://api.alegra.com/api/v1/items`
- Auth: HTTP basic

Endpoint que permite consultar los productos o servicios registrados en la aplicación

## Query parameters

- `start` integer
- `limit` integer
- `order_direction` string
- `order_field` string
- `query` string
- `metadata` boolean
- `idWarehouse` string
- `name` string
- `reference` string
- `price` string
- `description` string
- `priceList_id` string
- `idItemCategory` string
- `type` string
- `variantAttribute_id` string
- `variantAttributeOption_id` string
- `variantParent_id` string
- `customField_id` string
- `customField_value` string
- `status` string
- `inventariable` boolean
- `fields` string
- `mode` 'advanced' | 'simple'

## Response `200`

Ejemplo de consulta exitosa

- object
  - `id` string: Identificador único que representa un producto o servicio específico. La aplicación lo asigna automáticamente.
  - `name` string: Nombre del item.
  - `description` string: Descripción del item.
  - `reference` string: Referencia o código que identifica un item.
  - `price` object[]: Indica los precios asociados al item.
    - `idPriceList` string: Identificador que representa una lista de precios.
    - `name` string: Nombre de la lista de precios.
    - `price` number: Precio del producto en esa lista de precios.
  - `tax` object[]: Indica el impuesto asociado al item.
    - `id` string: Identificador del impuesto.
    - `name` string: Nombre del impuesto.
    - `percentage` number: Porcentaje del impuesto.
    - `description` string: Descripción del impuesto.
    - `status` string: Estado del impuesto, puede ser active para un impuesto activo, o inactive para un impuesto que se encuentra inactivo.
  - `category` object: Objeto que contiene la información de la categoría asociada al producto o servicio. Este objeto indica la categoría de Alegra a la cual se llevan los registros de tus ventas cuando realizas movimientos con este producto o servicio.
    - `id` string: Identificador de la categoría
    - `name` string: Nombre de la categoría
  - `inventory` object: Objeto que contiene la información del inventario del producto. Si este objeto está presente indica que el artículo es inventariable, si no lo está se asume como servicio.
    - `unit` string: Indica la unidad de medida del producto.
    - `availableQuantity` integer: Indica la cantidad disponible en el inventario. Si el producto se encuentra distribuido en múltiples bodegas, este atributo retorna la cantidad disponible en todas las bodegas.
    - `unitCost` integer: Indica el costo unitario del producto.
    - `initialQuantity` integer: Indica la cantidad inicial con la cual se creó el producto. Si el producto se encuentra
    - `warehouses` KitWarehouse[]: Array de objetos warehouse que indican las bodegas asociadas al producto (unresolved $ref)
  - `status` 'inactive' | 'active': Indica el estado del producto o servicio, active: para productos que se encuentran activos, inactive: para productos que se encuentran inactivos.
  - `type` 'simple' | 'kit' | 'variantParent' | 'variant': Indica el tipo del producto, simple: Producto sencillo, kit: Producto que está compuesto por otros, variantParent: Producto con características variantes (como el color o la talla). Es el item padre, compuesto de items variantes, variant: Producto asociado a un item con variantes, representa un conjunto de variantes en especifico. Es el item hijo asociado a un padre.
  - `subitems` object[]: Array de objetos que contienen la información de los productos que componen el kit. Aplica únicamente para productos tipo kit.
    - `quantity` number: Cantidad del subitem necesaria para conformar el kit.
    - `item` unknown
  - `kitWarehouse` object
    - `id` string: Identificador único de la bodega.
    - `name` string: Nombre de la bodega.
    - `observations` string: Observaciones de la bodega.
    - `isDefault` boolean: Indica si la bodega es la de por defecto.
    - `address` string: Dirección de la bodega.
    - `status` string: Estado de la bodega, puede ser active o inactive.
    - `initialQuantity` string: Cantidad inicial del producto en la bodega.
    - `availableQuantity` string: Cantidad disponible del producto en la bodega.
    - `minQuantity` string: Cantidad mínima establecida para el producto en la bodega.
    - `maxQuantity` string: Cantidad máxima establecida para el producto en la bodega.
  - `itemCategory` object: Objeto que indica la categoría de ítem asociada. Contiene un objeto itemCategory.
  - `customFields` object[]: Array con atributos adicionales asociados al producto.
    - `id` string: Id del atributo adicional.
    - `name` string: Nombre del atributo adicional.
    - `key` string: Identificador del atributo adicional.
    - `value` string: Valor del atributo adicional para el item.
  - `variantAttributes` object[]: Array con atributos variantes asociados al producto. Aplica únicamente para items de tipo "variantParent" y "variant"
    - `id` string: Id del atributo variante.
    - `name` string: Nombre del atributo variante.
    - `status` string: Estado del atributo variante.
    - `options` string[]: Array con las opciones del atributo variante.
  - `itemVariants` unknown
  - `accounting` object: Objeto que representa las cuentas de inventario y costo de ventas. Solo aplica para items inventariables.
    - `inventory` number: Cuenta de inventario
    - `inventariablePurchase` number: Costo del inventario

## Other responses

- `400`: Objeto que representa la respuesta cuando se sobrepasa el límite de productos a retornar
- `404`: 404 Not found

---

[API](https://skmtc.dev/alegra/apis/inventario.md) - [All operations](https://skmtc.dev/alegra/apis/inventario/llms.txt) - [OpenAPI document](https://skmtc.dev/alegra/apis/inventario/revisions/d1a516b653a1?raw)