Manage Vendors

Vendor group list

List of vendor group.

GET/vendor-group

Query parameters

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/vendor-group', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Add vendor group

Add data for vendor group

POST/vendor-group

Header parameters

Body

application/x-www-form-urlencoded

namestring

descriptionstring

statusinteger (int32)

commissioninteger (int32)

categoryIdsarray of integer

Response

200400

success response

Body

application/json

namestring

descriptionstring

isActiveinteger

commissioninteger

createdDatestring (date-time)

groupIdinteger

Request

JavaScriptCurl

const response = await fetch('/vendor-group', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "name": "text",
  "description": "text",
  "createdDate": "2024-04-28T22:13:48.747Z"
}

Update vendor group

Update a vendor group

PUT/vendor-group/{id}

Path parameters

id*integer

Header parameters

Body

*/*

namestring

descriptionstring

statusinteger (int32)

commissioninteger (int32)

categoryIdsarray of integer

Response

200400

success response

Body

*/*

namestring

descriptionstring

isActiveinteger

commissioninteger

groupIdinteger

modifiedDatestring (date-time)

Request

JavaScriptCurl

const response = await fetch('/vendor-group/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "name": "text",
  "description": "text",
  "modifiedDate": "2024-04-28T22:13:48.747Z"
}

Delete vendor group

Delete a vendor group

DELETE/vendor-group/{id}

Path parameters

id*integer

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/vendor-group/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Vendor Group Deleted Successfully."
}

Vendor group detail

Get a detail of vendor group

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

Path parameters

id*integer

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/vendor-group/vendor-group-details/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully got vendor group details."
}

Vendor group count

Get Count of vendor group

GET/vendor-group/vendor-group-count

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/vendor-group/vendor-group-count', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully got the vendor group count"
}

Create Vendor Category

Creates New Vendor-Category

POST/vendor-category/create-vendor-category

Header parameters

Body

application/x-www-form-urlencoded

vendorId*integer (int32)

categoryId*string

commissioninteger (int32)

Response

200400

success response

Body

application/json

vendorIdstring

categoryIdstring

vendorCategoryCommissioninteger (int32)

vendorCategoryIdinteger (int32)

Request

JavaScriptCurl

const response = await fetch('/vendor-category/create-vendor-category', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "categoryId": "text"
    }),
});
const data = await response.json();

Response

{
  "vendorId": "text",
  "categoryId": "text"
}

Update Vendor Category

Updates A Vendor Category

PUT/vendor-category/update-vendor-category

Header parameters

Body

application/x-www-form-urlencoded

vendorId*integer (int32)

categoryId*string

commissioninteger (int32)

Response

200400

Success response

Body

application/json

vendorIdstring

categoryIdstring

vendorCategoryCommissioninteger (int32)

vendorCategoryIdinteger (int32)

Request

JavaScriptCurl

const response = await fetch('/vendor-category/update-vendor-category', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "categoryId": "text"
    }),
});
const data = await response.json();

Response

{
  "vendorId": "text",
  "categoryId": "text"
}

Vendor Category List

Gets a Vendor Category list

GET/vendor-category/vendorCategoryList/{id}

Path parameters

id*integer (int32)

Query parameters

Header parameters

Response

200

Success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/vendor-category/vendorCategoryList/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Vendor Category Group-List

Gets List of a Vendor Category By Group

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

Path parameters

id*integer (int32)

Query parameters

Header parameters

Response

200

Success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/vendor-category/vendor-category-list/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Delete Vendor Category

Deletes a Vendor Category

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

Path parameters

id*number (int32)

Header parameters

Response

200400

Success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/vendor-category/delete-vendor-category/{id}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully deleted the vendor category."
}

Create vendor settings

Add a vendor settings

POST/vendor-setting/create-vendor-settings

Body

application/x-www-form-urlencoded

defaultCommissioninteger (int32)

Response

200

success response

Body

application/json

createdByinteger (int32)

createdDatestring (date-time)

modifiedByinteger (int32)

modifiedDatestring (date-time)

settingIdinteger (int32)

defaultCommissionstring

Request

JavaScriptCurl

