Category Sales API

Category Sales API Documentation

Actions

1. Get Category Sales Data

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

---

Description

This API endpoint provides sales data categorized by product categories for a vendor, allowing for breakdowns by week or year.

---

Request

Headers:

Key	Value
Content-Type	application/json
Authorization	Required. Only authenticated vendors or users with the 'Dashboard Management' role can access this endpoint.

are considered. |

Query Parameters:

Field	Type	Required	Description
filter_type	string	No	Time period for sales data: week, year (default: week)
orders	boolean	No	If set to true, retrieves total orders data.
quantity	boolean	No	If set to true, retrieves total quantity data.

Example Request:

• Get Category Sales Data (week, orders)

  GET /api/v1/best_seller/category-sales/?filter_type=week&orders=true
  

---

• Get Category Sales Data (year, Total Quantity)

  GET /api/v1/best_seller/category-sales/?filter_type=year&quantity=true
  

---

Response

On Success:

Body:

{
  "filter_type": "week",
  "metric": "total_orders",
  "data": [
    {
      "day": "Monday",
      "date": "2023-10-02",
      "categories": [
        {
          "category": "Electronics",
          "total_value": 1500
        },
        {
          "category": "Clothing",
          "total_value": 800
        }
      ]
    },
    {
      "day": "Tuesday",
      "date": "2023-10-03",
      "categories": [
        {
          "category": "Electronics",
          "total_value": 1200
        },
        {
          "category": "Clothing",
          "total_value": 600
        }
      ]
    }
    // Additional days...
  ]
}

---

On Error:

error 1

{
  "error": "Only vendors or Vendor Roles are authorized to view category based sales metric."
}

---

error 2

{
  "error": "Filter type must be either 'week' or 'year'"
}

---

error 3

{
  "error": "Query parameter must include either 'orders=true' or 'quantity=true'"
}

---