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

Responses

🟢200OK

application/json

Bodyapplication/json

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)