Product Categories

Add new category

This is for adding a new category.

POST/category

Header parameters

Body

application/x-www-form-urlencoded

parentIntinteger (int32)

sortOrder*integer (int32)

status*integer (int32)

name*string

imagestring

metaTagTitlestring

metaTagDescriptionstring

metaTagKeywordstring

categorySlugstring

categoryDescriptionstring

Response

200400

success response

Body

application/json

namestring

sortOrderstring

metaTagTitlestring

categorySlugstring

metaTagDescriptionstring

metaTagKeywordstring

isActivestring

categoryDescriptionstring

createdDatestring (date-time)

categoryIdinteger (int32)

Request

JavaScriptCurl

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

Response

{
  "name": "text",
  "sortOrder": "text",
  "metaTagTitle": "text",
  "categorySlug": "text",
  "metaTagDescription": "text",
  "metaTagKeyword": "text",
  "isActive": "text",
  "categoryDescription": "text",
  "createdDate": "2024-04-29T06:00:57.384Z"
}

View list of categories

This is for fetching the list of added categories.

GET/category

Query parameters

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

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

Update existing category

This is for updating already existing category.

PUT/category/{id}

Path parameters

id*integer

Header parameters

Body

application/x-www-form-urlencoded

categoryId*integer (int32)

parentIntinteger (int32)

sortOrder*integer (int32)

statusinteger (int32)

name*string

imagestring

metaTagTitlestring

metaTagDescriptionstring

metaTagKeywordstring

categorySlugstring

categoryDescriptionstring

Response

200400

success response

Body

application/json

createdDatestring

categoryIdinteger

namestring

imagestring

imagePathstring

sortOrderstring

metaTagTitlestring

metaTagDescriptionstring

metaTagKeywordstring

categorySlugstring

isActivestring

categoryDescriptionstring

Request

JavaScriptCurl

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

Response

{
  "createdDate": "text",
  "name": "text",
  "image": "text",
  "imagePath": "text",
  "sortOrder": "text",
  "metaTagTitle": "text",
  "metaTagDescription": "text",
  "metaTagKeyword": "text",
  "categorySlug": "text",
  "isActive": "text",
  "categoryDescription": "text"
}

Delete unwated category

This is for deleting a category that is not needed anymore.

DELETE/category/{id}

Path parameters

id*integer

Header parameters

Body

application/x-www-form-urlencoded

categoryId*integer (int32)

Response

200400

success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

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

List the category as in tree.

This is for listing the category like in tree.

GET/category-list-intree

Query parameters

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

{
  "message": "Successfully get category List count \" or \" successfully got the complete category list."
}

Update the category slug

This is for updating the existed category slug

PUT/update-category-slug

Response

200

success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

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

Count the Category

This is for count the total category

GET/category-count

Query parameters

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

{
  "message": "Successfully get Category Count"
}

View list of particular category

This is for getting the list of category.

GET/category-detail

Query parameters

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

{
  "message": "Successfully got category detail"
}

Getting the excel-sheet of category list

This is for getting the list of category on excel-sheet.

GET/category-excel-list

Query parameters

Header parameters

Response

400

error response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

{
  "message": "Choose atleast one category."
}

Export all category

This is for export all the category.

GET/category-export-all

Query parameters

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

{
  "message": "Successfully exported"
}