Stores Products: Supported Filters and Sorting

The following table shows field support for filters and sorting for the SearchProducts endpoint :

Field	Supported Filters	Sortable
id	$eq, $ne, $exists, $in, $startsWith
handle	$eq, $ne, $exists, $in, $startsWith
slug	$eq, $ne, $exists, $in, $startsWith
directCategoriesInfo.categories	$matchItems
directCategoriesInfo.categories.id	$eq, $ne, $exists, $in, $hasSome, $startsWith
allCategoriesInfo.categories	$matchItems
allCategoriesInfo.categories.id	$eq, $ne, $exists, $in, $hasSome, $startsWith
productType	$eq, $ne, $exists, $in
inventory.availabilityStatus	$eq, $ne, $exists, $in
inventory.preorderStatus	$eq, $ne, $exists, $in
inventory.preorderAvailability	$eq, $ne, $exists, $in
visible	$eq, $ne, $exists, $in
visibleInPos	$eq, $ne, $exists, $in
importId	$eq, $ne, $exists, $in, $startsWith
modifiers.id	$isEmpty, $hasAll, $hasSome
modifiers.choicesSettings.choices.choiceId	$isEmpty, $hasAll, $hasSome
modifiers.choicesSettings.choices.name	$isEmpty, $hasAll, $hasSome
modifiers.name	$isEmpty, $hasAll, $hasSome
options.id	$isEmpty, $hasAll, $hasSome
options.choicesSettings.choices.choiceId	$isEmpty, $hasAll, $hasSome
options.choicesSettings.choices.name	$isEmpty, $hasAll, $hasSome
options.name	$isEmpty, $hasAll, $hasSome
flattenOptions	$isEmpty, $hasAll, $hasSome
flattenModifiers	$isEmpty, $hasAll, $hasSome
brand.id	$eq, $ne, $exists, $in, $startsWith
brand.name	$eq, $ne, $exists, $in, $startsWith
ribbon.id	$eq, $ne, $exists, $in, $startsWith
ribbon.name	$eq, $ne, $exists, $in, $startsWith
infoSections.id	$isEmpty, $hasAll, $hasSome
infoSections.uniqueName	$isEmpty, $hasAll, $hasSome
taxGroupId	$eq, $ne, $exists, $in, $startsWith
physicalProperties.fulfillerId	$eq, $ne, $exists, $in, $startsWith
physicalProperties.shippingGroupId	$eq, $ne, $exists, $in, $startsWith
physicalProperties.deliveryProfileId	$eq, $ne, $exists, $in, $startsWith
variantsInfo.variants	$matchItems
variantsInfo.variants.visible	$eq, $ne, $exists, $in, $hasSome
variantsInfo.variants.price.actualPrice.amount	$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gte
variantsInfo.variants.price.compareAtPrice.amount	$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gte
variantsInfo.variants.choices.optionChoiceIds.optionId	$isEmpty, $hasAll, $hasSome
variantsInfo.variants.choices.optionChoiceIds.choiceId	$isEmpty, $hasAll, $hasSome
variantsInfo.variants.sku	$eq, $ne, $exists, $in, $hasSome, $startsWith
variantsInfo.variants.barcode	$eq, $ne, $exists, $in, $hasSome, $startsWith
variantsInfo.variants.physicalProperties.weight	$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gte
subscriptionDetails.allowOneTimePurchases	$eq, $ne, $exists, $in
name	$eq, $ne, $exists, $in, $startsWith	Sortable
updatedDate	$eq, $ne, $exists, $in, $lt, $lte, $gt, $gte	Sortable
createdDate	$eq, $ne, $exists, $in, $lt, $lte, $gt, $gte	Sortable
numericId	$eq, $ne, $exists, $in, $lt, $lte, $gt, $gte	Sortable
actualPriceRange.minValue.amount	$eq, $ne, $exists, $in, $lt, $lte, $gt, $gte	Sortable
actualPriceRange.maxValue.amount	$eq, $ne, $exists, $in, $lt, $lte, $gt, $gte	Sortable
compareAtPriceRange.minValue.amount	$eq, $ne, $exists, $in, $lt, $lte, $gt, $gte	Sortable
compareAtPriceRange.maxValue.amount	$eq, $ne, $exists, $in, $lt, $lte, $gt, $gte	Sortable
physicalProperties.shippingWeightRange.minValue	$eq, $ne, $exists, $in, $lt, $lte, $gt, $gte	Sortable
physicalProperties.shippingWeightRange.maxValue	$eq, $ne, $exists, $in, $lt, $lte, $gt, $gte	Sortable
directCategoriesInfo.categories.index	$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gte	Sortable
allCategoriesInfo.categories.index	$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gte	Sortable

The following table shows field support for filters and sorting for the QueryProducts endpoint :

Field	Supported Filters	Sortable
id	$eq, $ne, $exists, $in, $startsWith
handle	$eq, $ne, $exists, $in, $startsWith
options.id	$isEmpty, $hasAll, $hasSome
slug	$eq, $ne, $exists, $in, $startsWith	Sortable
createdDate	$eq, $ne, $exists, $in, $lt, $lte, $gt, $gte	Sortable
updatedDate	$eq, $ne, $exists, $in, $lt, $lte, $gt, $gte	Sortable
visible	$eq, $ne, $exists, $in	Sortable

Related content: API Query Language, Query Store Products, Search Store Products