This method is in Alpha and may change in the future.
Retrieves a list of product groups, given the provided paging, filtering, sorting, and free-text search.
Search Product Groups supports a broader set of filterable and sortable fields than Query Product Groups, including member fields, and adds free-text matching on the group's name and member product names.
By default, only members with status ACTIVE are included in the returned product groups. Members with status HIDDEN or OUT_OF_SYNC are returned only to callers that have the readNonVisible permission.
| Property | Capabilities | Filters |
|---|---|---|
createdDate | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte |
id | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
name | Search: ✓ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
members.productId | Search: ✗ Aggregate: ✓ Sort: ✗ | $hasAll, $hasSome |
members.productName | Search: ✓ Aggregate: ✓ Sort: ✗ | $hasAll, $hasSome |
groupingCustomizationId | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.