Last Updated Aug 15, 2025

Query Categories

get
/api/inventory/categories

Retrieves information about a specific inventory category, including its name, type, description, parent category, and any child categories. It is useful for displaying category hierarchies or fetching detailed information about a particular category.

Request

Field Description

category_type

(optional)		 [string] Filter by category type. Possible values: general, antique, component, sample.

category_id

(required)		 [integer] Get products by Category ID.

parent_caegory_id

(optional)

 [integer] Filter categories by their parent category ID.

 


GET /api/inventory/categories?category_id=1&category_type=general HTTP/1.1
Host: yourcompany.intend.com
api-key: your_api_key_here

Response

A successful request returns HTTP 200 and a JSON response body with category details.

Field Description
id [integer] Category ID.
name [string] Name of the category.
brand [string] Brand name.
description [string] Description of the category.
type [string] Type of category (general, antique, component, sample).
created_on [string] Timestamp when the category was created.
updated_on [string] Timestamp when the category was updated.
parent_category [object] Details of the parent category.
children [array] List of child categories.

 


{
   "status": 200,
   "response": true,
   "data": {
       "id": 1,
       "name": "Fabrics",
       "brand": null,
       "description": "Fabrics",
       "type": "general",
       "created_on": "2018-12-11T22:46:55.000000Z",
       "updated_on": "2025-07-18T21:31:15.000000Z",
       "parent_category": null,
       "children": []
   },
   "msg": "Request Successful"
}