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. Vendor API

Dashboard

PreviousRating and ReviewNextMarketing

Last updated 3 months ago

Get total dashboard counts

get

Retrieve the total counts for different dashboard categories for the vendor.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Responses
200
Successfully retrieved dashboard counts.
401
Unauthorized access. Token is missing or invalid.
500
Internal server error.
get
GET /backend/api/vendor/total-Dashboard-counts HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully get Total Dashboard count</message>
</object>

Get the complete order list

get

Retrieve the list of orders for the vendor, with pagination support using limit and offset query parameters.

Query parameters
limitintegerOptional

The maximum number of orders to return.

Default: 4
offsetintegerOptional

The starting point for pagination.

Default: 0
Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication.

Responses
200
Successfully retrieved the complete order list.
401
Unauthorized access. Token is missing or invalid.
500
Internal server error.
get
GET /backend/api/vendor-order/order-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the complete order list</message>
</object>

Get the complete payment list

get

Retrieve the list of payments for the vendor, with pagination support using limit and offset query parameters.

Query parameters
limitintegerOptional

The maximum number of payments to return.

Default: 4
offsetintegerOptional

The starting point for pagination.

Default: 0
Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication.

Responses
200
Successfully retrieved the complete payment list.
401
Unauthorized access. Token is missing or invalid.
500
Internal server error.
get
GET /backend/api/vendor-sales/payment HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the complete payment list</message>
</object>

Get the top-selling product list

get

Retrieve the list of top-selling products for the vendor based on a specified duration.

Query parameters
durationintegerRequired

The duration for which to retrieve top-selling products (e.g., 1 for past month).

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication.

Responses
200
Successfully retrieved the top-selling product list.
401
Unauthorized access. Token is missing or invalid.
500
Internal server error.
get
GET /backend/api/vendor-order/top-selling-productlist HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got yop selling product</message>
</object>

Get the order graph data

get

Retrieve the order count data for the vendor based on the specified duration.

Query parameters
durationintegerRequired

The duration for which to retrieve the order count (e.g., 1 for past month).

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication.

Responses
200
Successfully retrieved the order graph data.
401
Unauthorized access. Token is missing or invalid.
500
Internal server error.
get
GET /backend/api/vendor/order-graph HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully get order count.</message>
</object>
  • GETGet total dashboard counts
  • GETGet the complete order list
  • GETGet the complete payment list
  • GETGet the top-selling product list
  • GETGet the order graph data