Référence API
Documentation complète de tous les endpoints de l'API NERP Suite
Référence API
Documentation détaillée de tous les endpoints disponibles dans l'API NERP Suite.
URL de base
https://api.nerpsuite.com/v1/public-api
Endpoints disponibles
Products
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /products | Lister tous les produits |
| GET | /products/:id | Obtenir un produit |
| GET | /products/sku/:sku | Obtenir un produit par SKU |
| GET | /products/:id/stock | Stock d'un produit |
Stock
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /stock | Lister tout le stock |
| GET | /stock/product/:id | Stock par produit |
Categories
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /categories | Lister les catégories |
| GET | /categories/:id | Obtenir une catégorie |
| GET | /categories/:id/products | Produits d'une catégorie |
Customers
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /customers | Lister les clients |
| GET | /customers/:id | Obtenir un client |
| POST | /customers | Créer un client |
Orders
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /orders | Lister les commandes |
| GET | /orders/:id | Obtenir une commande |
| POST | /orders | Créer une commande |
Campaigns
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /campaigns/active | Campagnes actives |
| GET | /campaigns/:id | Obtenir une campagne |
Warehouses
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /warehouses | Lister les entrepôts |
| GET | /warehouses/:id | Obtenir un entrepôt |
Suppliers
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /suppliers | Lister les fournisseurs |
| GET | /suppliers/:id | Obtenir un fournisseur |
Stock Movements
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /stock-movements | Lister les mouvements |
| GET | /stock-movements/:id | Obtenir un mouvement |
Supplier Orders
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /supplier-orders | Lister les commandes fournisseurs |
| GET | /supplier-orders/:id | Obtenir une commande fournisseur |
| POST | /supplier-orders | Créer une commande fournisseur |
| PATCH | /supplier-orders/:id | Mettre à jour une commande |
Analytics
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /analytics/sales | Ventes agrégées |
| GET | /analytics/top-products | Top produits |
Journal Entries
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /journal-entries | Lister les écritures comptables |
| GET | /journal-entries/:id | Obtenir une écriture |
Webhooks
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /webhooks/events | Événements disponibles |
| GET | /webhooks | Lister les webhooks |
| GET | /webhooks/:id | Obtenir un webhook |
| GET | /webhooks/:id/logs | Logs de livraison |
| POST | /webhooks | Créer un webhook |
| PATCH | /webhooks/:id | Mettre à jour un webhook |
| DELETE | /webhooks/:id | Supprimer un webhook |
Scopes par endpoint
| Endpoint | Scope requis |
|---|---|
| GET /products/* | read:products |
| GET /stock/* | read:stock |
| GET /categories/* | read:categories |
| GET /categories/:id/products | read:products |
| GET /customers/* | read:customers |
| POST /customers | write:customers |
| GET /orders/* | read:orders |
| POST /orders | write:orders |
| GET /campaigns/* | read:campaigns |
| GET /warehouses/* | read:warehouses |
| GET /suppliers/* | read:suppliers |
| GET /stock-movements/* | read:stock-movements |
| GET /supplier-orders/* | read:supplier-orders |
| POST /supplier-orders | write:supplier-orders |
| PATCH /supplier-orders/:id | write:supplier-orders |
| GET /analytics/* | read:analytics |
| GET /journal-entries/* | read:accounting |
| GET /webhooks/* | read:webhooks |
| POST /webhooks | write:webhooks |
| PATCH /webhooks/:id | write:webhooks |
| DELETE /webhooks/:id | write:webhooks |