Skip to navigation

Libro de inventario de un producto

El libro de inventario del producto, el más reciente primero. El conteo que devuelve el resto de la API es un caché de la última de estas líneas, así que aquí se explica cualquier número: por qué la camisa dice 3 cuando la bodega dice 5.

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.

Path parameters

product_idstringRequired
ID del producto

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

pageintegerOptionalDefaults to 1
limitintegerOptional1-100Defaults to 10

Cuántos objetos devolver, de 1 a 100. Sin page, recorre la lista por cursor: del más reciente al más antiguo por fecha de creación, sin conteo total, con el encabezado has-more y un link con starting_after / ending_before. Fuera de rango responde 400 con code: invalid_limit. Con page, es el tamaño de esa página, ajustado a 1–100 sin error (si también mandas items, manda items). En /payment_methods, /customers/{customer_id}/payment_methods, /product_variants, /inventory y los movimientos de inventario, que ya tomaban limit como tamaño de página, limit solo sigue paginando por página; ahí el cursor empieza con starting_after, ending_before o X-List-Format: envelope.

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 libro

list of objects
OR
object

Errors

400
Bad Request Error