POST /api/category HTTP/1.1
Host: <API_HOST>
Accept: application/json
Authorization: Bearer <ACCESS_TOKEN>
Content-Type: application/json

{
  "name": "Electronics",
  "image": "",
  "parentInt": 0,
  "sortOrder": 1,
  "status": 1,
  "categorySlug": "electronics",
  "categoryDescription": "Electronic products"
}

{
  "status": 1,
  "message": "New category created successfully.",
  "data": {
    "categoryId": 1,
    "name": "Electronics",
    "categorySlug": "electronics",
    "parentInt": 0,
    "sortOrder": 1,
    "isActive": 1
  }
}

{
  "status": 0,
  "message": "Category can only be mapped up to 3 levels. More than 3 levels are not allowed."
}

Create or process Category

Post /api/category

Authentication: Vendor bearer token required for protected operations; verify exact permission decorator in controller.

Feature area: Categories

Implementation source: src/api/vendor/controllers/ProductController.ts

Request example provenance: Source-defined in AddCategoryRequest / CategoryController.

Response example provenance: Exact API comment example.

Example is based on the linked repository source. Replace example identifiers and credentials with values from your tenant.

POST

api

category

POST /api/category HTTP/1.1
Host: <API_HOST>
Accept: application/json
Authorization: Bearer <ACCESS_TOKEN>
Content-Type: application/json

{
  "name": "Electronics",
  "image": "",
  "parentInt": 0,
  "sortOrder": 1,
  "status": 1,
  "categorySlug": "electronics",
  "categoryDescription": "Electronic products"
}

{
  "status": 1,
  "message": "New category created successfully.",
  "data": {
    "categoryId": 1,
    "name": "Electronics",
    "categorySlug": "electronics",
    "parentInt": 0,
    "sortOrder": 1,
    "isActive": 1
  }
}

{
  "status": 0,
  "message": "Category can only be mapped up to 3 levels. More than 3 levels are not allowed."
}

Authorizations

Authorization

string

header

required

Paste the JWT access token returned by the corresponding login endpoint.

Body

application/json

Sample request body. Source-defined in AddCategoryRequest / CategoryController.

name

string

image

string

parentInt

integer

sortOrder

integer

status

integer

categorySlug

string

categoryDescription

string

Response

Successful response. Exact API comment example.

status

integer

message

string

data

object

Show child attributes

Store API

Vendor API

Create or process Category

Authorizations

Body

Response