List Product Categories

GET

store

product-categories

curl 'http://localhost:9000/store/product-categories?parent_category_id=null&limit=50' \
  -H 'x-publishable-api-key: pk_01JB2K3XYZ'

const { product_categories, count } = await client.store.productCategories.query({
  parent_category_id: "null",
  limit: 50,
})

{
  "product_categories": [
    {
      "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"
    }
  ],
  "count": 8,
  "offset": 0,
  "limit": 50
}

Returns a paginated list of product categories; inactive and internal categories are always excluded.

Query parameters

number

default:"50"

Maximum number of categories to return.

number

default:"0"

Number of categories to skip before collecting results.

string

Field to sort by, prefixed with - for descending order.

string

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

string

Free-text search term applied to category fields.

string | string[]

Filter by one or more category IDs.

string | string[]

Filter by one or more category handles.

string | string[]

Filter by parent category ID; pass null to fetch top-level categories.

boolean

Include each category’s ancestors in parent_category.

boolean

Include each category’s descendants in category_children.

object

Filter by creation date using operators like $gt, $gte, $lt, $lte.

object

Filter by update date using operators like $gt, $gte, $lt, $lte.

object[]

Join multiple filter objects with a logical AND.

object[]

Join multiple filter objects with a logical OR.

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.

number

Total number of matching categories.

number

Number of skipped categories.

number

Maximum number of returned categories.

curl 'http://localhost:9000/store/product-categories?parent_category_id=null&limit=50' \
  -H 'x-publishable-api-key: pk_01JB2K3XYZ'

const { product_categories, count } = await client.store.productCategories.query({
  parent_category_id: "null",
  limit: 50,
})

{
  "product_categories": [
    {
      "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"
    }
  ],
  "count": 8,
  "offset": 0,
  "limit": 50
}

curl 'http://localhost:9000/store/product-categories?parent_category_id=null&limit=50' \
  -H 'x-publishable-api-key: pk_01JB2K3XYZ'

const { product_categories, count } = await client.store.productCategories.query({
  parent_category_id: "null",
  limit: 50,
})

{
  "product_categories": [
    {
      "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"
    }
  ],
  "count": 8,
  "offset": 0,
  "limit": 50
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Query parameters

Response

​Query parameters

​Response

Query parameters

Response