Manage Vendors

Vendor group list

get

List of vendor group.

Query parameters

limitnumberOptional

offsetnumberOptional

keywordstringOptional

statusstringOptional

countstringOptional

Header parameters

AuthorizationstringRequired

Responses

200

success response

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully got vendor group list count. " or " Successfully got all vendor group List.

400

error response

*/*

get

/vendor-group

HTTPcURLJavaScriptPython

GET /vendor-group HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully got vendor group list count. \" or \" Successfully got all vendor group List. "
}

Add vendor group

post

Add data for vendor group

Header parameters

AuthorizationstringRequired

Body

application/x-www-form-urlencoded

namestringOptional

descriptionstringOptional

statusinteger · int32Optional

commissioninteger · int32Optional

categoryIdsinteger[]Optional

Responses

200

success response

application/json

namestringOptional

descriptionstringOptional

isActiveintegerOptional

commissionintegerOptional

createdDatestring · date-timeOptional

groupIdintegerOptional

400

error response

application/json

post

/vendor-group

HTTPcURLJavaScriptPython

POST /vendor-group HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 80

"name='text'&description='text'&status=1&commission=1&categoryIds=[1]"

{
  "name": "text",
  "description": "text",
  "isActive": 1,
  "commission": 1,
  "createdDate": "2026-05-14T07:50:47.650Z",
  "groupId": 1
}

Update vendor group

put

Update a vendor group

Path parameters

idintegerRequired

Header parameters

AuthorizationstringRequired

Body

*/*

namestringOptional

descriptionstringOptional

statusinteger · int32Optional

commissioninteger · int32Optional

categoryIdsinteger[]Optional

Responses

200

success response

*/*

namestringOptional

descriptionstringOptional

isActiveintegerOptional

commissionintegerOptional

groupIdintegerOptional

modifiedDatestring · date-timeOptional

400

error response

*/*

put

/vendor-group/{id}

HTTPcURLJavaScriptPython

PUT /vendor-group/{id} HTTP/1.1
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 80

{
  "name": "text",
  "description": "text",
  "status": 1,
  "commission": 1,
  "categoryIds": [
    1
  ]
}

{
  "name": "text",
  "description": "text",
  "isActive": 1,
  "commission": 1,
  "groupId": 1,
  "modifiedDate": "2026-05-14T07:50:47.650Z"
}

Delete vendor group

delete

Delete a vendor group

Path parameters

idintegerRequired

Header parameters

AuthorizationstringRequired

Responses

200

success response

*/*

statusintegerOptional

messagestringOptionalDefault: Vendor Group Deleted Successfully.

400

error response

*/*

delete

/vendor-group/{id}

HTTPcURLJavaScriptPython

DELETE /vendor-group/{id} HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Vendor Group Deleted Successfully."
}

Vendor group detail

get

Get a detail of vendor group

Path parameters

idintegerRequired

Header parameters

AuthorizationstringRequired

Responses

200

success response

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully got vendor group details.

400

error response

*/*

get

/vendor-group/vendor-group-details/{id}

HTTPcURLJavaScriptPython

GET /vendor-group/vendor-group-details/{id} HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully got vendor group details."
}

Vendor group count

get

Get Count of vendor group

Header parameters

AuthorizationstringRequired

Responses

200

success response

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully got the vendor group count

get

/vendor-group/vendor-group-count

HTTPcURLJavaScriptPython

GET /vendor-group/vendor-group-count HTTP/1.1
Authorization: text
Accept: */*

200

success response

{
  "status": 1,
  "message": "Successfully got the vendor group count"
}

Create Vendor Category

post

Creates New Vendor-Category

Header parameters

AuthorizationstringRequired

Body

application/x-www-form-urlencoded

vendorIdinteger · int32Required

categoryIdstringRequired

commissioninteger · int32Optional

Responses

200

success response

application/json

vendorIdstringOptional

categoryIdstringOptional

vendorCategoryCommissioninteger · int32Optional

vendorCategoryIdinteger · int32Optional

400

Error response

application/json

post

/vendor-category/create-vendor-category

HTTPcURLJavaScriptPython

POST /vendor-category/create-vendor-category HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 49

"vendorId=1&categoryId='text'&commission=1"

{
  "vendorId": "text",
  "categoryId": "text",
  "vendorCategoryCommission": 1,
  "vendorCategoryId": 1
}

Update Vendor Category

put

Updates A Vendor Category

Header parameters

AuthorizationstringRequired

Body

application/x-www-form-urlencoded

vendorIdinteger · int32Required

