GET /api/vendor-order/revenue-overview?duration=1 HTTP/1.1
Host: <API_HOST>
Accept: application/json
Authorization: Bearer <ACCESS_TOKEN>

{
  "status": 1,
  "message": "Successfully got revenue overview",
  "data": [
    {
      "revenue": 5000,
      "orderCount": 3,
      "month": 1,
      "year": 2026
    }
  ],
  "maxAmount": 5000
}

{
  "status": 0,
  "message": "Internal Server Error"
}

Sales reports

Retrieve Order Revenue Overview

Get /api/vendor-order/revenue-overview

Authentication: Vendor bearer token required for protected operations; verify exact permission decorator in controller.

Feature area: Revenue Overview

Implementation source: src/api/vendor/controllers/VendorController.ts

Request example provenance: Exact API comment example.

Response example provenance: Exact API comment example.

Example is based on the linked repository source. Replace example identifiers and credentials with values from your tenant.

GET

api

vendor-order

revenue-overview

GET /api/vendor-order/revenue-overview?duration=1 HTTP/1.1
Host: <API_HOST>
Accept: application/json
Authorization: Bearer <ACCESS_TOKEN>

{
  "status": 1,
  "message": "Successfully got revenue overview",
  "data": [
    {
      "revenue": 5000,
      "orderCount": 3,
      "month": 1,
      "year": 2026
    }
  ],
  "maxAmount": 5000
}

{
  "status": 0,
  "message": "Internal Server Error"
}

Authorizations

Authorization

string

header

required

Paste the JWT access token returned by the corresponding login endpoint.

Query Parameters

duration

integer

Query parameter duration.

Response

Successful response. Exact API comment example.

status

integer

message

string

data

object[]

Show child attributes

maxAmount

integer

Store API

Vendor API

Retrieve Order Revenue Overview

Authorizations

Query Parameters

Response