Ctrlk
DocumentAPI ReferenceAdd-ons
For the complete documentation index, see llms.txt. This page is also available as Markdown.
ChatGPT

Manage Products

Vendor product list.

get

Get list of vendor product.

Query parameters
limitintegerOptional
offsetintegerOptional
statusstringOptional
vendorIdstringOptional
keywordstringOptional
pricestringOptional
countintegerOptional
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptional
messagestringOptionalDefault: Successfully got Vendor Product list.
get/admin-vendor-product
GET /admin-vendor-product HTTP/1.1
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully got Vendor Product list."
}

Update product commission

put

Update a commission of product.

Header parameters
AuthorizationstringRequired
Body
productIdstringRequired
commissioninteger · int32Required
Responses
200

success response

application/json
statusintegerOptional
messagestringOptionalDefault: Successfully Updated the Commission.
put/admin-vendor-product
PUT /admin-vendor-product HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 35

"productId='text'&commission=1"
{
  "status": 1,
  "message": "Successfully Updated the Commission."
}

Create vendor product

post

add a vendor product.

Header parameters
AuthorizationstringRequired
Body
productNamestringOptional
productDescriptionstringOptional
skustringOptional
upcstringOptional
hsnstringOptional
productSlugstringOptional
quantityintegerOptional
categoryIdinteger[]Optional
imagestringOptional
priceintegerOptional
outOfStockStatusintegerOptional
requiredShippingintegerOptional
dateAvailablestringOptional
sortOrderintegerOptional
defaultImageintegerOptional
relatedProductIdstringOptional
packingCostintegerOptional
shippingCostintegerOptional
taxintegerOptional
taxTypeintegerOptional
othersintegerOptional
vendorProductCommissionintegerOptional
productDiscountinteger[]Optional
productSpecialinteger[]Optional
tirePricesinteger[]Optional
hasTirePriceintegerOptional
quotationAvailableintegerOptional
vendorIdintegerOptional
heightstringOptional
weightstringOptional
widthstringOptional
lengthstringOptional
Responses
200

success response

application/json
namestringOptional
descriptionstringOptional
productSlugstringOptional
skustringOptional
upcstringOptional
hsnstringOptional
quantityinteger · int32Optional
serviceChargesstringOptional
priceinteger · int32Optional
taxTypeinteger · int32Optional
taxValueinteger · int32Optional
stockStatusIdinteger · int32Optional
quotationAvailableinteger · int32Optional
shippinginteger · int32Optional
dateAvailablestring · date-timeOptional
skuIdinteger · int32Optional
hasTirePriceinteger · int32Optional
isActiveinteger · int32Optional
isFeaturedinteger · int32Optional
todayDealsinteger · int32Optional
sortOrderinteger · int32Optional
heightstringOptional
weightstringOptional
lengthstringOptional
widthstringOptional
keywordsstringOptional
ownerinteger · int32Optional
createdByinteger · int32Optional
createdDatestring · date-timeOptional
productIdinteger · int32Optional
isSimplifiedinteger · int32Optional
modifiedDatestring · date-timeOptional
post/admin-vendor-product
POST /admin-vendor-product HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 611

"productName='text'&productDescription='text'&sku='text'&upc='text'&hsn='text'&productSlug='text'&quantity=1&categoryId=[1]&image='text'&price=1&outOfStockStatus=1&requiredShipping=1&dateAvailable='text'&sortOrder=1&defaultImage=1&relatedProductId='text'&packingCost=1&shippingCost=1&tax=1&taxType=1&others=1&vendorProductCommission=1&productDiscount=[1]&productSpecial=[1]&tirePrices=[1]&hasTirePrice=1&quotationAvailable=1&vendorId=1&productVideo=[{'name':'text','path':'text','type':1}]&height='text'&weight='text'&width='text'&length='text'"
{
  "name": "text",
  "description": "text",
  "productSlug": "text",
  "sku": "text",
  "upc": "text",
  "hsn": "text",
  "quantity": 1,
  "serviceCharges": "text",
  "price": 1,
  "taxType": 1,
  "taxValue": 1,
  "stockStatusId": 1,
  "quotationAvailable": 1,
  "shipping": 1,
  "dateAvailable": "2026-01-01T00:00:00.000Z",
  "skuId": 1,
  "hasTirePrice": 1,
  "isActive": 1,
  "isFeatured": 1,
  "todayDeals": 1,
  "sortOrder": 1,
  "height": "text",
  "weight": "text",
  "length": "text",
  "width": "text",
  "keywords": "text",
  "owner": 1,
  "createdBy": 1,
  "createdDate": "2026-01-01T00:00:00.000Z",
  "productId": 1,
  "isSimplified": 1,
  "modifiedDate": "2026-01-01T00:00:00.000Z"
}

