API Inventaire

Surveillez les niveaux de stock dans vos entrepots en temps reel.

Endpoints

GET

/inventory

inventory:read

Obtenez les niveaux de stock de tous les produits. Supporte le filtrage par entrepot et statut de faible stock.

GET

/inventory/:productId

inventory:read

Obtenez les informations de stock d'un produit specifique dans tous les entrepots.

Reference des Champs

Champ	Type	Obligatoire	Description
id	string	Non	ID unique d'enregistrement de stock (lecture seule)
productId	string	Non	Identifiant du produit
productSku	string	Non	SKU du produit
productName	string	Non	Nom du produit (lecture seule)
warehouseId	string	Non	Identifiant de l'entrepot
warehouseName	string	Non	Nom de l'entrepot (lecture seule)
quantity	integer	Non	Quantite de stock actuelle
reservedQuantity	integer	Non	Quantité réservée pour les commandes en attente
availableQuantity	integer	Non	Quantité disponible (quantité moins réservée)
minThreshold	integer	Non	Seuil d'alerte de faible stock
updatedAt	datetime	Non	Horodatage de la derniere mise a jour

Parametres de Requete (Liste)

Champ	Type	Obligatoire	Description
page	integer	Non	Numero de page (defaut : 1)
limit	integer	Non	Elements par page (defaut : 20, max : 100)
warehouseId	string	Non	Filtrer par ID d'entrepot
lowStock	boolean	Non	Afficher uniquement les produits sous le seuil de faible stock

Exemple

Lister les niveaux de stock

bash

curl "https://api.mercozy.com/api/v1/external/inventory?lowStock=true" \
  -H "X-API-Key: mk_live_your_key_here"

Obtenir le stock d'un produit specifique

bash

curl "https://api.mercozy.com/api/v1/external/inventory/prod_abc123" \
  -H "X-API-Key: mk_live_your_key_here"

Exemple de Reponse

json

{
  "data": {
    "productId": "prod_abc123",
    "productName": "Premium Widget",
    "sku": "WDG-001",
    "quantity": 42,
    "lowStockThreshold": 10,
    "warehouseId": "wh_main",
    "warehouseName": "Main Warehouse",
    "updatedAt": "2025-12-15T10:30:00Z"
  }
}