StoreGetProductCategoriesParams

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

Properties

qstring

Search term to search product categories' names and handles.

handlestring

Handle to filter product categories by.

parent_category_idnull | string

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

include_descendants_treeboolean

Whether to include child categories in the retrieved categories.

expandstring

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

fieldsstring

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

offsetnumber

The number of items to skip when retrieving a list.

Default: 0

limitnumber

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

Default: 20

orderstring

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.