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

Common Product

vendor related specifics are not applicable for single vendor set up

Admin

Get product list of common catalog

get

This is for getting product list of common catalog.

Query parameters
limitintegerOptional
offsetintegerOptional
ownerintegerOptional
countintegerOptional
keywordstringOptional
Header parameters
authorizationstringOptional
Responses
200

success response

*/*
statusintegerOptionalDefault: 1
messagestringOptionalDefault: Successfully got the common catalog product list count " or " Successfully got the common catalog product list
get/admin-common-product
GET /admin-common-product HTTP/1.1
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully got the common catalog product list count \" or \" Successfully got the common catalog product list"
}

Set as common products

post

This is for set the common product.

Header parameters
authorizationstringRequired
Body
productIdstringRequired
commoninteger · int32Required
Responses
200

successfully got the product rating

application/json
createdByinteger · int64Optional
createdDatestring · date-timeOptional
modifiedByinteger · int64Optional
modifiedDatestring · date-timeOptional
productIdinteger · int64Optional
skustringOptional
upcstringOptional
hsnstringOptional
locationstringOptional
quantityinteger · int64Optional
minimumQuantityinteger · int64Optional
subtractStockinteger · int64Optional
stockStatusIdinteger · int64Optional
quotationAvailableinteger · int64Optional
imagestringOptional
imagePathstringOptional
manufacturerIdinteger · int64Optional
shippinginteger · int64Optional
serviceChargesstringOptional
taxTypeinteger · int64Optional
taxValueinteger · int64Optional
pricestringOptional
priceUpdateFileLogIdinteger · int64Optional
dateAvailablestring · date-timeOptional
sortOrderinteger · int64Optional
namestringOptional
descriptionstringOptional
amountinteger · int64Optional
metaTagTitlestringOptional
metaTagDescriptionstringOptional
metaTagKeywordstringOptional
keywordsstringOptional
discountinteger · int64Optional
deleteFlaginteger · int64Optional
isFeaturedinteger · int64Optional
todayDealsinteger · int64Optional
conditioninteger · int64Optional
ratinginteger · int64Optional
wishListStatusinteger · int64Optional
productSlugstringOptional
isActiveinteger · int64Optional
widthstringOptionalDefault: 0.00
heightstringOptionalDefault: 0.00
lengthstringOptionalDefault: 0.00
weightstringOptionalDefault: 0.00
hasStockinteger · int64Optional
isSimplifiedinteger · int64Optional
ownerinteger · int64Optional
isCommonstringOptional
skuIdinteger · int64Optional
hasTirePriceinteger · int64Optional
outOfStockThresholdinteger · int64Optional
notifyMinQuantityinteger · int64Optional
minQuantityAllowedCartinteger · int64Optional
maxQuantityAllowedCartinteger · int64Optional
enableBackOrdersinteger · int64Optional
pincodeBasedDeliveryinteger · int64Optional
attributeKeywordstringOptional
post/admin-common-product
POST /admin-common-product HTTP/1.1
authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 31

"productId='text'&common=1"
200

successfully got the product rating

{
  "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": "2026-01-01T00:00:00.000Z",
  "sortOrder": 1,
  "name": "text",
  "description": "text",
  "amount": 1,
  "metaTagTitle": "text",
  "metaTagDescription": "text",
  "metaTagKeyword": "text",
  "keywords": "text",
  "discount": 1,
  "deleteFlag": 1,
  "isFeatured": 1,
  "todayDeals": 1,
  "condition": 1,
  "rating": 1,
  "wishListStatus": 1,
  "productSlug": "text",
  "isActive": 1,
  "width": "0.00",
  "height": "0.00",
  "length": "0.00",
  "weight": "0.00",
  "hasStock": 1,
  "isSimplified": 1,
  "owner": 1,
  "isCommon": "text",
  "skuId": 1,
  "hasTirePrice": 1,
  "outOfStockThreshold": 1,
  "notifyMinQuantity": 1,
  "minQuantityAllowedCart": 1,
  "maxQuantityAllowedCart": 1,
  "enableBackOrders": 1,
  "pincodeBasedDelivery": 1,
  "attributeKeyword": "text"
}

Update a common product

put

This for update a common product.

Path parameters
idintegerRequired
Header parameters
authorizationstringOptional
Body
commoninteger · int32Required
Responses
200

successfully got the product rating

application/json
createdByinteger · int64Optional
createdDatestring · date-timeOptional
modifiedByinteger · int64Optional
modifiedDatestring · date-timeOptional
productIdinteger · int64Optional
skustringOptional
upcstringOptional
hsnstringOptional
locationstringOptional
quantityinteger · int64Optional
minimumQuantityinteger · int64Optional
subtractStockinteger · int64Optional
stockStatusIdinteger · int64Optional
quotationAvailableinteger · int64Optional
imagestringOptional
imagePathstringOptional
manufacturerIdinteger · int64Optional
shippinginteger · int64Optional
serviceChargesstringOptional
taxTypeinteger · int64Optional
taxValueinteger · int64Optional
pricestringOptional
priceUpdateFileLogIdinteger · int64Optional
dateAvailablestring · date-timeOptional
sortOrderinteger · int64Optional
namestringOptional
descriptionstringOptional
amountinteger · int64Optional
metaTagTitlestringOptional
metaTagDescriptionstringOptional
metaTagKeywordstringOptional
keywordsstringOptional
discountinteger · int64Optional
deleteFlaginteger · int64Optional
isFeaturedinteger · int64Optional
todayDealsinteger · int64Optional
conditioninteger · int64Optional
ratinginteger · int64Optional
wishListStatusinteger · int64Optional
productSlugstringOptional
isActiveinteger · int64Optional
widthstringOptionalDefault: 0.00
heightstringOptionalDefault: 0.00
lengthstringOptionalDefault: 0.00
weightstringOptionalDefault: 0.00
hasStockinteger · int64Optional
isSimplifiedinteger · int64Optional
ownerinteger · int64Optional
isCommoninteger · int64Optional
skuIdinteger · int64Optional
hasTirePriceinteger · int64Optional
outOfStockThresholdinteger · int64Optional
notifyMinQuantityinteger · int64Optional
minQuantityAllowedCartinteger · int64Optional
maxQuantityAllowedCartinteger · int64Optional
enableBackOrdersinteger · int64Optional
pincodeBasedDeliveryinteger · int64Optional
attributeKeywordstringOptional
put/admin-common-product/:id
PUT /admin-common-product/:id HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 12

"common=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": "2026-01-01T00:00:00.000Z",
  "sortOrder": 1,
  "name": "text",
  "description": "text",
  "amount": 1,
  "metaTagTitle": "text",
  "metaTagDescription": "text",
  "metaTagKeyword": "text",
  "keywords": "text",
  "discount": 1,
  "deleteFlag": 1,
  "isFeatured": 1,
  "todayDeals": 1,
  "condition": 1,
  "rating": 1,
  "wishListStatus": 1,
  "productSlug": "text",
  "isActive": 1,
  "width": "0.00",
  "height": "0.00",
  "length": "0.00",
  "weight": "0.00",
  "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"
}

List of a common product

get

This is for list of a common product.

Query parameters
limitintegerOptional
offsetintegerOptional
productIdintegerOptional
countintegerOptional
Header parameters
authorizationstringOptional
Responses
200

success response

*/*
statusintegerOptionalDefault: 1
messagestringOptionalDefault: Successfully got the Vendor Product List Count " or " Successfully got the Vendor Product List
get/admin-common-product/get-related-vendors
GET /admin-common-product/get-related-vendors HTTP/1.1
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully got the Vendor Product List Count \" or \" Successfully got the Vendor Product List"
}

