Saltar al contenido principal
POST
cURL

Autorizaciones

Authorization
string
header
requerido

Para tus propios scripts e integraciones de servidor a servidor. Crea una clave en la app en Configuración > Acceso > Claves de API y cópiala entonces, porque se muestra una sola vez. Envíala como Authorization: Bearer <key>. La clave actúa como el miembro que la creó, en la organización en la que se creó. Una llamada necesita el permiso del miembro y uno de los alcances de la clave, como inventory:read o sales:write. Una clave con * tiene todos los alcances.

Cuerpo

application/json

Un ajuste de existencias: un artículo por ID o SKU, una ubicación, un sentido, una cantidad decimal exacta positiva y un motivo. El motivo other necesita una nota.

item
string
requerido

El artículo, por su ID o su SKU. Un SKU coincide sin distinguir mayúsculas.

Maximum string length: 64
location_id
string<uuid>
requerido

El ID de la ubicación cuyas existencias cambian. La ubicación no puede estar archivada.

direction
enum<string>
requerido

Si el ajuste suma existencias o las quita: receipt o issue.

Opciones disponibles:
receipt,
issue
quantity
string
requerido

Un decimal exacto positivo, enviado como cadena, con hasta 20 dígitos a cada lado del punto. Está en unit, o en la unidad base del artículo cuando se omite unit.

Pattern: ^(?!0+(\.0+)?$)\d{1,20}(\.\d{1,20})?$
reason
enum<string>
requerido

Por qué cambiaron las existencias: found, damaged, lost, destroyed, correction, opening_balance u other.

Opciones disponibles:
found,
damaged,
lost,
destroyed,
correction,
opening_balance,
other
unit
string | null

La unidad en la que está la cantidad, como case. Debe ser una unidad desde la que el artículo se convierte. Si no se envía, se usa la unidad base del artículo.

Maximum string length: 16
note
string | null

Una nota que se guarda con el movimiento, de hasta 1000 caracteres. Obligatoria cuando el motivo es other.

Maximum string length: 1000
status
enum<string> | null

El estado de las existencias que se agregan o se sacan: available, quarantined o rejected. Si no se envía, las existencias quedan available.

Opciones disponibles:
available,
quarantined,
rejected
lot
string | null

El número de lote, para un artículo con seguimiento por lote. Los números de lote coinciden sin distinguir mayúsculas. En una recepción, se crea un lote que el artículo todavía no tiene; en una salida, el lote debe existir.

Maximum string length: 64
lot_expires_on
string<date-time> | null

La fecha de vencimiento de un lote nuevo, como una fecha del tipo 2027-03-31. Solo se guarda cuando la recepción crea el lote.

serials
string[] | null

Los números de serie, para un artículo con seguimiento por número de serie. Envía uno por unidad, de modo que la cantidad coincida con la cantidad en la unidad base. Máximo 25 en una solicitud; las existencias iniciales más grandes se cargan mediante una importación de existencias.

Maximum array length: 25

Un número de serie, sin espacios al inicio ni al final.

Maximum string length: 64
unit_cost
string | null

El costo de una unidad de unit, como decimal exacto de cero o más en la moneda de la organización. Solo una recepción lleva costo. Se guarda por unidad base.

Pattern: ^\d{1,20}(\.\d{1,20})?$
bulk_id
string<uuid> | null

El ID de la lista masiva de la que este comando es una línea, un UUID que el cliente elige para toda la lista. Omítelo para un comando fuera de una lista masiva; entonces no se ejecutan las comprobaciones masivas.

bulk_line
integer | null

La posición de la línea en la lista masiva, de 0 a 99.

Rango requerido: 0 <= x <= 99
decisions
object | null

La decisión para cada marca que el miembro resolvió en la vista previa masiva, como {"reserved": "leave"}. Solo se pueden decidir reserved, mixed_lots y short_dated.

bulk_undo_of
string<uuid> | null

En una línea de un "Deshacer todo", el bulk_id de la lista masiva que deshace.

Respuesta

Arreglo de StockMovementResource

data
StockMovementResource · object[]
requerido