const response = await fetch('/vendor-setting/create-vendor-settings', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "createdDate": "2024-04-28T22:13:48.747Z",
  "modifiedDate": "2024-04-28T22:13:48.747Z",
  "defaultCommission": "text"
}

Get vendor settings

Get list of vendor settings.

GET/vendor-setting/get-vendor-settings

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/vendor-setting/get-vendor-settings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Vendor List

Gets all Vendor List

GET/admin-vendor

Query parameters

Response

200400

Success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/admin-vendor ', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Add Vendor

POST/admin-vendor

Header parameters

Body

application/x-www-form-urlencoded

firstName*string

lastName*string

emailstring

mobileNumber*integer (int32)

password*string

confirmPassword*string

avatarstring

mailStatus*integer (int32)

status*integer (int32)

commissioninteger (int32)

companyNamestring

companyLocationstring

companyLogostring

companyCoverImagestring

companyDescriptionstring

companyAddress1string

companyAddress2string

companyCitystring

companyStatestring

companyCountryIdinteger (int32)

pincodeinteger (int32)

companyMobileNumberinteger (int32)

companyEmailIdstring

companyWebsitestring

companyTaxNumberstring

companyPanNumberstring

paymentInformationstring

vendorGroupId*integer (int32)

instagramstring

twitterstring

youtubestring

facebookstring

displayNameUrlstring

Response

200400

Success response

Body

application/xmlapplication/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/admin-vendor ', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "confirmPassword": "text",
      "firstName": "text",
      "lastName": "text",
      "password": "text"
    }),
});
const data = await response.json();

Response

{
  "message": "Successfully created new vendor with email Id and password and email sent.\"or\" Vendor Created Successfully."
}

Update Vendor

Updates a Vendor

PUT/admin-vendor/{id}

Path parameters

id*integer

Header parameters

Body

application/x-www-form-urlencoded

firstName*string

lastName*string

mobileNumber*integer (int32)

avatarstring

mailStatus*integer (int32)

status*integer (int32)

approvalFlaginteger (int32)

commissioninteger (int32)

companyNamestring

companyLogostring

companyCoverImagestring

companyDescriptionstring

companyAddress1string

companyAddress2string

companyCitystring

companyStatestring

companyCountryIdinteger (int32)

pincodeinteger (int32)

companyMobileNumberinteger (int32)

companyEmailIdstring

companyWebsitestring

companyTaxNumberstring

companyPanNumberstring

paymentInformationstring

vendorGroupId*integer (int32)

instagramstring

twitterstring

youtubestring

facebookstring

displayNameUrlstring

Response

200400

Success response

Body

application/xmlapplication/json

statusinteger

messagestring

dataobject

Request

JavaScriptCurl

const response = await fetch('/admin-vendor/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "firstName": "text",
      "lastName": "text"
    }),
});
const data = await response.json();

Response

{
  "message": "Vendor Updated Successfully.",
  "data": {
    "createdDate": "2024-04-28T22:13:48.747Z",
    "modifiedDate": "2024-04-28T22:13:48.747Z",
    "firstName": "text",
    "lastName": "text",
    "username": "text",
    "password": "text",
    "email": "text",
    "mobileNumber": "text",
    "address": "text",
    "zoneId": "text",
    "city": "text",
    "local": "text",
    "oauthData": "text",
    "avatar": "text",
    "newsletter": "text",
    "avatarPath": "text",
    "lastLogin": "2024-04-28T22:13:48.747Z",
    "ip": "text",
    "pincode": "text",
    "forgetPasswordKey": "text",
    "linkExpires": "2024-04-28T22:13:48.747Z",
    "lockedOn": "text"
  }
}

Delete single Vendor

Deletes a single Vendor

DELETE/admin-vendor/{id}

Path parameters

id*integer (int32)

Header parameters

Response

200400

Success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/admin-vendor/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Vendor Deleted Successfully"
}

Vendor Excel

Dowloads Vendor list -Excel

GET/admin-vendor/vendor-excel-list

Query parameters

Response

200

Success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/admin-vendor/vendor-excel-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Downloading Excel File...!"
}

