API Reference
Document API Reference Add-ons

Product

Get the list of products

This is for fetching the list of products.

GET/product
Query parameters
Header parameters
Response

success response

Body
statusinteger
messagestring
Request
const response = await fetch('/product', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "message": "Successfully got product lists count. \" or \" Successfully got the complete product list."
}

Add new product

This is for adding a new product.

POST/product
Header parameters
Body
productNamestring
productDescriptionstring
skustring
upcstring
hsnstring
productSlugstring
metaTagTitlestring
metaTagDescriptionstring
metaTagKeywordstring
categoryIdarray of integer (int32)
imagestring
pricestring
quantityinteger (int32)
outOfStockStatusinteger (int32)
requiredShippinginteger (int32)
dateAvailablestring
statusinteger (int32)
sortOrderinteger (int32)
quotationAvailableinteger (int32)
defaultImageinteger (int32)
relatedProductIdstring
packingCostinteger (int32)
shippingCoststring (int32)
taxinteger (int32)
taxTypeinteger (int32)
othersinteger (int32)
heightstring
weightstring
widthstring
lengthstring
hasTirePriceinteger (int32)
productDiscountarray of productDiscount (object)
productSpecialarray of productSpecial (object)
tirePricesarray of tirePrice (object)
productAttributearray of productArttribute (object)
productVideoarray of productVideo (object)
Response

success response

