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éthodeEndpointDescription
    GET/productsLister tous les produits
    GET/products/:idObtenir un produit
    GET/products/sku/:skuObtenir un produit par SKU
    GET/products/:id/stockStock d'un produit

    Stock

    MéthodeEndpointDescription
    GET/stockLister tout le stock
    GET/stock/product/:idStock par produit

    Categories

    MéthodeEndpointDescription
    GET/categoriesLister les catégories
    GET/categories/:idObtenir une catégorie
    GET/categories/:id/productsProduits d'une catégorie

    Customers

    MéthodeEndpointDescription
    GET/customersLister les clients
    GET/customers/:idObtenir un client
    POST/customersCréer un client

    Orders

    MéthodeEndpointDescription
    GET/ordersLister les commandes
    GET/orders/:idObtenir une commande
    POST/ordersCréer une commande

    Campaigns

    MéthodeEndpointDescription
    GET/campaigns/activeCampagnes actives
    GET/campaigns/:idObtenir une campagne

    Warehouses

    MéthodeEndpointDescription
    GET/warehousesLister les entrepôts
    GET/warehouses/:idObtenir un entrepôt

    Suppliers

    MéthodeEndpointDescription
    GET/suppliersLister les fournisseurs
    GET/suppliers/:idObtenir un fournisseur

    Stock Movements

    MéthodeEndpointDescription
    GET/stock-movementsLister les mouvements
    GET/stock-movements/:idObtenir un mouvement

    Supplier Orders

    MéthodeEndpointDescription
    GET/supplier-ordersLister les commandes fournisseurs
    GET/supplier-orders/:idObtenir une commande fournisseur
    POST/supplier-ordersCréer une commande fournisseur
    PATCH/supplier-orders/:idMettre à jour une commande

    Analytics

    MéthodeEndpointDescription
    GET/analytics/salesVentes agrégées
    GET/analytics/top-productsTop produits

    Journal Entries

    MéthodeEndpointDescription
    GET/journal-entriesLister les écritures comptables
    GET/journal-entries/:idObtenir une écriture

    Webhooks

    MéthodeEndpointDescription
    GET/webhooks/eventsÉvénements disponibles
    GET/webhooksLister les webhooks
    GET/webhooks/:idObtenir un webhook
    GET/webhooks/:id/logsLogs de livraison
    POST/webhooksCréer un webhook
    PATCH/webhooks/:idMettre à jour un webhook
    DELETE/webhooks/:idSupprimer un webhook

    Scopes par endpoint

    EndpointScope requis
    GET /products/*read:products
    GET /stock/*read:stock
    GET /categories/*read:categories
    GET /categories/:id/productsread:products
    GET /customers/*read:customers
    POST /customerswrite:customers
    GET /orders/*read:orders
    POST /orderswrite: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-orderswrite:supplier-orders
    PATCH /supplier-orders/:idwrite:supplier-orders
    GET /analytics/*read:analytics
    GET /journal-entries/*read:accounting
    GET /webhooks/*read:webhooks
    POST /webhookswrite:webhooks
    PATCH /webhooks/:idwrite:webhooks
    DELETE /webhooks/:idwrite:webhooks