Warehouses

    Endpoints pour consulter les entrepôts

    Warehouses API

    Endpoints pour accéder à la liste de vos entrepôts.

    Lister les entrepôts

    GET /v1/public-api/warehouses

    Scope requis: read:warehouses

    Paramètres de requête

    ParamètreTypeDescription
    pagenumberNuméro de page (défaut: 1)
    limitnumberÉléments par page (défaut: 20, max: 100)

    Exemple de requête

    curl -X GET "https://api.nerpsuite.com/v1/public-api/warehouses" \
      -H "X-API-Key: sk_live_xxx"

    Réponse

    {
      "data": [
        {
          "id": "wh_001",
          "name": "Entrepôt Central",
          "location": "Zone Industrielle Nord, Cotonou",
          "createdAt": "2024-01-10T08:00:00Z"
        },
        {
          "id": "wh_002",
          "name": "Dépôt Secondaire",
          "location": "Quartier Commerce, Parakou",
          "createdAt": "2024-03-15T10:30:00Z"
        }
      ],
      "total": 2,
      "page": 1,
      "limit": 20,
      "totalPages": 1
    }

    Obtenir un entrepôt

    GET /v1/public-api/warehouses/:id

    Scope requis: read:warehouses

    Paramètres de chemin

    ParamètreTypeDescription
    idstringID de l'entrepôt

    Exemple de requête

    curl -X GET "https://api.nerpsuite.com/v1/public-api/warehouses/wh_001" \
      -H "X-API-Key: sk_live_xxx"

    Réponse

    {
      "id": "wh_001",
      "name": "Entrepôt Central",
      "location": "Zone Industrielle Nord, Cotonou",
      "createdAt": "2024-01-10T08:00:00Z"
    }

    Champs de réponse

    ChampTypeDescription
    idstringIdentifiant unique
    namestringNom de l'entrepôt
    locationstringAdresse ou localisation
    createdAtstringDate de création (ISO 8601)

    Cas d'usage

    Afficher les entrepôts dans Power BI

    async function getWarehouses() {
      const response = await fetch('/v1/public-api/warehouses', {
        headers: { 'X-API-Key': apiKey }
      });
    
      const { data } = await response.json();
      return data; // Utiliser comme table de dimension dans Power BI
    }