Skip to content

Sales Metrics API

Sales Metrics API Documentation

Actions

1. List Sales Metrics

Endpoint: api/v1/best_seller/sales-metrics/
Method: GET
Permissions: IsAuthenticated

Description

This API endpoint provides sales metrics for a vendor, including total sales, total quantity, new customers, and total orders.

Request

Headers:

Key Value
Content-Type application/json
Authorization Optional. If the user is authenticated, their sales metrics are considered.

Query Parameters:

Field Type Required Description
filter_type string No Time period for sales comparison: daily, weekly, monthly, yearly (default: daily)
Example Request:
  • Get Sales Metrics (Daily) 
    GET /api/v1/best_seller/sales_metrics/?filter_type=daily
  • Get Sales Metrics (weekly) 
    GET /api/v1/best_seller/sales_metrics/?filter_type=weekly
  • Get Sales Metrics (monthly) 
    GET /api/v1/best_seller/sales_metrics/?filter_type=monthly

Response

On Success:

Body: 

{
  "vendor_id": 123,
  "filter_type": "daily",
  "metrics": {
    "sales": {
      "current": 5000,
      "previous": 4500,
      "change_percentage": 11.11,
      "trend": "up"
    },
    "quantity": {
      "current": 100,
      "previous": 95,
      "change_percentage": 5.26,
      "trend": "up"
    },
    "customers": {
      "current": 20,
      "previous": 15,
      "change_percentage": 33.33,
      "trend": "up"
    },
    "orders": {
      "current": 80,
      "previous": 70,
      "change_percentage": 14.29,
      "trend": "up"
    }
  }
}