Retrieve product variants using structured queries with cursor-based pagination.
Use this endpoint for simple filtering operations on productData.productId and variant identifiers.
The id field is deprecated and is not globally unique by itself. Use productData.productId
together with variantId as the unique variant key.
For complex queries with free-text search and aggregations, use Search Variants instead.
Up to 1,000 variants can be returned per request.
To learn about working with Query endpoints, see API Query Language, and Sorting and Paging.
Learn more about the differences between Query and Search methods.
| Property | Filters | Sort |
|---|---|---|
_id | $eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte | Sort: ASC, DESC |
variantId | $eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte | Sort: ASC, DESC |
productData.productId | $eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte | Sort: ASC, DESC |
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.