StoreGetProductCategoriesParams

Parameters used to filter and configure the pagination of the retrieved product categories.

constructor

Parameters

argsunknown[]Required

---

Properties

expandstring

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

fieldsstring

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

handlestring

Handle to filter product categories by.

include_descendants_treeboolean

Whether to include child categories in the retrieved categories.

limitnumber

Limit the number of product categories returned in the list. Default is 100.

Default: 20

offsetnumber

The number of items to skip when retrieving a list.

Default: 0

parent_category_idnull | string

Filter product categories by the ID of their associated parent category.

qstring

Search term to search product categories' names and handles.