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
  3. Payments

Earnings

PreviousArcheived PaymentsNextSettlements

Last updated 3 months ago

Get vendor earnings list

get

This endpoint returns a list of earnings for a vendor based on the given pagination parameters.

Query parameters
limitintegerOptional

The number of results to return per page.

offsetintegerOptional

The number of items to skip for pagination.

currentPageintegerOptional

The current page number for pagination.

countintegerOptional

Indicates whether to include the total count of items.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

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

Export product earning data

get

This endpoint exports the earnings data of a specific product.

Query parameters
productIdintegerRequired

The ID of the product whose earning details need to be exported.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Responses
200
Successfully exported product earning data
400
Bad Request
500
Internal Server Error
get
GET /backend/api/vendor-sales/product-earning-export HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Product earnings exported successfully</message>
</object>
  • GETGet vendor earnings list
  • GETExport product earning data