AdminGetProductsParams
Parameters used to filter and configure the pagination of the retrieved products.
constructor
Properties
category_id
string[]Filter products by their associated product category's ID.
collection_id
string[]Filter products by their associated product collection's ID.
created_at
DateComparisonOperatorDate filters to apply on the products' created_at
date.
created_at
DateComparisonOperatorcreated_at
date.deleted_at
DateComparisonOperatorDate filters to apply on the products' deleted_at
date.
deleted_at
DateComparisonOperatordeleted_at
date.description
stringDescription to filter products by.
discount_condition_id
stringFilter products by their associated discount condition's ID.
expand
stringComma-separated relations that should be expanded in the returned data.
fields
stringComma-separated fields that should be included in the returned data.
handle
stringHandle to filter products by.
id
string | string[]IDs to filter products by.
include_category_children
booleanWhether to include product category children in the response.
is_giftcard
booleanFilter products by whether they're gift cards.
limit
numberLimit the number of items returned in the list.
Default: 50
offset
numberThe number of items to skip when retrieving a list.
Default: 0
order
stringThe 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_id
string[]Filter products by their associated price lists' ID.
q
stringSearch term to search products' title, description, variants' title and sku, and collections' title.
sales_channel_id
string[]Filter products by their associated sales channels' ID.
status
ProductStatus[]Statuses to filter products by.
status
ProductStatus[]tags
string[]Filter products by their associated tags' value.
title
stringTitle to filter products by.
type_id
string[]Filter products by their associated product type's ID.
updated_at
DateComparisonOperatorDate filters to apply on the products' updated_at
date.
updated_at
DateComparisonOperatorupdated_at
date.Was this section helpful?