Sales by product summary (totals)

Developing

GET

/sales/by-product/summary

Aggregated metrics for the current filter set.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

API Key

Add parameter in cookie

access_token

Example:

access_token: ********************

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://mock.apidog.com/m1/1052146-0-default/sales/by-product/summary?categories&item&store&location&date_from&date_to&status&units_sold_min&units_sold_max&asp_min&asp_max&netsales_min&netsales_max&cogs_min&cogs_max&gp_min&gp_max&margin_min&margin_max&soh_min&soh_max' \
--header 'Authorization: Bearer <token>'

Responses

🟢200OK

application/json

Body

Example

{
    "success": true,
    "code": "LOGIN_OK",
    "message": "Authenticated",
    "data": {
        "productsSold": 128,
        "grossSales": 24500000,
        "discounts": 1800000,
        "grossProfit": 6200000,
        "marginPercent": 0.25
    },
    "meta": {
        "page": 1,
        "perPage": 50,
        "total": 1
    }
}

🟠401Unauthorized

Modified at 2025-10-06 16:06:52

Sales by product (cursor)

Expenses (cursor)