Spurtcommerce
DocumentAPI ReferenceAdd-ons
API Reference
API Reference
  • About Spurtcommerce APIs
  • Spurtcommerce
    • Admin API
      • Admin
        • Authentication
        • My Profile
        • Support
      • Buyers
        • Manage Buyer
      • Chat
      • CMS
        • Manage Banner
        • Manage Blogs
        • Manage Pages
        • Manage SEO
      • Dashboard
      • Marketing
        • Manage Cross Selling
          • Related Products
        • Manage Promotions
          • Coupon
      • Marketplace
        • Manage Products
        • Manage Sales
        • Manage Settlements
        • Product Configuration
        • Reports
      • Sellers
        • Seller
        • Seller Group
        • Seller KYC Request
      • Settings
        • Add-ons
        • Add-ons Product Attributes
        • Localization
        • Order Fulfilment Status
        • Personalise
        • Site Settings
        • Store Settings
        • System
        • User and Permission
        • Support-Category
    • Store API
      • Account Settings
        • Customer
        • My Order
        • My Quotation
        • My Wishlist
        • Profile
        • Support
      • Checkouts
      • Store
        • Admin Contact
        • Categories
        • Home
        • Product Detail Page
    • Vendor API
      • Page 1
      • Catalogue
        • Bulk Product Imports
          • Custom
          • Standard
        • Common Product
        • Data Export
        • Pricing
        • Product Localisation
        • Product List
        • Product Variants
        • Related Products
      • CRM
        • Customer
        • Customer Group
        • Question and Answer
        • Rating and Review
      • Dashboard
      • Marketing
      • Payments
        • Archeived Payments
        • Earnings
        • Settlements
      • Profile
        • Account Settings
          • My Business
          • My KYC
          • My Profile
          • My Shop
          • Personalised Setting
        • Chat
        • Vendor
        • Support
      • Reports
      • Sales
        • Archeive Orders
        • Back Orders
        • Failed Orders
        • Orders
        • Quotation Request
        • Stock Update
        • Variant Stock Update
      • Supplier
        • Contact
        • Supplier
Powered by GitBook
On this page
  1. Spurtcommerce
  2. Admin API

Dashboard

PreviousManage SEONextMarketing

Last updated 4 months ago

Sales Graph List API

get

Gets the sales count list for a specific year and month.

Query parameters
yearintegerRequired

Year for which sales graph data is requested

monthintegerRequired

Month for which sales graph data is requested

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Sales graph data retrieved successfully
400
Bad Request
500
Internal server error
get
GET /backend/api/order/sales-graph-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Vendor List API

get

Fetches vendor details based on the provided keyword.

Query parameters
keywordstringOptional

Optional keyword to filter the vendor list

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully retrieved vendor list
400
Bad Request
500
Internal server error
get
GET /backend/api/chat-admin/vendor-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Total Vendor and Product Count

get

Fetches the total count of vendors and products for the admin dashboard.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully retrieved the total vendor and product count
400
Bad Request
500
Internal server error
get
GET /backend/api/product/dashboard-admin-totalvendor-totalproduct-count HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Get Top 5 Repeatedly Purchased Customers

get

Fetches the list of the top 5 customers who have made repeated purchases.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully retrieved the top 5 repeatedly purchased customers
400
Bad Request
500
Internal server error
get
GET /backend/api/product/top-five-repeatedly-purchased-customers HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Get Recently Selling Products

get

Fetches a list of recently sold products.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully retrieved recently selling products
400
Bad Request
500
Internal Server Error
get
GET /backend/api/product/recent-selling-product HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Get Website Settings

get

Fetches settings based on the given query parameter.

Query parameters
defaultWebsiteintegerOptional

If set to 1, returns default website settings

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully retrieved settings
400
Bad Request - Invalid parameters
500
Internal Server Error
get
GET /backend/api/settings HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Get Average Order Value

get

Fetches the average order value based on provided filters.

Query parameters
limitintegerOptional

Number of records to return.

offsetintegerOptional

Offset for pagination.

countintegerOptional

Whether to count records (0 or 1).

durationintegerOptional