Body
namestring
descriptionstring
productSlugstring
skustring
upcstring
hsnstring
quantityinteger
quotationAvailableinteger
serviceChargesstring
pricestring
taxTypeinteger
taxValueinteger
stockStatusIdinteger
skuIdinteger
shippinginteger
dateAvailablestring
metaTagTitlestring
metaTagDescriptionstring
metaTagKeywordstring
isActiveinteger
isFeaturedinteger
todayDealsinteger
sortOrderinteger
heightstring
weightstring
lengthstring
widthstring
hasTirePriceinteger
keywordsstring
ownerinteger
createdByinteger
createdDatestring (date-time)
productIdinteger
isSimplifiedinteger
modifiedDatestring (date-time)
Request
const response = await fetch('/product', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{
  "name": "text",
  "description": "text",
  "productSlug": "text",
  "sku": "text",
  "upc": "text",
  "hsn": "text",
  "serviceCharges": "text",
  "price": "text",
  "dateAvailable": "text",
  "metaTagTitle": "text",
  "metaTagDescription": "text",
  "metaTagKeyword": "text",
  "height": "text",
  "weight": "text",
  "length": "text",
  "width": "text",
  "keywords": "text",
  "createdDate": "2024-04-29T03:38:41.335Z",
  "modifiedDate": "2024-04-29T03:38:41.335Z"
}

Update product

This is for updating an already added product.

POST/product/update-product/{id}
Path parameters
id*integer
Header parameters
Body
productIdinteger (int32)
productNamestring
productDescriptionstring
skustring
upcstring
hsnstring
productSlugstring
metaTagTitlestring
metaTagDescriptionstring
metaTagKeywordstring
categoryIdarray of integer (int32)
imagestring
pricestring
quantityinteger (int32)
outOfStockStatusinteger (int32)
requiredShippinginteger (int32)
dateAvailablestring
statusinteger (int32)
sortOrderinteger (int32)
quotationAvailableinteger (int32)
defaultImageinteger (int32)
relatedProductIdstring
packingCostinteger (int32)
shippingCoststring (int32)
taxinteger (int32)
taxTypeinteger (int32)
othersinteger (int32)
heightstring
weightstring
widthstring
lengthstring
hasTirePriceinteger (int32)
productDiscountarray of productDiscount (object)
productSpecialarray of productSpecial (object)
tirePricesarray of tirePrice (object)
productAttributearray of productArttribute (object)
productVideoarray of productVideo (object)
Response

success response

Body
createdByinteger
createdDatestring (date-time)
modifiedByinteger
modifiedDatestring (date-time)
productIdinteger
skustring
upcstring
hsnstring
locationstring
quantityinteger
minimumQuantityinteger
subtractStockinteger
stockStatusIdinteger
quotationAvailableinteger
imagestring
imagePathstring
manufacturerIdinteger
shippinginteger
serviceChargesstring
taxTypeinteger
taxValueinteger
pricestring
priceUpdateFileLogIdinteger
dateAvailablestring
sortOrderinteger
namestring
descriptionstring
amountstring
metaTagTitlestring
metaTagDescriptionstring
metaTagKeywordstring
keywordsstring
discountstring
deleteFlaginteger
isFeaturedinteger
todayDealsinteger
conditioninteger
ratinginteger
wishListStatusinteger
productSlugstring
isActiveinteger
widthstring
heightstring
lengthstring
weightstring
hasStockinteger
isSimplifiedinteger
ownerinteger
isCommoninteger
skuIdinteger
hasTirePriceinteger
outOfStockThresholdinteger
notifyMinQuantityinteger
minQuantityAllowedCartinteger
maxQuantityAllowedCartinteger
enableBackOrdersinteger
pincodeBasedDeliveryinteger
attributeKeywordstring
settedAsCommonOnstring
productCostinteger
packingCostinteger
shippingCostinteger
othersinteger
priceWithTaxinteger
productImagearray of updateProductImage (object)
Categoryarray of updateProductCategory (object)
productSpecialPricearray
productDiscountDataarray
productTirePricesarray
productVideoupdateProductVideo (object)
Request
const response = await fetch('/product/update-product/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{
  "createdDate": "2024-04-29T03:38:41.335Z",
  "modifiedDate": "2024-04-29T03:38:41.335Z",
  "sku": "text",
  "upc": "text",
  "hsn": "text",
  "location": "text",
  "image": "text",
  "imagePath": "text",
  "serviceCharges": "text",
  "price": "text",
  "dateAvailable": "text",
  "name": "text",
  "description": "text",
  "amount": "text",
  "metaTagTitle": "text",
  "metaTagDescription": "text",
  "metaTagKeyword": "text",
  "keywords": "text",
  "discount": "text",
  "productSlug": "text",
  "width": "text",
  "height": "text",
  "length": "text",
  "weight": "text",
  "attributeKeyword": "text",
  "settedAsCommonOn": "text",
  "productImage": [
    {
      "image": "text",
      "containerName": "text"
    }
  ],
  "Category": [
    {
      "createdDate": "2024-04-29T03:38:41.335Z",
      "modifiedDate": "2024-04-29T03:38:41.335Z",
      "name": "text",
      "image": "text",
      "imagePath": "text",
      "metaTagTitle": "text",
      "metaTagDescription": "text",
      "metaTagKeyword": "text",
      "categorySlug": "text",
      "isActive": "text",
      "categoryDescription": "text",
      "levels": "text"
    }
  ],
  "productSpecialPrice": [],
  "productDiscountData": [],
  "productTirePrices": [],
  "productVideo": {
    "name": "text"
  }
}

Product detail page

This is for getting the detail page of the product, after clicking on a product from the list page.

GET/product/product-detail/{id}
Path parameters
id*integer
Header parameters
Response

success response

Body
statusinteger
messagestring
Request
const response = await fetch('/product/product-detail/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "message": "Successfully get productDetail"
}

List of Top Selling Products

This is for fetching the list of Top Selling Products.

GET/product/top-selling-productlist
Header parameters
Response

success response

Body
statusinteger
messagestring
Request
const response = await fetch('/product/top-selling-productlist', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "message": "Successfully get Top Selling Product..!"
}

List of Top five repeating customers

This is for fetching the list of Top five repeating customers.

GET/product/top-five-repeatedly-purchased-customers
Header parameters
Response

success response

Body
statusinteger
messagestring
Request
const response = await fetch('/product/top-five-repeatedly-purchased-customers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "message": "Successfully got the top 5 repeatedly purchased customer..!"
}

List of Top performing products

This is for fetching the list of Top five performing products.

GET/product/top-performing-products
Query parameters
Header parameters
Response

success response

Body
statusinteger
messagestring
Request
const response = await fetch('/product/top-performing-products', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "message": "Successfully got the top performing product list"
}

Recently sold products

This is for getting the list of recently sold products.

GET/product/recent-selling-product
Header parameters
Response

success response

Body
statusinteger
messagestring
Request
const response = await fetch('/product/recent-selling-product', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "message": "successfully listed recently selling products..!"
}

View Log List

This is for viewing the log list in admin.

GET/product/viewLog-list
Query parameters
Header parameters
Response

success response

Body
statusinteger
messagestring
Request
const response = await fetch('/product/viewLog-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "message": "Successfully got view log count \" or \" Successfully got view log List"
}

Customer product view list

This is for getting the list of product views.

GET/product/customerProductView-list/{id}
Path parameters
id*integer
Query parameters
Header parameters
Response

success response

Body
statusinteger
messagestring
Request
const response = await fetch('/product/customerProductView-list/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "message": "Successfully got view log count \" or \" Successfully got view log List"
}

List of products in excel

This is for getting the list of products that are listed in the excel sheet.

GET/product/product-excel-list
Query parameters
Header parameters
Response

error response

Body
statusinteger
messagestring
Request
const response = await fetch('/product/product-excel-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "message": "Invalid productId"
}

All product excel sheet

This is for getting the list of all products that are listed, in the excel sheet.

GET/product/allproduct-excel-list
Header parameters
Response

error response

Body
statusinteger
messagestring
Request
const response = await fetch('/product/allproduct-excel-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "message": "Products are empty"
}

Delete an added product

This is for deleting an already added product, if not needed anymore.

DELETE/product/{id}
Path parameters
id*integer
Header parameters
Response

success response

Body
statusinteger
messagestring
Request
const response = await fetch('/product/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();
Response
{
  "message": "Successfully deleted the Product."
}

Delete multiple product

This

POST/product/delete-product
Header parameters
Body
productIdarray of integer (int32)
Response

success response

Body
statusinteger
messagestring
Request
const response = await fetch('/product/delete-product', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{
  "message": "Successfully deleted the Product"
}

Update slug for the product page

This is for updating the slug for the product page.

PUT/product/update-product-slug
Header parameters
Response

success response

Body
statusinteger
messagestring
Request
const response = await fetch('/product/update-product-slug', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();
Response
{
  "message": "Successfully updated the product slug."
}

Total product count

This is for getting the count for total products in the eCommerce portal.

GET/product/product-count
Header parameters
Response

success response

Body
statusinteger
messagestring
Request
const response = await fetch('/product/product-count', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "message": "successfully got the product count."
}

Import product data

This is for importing the product data into excel sheet.

POST/product/import-product-data
Header parameters
Body
file*string (binary)
Response

success response

Body
statusinteger
messagestring
Request
const response = await fetch('/product/import-product-data', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "file": "binary"
    }),
});
const data = await response.json();
Response
{
  "message": "Product Imported Successfully"
}

Download product sample

This is for downloading the product sample.

GET/product/download-product-sample
Header parameters
Response

success response

Body
statusinteger
messagestring
Request
const response = await fetch('/product/download-product-sample', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "message": "successfully downloaded the zip file"
}

Stock update

This is for updating the stock for a product.

POST/product/update-stock
Header parameters
Body
productIdinteger (int32)
hasStockinteger (int32)
productStockarray of arrayUpdateStock (object)
Response

success response

Body
createdByinteger
createdDatestring (date-time)
modifiedByinteger
modifiedDatestring (date-time)
productIdinteger
skustring
upcstring
hsnstring
locationstring
quantityinteger
minimumQuantityinteger
subtractStockinteger
stockStatusIdinteger
quotationAvailableinteger
imagestring
imagePathstring
manufacturerIdinteger
shippinginteger
serviceChargesstring
taxTypeinteger
taxValueinteger
pricestring
priceUpdateFileLogIdinteger
dateAvailablestring
sortOrderinteger
namestring
descriptionstring
amountstring
metaTagTitlestring
metaTagDescriptionstring
metaTagKeywordstring
keywordsstring
discountstring
deleteFlaginteger
isFeaturedinteger
todayDealsinteger
conditioninteger
ratinginteger
wishListStatusinteger
productSlugstring
isActiveinteger
widthstring
heightstring
lengthstring
weightstring
hasStockinteger
isSimplifiedinteger
ownerinteger
isCommoninteger
skuIdinteger
hasTirePriceinteger
outOfStockThresholdstring
notifyMinQuantityinteger
minQuantityAllowedCartinteger
maxQuantityAllowedCartinteger
enableBackOrdersinteger
pincodeBasedDeliveryinteger
attributeKeywordstring
settedAsCommonOnstring
Request
const response = await fetch('/product/update-stock', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{
  "createdDate": "2024-04-29T03:38:41.335Z",
  "modifiedDate": "2024-04-29T03:38:41.335Z",
  "sku": "text",
  "upc": "text",
  "hsn": "text",
  "location": "text",
  "image": "text",
  "imagePath": "text",
  "serviceCharges": "text",
  "price": "text",
  "dateAvailable": "text",
  "name": "text",
  "description": "text",
  "amount": "text",
  "metaTagTitle": "text",
  "metaTagDescription": "text",
  "metaTagKeyword": "text",
  "keywords": "text",
  "discount": "text",
  "productSlug": "text",
  "width": "text",
  "height": "text",
  "length": "text",
  "weight": "text",
  "outOfStockThreshold": "text",
  "attributeKeyword": "text",
  "settedAsCommonOn": "text"
}

Add tire price

This is for adding tier price for a product.

POST/product/add-tire-price
Header parameters
Body
hasTirePriceinteger (int32)
quantity*integer (int32)
price*string
productId*integer (int32)
Response

success response

Body
productIdstring
quantitystring
pricestring
createdDatestring (date-time)
idinteger
Request
const response = await fetch('/product/add-tire-price', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "price": "text"
    }),
});
const data = await response.json();
Response
{
  "productId": 1,
  "quantity": "text",
  "price": "text",
  "createdDate": "2024-04-29T03:38:41.335Z"
}