update a common product status

put

This for update a already added common product status.

Path parameters
idintegerRequired
Header parameters
authorizationstringRequired
Body
reuseStatusinteger · int32Required
Responses
200

Successfully updated reuse status.

application/json
createdByinteger · int64Optional
createdDatestring · date-timeOptional
modifiedByinteger · int64Optional
modifiedDatestring · date-timeOptional
vendorProductIdinteger · int64Optional
productIdinteger · int64Optional
vendorIdinteger · int64Optional
approvalFlaginteger · int64Optional
quotationAvailableinteger · int64Optional
approvedByinteger · int64Optional
approvedDatestring · date-timeOptional
vendorProductCommissioninteger · int64Optional
pincodeBasedDeliveryinteger · int64Optional
sku_idinteger · int64Optional
reuseinteger · int64Optional
reuseStatusinteger · int64Optional
put/admin-common-product/update-reuse-status/{id} 
PUT /admin-common-product/update-reuse-status/{id}  HTTP/1.1
authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 17

"reuseStatus=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
}

Get count of admin common product

get

This is for count the admin common product.

Header parameters
authorizationstringOptional
Responses
200

success response

*/*
statusintegerOptionalDefault: 1
messagestringOptionalDefault: Successfully got the common products count
get/admin-common-product/common-product-count
GET /admin-common-product/common-product-count HTTP/1.1
Accept: */*
200

