Documents
Parameter Product Categories Guide
Latest Update Time: 2026-07-02 00:00:00
Use this API to retrieve all top-level product categories in QIMA's reference data.
See the Parameter Introduction for base URL, authentication, and required headers.
Endpoint
GET https://ppapi.qima.com/parameter/v2/product-categories
Query Parameters
| Parameter | Required | Description |
|---|---|---|
refresh | No | Send false (default) to use the server cache, or true to force a fresh lookup. |
Request Example
curl --location --request GET 'https://ppapi.qima.com/parameter/v2/product-categories' \
--header 'Ai-Api-Access-Token: {your api access token}' \
--header 'Ai-User-Id: {your user ID}' \
--header 'Authorization: Bearer {your token}' \
--header 'Referer: https://preprodmy.qima.com/'
Successful Response
{
"message": null,
"content": [
{ "id": "bigCat1", "name": "Electrical & Electronic products" },
{ "id": "bigCat2", "name": "Homeware, Gardenware" },
{ "id": "bigCat3", "name": "Bodycare, Fashion & accessories" },
{ "id": "bigCat4", "name": "Printing & Packaging" },
{ "id": "bigCat5", "name": "Constructions & Mechanical items" },
{ "id": "bigCat6", "name": "Textile, Apparel, Footwear & Accessories" },
{ "id": "bigCat7", "name": "Toys & Recreational items" },
{ "id": "bigCat8", "name": "Food & Food containers" },
{ "id": "bigCat116", "name": "Others" },
{ "id": "bigCat15", "name": "Eyewear" }
]
}
Response Field Notes
| Field | Notes |
|---|---|
content[].id | The category ID, for example "bigCat1". Use this as categoryId in a product booking, or pass it to Get All Product Families to find families within this category. |
content[].name | Category display name. |
Common Errors
See common authentication errors for 401 and 403 responses.
| Status | Meaning | Recommended Action |
|---|---|---|
404 Not Found | Category data could not be found. | Contact QIMA support with the request time. |
Next Steps
- Use a category's
idto filter Get All Product Families (filter client-side, since this API does not accept a category filter parameter), or use Get Full Product Taxonomy Tree to get everything at once.
