Products API

Endpoints pour accéder à votre catalogue de produits.

Lister les produits

GET /v1/public-api/products

Scope requis: read:products

Paramètres de requête

Exemple de requête

curl -X GET "https://api.nerpsuite.com/v1/public-api/products?page=1&limit=20" \
  -H "X-API-Key: sk_live_xxx"

Réponse

{
  "data": [
    {
      "id": "clx1234567890",
      "name": "iPhone 15 Pro",
      "sku": "IPHONE-15-PRO-128",
      "description": "iPhone 15 Pro 128GB Titanium",
      "price": 999.00,
      "costPrice": 750.00,
      "categoryName": "Smartphones",
      "isActive": true,
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-20T14:00:00Z"
    }
  ],
  "total": 156,
  "page": 1,
  "limit": 20,
  "totalPages": 8
}

---

Obtenir un produit par ID

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

Scope requis: read:products

Paramètres de chemin

Exemple de requête

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

Réponse

{
  "id": "clx1234567890",
  "name": "iPhone 15 Pro",
  "sku": "IPHONE-15-PRO-128",
  "description": "iPhone 15 Pro 128GB Titanium",
  "price": 999.00,
  "costPrice": 750.00,
  "categoryName": "Smartphones",
  "isActive": true,
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-20T14:00:00Z"
}

---

Obtenir un produit par SKU

GET /v1/public-api/products/sku/:sku

Scope requis: read:products

Paramètres de chemin

Exemple de requête

curl -X GET "https://api.nerpsuite.com/v1/public-api/products/sku/IPHONE-15-PRO-128" \
  -H "X-API-Key: sk_live_xxx"

Réponse

Même format que l'endpoint par ID.

---

Obtenir le stock d'un produit

GET /v1/public-api/products/:id/stock

Scope requis: read:stock

Retourne les niveaux de stock du produit dans tous les entrepôts.

Paramètres de chemin

Exemple de requête

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

Réponse

[
  {
    "productId": "clx1234567890",
    "productName": "iPhone 15 Pro",
    "productSku": "IPHONE-15-PRO-128",
    "warehouseId": "wh_001",
    "warehouseName": "Entrepôt Principal",
    "quantity": 50,
    "minQuantity": 10,
    "maxQuantity": 100,
    "isLowStock": false
  },
  {
    "productId": "clx1234567890",
    "productName": "iPhone 15 Pro",
    "productSku": "IPHONE-15-PRO-128",
    "warehouseId": "wh_002",
    "warehouseName": "Boutique Centre",
    "quantity": 5,
    "minQuantity": 5,
    "maxQuantity": 20,
    "isLowStock": true
  }
]

Champs de réponse