Lister les produits les plus vendus d'une période

GET

/api/sales/top-products

Classe les produits selon leurs ventes de la période : ventes avant taxes, quantité, nombre de factures ou nombre de lignes, au choix de sort_by. Les ventes sont les lignes de produit des factures datées dans la période, payées ou non, montants avant taxes : leur total est égal au sous-total de la synthèse des ventes (/api/sales/summary) pour la même période. Les crédits émis depuis la facturation et les lignes négatives (retenues, escomptes) viennent en déduction ; les lignes de taxes, de transport et d'écriture comptable, les lignes archivées, les crédits saisis directement aux comptes clients, les commandes et les soumissions sont exclus. Le sommaire et les parts (share_pct) portent sur tous les produits, même quand limit tronque la liste (metadata.truncated). Les lignes sans produit (lignes de texte) forment un groupe d'identifiant 0, qui peut figurer dans le classement. Chaque ligne de chaque facture est lue : le premier calcul peut prendre plusieurs secondes sur une longue période, préférez des périodes ciblées. Conventions communes (cache de 4 h si la période se termine aujourd'hui ou plus tard, 24 h sinon, force_refresh, _links, metadata) : voir la présentation de la section Tableaux de bord.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Query Params

Responses

🟢200

application/json

Produits les plus vendus de la période, avec le sommaire

Bodyapplication/json

🟠400

🟠401

🟠404

🟠409

🟠422

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://relay.exostack.cloud//api/sales/top-products?from=&to=&limit=&sort_by=&force_refresh=' \
--header 'x-api-key: <api-key>'

Response Example

{
    "_links": {
        "all_products": "/api/inventory/products",
        "sales_summary": "/api/sales/summary?from=2026-01-01&to=2026-04-30&group_by=month",
        "self": "/api/sales/top-products?from=2026-01-01&to=2026-04-30&limit=10&sort_by=revenue"
    },
    "cache": {
        "age_seconds": 0,
        "cached_at": "2026-05-13T09:12:00-04:00",
        "expires_at": "2026-05-14T09:12:00-04:00",
        "force_refreshed": false,
        "key_hash": "sha1:5c2e8a41d07b9f3e6a1c4d8b2f0e7a9c3b5d1f6e",
        "status": "miss",
        "ttl_policy": "historical_24h",
        "ttl_remaining_seconds": 86400
    },
    "filter": {
        "limit": 10,
        "sort_by": "revenue"
    },
    "items": [
        {
            "_links": {
                "product_detail": "/api/inventory/products/by-id/412"
            },
            "avg_unit_price": 12.5,
            "invoices_count": 49,
            "lines_count": 57,
            "product": {
                "code": "GYP-12",
                "id": 412,
                "name": "Gypse régulier 1/2 po 4 x 8"
            },
            "qty_total": 5120,
            "rank": 1,
            "revenue": 64000,
            "share_pct": 21.33
        },
        {
            "_links": {
                "product_detail": "/api/inventory/products/by-id/236"
            },
            "avg_unit_price": 30,
            "invoices_count": 70,
            "lines_count": 81,
            "product": {
                "code": "PEI-BL4",
                "id": 236,
                "name": "Peinture latex blanc 3,78 L"
            },
            "qty_total": 1010,
            "rank": 2,
            "revenue": 30300,
            "share_pct": 10.1
        }
    ],
    "metadata": {
        "extracted_at": "2026-05-13T09:12:00-04:00",
        "organisation_id": "entreprise_exemple",
        "scope": "invoicing_lines_type_1_only",
        "scope_note": "Lignes de produit des factures de la période, avant taxes ; lignes de taxes, de transport et d'écriture comptable exclues",
        "sdk_indexes_used": {
            "invoicing": 6,
            "invoicing_line": 6
        },
        "truncated": true
    },
    "period": {
        "from": "2026-01-01",
        "to": "2026-04-30"
    },
    "summary": {
        "currency": "CAD",
        "invoices_count": 214,
        "lines_count": 1188,
        "products_count": 62,
        "qty_total": 18450.75,
        "revenue_total": 300000,
        "unassigned_lines_count": 240,
        "unassigned_revenue": 0
    }
}

Modified at 2026-10-10 14:01:59

Lister les ventes par représentant

Lister les factures réglées par un paiement client