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. Sellers

Seller KYC Request

PreviousSeller GroupNextSettings

Last updated 3 months ago

Get vendor list

get

Retrieves a list of vendors based on optional filters.

Query parameters
limitintegerOptional

The number of vendors to return per page

Default: 10
offsetintegerOptional

The offset from which to start retrieving vendors

Default: 0
namestringOptional

Filter by vendor name

emailstringOptional

Filter by vendor email

statusstringOptional

Filter by vendor status

countintegerOptional

Indicates whether to return the count of vendors

Default: 0
keywordstringOptional

Filter by keyword

vendorNamestringOptional

Filter by vendor's name

companyNamestringOptional

Filter by company name

vendorPrefixIdstringOptional

Filter by vendor prefix ID

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully retrieved vendor list
400
Bad request, 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 site settings

get

Retrieves the site settings based on the provided query parameters.

Query parameters
defaultWebsiteintegerOptional

Filter to get settings related to the default website

Default: 1
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully retrieved settings
400
Bad request due to invalid parameters
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>Successfully got settings</message>
</object>

Get vendor details

get

Retrieves the details of a specific vendor by their ID

Path parameters
idintegerRequired

ID of the vendor

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully retrieved vendor details
404
Vendor not found
get
GET /backend/api/admin-vendor/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>
  • GETGet vendor list
  • GETGet site settings
  • GETGet vendor details
  • PUTApprove or Reject Vendor KYC
  • PUTUpdate Vendor Status

Approve or Reject Vendor KYC

put

Updates the KYC status of a vendor and applies additional settings such as delivery method, subscription plan, and more.

Path parameters
idintegerRequired

The unique ID of the vendor to approve/reject

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
commentstringOptional

A comment explaining the decision (required for rejection)

Example: t
kycStatusstring ยท enumOptional

The KYC status to be applied to the vendor

Example: rejectedPossible values:
vendorIdintegerOptional

The ID of the vendor

Example: 292
deliveryMethodintegerOptional

The delivery method choice for the vendor

Example: 1
subscriptionPlanintegerOptional

The subscription plan for the vendor

Example: 1
distributionPointintegerOptional

The distribution point for the vendor

Example: 1
policyintegerOptional

The policy setting for the vendor

Example: 1
storeFrontintegerOptional

The storefront setting for the vendor

Example: 1
paymentInfointegerOptional

Payment information status

Example: 1
decisionintegerOptional

Final decision on the vendor

Example: 1
categoryintegerOptional

Category selection for the vendor

Example: 1
vendorGroupIdintegerOptional

The vendor group ID to which the vendor should belong

Example: 29
Responses
200
Successfully updated the vendor's KYC status and settings
400
Invalid input or missing required fields
404
Vendor not found
put
PUT /backend/api/admin-vendor/approve-vendor/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 202

"comment='t'&kycStatus='rejected'&vendorId=292&deliveryMethod=1&subscriptionPlan=1&distributionPoint=1&policy=1&storeFront=1&paymentInfo=1&decision=1&category=1&vendorGroupId=29"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Updated Seller Kyc Detail</message>
</object>

Update Vendor Status

put

Updates the active status of the vendor with the given ID.

Path parameters
idintegerRequired

The unique ID of the vendor whose status is being updated

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
isActiveintegerOptional

Status of the vendor: 0 for inactive, 1 for active

Example: 0
Responses
200
Successfully updated vendor status
400
Invalid input
404
Vendor not found
put
PUT /backend/api/admin-vendor/status/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 14

"isActive=0"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Updated Seller Status</message>
</object>