Dashboard Module JSON: { "name": "Dashboard Module", "description": "# Dashboard Module\n\n**Purpose:** Analytics and business intelligence data\n\n**Domains:** Statistics, Reports, Top Performers", "item": [ { "name": "Get Dashboard Statistics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/admin/dashboard/statistics?start=2024-01-01&end=2024-01-31", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "dashboard", "statistics" ], "query": [ { "key": "start", "value": "2024-01-01", "description": "Start date (optional, defaults to 30 days ago)" }, { "key": "end", "value": "2024-01-31", "description": "End date (optional, defaults to today)" } ] }, "description": "**Purpose:** Get comprehensive dashboard statistics including customers, orders, sales, and graphs\n\n**Frontend Usage:**\n- **Page:** `/admin/dashboard`\n- **Component:** DashboardStats\n- **Trigger:** Page load\n\n**Blade Reference:** `DashboardController@index`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **start** (query, date, optional): Start date for statistics (defaults to 30 days ago)\n- **end** (query, date, optional): End date for statistics (defaults to today)" } }, { "name": "Get Top Selling Categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/admin/dashboard/top-selling-categories?start=2024-01-01&end=2024-01-31", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "dashboard", "top-selling-categories" ], "query": [ { "key": "start", "value": "2024-01-01", "description": "Start date (optional)" }, { "key": "end", "value": "2024-01-31", "description": "End date (optional)" } ] }, "description": "**Purpose:** Get top 5 selling categories by quantity sold\n\n**Frontend Usage:**\n- **Page:** `/admin/dashboard`\n- **Component:** TopSellingCategories\n- **Trigger:** Page load\n\n**Blade Reference:** `DashboardController@getTopSellingCategories`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **start** (query, date, optional): Start date\n- **end** (query, date, optional): End date" } }, { "name": "Get Top Selling Products", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/admin/dashboard/top-selling-products?start=2024-01-01&end=2024-01-31", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "dashboard", "top-selling-products" ], "query": [ { "key": "start", "value": "2024-01-01", "description": "Start date (optional)" }, { "key": "end", "value": "2024-01-31", "description": "End date (optional)" } ] }, "description": "**Purpose:** Get top 5 selling products with revenue data\n\n**Frontend Usage:**\n- **Page:** `/admin/dashboard`\n- **Component:** TopSellingProducts\n- **Trigger:** Page load\n\n**Blade Reference:** `DashboardController@getTopSellingProducts`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **start** (query, date, optional): Start date\n- **end** (query, date, optional): End date" } }, { "name": "Get Customers with Most Sales", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/admin/dashboard/customer-with-most-sales?start=2024-01-01&end=2024-01-31", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "dashboard", "customer-with-most-sales" ], "query": [ { "key": "start", "value": "2024-01-01", "description": "Start date (optional)" }, { "key": "end", "value": "2024-01-31", "description": "End date (optional)" } ] }, "description": "**Purpose:** Get top 5 customers by total order value\n\n**Frontend Usage:**\n- **Page:** `/admin/dashboard`\n- **Component:** TopCustomers\n- **Trigger:** Page load\n\n**Blade Reference:** `DashboardController@getCustomerWithMostSales`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **start** (query, date, optional): Start date\n- **end** (query, date, optional): End date" } }, { "name": "Get Low Stock Products", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/admin/dashboard/stock-threshold", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "dashboard", "stock-threshold" ] }, "description": "**Purpose:** Get products with lowest stock quantities (top 5)\n\n**Frontend Usage:**\n- **Page:** `/admin/dashboard`\n- **Component:** LowStockAlert\n- **Trigger:** Page load\n\n**Blade Reference:** `DashboardController@getStockThreshold`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:** None" } } ] } =================== Catalog Module Summary: { "name": "Catalog Module", "description": "# Catalog Module\n\n**Purpose:** Product catalog management\n\n**Domains:** Products, Categories, Attributes, Attribute Families", "folders": { "Products (27 endpoints)": [ "GET /catalog/products", "POST /catalog/products", "GET /catalog/products/{id}", "GET /catalog/products-attributes/{id}", "POST /catalog/product-update/{id}", "POST /catalog/product-update-simple/{id}", "POST /catalog/products/{id}/inventories", "POST /catalog/products/{id}/images", "POST /catalog/products/{id}/videos", "POST /catalog/products/{id}/files", "DELETE /catalog/products/{id}", "POST /catalog/product-mass-update", "POST /catalog/product-mass-destroy", "POST /catalog/products/massupdateprice", "POST /catalog/products/massupdateqty", "POST /catalog/products/massupdatenew", "POST /catalog/products/massupdatefeatured", "POST /catalog/products/massupdatevisibility", "POST /catalog/products/massupdatestatus", "POST /catalog/product-search", "POST /catalog/products/getQuantity", "GET /catalog/products/getAll", "POST /catalog/products/{id}/variation", "GET /catalog/products/{id}/copy", "POST /catalog/getSlugData" ], "Categories (9 endpoints)": [ "GET /catalog/categories", "POST /catalog/categories", "GET /catalog/categories/{id}", "POST /catalog/categories/{id}", "DELETE /catalog/categories/{id}", "POST /catalog/categories-mass-destroy", "POST /catalog/category/search", "GET /catalog/category/categoriesHeader", "GET /catalog/category/getCategoryTree", "GET /catalog/category/getfilterableAttributes" ], "Attributes (6 endpoints)": [ "GET /catalog/attributes", "POST /catalog/attributes", "GET /catalog/attributes/{id}", "PUT /catalog/attributes/{id}", "DELETE /catalog/attributes/{id}", "POST /catalog/attributes/mass-destroy" ], "Attribute Families (5 endpoints)": [ "GET /catalog/attribute-families", "POST /catalog/attribute-families", "GET /catalog/attribute-families/{id}", "PUT /catalog/attribute-families/{id}", "DELETE /catalog/attribute-families/{id}" ] } }