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

Un ajustement de stock : un article par ID ou UGS, un emplacement, un sens, une quantité décimale exacte positive et un motif. Le motif other exige une note.

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 dont le stock change. L'emplacement ne peut pas être archivé.

direction
enum<string>
requis

Indique si l'ajustement ajoute du stock ou en retire : receipt ou issue.

Options disponibles:
receipt,
issue
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})?$
reason
enum<string>
requis

Pourquoi le stock a changé : found, damaged, lost, destroyed, correction, opening_balance ou other.

Options disponibles:
found,
damaged,
lost,
destroyed,
correction,
opening_balance,
other
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
note
string | null

Une note conservée avec le mouvement, d'au plus 1000 caractères. Obligatoire lorsque le motif est other.

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

Le statut du stock qui est ajouté ou retiré : available, quarantined ou rejected. Le stock est available lorsque ce champ est omis.

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

Le numéro de lot, pour un article suivi par lot. Les numéros de lot correspondent sans égard à la casse. Lors d'une réception, un lot que l'article n'a pas encore est créé ; lors d'une sortie, le lot doit exister.

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

La date d'expiration d'un nouveau lot, sous forme de date comme 2027-03-31. Elle n'est enregistrée que si la réception crée le lot.

serials
string[] | null

Les numéros de série, pour un article suivi par numéro de série. Envoyez-en un par unité, de sorte que le nombre corresponde à la quantité dans l'unité de base. Au plus 25 par requête; un stock d'ouverture plus important passe par une importation de stock.

Maximum array length: 25

Un numéro de série, sans les espaces en trop.

Maximum string length: 64
unit_cost
string | null

Le coût d'une unité de unit, sous forme de décimal exact de zéro ou plus dans la devise de l'organisation. Seule une réception accepte un coût. Il est enregistré par unité de base.

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

L'ID de la liste groupée dont cette commande est une ligne, un UUID que le client choisit pour toute la liste. Omettez-le pour une commande hors liste groupée; les vérifications groupées ne s'exécutent alors pas.

bulk_line
integer | null

La position de la ligne dans la liste groupée, de 0 à 99.

Plage requise: 0 <= x <= 99
decisions
object | null

Le choix pour chaque indicateur que le membre a tranché dans l'aperçu groupé, par exemple {"reserved": "leave"}. Seuls reserved, mixed_lots et short_dated peuvent être tranchés.

bulk_undo_of
string<uuid> | null

Sur une ligne d'un « Tout annuler », le bulk_id de la liste groupée qu'il annule.

Réponse

Tableau de StockMovementResource

data
StockMovementResource · object[]
requis