Aller au contenu principal

Intégration API - Récupération des stocks

Vue d'ensemble​

L'API UBSI permet de récupérer les données de stock d'un magasin spécifique via un endpoint public.

Swagger Documentation​

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

Récupération des stocks​

Endpoint​

GET /api/publique/stocks

Paramètres​

Obligatoires :

  • store_id (number) : ID du magasin

Optionnels :

  • page (number) : Numéro de page (défaut: 1)
  • limit (number) : Éléments par page (défaut: 10, max: 100)

Exemple de requête​

curl -X GET "https://.../api/publique/stocks?store_id=1&page=1&limit=20" \
  -H "Content-Type: application/json"

Réponse​

{
  "data": [
    {
      "productId": 1,
      "storeId": 1,
      "quantity": 50
    },
    {
      "productId": 2,
      "storeId": 1,
      "quantity": 25
    }
  ],
  "pageNumber": 1,
  "pageLimit": 20,
  "totalItems": 2,
  "totalPages": 1
}

Récupération des stocks d'un produit​

Endpoint​

GET /api/publique/reserve/:productId

Description​

Permet de récupérer le stock actuel d'un produit pour tous les magasins.

Paramètres​

  • productId (number) : ID du produit (obligatoire)

Exemple de requête​

curl -X GET "https://.../api/publique/reserve/70"

Exemple de réponse​

HTTP 200

[
  {
    "storeId": 5,
    "quantity": 2
  },
  {
    "storeId": 16,
    "quantity": 200
  }
]

Codes d'erreur spécifiques​

  • 400 : Requête invalide (ex. quantité manquante ou non numérique)
  • 404 : Produit non trouvé
  • 500 : Erreur serveur

Contraintes techniques​

  • Authentification non requise
  • Pagination maximale : 100 éléments
  • Format de réponse : JSON uniquement
  • Headers requis : Content-Type: application/json