DocumentationAPI RESTAPI Inventaire

API Inventaire

Gérez les entrepôts, niveaux de stock et mouvements d'inventaire sur tous les emplacements via l'API REST.

2 min de lecture

Sur cette page

Vue d'ensemble

L'API Inventaire fournit une gestion complète des stocks sur plusieurs entrepôts. Suivez les niveaux de stock en temps réel, enregistrez les mouvements (réceptions, expéditions, ajustements, transferts) et consultez l'historique des stocks pour l'audit.

Lister les entrepôts

GET https://app.kataio.com/api/v1/inventory/warehouses
Authorization: Bearer {accessToken}

Réponse (200)

{
  "data": [
    {
      "id": "wh_01...",
      "name": "Entrepôt Paris",
      "code": "WH-PAR",
      "address": {
        "line1": "Zone Industrielle Nord",
        "city": "Roissy-en-France",
        "postalCode": "95700",
        "country": "FR"
      },
      "isDefault": true,
      "isActive": true,
      "productCount": 47,
      "totalStock": 3420
    },
    {
      "id": "wh_02...",
      "name": "Entrepôt Lyon",
      "code": "WH-LYN",
      "address": {
        "line1": "Parc Logistique de Mions",
        "city": "Mions",
        "postalCode": "69780",
        "country": "FR"
      },
      "isDefault": false,
      "isActive": true,
      "productCount": 32,
      "totalStock": 1850
    }
  ]
}

Obtenir les niveaux de stock

Consultez les niveaux de stock actuels sur tous les entrepôts, avec des filtres optionnels.

GET https://app.kataio.com/api/v1/inventory/stock?warehouseId=wh_01...&lowStock=true&page=1&limit=50
Authorization: Bearer {accessToken}

Paramètres de requête

  • warehouseId — Filtrer par entrepôt spécifique
  • productId — Filtrer par produit spécifique
  • lowStock — Définir à true pour retourner uniquement les articles en dessous de leur seuil de réapprovisionnement
  • page / limit — Pagination

Réponse (200)

{
  "data": [
    {
      "productId": "prod_01...",
      "productName": "Chemise Oxford Bleue",
      "sku": "CHM-OXF-BLU-001",
      "warehouseId": "wh_01...",
      "warehouseName": "Entrepôt Paris",
      "quantity": 77,
      "reserved": 5,
      "available": 72,
      "reorderPoint": 20,
      "reorderQuantity": 100,
      "isLowStock": false,
      "updatedAt": "2026-03-15T08:00:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 50,
    "total": 142,
    "totalPages": 3
  }
}

Mettre à jour le niveau de stock

Définissez directement la quantité de stock pour un produit dans un entrepôt spécifique. Utilisez ceci pour les inventaires physiques ou les corrections.

PATCH https://app.kataio.com/api/v1/inventory/stock/prod_01...
Authorization: Bearer {accessToken}
Content-Type: application/json

{
  "warehouseId": "wh_01...",
  "quantity": 85,
  "reason": "Inventaire physique mensuel"
}
Préférez les mouvements : Pour les opérations courantes, utilisez l'endpoint de mouvements de stock plutôt que les mises à jour directes. Les mouvements créent une piste d'audit montrant exactement pourquoi le stock a changé, tandis que les mises à jour directes n'enregistrent que la nouvelle quantité.

Créer un mouvement de stock

Enregistrez un mouvement de stock pour ajuster l'inventaire avec une piste d'audit complète.

POST https://app.kataio.com/api/v1/inventory/movements
Authorization: Bearer {accessToken}
Content-Type: application/json

{
  "productId": "prod_01...",
  "warehouseId": "wh_01...",
  "type": "RECEIPT",
  "quantity": 200,
  "reference": "PO-2026-0042",
  "note": "Réception commande fournisseur TextilePro"
}

Types de mouvements

  • RECEIPT — Marchandises reçues (augmente le stock)
  • SHIPMENT — Marchandises expédiées pour une commande (diminue le stock)
  • ADJUSTMENT — Correction manuelle après inventaire physique
  • TRANSFER — Transfert entre entrepôts (nécessite destinationWarehouseId)
  • RETURN — Retour client (augmente le stock)
  • DAMAGE — Dépréciation de marchandises endommagées (diminue le stock)

Lister les mouvements de stock

GET https://app.kataio.com/api/v1/inventory/movements?productId=prod_01...&type=RECEIPT&dateFrom=2026-03-01
Authorization: Bearer {accessToken}

Réponse (200)

{
  "data": [
    {
      "id": "mv_01...",
      "productId": "prod_01...",
      "warehouseId": "wh_01...",
      "type": "RECEIPT",
      "quantity": 200,
      "reference": "PO-2026-0042",
      "note": "Réception commande fournisseur TextilePro",
      "createdBy": "admin@kataio.com",
      "createdAt": "2026-03-12T10:30:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 8,
    "totalPages": 1
  }
}
Mouvements automatiques : Lorsqu'une commande est synchronisée depuis un canal, Kataio crée automatiquement un mouvement SHIPMENT pour déduire le stock. Lorsqu'un retour est traité, un mouvement RETURN est créé. Ces mouvements automatiques incluent le numéro de commande comme référence.