categoryIdstringRequired

commissioninteger · int32Optional

Responses

200

Success response

application/json

vendorIdstringOptional

categoryIdstringOptional

vendorCategoryCommissioninteger · int32Optional

vendorCategoryIdinteger · int32Optional

400

Error response

application/json

put

/vendor-category/update-vendor-category

HTTPcURLJavaScriptPython

PUT /vendor-category/update-vendor-category HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 49

"vendorId=1&categoryId='text'&commission=1"

{
  "vendorId": "text",
  "categoryId": "text",
  "vendorCategoryCommission": 1,
  "vendorCategoryId": 1
}

Vendor Category List

get

Gets a Vendor Category list

Path parameters

idinteger · int32Required

Query parameters

keywordstringOptional

limitinteger · int32Optional

offsetinteger · int32Optional

countbooleanOptional

Header parameters

AuthorizationstringRequired

Responses

200

Success response

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully got the vendor category list.

get

/vendor-category/vendorCategoryList/{id}

HTTPcURLJavaScriptPython

GET /vendor-category/vendorCategoryList/{id} HTTP/1.1
Authorization: text
Accept: */*

200

Success response

{
  "status": 1,
  "message": "Successfully got the vendor category list."
}

Vendor Category Group-List

get

Gets List of a Vendor Category By Group

Path parameters

idinteger · int32Required

Query parameters

keywordstringOptional

limitinteger · int32Optional

offsetinteger · int32Optional

countbooleanOptional

Header parameters

AuthorizationstringRequired

Responses

200

Success response

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully got the vendor category list.

get

/vendor-category/vendor-category-list/{id}

HTTPcURLJavaScriptPython

GET /vendor-category/vendor-category-list/{id} HTTP/1.1
Authorization: text
Accept: */*

200

Success response

{
  "status": 1,
  "message": "Successfully got the vendor category list."
}

Delete Vendor Category

post

Deletes a Vendor Category

Path parameters

idnumber · int32Required

Header parameters

AuthorizationstringRequired

Responses

200

Success response

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully deleted the vendor category.

400

Error response

*/*

post

/vendor-category/delete-vendor-category/{id}

HTTPcURLJavaScriptPython

POST /vendor-category/delete-vendor-category/{id} HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully deleted the vendor category."
}

Create vendor settings

post

Add a vendor settings

Body

application/x-www-form-urlencoded

defaultCommissioninteger · int32Optional

Responses

200

success response

application/json

createdByinteger · int32Optional

createdDatestring · date-timeOptional

modifiedByinteger · int32Optional

modifiedDatestring · date-timeOptional

settingIdinteger · int32Optional

defaultCommissionstringOptional

post

/vendor-setting/create-vendor-settings

HTTPcURLJavaScriptPython

POST /vendor-setting/create-vendor-settings HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 23

"defaultCommission=1"

200

success response

{
  "createdBy": 1,
  "createdDate": "2026-05-14T07:50:47.650Z",
  "modifiedBy": 1,
  "modifiedDate": "2026-05-14T07:50:47.650Z",
  "settingId": 1,
  "defaultCommission": "text"
}

Get vendor settings

get

Get list of vendor settings.

Responses

200

success response

*/*

statusintegerOptional

messagestringOptionalDefault: data is empty " or " Successfully get vendor settings

get

/vendor-setting/get-vendor-settings

HTTPcURLJavaScriptPython

GET /vendor-setting/get-vendor-settings HTTP/1.1
Accept: */*

200

success response

{
  "status": 1,
  "message": "data is empty \" or \" Successfully get vendor settings"
}

Vendor List

get

Gets all Vendor List

Query parameters

limitinteger · int32Optional

offsetinteger · int32Optional

namestringOptional

statusstringOptional

emailstringOptional

countbooleanOptional

Responses

200

Success response

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully got vendor count"or"Successfully got Vendor list.

400

error response

*/*

get

/admin-vendor

HTTPcURLJavaScriptPython

