Skip to navigation

Listar el inventario

Todo lo que lleva un conteo en la tienda — un producto, o cada combinación de un producto que vende por variantes — con el más bajo primero, que es el mismo orden en que lo ve el comercio en Tienda → Inventarios.

Es la lista desde la que se sincroniza: status ya viene resuelto para que dos integraciones no discrepen sobre qué está bajo.

Authentication

X-SECRET-KEYstring

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

La llave también fija el ambiente: una sk_test_ solo lista y resuelve objetos de prueba (live_mode: false) y una sk_live_ solo objetos reales. Un ID del otro ambiente responde 404 (401 en /customers).

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Query parameters

statusenumOptional

Filtra la lista: low bajos, out agotados, soon por agotarse al ritmo al que se están vendiendo, all todos (por defecto).

Allowed values:
searchstringOptional

Busca por nombre de producto o de combinación.

pageintegerOptionalDefaults to 1
limitintegerOptional<=100Defaults to 25

Response headers

Response

Una página del inventario

product_idstringOptional
variant_idstring or nullOptional

La combinación que lleva el conteo, o null si es el producto.

namestringOptional
skustring or nullOptional
inventory_quantityintegerOptional

Puede ser negativo si se vendió más de lo que había.

low_stock_thresholdintegerOptional

El umbral que se le aplica, ya resuelto: el propio si tiene uno, si no el de la cuenta.

statusenumOptional

El mismo veredicto que muestra la pantalla de Inventarios. Se resuelve de este lado para que dos integraciones no terminen discrepando sobre qué está bajo. Lo peor gana: algo vendido de más está out_of_stock, no low_stock.

Allowed values:
continue_sellingbooleanOptional

Si se sigue vendiendo después de llegar a cero (pedido bajo demanda).