EBAYCCLONE
FRONTEND GUIDE FOR AI CODING AGENTS - PART 6 - CategoryManagement Service
This document is a part of a REST API guide for the ebaycclone project. It is designed for AI agents that will generate frontend code to consume the project’s backend.
This document provides extensive instruction for the usage of categoryManagement
Service Access
CategoryManagement service management is handled through service specific base urls.
CategoryManagement service may be deployed to the preview server, staging server, or production server. Therefore,it has 3 access URLs. The frontend application must support all deployment environments during development, and the user should be able to select the target API server on the login page (already handled in first part.).
For the categoryManagement service, the base URLs are:
-
Preview:
https://ebaycclone.prw.mindbricks.com/categorymanagement-api -
Staging:
https://ebaycclone-stage.mindbricks.co/categorymanagement-api -
Production:
https://ebaycclone.mindbricks.co/categorymanagement-api
Scope
CategoryManagement Service Description
Handles product categories and subcategories for marketplace browsing and classification, supporting public discovery plus admin-only management.
CategoryManagement service provides apis and business logic for following data objects in ebaycclone application. Each data object may be either a central domain of the application data structure or a related helper data object for a central concept. Note that data object concept is equal to table concept in the database, in the service database each data object is represented as a db table scheme and the object instances as table rows.
category
Data Object: Represents a product category in the marketplace (e.g.,
Electronics, Clothing, Toys), used for browsing, filtering, and
discovery. Admins manage categories.
subcategory
Data Object: Represents a subcategory within a parent category (e.g.,
'Smartphones' under 'Electronics'). Used for more granular product
discovery and navigation. 'group' categorizes special display
logic.
CategoryManagement Service Frontend Description By The Backend Architect
This service provides APIs for frontend public discovery and filtering of product categories and subcategories (including 'MOST_POPULAR' status for special sections), with soft-deleted records always hidden. Normal users only browse (read), while admins may create, update, or delete categories/subcategories. Subcategory 'group' field maps to enums for UX grouping/tabs in filters and landing sections.
API Structure
Object Structure of a Successful Response
When the service processes requests successfully, it wraps the requested resource(s) within a JSON envelope. This envelope includes the data and essential metadata such as configuration details and pagination information, providing context to the client.
HTTP Status Codes:
- 200 OK: Returned for successful GET, LIST, UPDATE, or DELETE operations, indicating that the request was processed successfully.
- 201 Created: Returned for CREATE operations, indicating that the resource was created successfully.
Success Response Format:
For successful operations, the response includes a
"status": "OK"
property, signaling that the request executed successfully. The
structure of a successful response is outlined below:
{
"status":"OK",
"statusCode": 200,
"elapsedMs":126,
"ssoTime":120,
"source": "db",
"cacheKey": "hexCode",
"userId": "ID",
"sessionId": "ID",
"requestId": "ID",
"dataName":"products",
"method":"GET",
"action":"list",
"appVersion":"Version",
"rowCount":3,
"products":[{},{},{}],
"paging": {
"pageNumber":1,
"pageRowCount":25,
"totalRowCount":3,
"pageCount":1
},
"filters": [],
"uiPermissions": []
}
-
products: In this example, this key contains the actual response content, which may be a single object or an array of objects depending on the operation.
Additional Data
Each API may include additional data besides the main data object, depending on the business logic of the API. These will be provided in each API’s response signature.
Error Response
If a request encounters an issue—whether due to a logical fault or a technical problem—the service responds with a standardized JSON error structure. The HTTP status code indicates the nature of the error, using commonly recognized codes for clarity:
- 400 Bad Request: The request was improperly formatted or contained invalid parameters.
- 401 Unauthorized: The request lacked a valid authentication token; login is required.
- 403 Forbidden: The current token does not grant access to the requested resource.
- 404 Not Found: The requested resource was not found on the server.
- 500 Internal Server Error: The server encountered an unexpected condition.
Each error response is structured to provide meaningful insight into the problem, assisting in efficient diagnosis and resolution.
{
"result": "ERR",
"status": 400,
"message": "errMsg_organizationIdisNotAValidID",
"errCode": 400,
"date": "2024-03-19T12:13:54.124Z",
"detail": "String"
}
Bucket Management
(This information is also given in PART 1 prompt.)
This application has a bucket service used to store user files and other object-related files. The bucket service is login-agnostic, so for write operations or private reads, include a bucket token (provided by services) in the request’s Authorization header as a Bearer token.
Please note that all other business services require the access token in the Bearer header, while the bucket service expects a bucket token because it is login-agnostic. Ensure you manage the required token injection properly; any auth interceptor should not replace the bucket token with the access token.
User Bucket This bucket stores public user files for each user.
When a user logs in—or in the
/currentuser
response—there is a
userBucketToken
to use when sending user-related public files to the bucket
service.
{
//...
"userBucketToken": "e56d...."
}
To upload a file
POST {baseUrl}/bucket/upload
The request body is form-data which includes the
bucketId
and the file binary in the
files
field.
{
bucketId: "{userId}-public-user-bucket",
files: {binary}
}
Response status is 200 on success, e.g., body:
{
"success": true,
"data": [
{
"fileId": "9da03f6d-0409-41ad-bb06-225a244ae408",
"originalName": "test (10).png",
"mimeType": "image/png",
"size": 604063,
"status": "uploaded",
"bucketName": "f7103b85-fcda-4dec-92c6-c336f71fd3a2-public-user-bucket",
"isPublic": true,
"downloadUrl": "https://babilcom.mindbricks.co/bucket/download/9da03f6d-0409-41ad-bb06-225a244ae408"
}
]
}
To download a file from the bucket, you need its
fileId. If you upload an avatar or other asset, ensure the download URL
or the
fileId
is stored in the backend.
Buckets are mostly used in object creations that require an additional file, such as a product image or user avatar. After uploading your image to the bucket, insert the returned download URL into the related property of the target object record.
Application Bucket
This Ebaycclone application also includes a common public bucket
that anyone can read, but only users with the
superAdmin,
admin, or
saasAdmin
roles can write (upload) to it.
When a user with one of these admin roles is logged in, the
/login
response or the
/currentuser
response also returns an
applicationBucketToken
field, which is used when uploading any file to the application
bucket.
{
//...
"applicationBucketToken": "e23fd...."
}
The common public application bucket ID is
"ebaycclone-public-common-bucket"
In certain admin areas—such as product management pages—since the user already has the application bucket token, they will be able to upload related object images.
Please configure your UI to upload files to the application bucket using this bucket token whenever needed.
Object Buckets Some objects may also return a bucket token for uploading or accessing files related to that object. For example, in a project management application, when you fetch a project’s data, a public or private bucket token may be provided to upload or download project-related files.
These buckets will be used as described in the relevant object definitions.
Category Data Object
Represents a product category in the marketplace (e.g., Electronics, Clothing, Toys), used for browsing, filtering, and discovery. Admins manage categories.
Category Data Object Frontend Description By The Backend Architect
Public categories are displayed as top-level navigation and landing page filters. Each category includes a title, subtitle, and optionally an image (URL). Only active categories appear in listings; admins create/edit/remove categories.
Category Data Object Properties
Category data object has got following properties that are represented as table fields in the database scheme. These properties don't stand just for data storage, but each may have different settings to manage the business logic.
| Property | Type | IsArray | Required | Description |
|---|---|---|---|---|
imageUrl
|
String | false | No | URL for category image/avatar (optional, used for homepage visuals). |
subtitle
|
String | false | No | Optional short description for UI/tooltips. |
title
|
String | false | Yes | Display name of the category. |
- Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set.
Filter Properties
title
Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API's.
-
title: String has a filter named
title
Subcategory Data Object
Represents a subcategory within a parent category (e.g., 'Smartphones' under 'Electronics'). Used for more granular product discovery and navigation. 'group' categorizes special display logic.
Subcategory Data Object Frontend Description By The Backend Architect
Subcategories are displayed as filters/tabs within categories. Most-popular subcategories can be shown in special sections/tabs depending on their 'group' enum. Only active subcategories are visible to public; admins may manage all.
Subcategory Data Object Properties
Subcategory data object has got following properties that are represented as table fields in the database scheme. These properties don't stand just for data storage, but each may have different settings to manage the business logic.
| Property | Type | IsArray | Required | Description |
|---|---|---|---|---|
categoryId
|
ID | false | Yes | Reference to the parent category (category.id). |
name
|
String | false | Yes | Display name of the subcategory. |
group
|
Enum | false | Yes | Classification for subcategory display; restrict to enum of MOST_POPULAR or MORE. |
- Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set.
Enum Properties
Enum properties are defined with a set of allowed values, ensuring that only valid options can be assigned to them. The enum options value will be stored as strings in the database, but when a data object is created an additional property with the same name plus an idx suffix will be created, which will hold the index of the selected enum option. You can use the {fieldName_idx} property to sort by the enum value or when your enum options represent a hiyerarchy of values. In the frontend input components, enum type properties should only accept values from an option component that lists the enum options.
- group: [MOST_POPULAR, MORE]
Relation Properties
categoryId
Mindbricks supports relations between data objects, allowing you to define how objects are linked together. The relations may reference to a data object either in this service or in another service. Id the reference is remote, backend handles the relations through service communication or elastic search. These relations should be respected in the frontend so that instaead of showing the related objects id, the frontend should list human readable values from other data objects. If the relation points to another service, frontend should use the referenced service api in case it needs related data. The relation logic is montly handled in backend so the api responses feeds the frontend about the relational data. In mmost cases the api response will provide the relational data as well as the main one.
In frontend, please ensure that,
1- instaead of these relational ids you show the main human readable field of the related target data (like name), 2- if this data object needs a user input of these relational ids, you should provide a combobox with the list of possible records or (a searchbox) to select with the realted target data object main human readable field.
-
categoryId: ID Relation to
category.id
The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.
Required: Yes
Filter Properties
categoryId
name
group
Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API's.
-
categoryId: ID has a filter named
categoryId -
name: String has a filter named
name -
group: Enum has a filter named
group
API Reference
Delete Category
API
Soft-delete a category (admin-only).
Rest Route
The
deleteCategory
API REST controller can be triggered via the following route:
/v1/categories/:categoryId
Rest Request Parameters
The
deleteCategory
api has got 1 request parameter
| Parameter | Type | Required | Population |
|---|---|---|---|
| categoryId | ID | true | request.params?.categoryId |
| categoryId : This id paremeter is used to select the required data object that will be deleted |
REST Request To access the api you can use the REST controller with the path DELETE /v1/categories/:categoryId
axios({
method: 'DELETE',
url: `/v1/categories/${categoryId}`,
data: {
},
params: {
}
});
REST Response
{
"status": "OK",
"statusCode": "200",
"elapsedMs": 126,
"ssoTime": 120,
"source": "db",
"cacheKey": "hexCode",
"userId": "ID",
"sessionId": "ID",
"requestId": "ID",
"dataName": "category",
"method": "DELETE",
"action": "delete",
"appVersion": "Version",
"rowCount": 1,
"category": {
"id": "ID",
"imageUrl": "String",
"subtitle": "String",
"title": "String",
"isActive": false,
"recordVersion": "Integer",
"createdAt": "Date",
"updatedAt": "Date",
"_owner": "ID"
}
}
Get Subcategory
API
Get a subcategory by ID. Public - only active subcategories returned except for admin.
Rest Route
The
getSubcategory
API REST controller can be triggered via the following route:
/v1/subcategories/:subcategoryId
Rest Request Parameters
The
getSubcategory
api has got 1 request parameter
| Parameter | Type | Required | Population |
|---|---|---|---|
| subcategoryId | ID | true | request.params?.subcategoryId |
| subcategoryId : This id paremeter is used to query the required data object. |
REST Request To access the api you can use the REST controller with the path GET /v1/subcategories/:subcategoryId
axios({
method: 'GET',
url: `/v1/subcategories/${subcategoryId}`,
data: {
},
params: {
}
});
REST Response
{
"status": "OK",
"statusCode": "200",
"elapsedMs": 126,
"ssoTime": 120,
"source": "db",
"cacheKey": "hexCode",
"userId": "ID",
"sessionId": "ID",
"requestId": "ID",
"dataName": "subcategory",
"method": "GET",
"action": "get",
"appVersion": "Version",
"rowCount": 1,
"subcategory": {
"id": "ID",
"categoryId": "ID",
"name": "String",
"group": "Enum",
"group_idx": "Integer",
"isActive": true,
"recordVersion": "Integer",
"createdAt": "Date",
"updatedAt": "Date",
"_owner": "ID"
}
}
Get Category
API
Get a single category by ID. Public - only active categories returned (for non-admins).
Rest Route
The
getCategory
API REST controller can be triggered via the following route:
/v1/categories/:categoryId
Rest Request Parameters
The
getCategory
api has got 1 request parameter
| Parameter | Type | Required | Population |
|---|---|---|---|
| categoryId | ID | true | request.params?.categoryId |
| categoryId : This id paremeter is used to query the required data object. |
REST Request To access the api you can use the REST controller with the path GET /v1/categories/:categoryId
axios({
method: 'GET',
url: `/v1/categories/${categoryId}`,
data: {
},
params: {
}
});
REST Response
{
"status": "OK",
"statusCode": "200",
"elapsedMs": 126,
"ssoTime": 120,
"source": "db",
"cacheKey": "hexCode",
"userId": "ID",
"sessionId": "ID",
"requestId": "ID",
"dataName": "category",
"method": "GET",
"action": "get",
"appVersion": "Version",
"rowCount": 1,
"category": {
"id": "ID",
"imageUrl": "String",
"subtitle": "String",
"title": "String",
"isActive": true,
"recordVersion": "Integer",
"createdAt": "Date",
"updatedAt": "Date",
"_owner": "ID"
}
}
Update Subcategory
API
Update subcategory (admin-only), including group enum change.
Rest Route
The
updateSubcategory
API REST controller can be triggered via the following route:
/v1/subcategories/:subcategoryId
Rest Request Parameters
The
updateSubcategory
api has got 4 request parameters
| Parameter | Type | Required | Population |
|---|---|---|---|
| subcategoryId | ID | true | request.params?.subcategoryId |
| categoryId | ID | false | request.body?.categoryId |
| name | String | false | request.body?.name |
| group | Enum | false | request.body?.group |
| subcategoryId : This id paremeter is used to select the required data object that will be updated | |||
| categoryId : Reference to the parent category (category.id). | |||
| name : Display name of the subcategory. | |||
| group : Classification for subcategory display; restrict to enum of MOST_POPULAR or MORE. |
REST Request To access the api you can use the REST controller with the path PATCH /v1/subcategories/:subcategoryId
axios({
method: 'PATCH',
url: `/v1/subcategories/${subcategoryId}`,
data: {
categoryId:"ID",
name:"String",
group:"Enum",
},
params: {
}
});
REST Response
{
"status": "OK",
"statusCode": "200",
"elapsedMs": 126,
"ssoTime": 120,
"source": "db",
"cacheKey": "hexCode",
"userId": "ID",
"sessionId": "ID",
"requestId": "ID",
"dataName": "subcategory",
"method": "PATCH",
"action": "update",
"appVersion": "Version",
"rowCount": 1,
"subcategory": {
"id": "ID",
"categoryId": "ID",
"name": "String",
"group": "Enum",
"group_idx": "Integer",
"isActive": true,
"recordVersion": "Integer",
"createdAt": "Date",
"updatedAt": "Date",
"_owner": "ID"
}
}
List Subcategories
API
List all subcategories for browsing/filtering, with support for group enum and parent category queries. Only active subcategories shown to public/non-admin users.
Rest Route
The
listSubcategories
API REST controller can be triggered via the following route:
/v1/subcategories
Rest Request Parameters The
listSubcategories
api has got no request parameters.
REST Request To access the api you can use the REST controller with the path GET /v1/subcategories
axios({
method: 'GET',
url: '/v1/subcategories',
data: {
},
params: {
}
});
REST Response
{
"status": "OK",
"statusCode": "200",
"elapsedMs": 126,
"ssoTime": 120,
"source": "db",
"cacheKey": "hexCode",
"userId": "ID",
"sessionId": "ID",
"requestId": "ID",
"dataName": "subcategories",
"method": "GET",
"action": "list",
"appVersion": "Version",
"rowCount": "\"Number\"",
"subcategories": [
{
"id": "ID",
"categoryId": "ID",
"name": "String",
"group": "Enum",
"group_idx": "Integer",
"isActive": true,
"recordVersion": "Integer",
"createdAt": "Date",
"updatedAt": "Date",
"_owner": "ID"
},
{},
{}
],
"paging": {
"pageNumber": "Number",
"pageRowCount": "NUmber",
"totalRowCount": "Number",
"pageCount": "Number"
},
"filters": [],
"uiPermissions": []
}
Delete Subcategory
API
Soft-delete a subcategory (admin-only).
Rest Route
The
deleteSubcategory
API REST controller can be triggered via the following route:
/v1/subcategories/:subcategoryId
Rest Request Parameters
The
deleteSubcategory
api has got 1 request parameter
| Parameter | Type | Required | Population |
|---|---|---|---|
| subcategoryId | ID | true | request.params?.subcategoryId |
| subcategoryId : This id paremeter is used to select the required data object that will be deleted |
REST Request To access the api you can use the REST controller with the path DELETE /v1/subcategories/:subcategoryId
axios({
method: 'DELETE',
url: `/v1/subcategories/${subcategoryId}`,
data: {
},
params: {
}
});
REST Response
{
"status": "OK",
"statusCode": "200",
"elapsedMs": 126,
"ssoTime": 120,
"source": "db",
"cacheKey": "hexCode",
"userId": "ID",
"sessionId": "ID",
"requestId": "ID",
"dataName": "subcategory",
"method": "DELETE",
"action": "delete",
"appVersion": "Version",
"rowCount": 1,
"subcategory": {
"id": "ID",
"categoryId": "ID",
"name": "String",
"group": "Enum",
"group_idx": "Integer",
"isActive": false,
"recordVersion": "Integer",
"createdAt": "Date",
"updatedAt": "Date",
"_owner": "ID"
}
}
List Categories
API
List all categories for browsing and filtering. Only active categories shown to public/non-admin users.
Rest Route
The
listCategories
API REST controller can be triggered via the following route:
/v1/categories
Rest Request Parameters The
listCategories
api has got no request parameters.
REST Request To access the api you can use the REST controller with the path GET /v1/categories
axios({
method: 'GET',
url: '/v1/categories',
data: {
},
params: {
}
});
REST Response
{
"status": "OK",
"statusCode": "200",
"elapsedMs": 126,
"ssoTime": 120,
"source": "db",
"cacheKey": "hexCode",
"userId": "ID",
"sessionId": "ID",
"requestId": "ID",
"dataName": "categories",
"method": "GET",
"action": "list",
"appVersion": "Version",
"rowCount": "\"Number\"",
"categories": [
{
"id": "ID",
"imageUrl": "String",
"subtitle": "String",
"title": "String",
"isActive": true,
"recordVersion": "Integer",
"createdAt": "Date",
"updatedAt": "Date",
"_owner": "ID"
},
{},
{}
],
"paging": {
"pageNumber": "Number",
"pageRowCount": "NUmber",
"totalRowCount": "Number",
"pageCount": "Number"
},
"filters": [],
"uiPermissions": []
}
Update Category
API
Update category details (admin-only).
Rest Route
The
updateCategory
API REST controller can be triggered via the following route:
/v1/categories/:categoryId
Rest Request Parameters
The
updateCategory
api has got 4 request parameters
| Parameter | Type | Required | Population |
|---|---|---|---|
| categoryId | ID | true | request.params?.categoryId |
| imageUrl | String | false | request.body?.imageUrl |
| subtitle | String | false | request.body?.subtitle |
| title | String | false | request.body?.title |
| categoryId : This id paremeter is used to select the required data object that will be updated | |||
| imageUrl : URL for category image/avatar (optional, used for homepage visuals). | |||
| subtitle : Optional short description for UI/tooltips. | |||
| title : Display name of the category. |
REST Request To access the api you can use the REST controller with the path PATCH /v1/categories/:categoryId
axios({
method: 'PATCH',
url: `/v1/categories/${categoryId}`,
data: {
imageUrl:"String",
subtitle:"String",
title:"String",
},
params: {
}
});
REST Response
{
"status": "OK",
"statusCode": "200",
"elapsedMs": 126,
"ssoTime": 120,
"source": "db",
"cacheKey": "hexCode",
"userId": "ID",
"sessionId": "ID",
"requestId": "ID",
"dataName": "category",
"method": "PATCH",
"action": "update",
"appVersion": "Version",
"rowCount": 1,
"category": {
"id": "ID",
"imageUrl": "String",
"subtitle": "String",
"title": "String",
"isActive": true,
"recordVersion": "Integer",
"createdAt": "Date",
"updatedAt": "Date",
"_owner": "ID"
}
}
Create Subcategory
API
Create a new subcategory under a given category (admin-only), with enum group constraint.
Rest Route
The
createSubcategory
API REST controller can be triggered via the following route:
/v1/subcategories
Rest Request Parameters
The
createSubcategory
api has got 3 request parameters
| Parameter | Type | Required | Population |
|---|---|---|---|
| categoryId | ID | true | request.body?.categoryId |
| name | String | true | request.body?.name |
| group | Enum | true | request.body?.group |
| categoryId : Reference to the parent category (category.id). | |||
| name : Display name of the subcategory. | |||
| group : Classification for subcategory display; restrict to enum of MOST_POPULAR or MORE. |
REST Request To access the api you can use the REST controller with the path POST /v1/subcategories
axios({
method: 'POST',
url: '/v1/subcategories',
data: {
categoryId:"ID",
name:"String",
group:"Enum",
},
params: {
}
});
REST Response
{
"status": "OK",
"statusCode": "201",
"elapsedMs": 126,
"ssoTime": 120,
"source": "db",
"cacheKey": "hexCode",
"userId": "ID",
"sessionId": "ID",
"requestId": "ID",
"dataName": "subcategory",
"method": "POST",
"action": "create",
"appVersion": "Version",
"rowCount": 1,
"subcategory": {
"id": "ID",
"categoryId": "ID",
"name": "String",
"group": "Enum",
"group_idx": "Integer",
"isActive": true,
"recordVersion": "Integer",
"createdAt": "Date",
"updatedAt": "Date",
"_owner": "ID"
}
}
Create Category
API
Create a new category (admin-only) for product classification.
Rest Route
The
createCategory
API REST controller can be triggered via the following route:
/v1/categories
Rest Request Parameters
The
createCategory
api has got 3 request parameters
| Parameter | Type | Required | Population |
|---|---|---|---|
| imageUrl | String | false | request.body?.imageUrl |
| subtitle | String | false | request.body?.subtitle |
| title | String | true | request.body?.title |
| imageUrl : URL for category image/avatar (optional, used for homepage visuals). | |||
| subtitle : Optional short description for UI/tooltips. | |||
| title : Display name of the category. |
REST Request To access the api you can use the REST controller with the path POST /v1/categories
axios({
method: 'POST',
url: '/v1/categories',
data: {
imageUrl:"String",
subtitle:"String",
title:"String",
},
params: {
}
});
REST Response
{
"status": "OK",
"statusCode": "201",
"elapsedMs": 126,
"ssoTime": 120,
"source": "db",
"cacheKey": "hexCode",
"userId": "ID",
"sessionId": "ID",
"requestId": "ID",
"dataName": "category",
"method": "POST",
"action": "create",
"appVersion": "Version",
"rowCount": 1,
"category": {
"id": "ID",
"imageUrl": "String",
"subtitle": "String",
"title": "String",
"isActive": true,
"recordVersion": "Integer",
"createdAt": "Date",
"updatedAt": "Date",
"_owner": "ID"
}
}
After this prompt, the user may give you new instructions to update the output of this prompt or provide subsequent prompts about the project.