POST

Search Variants


Search product variants using free-text search with advanced query capabilities.

Use this endpoint for complex queries that include free-text search, aggregations, or when you need faceted search results. For simple filtering, use Query Variants instead.

Supports Wix Query Language (WQL) for structured filtering combined with free-text search.

Note: Non-visible variants, and variants related to non-visible products are filtered from results if you don't have permissions to read hidden products.

PropertyCapabilitiesFilters
optionChoices.optionChoiceIds.choiceIdSearch: ✗
Aggregate:
Sort: ASC, DESC
$hasAll, $hasSome
optionChoices.optionChoiceIds.optionIdSearch: ✗
Aggregate:
Sort: ASC, DESC
$hasAll, $hasSome
barcodeSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
inventoryStatus.inStockSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any
inventoryStatus.preorderEnabledSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any
price.actualPrice.amountSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
price.compareAtPrice.amountSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
productData.nameSearch:
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
productData.productIdSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
productData.productTypeSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any
productData.slugSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
productData.visibleSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any
productData.visibleInPosSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any
skuSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
visibleSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any
Endpoint
POST
https://www.wixapis.com/stores/v3/products/search-variants

Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?