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

PreviousSellersNextSeller Group

Last updated 4 months ago

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
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
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got settings</message>
</object>

Get vendor group list

get

Retrieves the list of vendor groups based on the provided query parameters.

Query parameters
limitintegerOptional

The number of records to return

Default: 0
offsetintegerOptional

The number of records to skip before starting the list

Default: 0
keywordstringOptional

Filter results by a keyword (e.g., group name)

statusintegerOptional

Filter results by status (e.g., 1 for active, 0 for inactive)

countintegerOptional

Indicates if only the count of vendor groups should be returned

Default: 0
Responses
200
Successfully retrieved vendor group list
400
Bad request due to invalid parameters
get
GET /backend/api/vendor-group HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got all seller group List</message>
</object>

Get industry list

get

Retrieves the list of industries based on the provided query parameters.

Query parameters
limitintegerOptional

The number of records to return

Default: 0
offsetintegerOptional

The number of records to skip before starting the list

Default: 0
keywordstringOptional

Filter results by a keyword (e.g., industry name)

statusintegerOptional

Filter results by status (e.g., 1 for active, 0 for inactive)

countintegerOptional

Indicates if only the count of industries should be returned

Default: 0
Responses
200
Successfully retrieved industry list
400
Bad request due to invalid parameters
get
GET /backend/api/list/industry HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got industry list</message>
</object>

Get vendor document list

get

Retrieves the list of documents associated with vendors.

Responses
200
Successfully retrieved the document list
400
Bad request
get
GET /backend/api/admin-vendor/master/document HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got documents list</message>
</object>

Get vendor details

get

Retrieves the details of a specific vendor by their ID

Path parameters
idintegerRequired

ID of the vendor

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
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Delete seller

delete

Deletes a specific seller by their vendor ID

Path parameters
idintegerRequired

ID of the vendor to be deleted

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully deleted seller
400
Invalid vendor ID
delete
DELETE /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>Seller Deleted Successfully</message>
</object>

Get vendor products

get

Retrieves a list of products for a specific vendor

Query parameters
offsetintegerOptional

The offset for pagination

limitintegerOptional

The limit for the number of results

countintegerOptional

If set to 1, returns only the count of products

vendorIdintegerRequired

The ID of the vendor

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully retrieved vendor products
get
GET /backend/api/admin-vendor-product HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
200

Successfully retrieved vendor products

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

Get vendor settings

get

Retrieves the settings for a specific vendor

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully retrieved vendor settings
404
Vendor settings not found
get
GET /backend/api/vendor-setting/get-vendor-settings 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
  • POSTCreate a new vendor
  • GETGet site settings
  • GETGet vendor group list
  • GETGet industry list
  • GETGet vendor document list
  • POSTCheck if a vendor display name URL is available
  • GETGet vendor details
  • PUTUpdate seller details
  • DELETEDelete seller
  • GETGet vendor products
  • GETGet vendor settings
  • PUTUpdate vendor commission

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

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
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got seller list</message>
</object>

Create a new vendor

post

Creates a new vendor with the given details, including email, password, and other company-related information. An email with credentials is sent to the vendor.

Body
customerGroupIdstringOptionalExample: null
firstNamestringOptionalExample: test
lastNamestringOptionalExample: svsfgf
emailstringOptionalExample: test@gmail.com
mobileNumberstringOptionalExample: 23563554
passwordstringOptionalExample: Picco123@
confirmPasswordstringOptionalExample: Picco123@
avatarstringOptional
companyNamestringOptionalExample: test
companyLogostringOptional
companyDescriptionstringOptionalExample: <p>fsdfsd</p>
companyAddress1stringOptionalExample: sdfs
companyAddress2stringOptionalExample: sdfds
companyCitystringOptionalExample: sdfds
companyCountryIdintegerOptionalExample: 99
companyStateintegerOptionalExample: 76
pincodestringOptionalExample: 454354
companyWebsitestringOptional
mailStatusintegerOptionalExample: 1
statusintegerOptionalExample: 1
approvalFlagintegerOptionalExample: 1
commissionstringOptional
customerIdstringOptional
companyGstNumberstringOptional
companyCoverImagestringOptional
vendorGroupIdintegerOptionalExample: 28
displayNameUrlstringOptionalExample: test254354353
instagramstringOptional
youtubestringOptional
facebookstringOptional
twitterstringOptional
companyTaxNumberstringOptionalExample: 34543543
companyAccountHolderNamestringOptionalExample: sdsdgs
companyAccountNumberstringOptionalExample: 43543543553453
companyAccountBranchstringOptionalExample: sfs
companyAccountCreatedOnstringOptionalExample: 43535
companyAccountBankNamestringOptionalExample: sgf
companyAccountBicstringOptionalExample: sds
ifscCodestringOptionalExample: sdf435
industryIdintegerOptionalExample: 1
companyBusinessNumberstringOptionalExample: 4254252
vendorDocumentsstring[]Optional
zoneIdintegerOptionalExample: 76
Responses
200
Successfully created new vendor with email Id and password and email sent
400
Bad request, invalid data
post
POST /backend/api/admin-vendor HTTP/1.1
Host: 139.59.67.17
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 963