Vendor Details

Gets a Vendor Detail

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

Path parameters

id*integer (int32)

Header parameters

Response

200

Success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/admin-vendor/vendor-details/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "successfully got Vendor details."
}

Vendor Approval

Approval For a Vendor

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

Path parameters

id*integer (int32)

Header parameters

Body

application/x-www-form-urlencoded

approvalFlaginteger (int32)

Response

200400

Success response

Body

application/json

statusinteger

messagestring

dataobject

Request

JavaScriptCurl

const response = await fetch('/admin-vendor/approve-vendor/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "message": "Vendor Approved and email has been sent to the Vendor with Login credentials.",
  "data": {
    "createdDate": "2024-04-28T22:13:48.747Z",
    "modifiedDate": "2024-04-28T22:13:48.747Z",
    "vendorPrefixId": "text",
    "contactPersonName": "text",
    "vendorSlugName": "text",
    "designation": "text",
    "companyName": "text",
    "companyAddress1": "text",
    "companyAddress2": "text",
    "companyCity": "text",
    "companyState": "text",
    "companyDescription": "text",
    "companyMobileNumber": "text",
    "companyEmailId": "text",
    "companyWebsite": "text",
    "companyTaxNumber": "text",
    "companyPanNumber": "text",
    "companyLogo": "text",
    "companyLogoPath": "text",
    "paymentInformation": "text",
    "approvalDate": "2024-04-28T22:13:48.747Z",
    "companyCoverImage": "text",
    "companyCoverImagePath": "text",
    "displayNameUrl": "text",
    "instagram": "text",
    "twitter": "text",
    "youtube": "text",
    "facebook": "text"
  }
}

Delete Multiple Vendor

Deletes Multiple Vendor

POST/admin-vendor/delete-multiple-vendor

Header parameters

Body

application/x-www-form-urlencoded

vendorId*string

Response

200400

Success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/admin-vendor/delete-multiple-vendor', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "vendorId": "text"
    }),
});
const data = await response.json();

Response

{
  "message": "Successfully deleted the vendor"
}

Update Vendor Commission

Updates a Vendor-Commision

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

Path parameters

vendorId*integer (int32)

Header parameters

Body

application/x-www-form-urlencoded

commission*string

Response

200400

Success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/admin-vendor/update-vendor-commission/{vendorId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "commission": "text"
    }),
});
const data = await response.json();

Response

{
  "message": "Successfully Updated the Vendor Commission."
}

Verify Customer Document

To Verify Costumer document

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

Path parameters

customerDocumentId*integer

Header parameters

Body

application/x-www-form-urlencoded

documentStatus*integer (int32)

Response

200400

Success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/admin-vendor/verify-customer-document/{customerDocumentId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "message": "Successfully verified the customer document."
}

Get Customer Document

Gets Customer Documents

GET/admin-vendor/customer-document-list

Query parameters

Header parameters

Response

200

Success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/admin-vendor/customer-document-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "successfully list the customer document"
}

Download Customer Document

Downloads a Customer Document

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

Path parameters

customerDocumentId*integer (int32)

Header parameters

Response

200400

Success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/admin-vendor/download-customer-document/{customerDocumentId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "text"
}

Vendor Count

Gets Vendor Count

GET/admin-vendor/vendor-count

Header parameters

Response

200

Success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/admin-vendor/vendor-count', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully got the vendor count"
}

Update Vendor Name Slug

Updates Vendor slug Name

PUT/admin-vendor/update-vendor-slug

Response

200

Success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/admin-vendor/update-vendor-slug', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully updated the vendor slug."
}

Check Vendor Display Name

Checks Vendor Display name

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

Header parameters

Body

application/x-www-form-urlencoded

vendorIdinteger (int32)

displayNameURL*string

Response

200400

Success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/admin-vendor/check-display-name-url', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "displayNameURL": "text"
    }),
});
const data = await response.json();

Response

{
  "message": "Display name available"
}

Plugin

Gets Plugin list

GET/admin-vendor/get-addons

Query parameters

Response

200400

Success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/admin-vendor/get-addons', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully got the list"
}