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.

Para sincronizar la lista completa, recórrela por cursor (starting_after con el id de la última fila, o X-List-Format: envelope): ahí va del más reciente al más antiguo por fecha de creación, porque los conteos cambian con cada venta y moverían las páginas. limit sin cursor sigue siendo el tamaño de la página.

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.

Headers

X-ACCOUNT-IDstringOptional

ID de una cuenta hija conectada. Ejecuta el request dentro de esa cuenta, como Stripe-Account en Stripe Connect. La plataforma puede acceder a todos los recursos API que pertenecen a la hija, sin filtrar por creador. Solo aplica a hijas directas: si la cuenta no está conectada a la tuya, el request responde 404 con code: connected_account_not_found.

Con una llave de organización este header nombra la cuenta miembro sobre la que quieres operar; si no pertenece a la organización, el request responde 404 con code: organization_account_not_found. En una lectura puedes omitirlo para abarcar todas las cuentas de la organización.

X-List-FormatenumOptionalDefaults to array

Forma del cuerpo. array (por defecto) devuelve el arreglo de siempre. envelope devuelve el objeto lista (ListObject): { "object": "list", "data": [...], "has_more": true, "url": "/api/customers" }, y sin page recorre la lista por cursor.

Allowed values:

Query parameters

statusenumOptional

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

Allowed values:
searchstringOptional

Busca por nombre de producto o de combinación.

pageintegerOptionalDefaults to 1
limitintegerOptional<=100Defaults to 25

Filas por página (por defecto 25), de 1 a 100. En un recorrido por cursor, cuántas filas devolver (por defecto 10).

starting_afterstringOptional

Cursor: el id del último objeto que recibiste. Devuelve los que vienen después (más antiguos). Los objetos creados mientras recorres la lista no corren las páginas, así que no te saltas ni repites ninguno. Debe ser un objeto de esta misma lista; si no, responde 400 con code: invalid_cursor. No se combina con ending_before ni con page (code: pagination_conflict).

ending_beforestringOptional

Cursor: el id del primer objeto que recibiste. Devuelve la página anterior (objetos más recientes), también ordenada del más reciente al más antiguo; has-more dice si hay más objetos más recientes. No se combina con starting_after ni con page.

Response headers

has-moreenumOptional

true si hay más objetos después de esta página en la dirección que recorres; false si es la última.

Allowed values:

Response

Una página del inventario

list of objects
OR
object

Errors

400
Bad Request Error