GET /admin-vendor  HTTP/1.1
Accept: */*

{
  "status": 1,
  "message": "Successfully got vendor count\"or\"Successfully got Vendor list."
}

Add Vendor

post

Header parameters

AuthorizationstringRequired

Body

application/x-www-form-urlencoded

firstNamestringRequired

lastNamestringRequired

emailstringOptional

mobileNumberinteger · int32Required

passwordstringRequired

confirmPasswordstringRequired

avatarstringOptional

mailStatusinteger · int32Required

statusinteger · int32Required

commissioninteger · int32Optional

companyNamestringOptional

companyLocationstringOptional

companyLogostringOptional

companyCoverImagestringOptional

companyDescriptionstringOptional

companyAddress1stringOptional

companyAddress2stringOptional

companyCitystringOptional

companyStatestringOptional

companyCountryIdinteger · int32Optional

pincodeinteger · int32Optional

companyMobileNumberinteger · int32Optional

companyEmailIdstringOptional

companyWebsitestringOptional

companyTaxNumberstringOptional

companyPanNumberstringOptional

paymentInformationstringOptional

vendorGroupIdinteger · int32Required

instagramstringOptional

twitterstringOptional

youtubestringOptional

facebookstringOptional

displayNameUrlstringOptional

Responses

200

Success response

application/xmlapplication/json

statusintegerOptional

messagestringOptionalDefault: Successfully created new vendor with email Id and password and email sent."or" Vendor Created Successfully.

400

error response

application/xmlapplication/json

post

/admin-vendor

HTTPcURLJavaScriptPython

POST /admin-vendor  HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 683

"firstName='text'&lastName='text'&email='text'&mobileNumber=1&password='text'&confirmPassword='text'&avatar='text'&mailStatus=1&status=1&commission=1&companyName='text'&companyLocation='text'&companyLogo='text'&companyCoverImage='text'&companyDescription='text'&companyAddress1='text'&companyAddress2='text'&companyCity='text'&companyState='text'&companyCountryId=1&pincode=1&companyMobileNumber=1&companyEmailId='text'&companyWebsite='text'&companyTaxNumber='text'&companyPanNumber='text'&paymentInformation='text'&vendorGroupId=1&instagram='text'&twitter='text'&youtube='text'&facebook='text'&displayNameUrl='text'"

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully created new vendor with email Id and password and email sent.&quot;or&quot; Vendor Created Successfully.</message>
</object>

Update Vendor

put

Updates a Vendor

Path parameters

idintegerRequired

Header parameters

AuthorizationstringRequired

Body

application/x-www-form-urlencoded

firstNamestringRequired

lastNamestringRequired

mobileNumberinteger · int32Required

avatarstringOptional

mailStatusinteger · int32Required

statusinteger · int32Required

approvalFlaginteger · int32Optional

commissioninteger · int32Optional

companyNamestringOptional

companyLogostringOptional

companyCoverImagestringOptional

companyDescriptionstringOptional

companyAddress1stringOptional

companyAddress2stringOptional

companyCitystringOptional

companyStatestringOptional

companyCountryIdinteger · int32Optional

pincodeinteger · int32Optional

companyMobileNumberinteger · int32Optional

companyEmailIdstringOptional

companyWebsitestringOptional

companyTaxNumberstringOptional

companyPanNumberstringOptional

paymentInformationstringOptional

vendorGroupIdinteger · int32Required

instagramstringOptional

twitterstringOptional

youtubestringOptional

facebookstringOptional

displayNameUrlstringOptional

Responses

200

Success response

application/xmlapplication/json

statusintegerOptional

messagestringOptionalDefault: Vendor Updated Successfully.

400

error response

application/xmlapplication/json

put

/admin-vendor/{id}

HTTPcURLJavaScriptPython

PUT /admin-vendor/{id} HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 617

"firstName='text'&lastName='text'&mobileNumber=1&avatar='text'&mailStatus=1&status=1&approvalFlag=1&commission=1&companyName='text'&companyLogo='text'&companyCoverImage='text'&companyDescription='text'&companyAddress1='text'&companyAddress2='text'&companyCity='text'&companyState='text'&companyCountryId=1&pincode=1&companyMobileNumber=1&companyEmailId='text'&companyWebsite='text'&companyTaxNumber='text'&companyPanNumber='text'&paymentInformation='text'&vendorGroupId=1&instagram='text'&twitter='text'&youtube='text'&facebook='text'&displayNameUrl='text'"

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Vendor Updated Successfully.</message>
	<data>
		<createdBy>1</createdBy>
		<createdDate>2026-05-14T07:50:47.650Z</createdDate>
		<modifiedBy>1</modifiedBy>
		<modifiedDate>2026-05-14T07:50:47.650Z</modifiedDate>
		<id>1</id>
		<firstName>text</firstName>
		<lastName>text</lastName>
		<username>text</username>
		<password>text</password>
		<email>text</email>
		<mobileNumber>text</mobileNumber>
		<address>text</address>
		<countryId>1</countryId>
		<zoneId>text</zoneId>
		<city>text</city>
		<local>text</local>
		<oauthData>text</oauthData>
		<avatar>text</avatar>
		<newsletter>text</newsletter>
		<avatarPath>text</avatarPath>
		<customerGroupId>1</customerGroupId>
		<lastLogin>2026-05-14T07:50:47.650Z</lastLogin>
		<safe>1</safe>
		<ip>text</ip>
		<mailStatus>1</mailStatus>
		<pincode>text</pincode>
		<deleteFlag>1</deleteFlag>
		<isActive>1</isActive>
		<forgetPasswordKey>text</forgetPasswordKey>
		<linkExpires>2026-05-14T07:50:47.650Z</linkExpires>
		<lockedOn>text</lockedOn>
	</data>
</object>

Delete single Vendor

delete

Deletes a single Vendor

Path parameters

idinteger · int32Required

Header parameters

AuthorizationstringRequired

Responses

200

Success response

*/*

