The following table shows field support for filters and sorting for the SearchProducts endpoint :
| Field | Supported Filters | Sortable |
|---|---|---|
id | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
handle | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
slug | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
directCategoriesInfo.id | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
allCategoriesInfo.id | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
productType | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
inventory.availabilityStatus | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
inventory.preorderStatus | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
inventory.prerorderAvailability | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
visible | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
visibleInPos | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
importId | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
modifiers.id | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
modifiers.choicesSettings.choices.choiceId | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
modifiers.choicesSettings.choices.name | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
modifiers.name | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
options.id | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
options.choicesSettings.choices.choiceId | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
options.choicesSettings.choices.name | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
options.name | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
flattenOptions | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
flattenModifiers | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
brand.id | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
brand.name | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
ribbon.id | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
ribbon.name | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
infoSections.id | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
infoSections.uniqueName | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
taxGroupId | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
physicalProperties.fulfillerId | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
physicalProperties.shippingGroupId | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
physicalProperties.deliveryProfile.Id | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
variantsInfo.variants.visible | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
variantsInfo.variants.price.actualPrice.amount | $eq, $ne, $exists, $in, $hasSome, $lt, $le, $gt, $ge | |
variantsInfo.variants.choices.optionChoiceIds.OptionId | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
variantsInfo.variants.choices.optionChoiceIds.ChoiceId | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
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, $le, $gt, $ge | |
subscriptionDetails.allowOneTimePurchases | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
name | $eq, $ne, $exists, $in, $hasSome, $startsWith | Sortable |
updatedDate | $eq, $ne, $exists, $in, $hasSome, $lt, $le, $gt, $ge | Sortable |
createdDate | $eq, $ne, $exists, $in, $hasSome, $lt, $le, $gt, $ge | Sortable |
numbericId | $eq, $ne, $exists, $in, $hasSome, $lt, $le, $gt, $ge | Sortable |
actualPriceRange.minValue.amount | $eq, $ne, $exists, $in, $hasSome, $lt, $le, $gt, $ge | Sortable |
actualPriceRange.maxValue.amount | $eq, $ne, $exists, $in, $hasSome, $lt, $le, $gt, $ge | Sortable |
compareAtPriceRange.minValue.amount | $eq, $ne, $exists, $in, $hasSome, $lt, $le, $gt, $ge | Sortable |
compareAtPriceRange.maxValue.amount | $eq, $ne, $exists, $in, $hasSome, $lt, $le, $gt, $ge | Sortable |
physicalProperties.shippingWeightRange.minValue | $eq, $ne, $exists, $in, $hasSome, $lt, $le, $gt, $ge | Sortable |
physicalProperties.shippingWeightRange.maxValue | $eq, $ne, $exists, $in, $hasSome, $lt, $le, $gt, $ge | Sortable |
directCategoriesInfo.categories.index | $eq, $ne, $exists, $in, $hasSome, $lt, $le, $gt, $ge | Sortable |
allCategoriesInfo.categories.index | $eq, $ne, $exists, $in, $hasSome, $lt, $le, $gt, $ge | Sortable |
minVariantPriceInfo.sku | $eq, $ne, $exists, $in, $hasSome, $startsWith | Sortable |
The following table shows field support for filters and sorting for the QueryProducts endpoint :
| Field | Supported Filters | Sortable |
|---|---|---|
id | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
handle | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
options.id | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
slug | $eq, $ne, $exists, $in, $hasSome, $startsWith | Sortable |
createdDate | $eq, $ne, $exists, $in, $hasSome, $lt, $le, $gt, $ge | Sortable |
updatedDate | $eq, $ne, $exists, $in, $hasSome, $lt, $le, $gt, $ge | Sortable |
visible | $eq, $ne, $exists, $in, $hasSome, $startsWith |
Related content: API Query Language, Query Store Products, Search Store Products