AdminGetProductsParams

Parameters used to filter and configure the pagination of the retrieved products.

Properties

offsetnumber

The number of items to skip when retrieving a list.

Default: 0

limitnumber

Limit the number of items returned in the list.

Default: 50

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.

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

idstring | string[]

IDs to filter products by.

qstring

Search term to search products' title, description, variants' title and sku, and collections' title.

statusProductStatus[]

Statuses to filter products by.

price_list_idstring[]

Filter products by their associated price lists' ID.

collection_idstring[]

Filter products by their associated product collection's ID.

tagsstring[]

Filter products by their associated tags' value.

titlestring

Title to filter products by.

descriptionstring

Description to filter products by.

handlestring

Handle to filter products by.

is_giftcardboolean

Filter products by whether they're gift cards.

type_idstring[]

Filter products by their associated product type's ID.

sales_channel_idstring[]

Filter products by their associated sales channels' ID.

discount_condition_idstring

Filter products by their associated discount condition's ID.

category_idstring[]

Filter products by their associated product category's ID.

include_category_childrenboolean

Whether to include product category children in the response.

created_atDateComparisonOperator

Date filters to apply on the products' created_at date.

updated_atDateComparisonOperator

Date filters to apply on the products' updated_at date.

deleted_atDateComparisonOperator

Date filters to apply on the products' deleted_at date.