Aller au contenu

Stock.ArticleDepot

En bref

8 opérations sur 4 chemins. Préfixe /v2. Authentification JWT (voir Démarrer).

Opérations

Méthode Chemin Rôle
GET /v2/articledepot Lister les enregistrements
POST /v2/articledepot Créer l'enregistrement
PUT /v2/articledepot Mettre à jour l'enregistrement
DELETE /v2/articledepot Supprimer l'enregistrement
GET /v2/articledepot/count Compter les enregistrements
POST /v2/articledepot/count Compter les enregistrements
POST /v2/articledepot/recherche Rechercher des enregistrements
POST /v2/articledepot/save Créer ou mettre à jour l'enregistrement (upsert)

Rôle déduit

La spécification ne porte ni summary ni description d'opération : la colonne Rôle est déduite mécaniquement de la méthode HTTP et du chemin.

Détail

GET /v2/articledepot

Lister les enregistrements.

Paramètres

Nom Emplacement Type Obligatoire Description
sort query string non -
where query string non -

Réponses

Code Description Schéma de data
200 OK -
401 Unauthorized -
403 Forbidden -

Exemple

curl -s -X GET "https://<votre-connecteur>/v2/articledepot?sort=<sort>&where=<where>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

POST /v2/articledepot

Créer l'enregistrement.

Corps de la requête (application/json)

Schéma ArticleDepotDto - 10 propriétés (détail : Schémas).

Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).

Réponses

Code Description Schéma de data
200 OK -
401 Unauthorized -
403 Forbidden -

Exemple

curl -s -X POST "https://<votre-connecteur>/v2/articledepot" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"refArticle": "…", "idDepot": 0, "quantiteMini": 0.0}'

PUT /v2/articledepot

Mettre à jour l'enregistrement.

Corps de la requête (application/json)

Schéma ArticleDepotDto - 10 propriétés (détail : Schémas).

Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).

Réponses

Code Description Schéma de data
200 OK -
401 Unauthorized -
403 Forbidden -

Exemple

curl -s -X PUT "https://<votre-connecteur>/v2/articledepot" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"refArticle": "…", "idDepot": 0, "quantiteMini": 0.0}'

DELETE /v2/articledepot

Supprimer l'enregistrement.

Corps de la requête (application/json)

Schéma ArticleDepotDto - 10 propriétés (détail : Schémas).

Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).

Réponses

Code Description Schéma de data
200 OK -
401 Unauthorized -
403 Forbidden -

Exemple

curl -s -X DELETE "https://<votre-connecteur>/v2/articledepot" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"refArticle": "…", "idDepot": 0, "quantiteMini": 0.0}'

GET /v2/articledepot/count

Compter les enregistrements.

Paramètres

Nom Emplacement Type Obligatoire Description
where query string non -

Réponses

Code Description Schéma de data
200 OK -
401 Unauthorized -
403 Forbidden -

Exemple

curl -s -X GET "https://<votre-connecteur>/v2/articledepot/count?where=<where>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

POST /v2/articledepot/count

Compter les enregistrements.

Réponses

Code Description Schéma de data
200 OK -
401 Unauthorized -
403 Forbidden -

Exemple

curl -s -X POST "https://<votre-connecteur>/v2/articledepot/count" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

POST /v2/articledepot/recherche

Rechercher des enregistrements.

Réponses

Code Description Schéma de data
200 OK -
401 Unauthorized -
403 Forbidden -

Exemple

curl -s -X POST "https://<votre-connecteur>/v2/articledepot/recherche" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

POST /v2/articledepot/save

Créer ou mettre à jour l'enregistrement (upsert).

Corps de la requête (application/json)

Schéma ArticleDepotDto - 10 propriétés (détail : Schémas).

Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).

Réponses

Code Description Schéma de data
200 OK -
401 Unauthorized -
403 Forbidden -

Exemple

curl -s -X POST "https://<votre-connecteur>/v2/articledepot/save" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"refArticle": "…", "idDepot": 0, "quantiteMini": 0.0}'

Schémas

Schémas résolus à un niveau : les propriétés qui référencent un autre schéma sont citées par leur nom, sans être dépliées.

ArticleDepotDto

ArticleDepotDto - 10 propriétés
Propriété Type Notes
refArticle string nullable, Référence de l'article.
idDepot integer (int32) Numéro interne du dépôt (DE_No).
quantiteMini number (double) Seuil de stock minimum.
quantiteMaxi number (double) Seuil de stock maximum.
montantStock number (double) Montant valorisé du stock.
quantiteStock number (double) Quantité en stock (réel).
quantiteReservee number (double) Quantité réservée.
quantiteCommandee number (double) Quantité commandée.
quantitePreparation number (double) Quantité en préparation.
estPrincipal boolean Dépôt principal de l'article.

Voir aussi

Écrans qui utilisent ce groupe

Documentation de SenSaaS v2. Chaque page est écrite à partir du produit livré ; ce qui reste à vérifier y est signalé.