List Product Categories

Retrieve a list of product categories. The product categories can be filtered by fields such as handle or q. The product categories can also be paginated. This API Route can also be used to retrieve a product category by its handle.

Responses

🟢200OK

application/json

Body

Example

{
    "count": 0,
    "offset": 0,
    "limit": 0,
    "product_categories": [
        {
            "id": "pcat_01G2SG30J8C85S4A5CHM2S1NS2",
            "name": "Regular Fit",
            "description": "",
            "handle": "regular-fit",
            "mpath": "pcat_id1.pcat_id2.pcat_id3",
            "is_internal": false,
            "is_active": false,
            "rank": 0,
            "parent_category_id": null,
            "parent_category": {},
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "category_children": [
                {}
            ],
            "products": [
                {}
            ],
            "metadata": {
                "car": "white"
            }
        }
    ]
}

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

List Product Categories

Request

Request samples

Responses