Product Sub Category API

This documentation provides comprehensive details for the Product Sub Category API endpoints. The API supports creating, retrieving, updating, and deleting product sub categories within the platform. Product sub categories are associated with specific product categories and can be managed by administrators or authorized users.

Base URL: http://localhost:8080

Authentication

All Product Sub Category endpoints require Bearer token authentication. Include the access token in the Authorization header:

Authorization: Bearer <your_access_token>

Product Sub Category Endpoints

Method	Endpoint	Description	Authentication Required
POST	/product-subcategory	Create a new product sub category	Yes
GET	/product-subcategory	Retrieve list of product sub categories	Yes
PUT	/product-subcategory/{id}	Update an existing product sub category	Yes
DELETE	/product-subcategory/{id}	Delete a product sub category	Yes

---

Endpoint Details

1. Create Product Sub Category

POST /product-subcategory

Create a new product sub category with a specified name and associated product category.

Request Body

Parameter	Type	Required	Description
name	string	Yes	Name of the product sub category
categoryId	string	Yes	UUID of the product category to associate with

Headers

Header	Value	Required
Authorization	Bearer <access_token>	Yes
Content-Type	application/json	Yes

Example Request

curl -X 'POST' \
  'http://localhost:8080/product-subcategory' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9...' \
  -H 'Content-Type: application/json' \
  -d '{
  "categoryId": "b8ccc13f-e118-4540-8e9e-5eaa8028cb4f",
  "name": "Paper"
}'

Example Response

{
    "id": "751cef10-f98a-4ecc-ae03-4173830a626d",
    "categoryId": "b8ccc13f-e118-4540-8e9e-5eaa8028cb4f",
    "name": "Paper"
  }
}

Response Fields

Field	Type	Description
id	string	Unique identifier for the created product sub category
categoryId	string	UUID of the associated product category
name	string	Name of the product sub category

---

2. Get Product Sub Categories

GET /product-subcategory

Retrieve a list of product sub categories with optional filtering and pagination support.

Query Parameters

Parameter	Type	Required	Description
id	string	No	Filter by specific category ID (returns sub categories for that category)
limit	number	No	Maximum number of sub-categories to return (default: 20)
offset	number	No	Number of sub-categories to skip for pagination (default: 0)

Headers

Header	Value	Required
Authorization	Bearer <access_token>	Yes

Example Request

curl -X 'GET' \
  'http://localhost:8080/product-subcategory?id=b8ccc13f-e118-4540-8e9e-5eaa8028cb4f&limit=10' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9...'

Example Response

[
    {
      "id": "751cef10-f98a-4ecc-ae03-4173830a626d",
      "categoryId": "b8ccc13f-e118-4540-8e9e-5eaa8028cb4f",
      "name": "Paper"
    }
  ]
}

Response Fields

Field	Type	Description
data	array	Array of product sub category objects
data[].id	string	Unique identifier for the product sub category
data[].categoryId	string	UUID of the associated product category
data[].name	string	Name of the product sub category

---

3. Update Product Sub Category

PUT /product-subcategory/{id}

Update an existing product sub category by its ID. You can modify the sub category name.

Path Parameters

Parameter	Type	Required	Description
id	string	Yes	Unique identifier of the product sub category to update

Query Parameters

Parameter	Type	Required	Description
name	string	Yes	New name for the product sub category

Headers

Header	Value	Required
Authorization	Bearer <access_token>	Yes

Example Request

curl -X 'PUT' \
  'http://localhost:8080/product-subcategory/751cef10-f98a-4ecc-ae03-4173830a626d?name=Pencil' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9...'

Example Response

{
    "id": "751cef10-f98a-4ecc-ae03-4173830a626d",
    "categoryId": "b8ccc13f-e118-4540-8e9e-5eaa8028cb4f",
    "name": "Pencil"
  }
}

Response Fields

Field	Type	Description
id	string	Unique identifier of the updated product sub category
categoryId	string	UUID of the associated product category
name	string	Updated name of the product sub category

---

4. Delete Product Sub Category

DELETE /product-subcategory/{id}

Delete a product sub category by its ID. This operation permanently removes the sub category from the system.

Path Parameters

Parameter	Type	Required	Description
id	string	Yes	Unique identifier of the product sub category to delete

Headers

Header	Value	Required
Authorization	Bearer <access_token>	Yes

Example Request

curl -X 'DELETE' \
  'http://localhost:8080/product-subcategory/751cef10-f98a-4ecc-ae03-4173830a626d' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9...'

Example Response

"751cef10-f98a-4ecc-ae03-4173830a626d"

Response Fields

Field	Type	Description
data	string	ID of the deleted product sub category

---

Error Handling

This API follows industry-standard error handling patterns (Stripe, GitHub, OpenAI):

Success Responses

• HTTP status code indicates success (200, 201, 204)
• Response body contains data directly (no wrapper object)
• No isSuccess or statusCode fields needed

Error Responses

Standard Error (400/401/403/404/500):

{
  "message": "Error description"
}

Validation Error (400):

{
  "message": "Validation failed",
  "errors": [
    {"field": "email", "message": "Invalid email format"},
    {"field": "password", "message": "Password must be at least 8 characters"}
  ]
}

Common Error Codes

Status Code	Description	Example Message
400	Bad Request	"Invalid email or password"
401	Unauthorized	"Authentication required"
403	Forbidden	"Insufficient permissions"
404	Not Found	"Product not found"
409	Conflict	"User already exists with this email"
500	Internal Server Error	"Internal server error"

All error messages are centralized and consistent across all endpoints.

---