Update vendor product

put

Update a vendor product

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Body
productNamestringOptional
productDescriptionstringOptional
skustringOptional
upcstringOptional
hsnstringOptional
productSlugstringOptional
quantityintegerOptional
categoryIdinteger[]Optional
imagestringOptional
priceintegerOptional
outOfStockStatusintegerOptional
requiredShippingintegerOptional
dateAvailablestringOptional
sortOrderintegerOptional
defaultImageintegerOptional
relatedProductIdstringOptional
packingCostintegerOptional
shippingCostintegerOptional
taxintegerOptional
taxTypeintegerOptional
othersintegerOptional
vendorProductCommissionintegerOptional
productDiscountinteger[]Optional
productSpecialinteger[]Optional
tirePricesinteger[]Optional
hasTirePriceintegerOptional
quotationAvailableintegerOptional
vendorIdintegerOptional
heightstringOptional
weightstringOptional
widthstringOptional
lengthstringOptional
Responses
200

success response

application/json
statusintegerOptional
messagestringOptionalDefault: Successfully updated the Vendor Product.
put/admin-vendor-product/{id}
PUT /admin-vendor-product/{id} HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 611

"productName='text'&productDescription='text'&sku='text'&upc='text'&hsn='text'&productSlug='text'&quantity=1&categoryId=[1]&image='text'&price=1&outOfStockStatus=1&requiredShipping=1&dateAvailable='text'&sortOrder=1&defaultImage=1&relatedProductId='text'&packingCost=1&shippingCost=1&tax=1&taxType=1&others=1&vendorProductCommission=1&productDiscount=[1]&productSpecial=[1]&tirePrices=[1]&hasTirePrice=1&quotationAvailable=1&vendorId=1&productVideo=[{'name':'text','path':'text','type':1}]&height='text'&weight='text'&width='text'&length='text'"
{
  "status": 1,
  "message": "Successfully updated the Vendor Product."
}

Vendor product detail

get

List of vendor product detail.

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptional
messagestringOptionalDefault: Successfully get productDetail
get/admin-vendor-product/vendor-product-detail/{id}
GET /admin-vendor-product/vendor-product-detail/{id} HTTP/1.1
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully get productDetail"
}

Bulk vendor product excel list

get

Get excel list of vendor product

