Seller

Get vendor list

get
/admin-vendor

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
chevron-right
200

Successfully retrieved vendor list

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully got seller list
get
/admin-vendor

Create a new vendor

post
/admin-vendor

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: [email protected]
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
chevron-right
200

Successfully created new vendor with email Id and password and email sent

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully created new vendor with email Id and password and email sent
post
/admin-vendor

Get site settings

get
/settings

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
chevron-right
200

Successfully retrieved settings

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully got settings
get
/settings

Get vendor group list

get
/vendor-group

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
chevron-right
200

Successfully retrieved vendor group list

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully got all seller group List
get
/vendor-group

Get industry list

get
/list/industry

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
chevron-right
200

Successfully retrieved industry list

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully got industry list
get
/list/industry

Get vendor document list

get
/admin-vendor/master/document

Retrieves the list of documents associated with vendors.

Responses
chevron-right
200

Successfully retrieved the document list

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully got documents list
get
/admin-vendor/master/document

Check if a vendor display name URL is available

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

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
chevron-right
200

Successfully checked the display name availability

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Display name available
post
/admin-vendor/check-display-name-url

Get vendor details

get
/admin-vendor/{id}

Retrieves the details of a specific vendor by their ID

Path parameters
idintegerRequired

ID of the vendor

Responses
chevron-right
200

Successfully retrieved vendor details

*/*
statusintegerOptional
messagestringOptional
get
/admin-vendor/{id}

Update seller details

put
/admin-vendor/{id}

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: [email protected]
companyTaxNumberstringOptionalExample: 34543543
companyAccountHolderNamestringOptionalExample: sdsdgs
companyAccountNumberstringOptionalExample: 43543543553453
companyAccountBranchstringOptionalExample: sfs
companyAccountCreatedOnstringOptionalExample: 43535
companyAccountBankNamestringOptionalExample: sgf
companyAccountBicstringOptionalExample: sds
ifscCodestringOptionalExample: sdf435
industryIdintegerOptionalExample: 1
companyBusinessNumberstringOptionalExample: 4254252
zoneIdintegerOptionalExample: 76
statestringOptional
Responses
chevron-right
200

Successfully updated seller details

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Seller Updated Successfully
put
/admin-vendor/{id}

Delete seller

delete
/admin-vendor/{id}

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
chevron-right
200

Successfully deleted seller

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Seller Deleted Successfully
delete
/admin-vendor/{id}

Get vendor products

get
/admin-vendor-product

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
chevron-right
200

Successfully retrieved vendor products

*/*
statusintegerOptional
messagestringOptional
get
/admin-vendor-product
200

Successfully retrieved vendor products

Get vendor settings

get
/vendor-setting/get-vendor-settings

Retrieves the settings for a specific vendor

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved vendor settings

*/*
statusintegerOptional
messagestringOptional
get
/vendor-setting/get-vendor-settings

Update vendor commission

put
/admin-vendor/update-vendor-commission/{id}

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
chevron-right
200

Successfully updated the vendor commission

*/*
statusintegerOptional
messagestringOptional
put
/admin-vendor/update-vendor-commission/{id}

Get seller group count

get
/vendor-group/vendor-group-count

Retrieves the count of all seller groups

Responses
chevron-right
200

Successfully retrieved the seller group count

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully got the seller group count
get
/vendor-group/vendor-group-count

Get vendor category list

get
/category

Retrieves the list of vendor categories with optional filters

Query parameters
limitintegerOptional

Number of categories to return

offsetintegerOptional

The offset for pagination

countintegerOptional

Whether to return the count of categories

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved vendor category list

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully got the vendor category list.
get
/category

Get vendor group details

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

Retrieves the details of a specific vendor group by its ID

Path parameters
idintegerRequired

ID of the vendor group

Query parameters
idintegerRequired

ID of the vendor group

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved vendor group details

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully got seller group details
get
/vendor-group/vendor-group-details/{id}

Update vendor group

put
/vendor-group/{id}

Updates the details of a specific vendor group by its ID

Path parameters
idintegerRequired

ID of the vendor group

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
namestringOptionalExample: test
commissionstringOptionalExample: 3.00
categoryIdsinteger[]OptionalExample: [1424]
statusintegerOptionalExample: 1
groupIdstringOptionalExample: 39
Responses
chevron-right
200

Successfully updated vendor group

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Seller Group updated successfully
put
/vendor-group/{id}

Delete vendor group

delete
/vendor-group/{id}

Deletes a specific vendor group identified by its ID

Path parameters
idintegerRequired

ID of the vendor group to delete

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully deleted vendor group

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Seller group deleted successfully
delete
/vendor-group/{id}

Approve or Reject Vendor KYC

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

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
chevron-right
200

Successfully updated the vendor's KYC status and settings

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully Updated Seller Kyc Detail
put
/admin-vendor/approve-vendor/{id}

Update Vendor Status

put
/admin-vendor/status/{id}

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
chevron-right
200

Successfully updated vendor status

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully Updated Seller Status
put
/admin-vendor/status/{id}

Last updated