Aller au contenu principal

API Stocks - Documentation

Vue d'ensemble

L'API Stocks gère l'inventaire des produits dans les magasins via un système de mouvements de stock. Le principe fondamental est que les reserves ne sont jamais mis à jour directement, mais uniquement via l'ajout de mouvements.

Architecture

Principe de fonctionnement

  • Ajout uniquement : Les reserves sont gérés par l'ajout de mouvements (entrées, sorties, ajustements)
  • Traçabilité complète : Chaque changement de stock est enregistré comme un mouvement avec horodatage
  • Calcul en temps réel : Les quantités actuelles sont calculées par une trigger SQL

Logique métier

Gestion des quantités

  1. Entrées (type: 'IN') : Augmentent la reserve

    • Réceptions fournisseurs
    • Retours clients
    • Transferts entrants
  2. Sorties (type: 'OUT') : Diminuent la reserve

    • Ventes
    • Casse/perte
    • Transferts sortants
  3. Ajustements (type: 'ADJUST') : Corrigent la reserve

    • Inventaires physiques
    • Corrections d'erreurs
    • Régularisations

Avantages de cette approche

  • Traçabilité complète : Aucune donnée n'est perdue
  • Audit trail : Historique complet de tous les changements
  • Intégrité des données : Impossible de "perdre" des mouvements
  • Debugging facilité : Possibilité de reconstituer n'importe quel état passé
  • Conformité : Répond aux exigences de traçabilité légales

Swagger Documentation

Cette API est documentée dans Swagger UI accessible à /api/swagger avec tous les schémas DTO et exemples de requêtes.