Duration in months to calculate the average order value.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully got the average order value
400
Invalid request parameters
get
GET /backend/api/product/average-order-value HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the average order value</message>
</object>

Get Top Performing Products

get

Fetches the top-performing products based on provided filters.

Query parameters
limitintegerOptional

Number of records to return.

offsetintegerOptional

Offset for pagination.

countintegerOptional

Whether to count records (0 or 1).

durationintegerOptional

Duration in months to calculate performance.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully got the top performing product list
400
Invalid request parameters
get
GET /backend/api/product/top-performing-products HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the top performing product list</message>
</object>

Get Total Revenue

get

Retrieves the total revenue amount for a given duration.

Query parameters
durationintegerRequired

Duration in months to calculate total revenue.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully got the total revenue amount
400
Invalid request parameters
get
GET /backend/api/product/total-revenue HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>0</status>
	<message>Successfully got the total revenue amount</message>
</object>

Get Orders Count

get

Retrieves the count of orders and vendors based on the specified duration.

Query parameters
durationintegerRequired

Duration in months to retrieve order count.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully got dashboard orders and vendors count based on orders
400
Invalid request parameters
get
GET /backend/api/product/orders-count HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got dashboard orders and vendors count based on orders</message>
</object>

Get Dashboard Customers Count

get

Retrieves the total number of customers for the specified duration.

Query parameters
durationintegerRequired

Duration in months to retrieve customers count.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully got dashboard customers count
400
Invalid request parameters
get
GET /backend/api/product/dashboard/admin-customers-count HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got dashboard customers count</message>
</object>

Get Average Conversion Ratio

get

Retrieves the average conversion ratio for the specified duration.

Query parameters
durationintegerRequired

Duration in months to retrieve the average conversion ratio.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully got average conversion ratio
400
Invalid request parameters
get
GET /backend/api/product/average-conversion-ratio HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got average conversion ratio</message>
</object>

Get Customer Visit List

get

Retrieves the list of buyer visits based on the specified month and year.

Query parameters
monthintegerRequired

Month for the buyer visit list.

yearintegerRequired

Year for the buyer visit list.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully got the buyer visit list
400
Invalid request parameters
get
GET /backend/api/admin-customer/customer-visit-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the buyer visit list</message>
</object>

Get Transaction List

get

Retrieves the transaction list based on the specified year.

Query parameters
yearintegerRequired

The year for which the transaction list is requested.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully got the transaction list
400
Invalid year parameter
get
GET /backend/api/order/transaction-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the transaction list</message>
</object>

Get Seller List

get

Retrieves a list of vendors based on optional filtering criteria.

Query parameters
limitintegerOptional

Number of records to retrieve.

offsetintegerOptional

The offset from where to start fetching the vendor records.

namestringOptional

Filter vendors by name.

emailstringOptional

Filter vendors by email.

statusintegerOptional

Filter vendors by their status (1 for active, 0 for inactive).

countintegerOptional

Flag to indicate if only the count of vendors should be returned (1) or a detailed list (0).

keywordstringOptional

Keyword search for vendor name or other attributes.

vendorNamestringOptional

Filter vendors by vendor name.

companyNamestringOptional

Filter vendors by company name.

vendorPrefixIdintegerOptional

Filter vendors by a specific vendor prefix ID.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully got the seller list
400
Invalid parameters
get
GET /backend/api/admin-vendor HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got seller list</message>
</object>

Get Profile

get

Retrieves the profile details of the authenticated user.

Responses
200
Successfully got the profile
400
Invalid request parameters
401
Unauthorized access
get
GET /backend/api/auth/get-profile HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the profile</message>
</object>
  • GETSales Graph List API
  • GETVendor List API
  • GETTotal Vendor and Product Count
  • GETGet Top 5 Repeatedly Purchased Customers
  • GETGet Recently Selling Products
  • GETGet Website Settings
  • GETGet Average Order Value
  • GETGet Top Performing Products
  • GETGet Total Revenue
  • GETGet Orders Count
  • GETGet Dashboard Customers Count
  • GETGet Average Conversion Ratio
  • GETGet Customer Visit List
  • GETGet Transaction List
  • GETGet Seller List
  • GETGet Profile