AdminGetProductCategoriesParams

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

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 product categories in the response.

is_activeboolean

Filter product categories by whether they're active.

is_internalboolean

Filter product categories by whether they're internal.

limitnumber

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

offsetnumber

The number of items to skip when retrieving a list.

Default: 0

parent_category_idnull | string

Filter product categories by their associated parent ID.

qstring

Search term to search product categories' names and handles.