Passer au contenu principal
POST
cURL

Autorisations

Authorization
string
header
requis

Pour vos propres scripts et vos intégrations de serveur à serveur. Créez une clé dans l'application sous Paramètres > Accès > Clés d'API et copiez-la à ce moment-là, car elle n'est affichée qu'une fois. Envoyez-la sous la forme Authorization: Bearer <key>. La clé agit en tant que le membre qui l'a créée, dans l'organisation où elle a été créée. Un appel exige l'autorisation du membre et l'une des portées de la clé, comme inventory:read ou sales:write. Une clé avec * a toutes les portées.

Corps

application/json

Une demande de libération de stock retenu : un article par ID ou UGS, un emplacement et le statut dans lequel le stock est retenu. Elle accepte aussi une quantité décimale exacte positive et son lot, son numéro de série ou sa pièce étiquetée.

item
string
requis

L'article, par son ID ou son UGS. Un UGS correspond sans égard à la casse.

Maximum string length: 64
location_id
string<uuid>
requis

L'ID de l'emplacement où le stock est retenu.

held_status
enum<string>
requis

Le statut dans lequel le stock est retenu : quarantined ou rejected.

Options disponibles:
available,
quarantined,
rejected
quantity
string
requis

Une quantité décimale exacte positive, envoyée sous forme de chaîne, avec jusqu'à 20 chiffres de chaque côté du point. Elle est en unit, ou dans l'unité de base de l'article lorsque unit est omis.

Pattern: ^(?!0+(\.0+)?$)\d{1,20}(\.\d{1,20})?$
unit
string | null

L'unité dans laquelle la quantité est exprimée, comme case. Ce doit être une unité dont l'article peut être converti. L'unité de base de l'article est utilisée si elle est omise.

Maximum string length: 16
lot
string | null

Le numéro de lot, pour un article suivi par lot.

Maximum string length: 64
serial
string | null

Le numéro de série, pour un article suivi par numéro de série.

Maximum string length: 64
piece
string | null

L'ID de pièce sur l'étiquette qui a été balayée.

Maximum string length: 64
note
string | null

Une note pour les membres qui peuvent libérer le stock, d'au plus 1000 caractères.

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

L'ID de la commande d'appareil qui attend la libération.

Réponse

ReleaseRequestResource

data
ReleaseRequestResource · object
requis

Une demande de libération de stock retenu, pour qu'il redevienne disponible.