Aller au contenu principal

API Stocks

L'API Stocks permet de récupérer les informations de stock pour un magasin spécifique.

Obtenir les stocks​

  • URL : /api/publique/stocks
  • Méthode : GET
  • Description : Récupérer les informations de stock pour un magasin

Paramètres de requête​

  • store_id (requis) : ID du magasin (nombre)
  • page (optionnel) : Numéro de page (défaut : 1)
  • limit (optionnel) : Éléments par page (défaut : 20)

Exemple de requête​

GET /api/publique/stocks?store_id=1&page=1&limit=10

Réponse​

{
  "data": [
    {
      "productId": 1,
      "storeId": 1,
      "quantity": 50,
      "stockMagasin": 50,
      "stockLogistique": 20,
      "productName": "Laptop Gaming",
      "productEan": "1234567890123",
      "priceCents": 129900,
      "seuilReapprovisionnement": 30
    }
  ],
  "pageNumber": 1,
  "pageLimit": 10,
  "totalItems": 100,
  "totalPages": 10
}

Modèle de données - Stock​

interface StockItem {
  productId: number;
  storeId: number;
  quantity: number;
  stockMagasin: number;
  stockLogistique: number;
  productName: string;
  productEan: string;
  priceCents: number;
  seuilReapprovisionnement?: number;
  quantiteMinimaleCommande?: number;
}

interface StocksResponse {
  data: StockItem[];
  pageNumber: number;
  pageLimit: number;
  totalItems: number;
  totalPages: number;
}

Champs enrichis​

L'API enrichit les données de stock avec des informations provenant du référentiel local :

  • seuilReapprovisionnement : Quantité minimum à maintenir (provient de quantiteMin du référentiel produit)
  • stockLogistique : Stock disponible en logistique (TODO: à implémenter avec l'API logistique)

Interface utilisateur​

L'interface affiche pour chaque produit :

  • EAN / Référence : Identifiant unique du produit
  • Désignation : Nom du produit
  • Stock magasin : Quantité en magasin
  • Stock logistique : Quantité disponible en logistique
  • Seuil de réapprovisionnement : Niveau minimum à maintenir
  • État : ✅ au-dessus du seuil / ⚠️ sous le seuil

Fonctionnalités​

  • Filtre "Produits sous le seuil" : Affiche uniquement les produits nécessitant un réapprovisionnement
  • Lien direct vers création de commande : Bouton "Réapprovisionner" qui préremplit le formulaire avec l'EAN et la quantité nécessaire

Codes d'erreur possibles​

  • 400 Bad Request : Paramètres de requête invalides (store_id manquant)
  • 500 Internal Server Error : Erreur lors de la récupération des données de stock

Notes importantes​

  • Cette API fait appel au service Gestion via Kong API Gateway
  • Les données de stock sont récupérées en temps réel depuis le système de gestion
  • La pagination est automatiquement appliquée pour les grandes quantités de données