statusintegerOptional

messagestringOptionalDefault: Vendor Deleted Successfully

400

error response

*/*

delete

/admin-vendor/{id}

HTTPcURLJavaScriptPython

DELETE /admin-vendor/{id} HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Vendor Deleted Successfully"
}

Vendor Excel

get

Dowloads Vendor list -Excel

Query parameters

vedorIdstringOptional

namestringOptional

statusstringOptional

emailstringOptional

Responses

200

Success response

*/*

statusintegerOptional

messagestringOptionalDefault: Downloading Excel File...!

get

/admin-vendor/vendor-excel-list

HTTPcURLJavaScriptPython

GET /admin-vendor/vendor-excel-list HTTP/1.1
Accept: */*

200

Success response

{
  "status": 1,
  "message": "Downloading Excel File...!"
}

Vendor Details

get

Gets a Vendor Detail

Path parameters

idinteger · int32Required

Header parameters

AuthorizationstringRequired

Responses

200

Success response

*/*

statusintegerOptional

messagestringOptionalDefault: successfully got Vendor details.

get

/admin-vendor/vendor-details/{id}

HTTPcURLJavaScriptPython

GET /admin-vendor/vendor-details/{id} HTTP/1.1
Authorization: text
Accept: */*

200

Success response

{
  "status": 1,
  "message": "successfully got Vendor details."
}

Vendor Approval

put

Approval For a Vendor

Path parameters

idinteger · int32Required

Header parameters

AuthorizationstringRequired

Body

application/x-www-form-urlencoded

approvalFlaginteger · int32Optional

Responses

200

Success response

application/json

statusintegerOptional

messagestringOptionalDefault: Vendor Approved and email has been sent to the Vendor with Login credentials.

400

error response

application/json

put

/admin-vendor/approve-vendor/{id}

HTTPcURLJavaScriptPython

PUT /admin-vendor/approve-vendor/{id} HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 18

"approvalFlag=1"

{
  "status": 1,
  "message": "Vendor Approved and email has been sent to the Vendor with Login credentials.",
  "data": {
    "createdBy": 1,
    "createdDate": "2026-05-14T07:50:47.650Z",
    "modifiedBy": 1,
    "modifiedDate": "2026-05-14T07:50:47.650Z",
    "vendorId": 1,
    "vendorPrefixId": "text",
    "customerId": 1,
    "vendorGroupId": 1,
    "commission": 1,
    "contactPersonName": "text",
    "vendorSlugName": "text",
    "designation": "text",
    "companyName": "text",
    "companyAddress1": "text",
    "companyAddress2": "text",
    "companyCity": "text",
    "companyState": "text",
    "companyCountryId": 1,
    "pincode": 1,
    "companyDescription": "text",
    "companyMobileNumber": "text",
    "companyEmailId": "text",
    "companyWebsite": "text",
    "companyTaxNumber": "text",
    "companyPanNumber": "text",
    "companyLogo": "text",
    "companyLogoPath": "text",
    "paymentInformation": "text",
    "approvalFlag": 1,
    "approvedBy": 1,
    "approvalDate": "2026-05-14T07:50:47.650Z",
    "companyCoverImage": "text",
    "companyCoverImagePath": "text",
    "displayNameUrl": "text",
    "instagram": "text",
    "twitter": "text",
    "youtube": "text",
    "facebook": "text"
  }
}

Delete Multiple Vendor

post

Deletes Multiple Vendor

Header parameters

AuthorizationstringRequired

Body

application/x-www-form-urlencoded

vendorIdstringRequired

Responses

200

Success response

application/json

statusintegerOptional

messagestringOptionalDefault: Successfully deleted the vendor

400

error response

application/json

post

/admin-vendor/delete-multiple-vendor

HTTPcURLJavaScriptPython

POST /admin-vendor/delete-multiple-vendor HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 19

"vendorId='text'"

{
  "status": 1,
  "message": "Successfully deleted the vendor"
}

Update Vendor Commission

put

Updates a Vendor-Commision

Path parameters

vendorIdinteger · int32Required

Header parameters

AuthorizationstringRequired

Body

application/x-www-form-urlencoded

commissionstringRequired

Responses

200

Success response

application/json

statusintegerOptional

messagestringOptionalDefault: Successfully Updated the Vendor Commission.

400

error response

application/json

put

/admin-vendor/update-vendor-commission/{vendorId}

HTTPcURLJavaScriptPython

PUT /admin-vendor/update-vendor-commission/{vendorId} HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 21

"commission='text'"

{
  "status": 1,
  "message": "Successfully Updated the Vendor Commission."
}

Verify Customer Document

put

To Verify Costumer document

Path parameters

customerDocumentIdintegerRequired

Header parameters

AuthorizationstringRequired

Body

application/x-www-form-urlencoded

documentStatusinteger · int32Required

Responses

200

Success response

application/json

statusintegerOptional

messagestringOptionalDefault: Successfully verified the customer document.

400

error response

application/json

put

/admin-vendor/verify-customer-document/{customerDocumentId}

HTTPcURLJavaScriptPython

PUT /admin-vendor/verify-customer-document/{customerDocumentId} HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 20

"documentStatus=1"

{
  "status": 1,
  "message": "Successfully verified the customer document."
}

Get Customer Document

get

Gets Customer Documents

Query parameters

keywordstringOptional

limitinteger · int32Optional

offsetinteger · int32Optional

vendorIdinteger · int32Optional

countinteger · int32Optional

Header parameters

AuthorizationstringRequired

Responses

200

Success response

*/*

