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

Reports

PreviousSupportNextSales

Last updated 3 months ago

Get seller sales report

get

This endpoint retrieves the sales report for a specific seller based on the given product IDs and date range.

Query parameters
productIdinteger[]Required

A comma-separated list of product IDs to filter the sales report.

startDatestring ยท dateRequired

The start date of the sales report in 'YYYY-MM-DD' format.

endDatestring ยท dateRequired

The end date of the sales report in 'YYYY-MM-DD' format.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Responses
200
Successfully retrieved the seller sales report.
400
Bad Request
500
Internal Server Error
get
GET /backend/api/vendor-order/sales-report-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got seller sales list</message>
	<data>
		<productId>2015</productId>
		<productName>Product Name</productName>
		<salesQuantity>100</salesQuantity>
		<totalRevenue>1500.5</totalRevenue>
		<date>2025-01-01</date>
	</data>
</object>

Get vendor product list

get

This endpoint fetches the product list for a vendor, with optional filters like SKU, status, and price range.

Query parameters
offsetintegerOptional

The offset for pagination (starting from 0).

Default: 0
limitintegerOptional

The number of results per page.

Default: 0
skustringOptional

An optional SKU to filter the product list.

statusstringOptional

An optional status to filter the product list (e.g., active, inactive).

pricestringOptional

An optional price filter for the product list (e.g., price range).

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Responses
200
Successfully retrieved the vendor product list.
400
Bad Request
500
Internal Server Error
get
GET /backend/api/vendor-product HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got your product list.</message>
</object>

Get vendor category list

get

This endpoint retrieves the list of vendor categories with optional filters like keyword and status.

Query parameters
offsetintegerOptional

The offset for pagination (starting from 0).

Default: 0
limitintegerOptional

The number of results per page.

Default: 0
keywordstringOptional

An optional keyword to filter the vendor categories.

statusstringOptional

An optional status to filter the categories (active, inactive).

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Responses
200
Successfully retrieved the vendor category list.
400
Bad Request
500
Internal Server Error
get
GET /backend/api/vendor-product/vendor-category-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the vendor category list</message>
</object>
  • GETGet seller sales report
  • GETGet vendor product list
  • GETGet vendor category list