List Categories

GET/store/:storeCode/product-categories
publishable key

Retrieve a paginated list of product categories.

Path Parameters
storeCoderequiredstring

Store slug in the URL (first argument to every SDK store method).

Query Parameters
limitnumber

Maximum number of items to return.

offsetnumber

Number of items to skip before collecting the result set.

orderstring

Field to sort by. Prefix with `-` for descending order (e.g. `-created_at`).

fieldsstring

Comma-separated fields to include. Prefix with `*` to expand a relation (e.g. `id,*variants`).

qstring

Search query.

idstring | string[]

Filter by ID(s).

namestring

Filter by name.

handlestring

Filter by handle.

parent_category_idstring | null

Filter by parent category.

include_descendants_treeboolean

Include the full descendants tree.

include_ancestors_treeboolean

Include the ancestors tree.

Response

Status

200OK

Schema

Copy
HttpTypes.StoreProductCategoryListResponse

Properties

product_categoriesrequiredStoreProductCategory[]

List of categories.

countrequirednumber

Total count.

offsetrequirednumber

Offset applied.

limitrequirednumber

Limit applied.