Skip to navigation

Ajustar el inventario de una variante

Igual que el de un producto, sobre el conteo de una combinación.

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_variant_idstringRequired
ID de la variante

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.

Request

This endpoint expects an object.
inventory_adjustmentobjectRequired

Mover el inventario de un producto o de una de sus combinaciones.

La razón lleva el signo, así que quantity siempre es cuántas unidades se movieron y nunca un número negativo cuyo significado podría contradecir la razón que va al lado: received suma, damaged y lost restan. recount es la excepción — dice cuánto hay en la bodega y el libro calcula la diferencia.

Response

La línea que quedó en el libro

idstringOptional
product_idstringOptional
variant_idstring or nullOptional
deltaintegerOptional

Las unidades que se movieron, con signo: una venta es negativa, una entrega positiva.

resulting_quantityintegerOptional

El conteo que quedó justo después de este movimiento.

reasonenumOptional

sale y refund los escribe un pago; el resto los escribe el comercio o una integración. manual es un conteo escrito en el formulario del producto y api su equivalente enviado por la API. complimentary es una entrega sin cobro registrada desde Inventarios: descuenta unidades sin crear un pago.

notestring or nullOptional<=200 characters
created_atdatetimeOptional

Errors

422
Unprocessable Entity Error