Parameter Product Families Guide

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

Use this API to retrieve all product families in QIMA's reference data. Product families group related product types within a category, and are also used as supplier/factory product line values.

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

Endpoint

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

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

The real list has many entries — trimmed to 2 here.

{
    "message": null,
    "content": [
        {
            "id": "bigCat8_s6",
            "categoryName": null,
            "categoryId": "bigCat8",
            "name": "Plastic food containers"
        },
        {
            "id": "bigCat6_s7",
            "categoryName": null,
            "categoryId": "bigCat6",
            "name": "Home textile "
        }
    ]
}

Response Field Notes

Field	Notes
`content[].id`	The family ID, for example `"bigCat8_s6"`. Use this as `familyId` in a product booking, or as a supplier/factory `ProductLines` entry (see Inspection Booking or Audit Order Create).
`content[].categoryId`	The parent category's ID. Matches an `id` from Get All Product Categories.
`content[].categoryName`	`null` in this API's response — use `categoryId` with Get All Product Categories to resolve the category name.
`content[].name`	Family display name.

Common Errors

See common authentication errors for 401 and 403 responses.

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

Next Steps

Use a family's id with Get All Product Types (filter client-side by familyId), or use Get Full Product Taxonomy Tree to get everything at once.

Documents