Read-Only Variants API: Supported Filters and Sorting

Query Variants Endpoint

The following table shows field support for filters and sorting for the Query Variants method:

FieldSupported FiltersSortable
id$eq, $in, $ne, $ninSortable
productData.productId$eq, $in, $ne, $ninSortable

Search Variants Endpoint

The following table shows field support for filters and sorting for the Search Variants method:

FieldSupported FiltersSortableField Search
productData.name$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gteSortableSearchable
productData.slug$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gteSortable
productData.productId$eq, $in, $ne, $ninSortable
productData.productType$eq, $ne, $inSortable
productData.visible$eq, $ne, $exists, $in, $anySortable
productData.visibleInPos$eq, $ne, $exists, $in, $anySortable
productData.directCategoryIds$eq, $ne, $exists, $in, $any, $allSortable
sku$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gteSortable
barcode$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gteSortable
optionChoices.optionChoiceIds.optionId$eq, $ne, $exists, $in, $any, $beginsSortable
optionChoices.optionChoiceIds.choiceId$eq, $ne, $exists, $in, $any, $beginsSortable
price.actualPrice.amount$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gteSortable
price.compareAtPrice.amount$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gteSortable
inventoryStatus.inStock$eq, $ne, $exists, $in, $anySortable
inventoryStatus.preorderEnabled$eq, $ne, $exists, $in, $anySortable
visible$eq, $ne, $exists, $in, $anySortable

Related content: API Query Language, Query Variants, Search Variants

Did this help?