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

Una solicitud para liberar existencias retenidas: un artículo por ID o SKU, una ubicación y el estado en que se retienen las existencias. También toma una cantidad decimal exacta positiva y su lote, número de serie o pieza etiquetada.

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 donde se retienen las existencias.

held_status
enum<string>
requerido

El estado en el que se retienen las existencias: quarantined o rejected.

Opciones disponibles:
available,
quarantined,
rejected
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})?$
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
lot
string | null

El número de lote, para un artículo con seguimiento por lote.

Maximum string length: 64
serial
string | null

El número de serie, para un artículo con seguimiento por número de serie.

Maximum string length: 64
piece
string | null

El ID de pieza de la etiqueta que se escaneó.

Maximum string length: 64
note
string | null

Una nota para los miembros que pueden liberar las existencias, de hasta 1000 caracteres.

Maximum string length: 1000
waiting_command_id
string<uuid> | null

El ID del comando del dispositivo que espera la liberación.

Respuesta

ReleaseRequestResource

data
ReleaseRequestResource · object
requerido

Una solicitud para liberar existencias retenidas, para que vuelvan a estar disponibles.