List Product Categories

GET/store/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.

Request

Query Params

string

optional

term used to search product category's names and handles.

handle

string

optional

Filter by handle.

parent_category_id

string

optional

Filter by the ID of a parent category. Only children of the provided parent category are retrieved.

include_descendants_tree

string

optional

Whether all nested categories inside a category should be retrieved.

offset

integer

optional

The number of product categories to skip when retrieving the product categories.

limit

integer

optional

Limit the number of product categories returned.

expand

string

optional

Comma-separated relations that should be expanded in the returned product categories.

fields

string

optional

Comma-separated fields that should be included in the returned product categories.

Request samples

Responses

OK(200)

Client Error or Multiple Errors(400)

User is not authorized. Must log in first(401)

Not Found Error(404)

Invalid State Error(409)

Invalid Request Error(422)

Server Error(500)

HTTP Code: 200

Content Type : JSONapplication/json

No schema defined

Not configured

Last modified: a year ago