delete tire price

This is for deleting a tier price, when not needed anymore.

DELETE/product/delete-tire-price/{id}
Path parameters
id*integer
Header parameters
Response

success response

Body
statusinteger
messagestring
Request
const response = await fetch('/product/delete-tire-price/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();
Response
{
  "message": "Successfully deleted."
}

Get product tier price list

This is for fetching the tier price list for a product.

GET/product/get-product-tire-price-list
Query parameters
Header parameters
Response

success response

Body
statusinteger
messagestring
Request
const response = await fetch('/product/get-product-tire-price-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "message": "Successfully Get product tire price"
}

Inventory product list

This is for getting the list for the products to update inventory.

GET/product/inventory-product-list
Query parameters
Header parameters
Response

success response

Body
statusinteger
messagestring
Request
const response = await fetch('/product/inventory-product-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "message": "text"
}

Update SKU

This is for updating the SKU for a product.

POST/product/update-sku
Header parameters
Body
limitinteger (int32)
offsetinteger (int32)
Response

success response

Body
statusinteger
messagestring
Request
const response = await fetch('/product/update-sku ', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{
  "message": "Successfully updated Sku"
}

This is for updating the owner product list.

Update owner product list

GET/product/update-owner-product-list
Query parameters
Header parameters
Response

success response

Body
statusinteger
messagestring
Request
const response = await fetch('/product/update-owner-product-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "message": "Successfully got count \" or \" Successfully got the complete product list."
}

This is for updating the vendor sku list.

Update vendor sku list

GET/product/update-vendor-sku-list
Query parameters
Header parameters
Response

success response

Body
statusinteger
messagestring
Request
const response = await fetch('/product/update-vendor-sku-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "message": "Successfully got the complete product list. "
}
PreviousManage CatalogNextProduct Categories

Last updated