Query parameters
statusstringOptional
productTypeintegerOptional
vendorIdintegerOptional
keywordstringOptional
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptional
messagestringOptionalDefault: Successfully got the vendor product excel list.
get/admin-vendor-product/bulk-vendor-product-excel-list
GET /admin-vendor-product/bulk-vendor-product-excel-list HTTP/1.1
Authorization: text
Accept: */*
200

success response

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

Vendor product excel list.

get

Get list of vendor product excel list.

Query parameters
productIdstringOptional
Header parameters
AuthorizationstringRequired
Responses
400

error response

*/*
statusintegerOptional
messagestringOptionalDefault: Invalid productId
get/admin-vendor-product/vendor-product-excel-list
GET /admin-vendor-product/vendor-product-excel-list HTTP/1.1
Authorization: text
Accept: */*
400

error response

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

Update vendor product approval

put

Update a vendor product approval.

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Body
approvalFlaginteger · int32Optional
Responses
200

success response

application/json
createdByinteger · int32Optional
createdDatestring · date-timeOptional
modifiedByinteger · int32Optional
modifiedDatestring · date-timeOptional
vendorProductIdinteger · int32Optional
productIdinteger · int32Optional
vendorIdinteger · int32Optional
approvalFlaginteger · int32Optional
quotationAvailableinteger · int32Optional
approvedByinteger · int32Optional
approvedDatestring · date-timeOptional
vendorProductCommissioninteger · int32Optional
pincodeBasedDeliveryinteger · int32Optional
sku_idinteger · int32Optional
reuseinteger · int32Optional
reuseStatusinteger · int32Optional
approvalDatestring · date-timeOptional
put/admin-vendor-product/approve-product/{id}
PUT /admin-vendor-product/approve-product/{id} HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 18

"approvalFlag=1"
{
  "createdBy": 1,
  "createdDate": "2026-01-01T00:00:00.000Z",
  "modifiedBy": 1,
  "modifiedDate": "2026-01-01T00:00:00.000Z",
  "vendorProductId": 1,
  "productId": 1,
  "vendorId": 1,
  "approvalFlag": 1,
  "quotationAvailable": 1,
  "approvedBy": 1,
  "approvedDate": "2026-01-01T00:00:00.000Z",
  "vendorProductCommission": 1,
  "pincodeBasedDelivery": 1,
  "sku_id": 1,
  "reuse": 1,
  "reuseStatus": 1,
  "approvalDate": "2026-01-01T00:00:00.000Z"
}

Add product status

put

Add a status of product.

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Body
statusinteger · int32Required
Responses
200

success response

application/json
createdByinteger · int32Optional
createdDatestring · date-timeOptional
modifiedByinteger · int32Optional
modifiedDatestring · date-timeOptional
productIdinteger · int32Optional
skustringOptional
upcstringOptional
hsnstringOptional
locationstringOptional
quantityinteger · int32Optional
minimumQuantityinteger · int32Optional
subtractStockinteger · int32Optional
stockStatusIdinteger · int32Optional
quotationAvailableinteger · int32Optional
imagestringOptional
imagePathstringOptional
manufacturerIdinteger · int32Optional
shippinginteger · int32Optional
serviceChargesstringOptional
taxTypeinteger · int32Optional
taxValueinteger · int32Optional
pricestringOptional
priceUpdateFileLogIdinteger · int32Optional
dateAvailablestringOptional
sortOrderinteger · int32Optional
namestringOptional
descriptionstringOptional
amountstringOptional
keywordsstringOptional
discountstringOptional
deleteFlaginteger · int32Optional
isFeaturedinteger · int32Optional
todayDealsinteger · int32Optional
conditionstringOptional
ratingstringOptional
wishListStatusinteger · int32Optional
productSlugstringOptional
isActiveinteger · int32Optional
widthstringOptional
heightstringOptional
lengthstringOptional
weightstringOptional
hasStockinteger · int32Optional
isSimplifiedinteger · int32Optional
ownerinteger · int32Optional
isCommoninteger · int32Optional
skuIdinteger · int32Optional
hasTirePriceinteger · int32Optional
outOfStockThresholdinteger · int32Optional
notifyMinQuantityinteger · int32Optional
minQuantityAllowedCartinteger · int32Optional
maxQuantityAllowedCartinteger · int32Optional
enableBackOrdersinteger · int32Optional
pincodeBasedDeliveryinteger · int32Optional
attributeKeywordstringOptional
settedAsCommonOninteger · int32Optional
put/admin-vendor-product/add-product-status/{id}
PUT /admin-vendor-product/add-product-status/{id} HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 12

"status=1"
{
  "createdBy": 1,
  "createdDate": "2026-01-01T00:00:00.000Z",
  "modifiedBy": 1,
  "modifiedDate": "2026-01-01T00:00:00.000Z",
  "productId": 1,
  "sku": "text",
  "upc": "text",
  "hsn": "text",
  "location": "text",
  "quantity": 1,
  "minimumQuantity": 1,
  "subtractStock": 1,
  "stockStatusId": 1,
  "quotationAvailable": 1,
  "image": "text",
  "imagePath": "text",
  "manufacturerId": 1,
  "shipping": 1,
  "serviceCharges": "text",
  "taxType": 1,
  "taxValue": 1,
  "price": "text",
  "priceUpdateFileLogId": 1,
  "dateAvailable": "text",
  "sortOrder": 1,
  "name": "text",
  "description": "text",
  "amount": "text",
  "keywords": "text",
  "discount": "text",
  "deleteFlag": 1,
  "isFeatured": 1,
  "todayDeals": 1,
  "condition": "text",
  "rating": "text",
  "wishListStatus": 1,
  "productSlug": "text",
  "isActive": 1,
  "width": "text",
  "height": "text",
  "length": "text",
  "weight": "text",
  "hasStock": 1,
  "isSimplified": 1,
  "owner": 1,
  "isCommon": 1,
  "skuId": 1,
  "hasTirePrice": 1,
  "outOfStockThreshold": 1,
  "notifyMinQuantity": 1,
  "minQuantityAllowedCart": 1,
  "maxQuantityAllowedCart": 1,
  "enableBackOrders": 1,
  "pincodeBasedDelivery": 1,
  "attributeKeyword": "text",
  "settedAsCommonOn": 1
}

Vendor product count

get

Get count of vendor product.

Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptional
messagestringOptionalDefault: Successfully got the vendor product count
get/admin-vendor-product/vendor-product-count
GET /admin-vendor-product/vendor-product-count HTTP/1.1
Authorization: text
Accept: */*
200

success response

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

Last updated