Retrieve Product Category

GET

store

product-categories

{id}

curl 'http://localhost:9000/store/product-categories/pcat_01JB2K6A2B?include_descendants_tree=true' \
  -H 'x-publishable-api-key: pk_01JB2K3XYZ'

const { product_category } = await client.store.productCategories.$id.query({
  $id: "pcat_01JB2K6A2B",
  include_descendants_tree: true,
})

{
  "product_category": {
    "id": "pcat_01JB2K6A2B",
    "name": "Shirts",
    "description": "",
    "handle": "shirts",
    "rank": 0,
    "parent_category_id": null,
    "parent_category": null,
    "category_children": [{ "id": "pcat_01JB2K6H7J", "name": "Linen Shirts" }],
    "metadata": null,
    "created_at": "2026-05-01T10:00:00.000Z",
    "updated_at": "2026-05-01T10:00:00.000Z"
  }
}

Returns a single category; inactive or internal categories return a 404.

Path parameters

string

required

The category’s ID.

Query parameters

string

Comma-separated fields and relations to include; prefix with +/- to add to or remove from the defaults.

boolean

Include the category’s ancestors in parent_category.

boolean

Include the category’s descendants in category_children.

Response

object

Show properties

string

The category’s ID.

string

The category’s name.

string

The category’s description.

string

URL-safe handle.

number

Sort rank among siblings.

string | null

ID of the parent category.

object | null

The parent category.

object[]

Direct child categories.

object | null

Custom key-value data.

string

Creation timestamp.

string

Last update timestamp.

curl 'http://localhost:9000/store/product-categories/pcat_01JB2K6A2B?include_descendants_tree=true' \
  -H 'x-publishable-api-key: pk_01JB2K3XYZ'

const { product_category } = await client.store.productCategories.$id.query({
  $id: "pcat_01JB2K6A2B",
  include_descendants_tree: true,
})

{
  "product_category": {
    "id": "pcat_01JB2K6A2B",
    "name": "Shirts",
    "description": "",
    "handle": "shirts",
    "rank": 0,
    "parent_category_id": null,
    "parent_category": null,
    "category_children": [{ "id": "pcat_01JB2K6H7J", "name": "Linen Shirts" }],
    "metadata": null,
    "created_at": "2026-05-01T10:00:00.000Z",
    "updated_at": "2026-05-01T10:00:00.000Z"
  }
}

curl 'http://localhost:9000/store/product-categories/pcat_01JB2K6A2B?include_descendants_tree=true' \
  -H 'x-publishable-api-key: pk_01JB2K3XYZ'

const { product_category } = await client.store.productCategories.$id.query({
  $id: "pcat_01JB2K6A2B",
  include_descendants_tree: true,
})

{
  "product_category": {
    "id": "pcat_01JB2K6A2B",
    "name": "Shirts",
    "description": "",
    "handle": "shirts",
    "rank": 0,
    "parent_category_id": null,
    "parent_category": null,
    "category_children": [{ "id": "pcat_01JB2K6H7J", "name": "Linen Shirts" }],
    "metadata": null,
    "created_at": "2026-05-01T10:00:00.000Z",
    "updated_at": "2026-05-01T10:00:00.000Z"
  }
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Path parameters

Query parameters

Response

​Path parameters

​Query parameters

​Response

Path parameters

Query parameters

Response