success response

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

List of common product

get

This is for getting the common product list.

Path parameters
productSlugstringRequired
Query parameters
limitintegerOptional
offsetintegerOptional
countintegerOptional
Responses
200

success response

*/*
statusintegerOptionalDefault: 1
messagestringOptionalDefault: Successfully got the count " or " Successfully got the Product List
get/store-common-product/common-product-list/{productSlug}
GET /store-common-product/common-product-list/{productSlug} HTTP/1.1
Accept: */*

{
  "status": 1,
  "message": "Successfully got the count \" or \" Successfully got the Product List"
}

Count of vendor common catalog

get

This is for count of vendor common catalog.

Path parameters
productIdstringRequired
Responses
200

success response

*/*
statusintegerOptionalDefault: 1
messagestringOptionalDefault: Successfully got vendor count
get/store-common-product/vendor-count/{productId}
GET /store-common-product/vendor-count/{productId} HTTP/1.1
Accept: */*

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

List of common vendor product

get

This is for getting list of Common vendor product.

Query parameters
limitintegerOptional
offsetintegerOptional
countintegerOptional
keywordintegerOptional
addedProductsintegerOptional
Header parameters
authorizationstringRequired
Responses
200

success response

*/*
statusintegerOptionalDefault: 1
messagestringOptionalDefault: ""
get/vendor-common-product/common-product-list
GET /vendor-common-product/common-product-list HTTP/1.1
authorization: text
Accept: */*
200

success response

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

Add and update common vendor product

post

This for add and update the common vendor product.

Header parameters
authorizationstringRequired
Body
productIdinteger · int32Optional
skustringOptional
pricestringOptional
quantityinteger · int32Optional
Responses
200

successfully got the responses

application/json
createdByinteger · int64Optional
createdDatestring · date-timeOptional
modifiedByinteger · int64Optional
modifiedDatestring · date-timeOptional
vendorProductIdinteger · int64Optional
productIdinteger · int64Optional
vendorIdinteger · int64Optional
approvalFlaginteger · int64Optional
quotationAvailableinteger · int64Optional
approvedByinteger · int64Optional
approvedDatestring · date-timeOptional
vendorProductCommissioninteger · int64Optional
pincodeBasedDeliveryinteger · int64Optional
sku_idinteger · int64Optional
reuseinteger · int64Optional
reuseStatusinteger · int64Optional
post/vendor-common-product/set-vendor-common-product
POST /vendor-common-product/set-vendor-common-product HTTP/1.1
authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 56

"productId=1&sku='text'&price='text'&quantity=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
}

Delete the vendor common product

delete

This is for delete the vendor common product.

Path parameters
productIdintegerRequired
Header parameters
authorizationstringRequired
Responses
200

successfully got the responses

*/*
statusintegerOptionalDefault: 1
messagestringOptionalDefault: Successfully deleted the vendor common product.
delete/vendor-common-product/delete/vendor-common-product/{productId}
DELETE /vendor-common-product/delete/vendor-common-product/{productId} HTTP/1.1
authorization: text
Accept: */*

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

Last updated