AdminGetCollectionsParams

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

Properties

limitnumberRequired

Limit the number of items returned in the list.

Default: 10

offsetnumberRequired

The number of items to skip when retrieving a list.

Default: 0

titlestring

Title to filter product collections by.

handlestring

Handle to filter product collections by.

created_atDateComparisonOperator

Date filters to apply on the product collections' created_at date.

updated_atDateComparisonOperator

Date filters to apply on the product collections' updated_at date.

deleted_atDateComparisonOperator

Date filters to apply on the product collections' deleted_at date.

qstring

Term to search product collections by their title and handle.

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 -.

discount_condition_idstring

Filter product collections by their associated discount condition's ID.