Parameter Product Types Guide

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

Use this API to retrieve all product types in QIMA's reference data. Product types are the most granular level of the product taxonomy.

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

Endpoint

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

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-types' \
  --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. Unlike the other Parameter list APIs, content here is an object with data (the array) and success, not a bare array.

{
    "message": null,
    "content": {
        "data": [
            {
                "name": "Scallops / clams",
                "category": "Food & Food containers",
                "categoryId": "bigCat8",
                "family": "Seafood Processed",
                "familyId": "bigCat8_s103",
                "productTypeId": "bigCat8_s103_t11",
                "type": "General",
                "maxNbOfPcs": 50,
                "maxNbOfRefs": 0,
                "maxNbOfPts": 0
            },
            {
                "name": "Cooler bag / isothermal bag",
                "category": "Textile, Apparel, Footwear & Accessories",
                "categoryId": "bigCat6",
                "family": "Bags & Luggage",
                "familyId": "bigCat6_s1",
                "productTypeId": "bigCat6_s1_t4",
                "type": "Textile",
                "maxNbOfPcs": 315,
                "maxNbOfRefs": 0,
                "maxNbOfPts": 0
            }
        ],
        "success": true
    }
}

Response Field Notes

Field	Notes
`content.success`	Whether the lookup succeeded.
`content.data[].productTypeId`	The product type ID. Use this as `typeId` in a product booking.
`content.data[].categoryId` / `familyId`	The parent category/family IDs. Match `id` values from Get All Product Categories / Get All Product Families.
`content.data[].category` / `family`	Display names for the parent category/family (unlike Get All Product Families, these are populated here, not `null`).
`content.data[].type`	The booking type this product type is associated with, for example `"General"` or `"Textile"`.
`content.data[].maxNbOfPcs` / `maxNbOfRefs` / `maxNbOfPts`	Maximum pieces/references/points allowed per man-day for this product type, used in inspection sampling calculations.

Common Errors

See common authentication errors for 401 and 403 responses.

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

Next Steps

Use a product type's productTypeId as typeId when booking an Inspection, Audit, or Lab Testing order.

Documents