AdminGetProductsParams

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

Properties

category_idstring[]

Filter products by their associated product category's ID.

collection_idstring[]

Filter products by their associated product collection's ID.

created_atDateComparisonOperator

Date filters to apply on the products' created_at date.

deleted_atDateComparisonOperator

Date filters to apply on the products' deleted_at date.

descriptionstring

Description to filter products by.

discount_condition_idstring

Filter products by their associated discount condition's ID.

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

idstring | string[]

IDs to filter products by.

include_category_childrenboolean

Whether to include product category children in the response.

is_giftcardboolean

Filter products by whether they're gift cards.

limitnumber

Limit the number of items returned in the list.

Default: 50

offsetnumber

The number of items to skip when retrieving a list.

Default: 0

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

price_list_idstring[]

Filter products by their associated price lists' ID.

qstring

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

sales_channel_idstring[]

Filter products by their associated sales channels' ID.

statusProductStatus[]

Statuses to filter products by.

tagsstring[]

Filter products by their associated tags' value.

titlestring

Title to filter products by.

type_idstring[]

Filter products by their associated product type's ID.

updated_atDateComparisonOperator

Date filters to apply on the products' updated_at date.