Parameter Product Tree Guide

Latest Update Time: 2026-07-02 00:00:00

Use this API to retrieve the complete product taxonomy — categories, families, and types — in a single call, instead of calling Get All Product Categories, Get All Product Families, and Get All Product Types separately.

See the Parameter Introduction for base URL, authentication, and required headers.

Endpoint

GET https://ppapi.qima.com/parameter/v2/product-tree

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-tree' \
  --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

content is a fixed object with 3 arrays (categories, families, types) — trimmed to 2 items each here.

{
    "message": null,
    "content": {
        "categories": [
            { "id": "bigCat1", "name": "Electrical & Electronic products" },
            { "id": "bigCat2", "name": "Homeware, Gardenware" }
        ],
        "families": [
            {
                "id": "bigCat8_s6",
                "categoryName": null,
                "categoryId": "bigCat8",
                "name": "Plastic food containers"
            },
            {
                "id": "bigCat6_s7",
                "categoryName": null,
                "categoryId": "bigCat6",
                "name": "Home textile "
            }
        ],
        "types": [
            {
                "name": "Scallops / clams",
                "category": null,
                "categoryId": "bigCat8",
                "family": null,
                "familyId": "bigCat8_s103",
                "productTypeId": "bigCat8_s103_t11",
                "type": "General",
                "maxNbOfPcs": 50,
                "maxNbOfRefs": 0,
                "maxNbOfPts": 0
            },
            {
                "name": "Cooler bag / isothermal bag",
                "category": null,
                "categoryId": "bigCat6",
                "family": null,
                "familyId": "bigCat6_s1",
                "productTypeId": "bigCat6_s1_t4",
                "type": "Textile",
                "maxNbOfPcs": 315,
                "maxNbOfRefs": 0,
                "maxNbOfPts": 0
            }
        ]
    }
}

Response Field Notes

Field	Notes
`content.categories[]`	Same shape as Get All Product Categories (`id`, `name`).
`content.families[]`	Same shape as Get All Product Families (`id`, `categoryName`, `categoryId`, `name`).
`content.types[]`	Same shape as Get All Product Types's `data[]`, except `category` and `family` are `null` here (only `categoryId`/`familyId` are populated) — resolve display names via `content.categories`/`content.families` instead.

Common Errors

See common authentication errors for 401 and 403 responses.

Status	Meaning	Recommended Action
`404 Not Found`	Product tree data could not be found.	Contact QIMA support with the request time.

Next Steps

Build a category → family → type cascading picker client-side using categoryId/familyId to join the 3 arrays.

Documents