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

Manage Products

PreviousMarketplaceNextManage Sales

Last updated 4 months ago

Get common catalog products

get

Fetch a list of common catalog products with pagination and filtering options.

Query parameters
limitintegerOptional

Number of products to retrieve per page.

offsetintegerOptional

Number of products to skip before starting to fetch the results.

countintegerOptional

Flag to include total product count (1 for yes, 0 for no).

ownerintegerOptional

Filter products by owner ID.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Common catalog product list retrieved successfully
400
Invalid request parameters
get
GET /backend/api/admin-common-product HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the common catalog product list</message>
</object>
  • GETGet seller product list
  • PUTApprove or reject a seller product
  • PUTUpdate product status
  • POSTGenerate Excel for vendor product
  • GETGet common catalog products
  • PUTSet product as common

Get seller product list

get

Retrieves a list of products associated with sellers.

Query parameters
limitintegerOptional

Number of products to return per page.

offsetintegerOptional

Pagination offset for product retrieval.

countintegerOptional

Include total count (0 = no, 1 = yes).

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

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

Approve or reject a seller product

put

Approves or rejects a product based on provided parameters.

Path parameters
idintegerRequired

Product ID to approve or reject.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
productIdsintegerRequired

Product ID being processed.

approvalFlagstringRequired

Approval status (e.g., '1' for approved, '2' for rejected).

reasonstringRequired

Reason for rejection, if applicable.

Responses
200
Product approval/rejection successful
400
Invalid input data
put
PUT /backend/api/admin-vendor-product/approve-product/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 54

"productIds=1&approvalFlag='text'&reason='text'"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Update product status

put

Updates the status of a vendor product.

Path parameters
idintegerRequired

Product ID for which the status is to be updated.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
statusintegerRequired

New status of the product (0 for inactive, 1 for active).

idintegerRequired

ID of the product being updated.

Responses
200
Status update successful
400
Invalid input data
put
PUT /backend/api/admin-vendor-product/add-product-status/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 19

"status=1&id=1"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Generate Excel for vendor product

post

Generates an Excel list for the provided product ID.

Query parameters
productIdintegerRequired

Product ID for which the Excel list will be generated.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
productIdstringRequired

Product ID as a string input.

Responses
200
Excel list generated successfully
400
Invalid product ID provided
post
POST /backend/api/admin-vendor-product/vendor-product-excel-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 20

"productId='text'"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully generated Excel list</message>
</object>

Set product as common

put

Update a product to mark it as common.

Path parameters
idintegerRequired

The ID of the product to be updated.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
commonIdintegerOptionalExample: 2125
commonintegerOptional

Flag to set product as common (1 for common, 0 for not common)

Example: 1
Responses
200
Successfully updated product as common
400
Invalid request or missing parameters
put
PUT /backend/api/admin-common-product/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 28

"commonId=2125&common=1"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully set as common product</message>
</object>