Sales by product (cursor)

Developing

GET

/sales/by-product

Scrollable table of product-level sales metrics for a period. search matches SKU and name.

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?cursor&limit&search&sortKey&sortDir&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": {
        "rows": [
            {
                "id": "string",
                "sku": "SKU-000123",
                "name": "Basmati Rice 5kg",
                "category": "Groceries",
                "unit": "Pack",
                "unitsSold": 340,
                "avgSellingPrice": 6500,
                "netSales": 2080000,
                "cogs": 1496000,
                "grossProfit": 584000,
                "marginPercent": 0.28,
                "stockOnHand": 120,
                "lastSoldAt": "2025-09-30T20:06:30.000Z"
            }
        ],
        "nextCursor": "string",
        "hasNext": true
    },
    "meta": {
        "page": 1,
        "perPage": 50,
        "total": 1
    }
}

🟠400Bad Request

🟠401Unauthorized

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

Get sales summary

Sales by product summary (totals)