"customerGroupId='null'&firstName='test'&lastName='svsfgf'&email='test@gmail.com'&mobileNumber='23563554'&password='Picco123@'&confirmPassword='Picco123@'&avatar=''&companyName='test'&companyLogo=''&companyDescription='<p>fsdfsd</p>'&companyAddress1='sdfs'&companyAddress2='sdfds'&companyCity='sdfds'&companyCountryId=99&companyState=76&pincode='454354'&companyWebsite=''&mailStatus=1&status=1&approvalFlag=1&commission=''&customerId=''&companyGstNumber=''&companyCoverImage=''&vendorGroupId=28&displayNameUrl='test254354353'&instagram=''&youtube=''&facebook=''&twitter=''&companyTaxNumber='34543543'&companyAccountHolderName='sdsdgs'&companyAccountNumber='43543543553453'&companyAccountBranch='sfs'&companyAccountCreatedOn='43535'&companyAccountBankName='sgf'&companyAccountBic='sds'&ifscCode='sdf435'&industryId=1&companyBusinessNumber='4254252'&vendorDocuments=[]&zoneId=76"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully created new vendor with email Id and password and email sent</message>
</object>

Check if a vendor display name URL is available

post

Checks if a given display name URL is available for a vendor. It returns whether the URL can be used or if it is already taken.

Body
displayNameURLstringOptionalExample: test254354353
Responses
200
Successfully checked the display name availability
400
Bad request, invalid display name URL format
post
POST /backend/api/admin-vendor/check-display-name-url HTTP/1.1
Host: 139.59.67.17
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 34

"displayNameURL='test254354353'"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Display name available</message>
</object>

Update seller details

put

Updates the details of a specific seller by their vendor ID

Path parameters
idintegerRequired

ID of the vendor

Body
customerGroupIdstringOptionalExample: null
firstNamestringOptionalExample: test
lastNamestringOptionalExample: svsfgf
mobileNumberstringOptionalExample: 23563554
avatarstringOptional
companyNamestringOptionalExample: test
companyLogostringOptional
companyDescriptionstringOptionalExample: <p>fsdfsd</p>
companyAddress1stringOptionalExample: sdfs
companyAddress2stringOptionalExample: sdfds
companyCitystringOptionalExample: sdfds
companyCountryIdintegerOptionalExample: 99
companyStateintegerOptionalExample: 76
pincodeintegerOptionalExample: 454354
companyWebsitestringOptional
mailStatusintegerOptionalExample: 0
statusintegerOptionalExample: 1
approvalFlagintegerOptionalExample: 1
commissionintegerOptionalExample: 12
customerIdintegerOptionalExample: 452
paymentInformationstringOptional
companyEmailIdstringOptional
companyCoverImagestringOptional
passwordstringOptional
confirmPasswordstringOptional
companyGstNumberstringOptional
vendorGroupIdintegerOptionalExample: 28
displayNameUrlstringOptionalExample: test254354353
instagramstringOptional
youtubestringOptional
facebookstringOptional
whatsAppstringOptional
vendorDocumentsstring[]Optional
emailstringOptionalExample: test@gmail.com
companyTaxNumberstringOptionalExample: 34543543
companyAccountHolderNamestringOptionalExample: sdsdgs
companyAccountNumberstringOptionalExample: 43543543553453
companyAccountBranchstringOptionalExample: sfs
companyAccountCreatedOnstringOptionalExample: 43535
companyAccountBankNamestringOptionalExample: sgf
companyAccountBicstringOptionalExample: sds
ifscCodestringOptionalExample: sdf435
industryIdintegerOptionalExample: 1
companyBusinessNumberstringOptionalExample: 4254252
zoneIdintegerOptionalExample: 76
statestringOptional
Responses
200
Successfully updated seller details
400
Invalid input
put
PUT /backend/api/admin-vendor/{id} HTTP/1.1
Host: 139.59.67.17
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 1000

"customerGroupId='null'&firstName='test'&lastName='svsfgf'&mobileNumber='23563554'&avatar=''&companyName='test'&companyLogo=''&companyDescription='<p>fsdfsd</p>'&companyAddress1='sdfs'&companyAddress2='sdfds'&companyCity='sdfds'&companyCountryId=99&companyState=76&pincode=454354&companyWebsite=''&mailStatus=0&status=1&approvalFlag=1&commission=12&customerId=452&paymentInformation=''&companyEmailId=''&companyCoverImage=''&password=''&confirmPassword=''&companyGstNumber=''&vendorGroupId=28&displayNameUrl='test254354353'&instagram=''&youtube=''&facebook=''&whatsApp=''&vendorDocuments=[]&email='test@gmail.com'&companyTaxNumber='34543543'&companyAccountHolderName='sdsdgs'&companyAccountNumber='43543543553453'&companyAccountBranch='sfs'&companyAccountCreatedOn='43535'&companyAccountBankName='sgf'&companyAccountBic='sds'&ifscCode='sdf435'&industryId=1&companyBusinessNumber='4254252'&zoneId=76&state=''"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Seller Updated Successfully</message>
</object>

Update vendor commission

put

Updates the commission of a vendor based on their ID

Path parameters
idintegerRequired

ID of the vendor

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
commissionnumberOptional
Responses
200
Successfully updated the vendor commission
404
Vendor not found
put
PUT /backend/api/admin-vendor/update-vendor-commission/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 16

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