statusintegerOptional

messagestringOptionalDefault: successfully list the customer document

get

/admin-vendor/customer-document-list

HTTPcURLJavaScriptPython

GET /admin-vendor/customer-document-list HTTP/1.1
Authorization: text
Accept: */*

200

Success response

{
  "status": 1,
  "message": "successfully list the customer document"
}

Download Customer Document

get

Downloads a Customer Document

Path parameters

customerDocumentIdinteger · int32Required

Header parameters

AuthorizationstringRequired

Responses

200

Success response

*/*

statusintegerOptional

messagestringOptionalDefault: ""

400

error response

*/*

get

/admin-vendor/download-customer-document/{customerDocumentId}

HTTPcURLJavaScriptPython

GET /admin-vendor/download-customer-document/{customerDocumentId} HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": ""
}

Vendor Count

get

Gets Vendor Count

Header parameters

AuthorizedstringRequired

Responses

200

Success response

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully got the vendor count

get

/admin-vendor/vendor-count

HTTPcURLJavaScriptPython

GET /admin-vendor/vendor-count HTTP/1.1
Authorized: text
Accept: */*

200

Success response

{
  "status": 1,
  "message": "Successfully got the vendor count"
}

Update Vendor Name Slug

put

Updates Vendor slug Name

Responses

200

Success response

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully updated the vendor slug.

put

/admin-vendor/update-vendor-slug

HTTPcURLJavaScriptPython

PUT /admin-vendor/update-vendor-slug HTTP/1.1
Accept: */*

200

Success response

{
  "status": 1,
  "message": "Successfully updated the vendor slug."
}

Check Vendor Display Name

post

Checks Vendor Display name

Header parameters

AuthorizationstringRequired

Body

application/x-www-form-urlencoded

vendorIdinteger · int32Optional

displayNameURLstringRequired

Responses

200

Success response

application/json

statusintegerOptional

messagestringOptionalDefault: Display name available

400

error response

application/json

post

/admin-vendor/check-display-name-url

HTTPcURLJavaScriptPython

POST /admin-vendor/check-display-name-url HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 38

"vendorId=1&displayNameURL='text'"

{
  "status": 1,
  "message": "Display name available"
}

Plugin

get

Gets Plugin list

Query parameters

limitinteger · int32Optional

offsetinteger · int32Optional

countbooleanOptional

Responses

200

Success response

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully got the list

400

error response

*/*

get

/admin-vendor/get-addons

HTTPcURLJavaScriptPython

GET /admin-vendor/get-addons HTTP/1.1
Accept: */*

{
  "status": 1,
  "message": "Successfully got the list"
}