@wix/ditto-codegen-public 1.0.161 → 1.0.163

package/dist/docs-output/api-docs/stores-readOnlyVariantsV3-searchVariants-doc.txt

@@ -0,0 +1,353 @@
+<stores_readOnlyVariantsV3_searchVariants>
+<description>
+# Method name:
+
+stores.readOnlyVariantsV3.searchVariants(search: CursorSearch, options: SearchVariantsOptions)
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/read-only-variants-v3/search-variants
+
+# Method Description:
+
+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.
+
+| Property | Capabilities | Filters
+|-------|------------|------|
+| `optionChoices.optionChoiceIds.choiceId` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$hasAll`, `$hasSome` |
+| `optionChoices.optionChoiceIds.optionId` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$hasAll`, `$hasSome` |
+| `barcode` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |
+| `inventoryStatus.inStock` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any` |
+| `inventoryStatus.preorderEnabled` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any` |
+| `price.actualPrice.amount` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |
+| `price.compareAtPrice.amount` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |
+| `productData.handle` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |
+| `productData.name` | Search: <span style="color: #2e7d32;">✓</span><br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |
+| `productData.productId` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |
+| `productData.productType` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any` |
+| `productData.slug` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |
+| `productData.visible` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any` |
+| `productData.visibleInPos` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any` |
+| `sku` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |
+| `visible` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any` |
+
+
+# Method Permissions:
+
+- WIX_STORES.READ_ONLY_VARIANT_READ
+- WIX_STORES.READ_ONLY_VARIANT_READ_HIDDEN
+
+# Method Permissions Scopes IDs:
+
+undefined
+
+
+
+# Method Code Examples:
+
+## searchVariants
+
+```javascript
+import { readOnlyVariantsV3 } from '@wix/stores';
+
+async function searchVariants(search, options) {
+ const response = await readOnlyVariantsV3.searchVariants(search, options);
+};
+```
+
+## searchVariants (with elevated permissions)
+
+```javascript
+import { readOnlyVariantsV3 } from '@wix/stores';
+import { auth } from '@wix/essentials';
+
+async function mySearchVariantsMethod(search, options) {
+ const elevatedSearchVariants = auth.elevate(readOnlyVariantsV3.searchVariants);
+ const response = await elevatedSearchVariants(search, options);
+}
+```
+
+
+
+## default
+
+```javascript
+try {
+     const result = await readOnlyVariantsV3.searchVariants({
+       search: {
+         aggregations: [],
+         filter: {},
+         search: {
+           expression: "Future Product",
+           fields: ["productData.name"],
+           fuzzy: true,
+           mode: "OR"
+         },
+         sort: [],
+         timeZone: "+02:00"
+       }
+     }, {});
+     return result;
+   } catch (error) {
+     console.error(error);
+     throw error;
+  }
+```
+</description>
+<type_definition>
+```
+Method: stores.readOnlyVariantsV3.searchVariants(search, options)
+Description: 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.  | Property | Capabilities | Filters |-------|------------|------| | `optionChoices.optionChoiceIds.choiceId` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$hasAll`, `$hasSome` | | `optionChoices.optionChoiceIds.optionId` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$hasAll`, `$hasSome` | | `barcode` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` | | `inventoryStatus.inStock` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any` | | `inventoryStatus.preorderEnabled` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any` | | `price.actualPrice.amount` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` | | `price.compareAtPrice.amount` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` | | `productData.handle` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` | | `productData.name` | Search: <span style="color: #2e7d32;">✓</span><br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` | | `productData.productId` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` | | `productData.productType` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any` | | `productData.slug` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` | | `productData.visible` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any` | | `productData.visibleInPos` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any` | | `sku` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` | | `visible` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any` | 
+Method parameters:
+  param name:  search | type: CursorSearch | description:  WQL expression for searching variants. | required: true
+      - name: aggregations  | type: Array<Aggregation> | description:  Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition. 
+            - name: fieldPath  | type: string | description:  Field to aggregate by, use dot notation to specify json path 
+            - name: name  | type: string | description:  User-defined name of aggregation, should be unique, will appear in aggregation results 
+            - name: type  | type: AggregationType | description:  Type of aggregation, client must provide matching aggregation field below 
+                enum: 
+                     DATE_HISTOGRAM: An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.)
+                     NESTED: Multi-level aggregation, where each next aggregation is nested within previous one
+                     RANGE: An aggregation, where user can define set of ranges - each representing a bucket
+                     SCALAR: A single-value metric aggregation - e.g. min, max, sum, avg
+                   UNKNOWN_AGGREGATION_TYPE,   VALUE: An aggregation where result buckets are dynamically built - one per unique value
+            - ONE-OF: 
+              - name: dateHistogram  | type: DateHistogramAggregation | description:  Date histogram aggregation 
+                  - name: interval  | type: Interval | description:  Interval for date histogram aggregation 
+                      enum: 
+                           DAY: Daily interval
+                           HOUR: Hourly interval
+                           MINUTE: Minute interval
+                           MONTH: Monthly interval
+                           SECOND: Second interval
+                         UNKNOWN_INTERVAL,   WEEK: Weekly interval
+                           YEAR: Yearly interval
+              - name: nested  | type: NestedAggregation | description:  Nested aggregation 
+                  - name: nestedAggregations  | type: Array<NestedAggregationItem> | description:  Flattened list of aggregations, where each next aggregation is nested within previous one 
+                        - name: fieldPath  | type: string | description:  Field to aggregate by, use dont notation to specify json path 
+                        - name: name  | type: string | description:  User-defined name of aggregation, should be unique, will appear in aggregation results 
+                        - name: type  | type: NestedAggregationType | description:  Type of aggregation, client must provide matching aggregation field below 
+                            enum: 
+                                 DATE_HISTOGRAM: An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.)
+                                 RANGE: An aggregation, where user can define set of ranges - each representing a bucket
+                                 SCALAR: A single-value metric aggregation - e.g. min, max, sum, avg
+                               UNKNOWN_AGGREGATION_TYPE,   VALUE: An aggregation where result buckets are dynamically built - one per unique value
+                        - ONE-OF: 
+                          - name: dateHistogram  | type: DateHistogramAggregation | description:  Date histogram aggregation 
+                          - name: range  | type: RangeAggregation | description:  Range aggregation 
+                              - name: buckets  | type: Array<RangeBucket> | description:  List of range buckets, where during aggregation each entity will be placed in the first bucket where its value falls into based on provided range bounds 
+                                    - name: from  | type: number | description:  Inclusive lower bound of the range. Required if to is not given 
+                                    - name: to  | type: number | description:  Exclusive upper bound of the range. Required if from is not given 
+                          - name: scalar  | type: ScalarAggregation | description:  Scalar aggregation 
+                              - name: type  | type: ScalarType | description:  Define the operator for the scalar aggregation 
+                                  enum: 
+                                       COUNT_DISTINCT: Count of distinct values
+                                       MAX: Maximum value
+                                       MIN: Minimum value
+                                     UNKNOWN_SCALAR_TYPE
+                          - name: value  | type: ValueAggregation | description:  Value aggregation 
+                              - name: limit  | type: number | description:  How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. 
+                              - name: missingValues  | type: MissingValues | description:  Should missing values be included or excluded from the aggregation results. Default is EXCLUDE 
+                                  enum: 
+                                       EXCLUDE: Should missing values be excluded from the aggregation results
+                                       INCLUDE: Should missing values be included in the aggregation results
+                              - name: sortDirection  | type: SortDirection | description:  Should sort in ascending or descending order 
+                                  enum: 
+                                       ASC: Should sort in ascending order
+                                       DESC: Should sort in descending order
+                              - name: sortType  | type: SortType | description:  Should sort by number of matches or value of the field 
+                                  enum: 
+                                       COUNT: Should sort by number of matches
+                                       VALUE: Should sort by value of the field alphabetically
+                              - ONE-OF: 
+                                - name: includeOptions  | type: IncludeMissingValuesOptions | description:  Options for including missing values 
+                                    - name: addToBucket  | type: string | description:  Can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... 
+              - name: range  | type: RangeAggregation | description:  Range aggregation 
+              - name: scalar  | type: ScalarAggregation | description:  Scalar aggregation 
+              - name: value  | type: ValueAggregation | description:  Value aggregation 
+      - name: filter  | type: Record<string, any> | description:  A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) 
+      - name: search  | type: SearchDetails | description:  Free text to match in searchable fields 
+          - name: expression  | type: string | description:  Search term or expression 
+          - name: fields  | type: Array<string> | description:  Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path 
+          - name: fuzzy  | type: boolean | description:  Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) 
+          - name: mode  | type: Mode | description:  Defines how separate search terms in `expression` are combined 
+              enum: 
+                   AND: All search terms must be present
+                   OR: Any of the search terms must be present
+      - name: sort  | type: Array<Sorting> | description:  Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] 
+            - name: fieldName  | type: string | description:  Name of the field to sort by. 
+            - name: order  | type: SortOrder | description:  Sort order. 
+                enum: ASC, DESC
+      - name: timeZone  | type: string | description:  UTC offset or IANA time zone. Valid values are ISO 8601 UTC offsets, such as +02:00 or -06:00, and IANA time zone GUIDs, such as Europe/Rome  Affects all filters and aggregations returned values. You may override this behavior in a specific filter by providing timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"` 
+      - ONE-OF: 
+        - name: cursorPaging  | type: CursorPaging | description:  Cursor pointing to page of results. When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided. 
+            - name: cursor  | type: string | description:  Pointer to the next or previous page in the list of results.  Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. 
+            - name: limit  | type: number | description:  Maximum number of items to return in the results. 
+  param name:  options | type: SearchVariantsOptions | description:  none 
+      - name: fields  | type: Array<RequestedFields> | description:  List of additional fields to include in the response. See VariantOps.RequestedFields for available options. 
+            enum: 
+                 CURRENCY: Include currency information in product data.  Returns the currency code (ISO-4217 format) used for pricing this variant. Defaults to the site's currency unless specified in request headers.
+                 MERCHANT_DATA: Include merchant-specific data such as cost and profit information.  Returns revenue details including cost, profit, and profit margin. Requires `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.
+                 SUBSCRIPTION_PRICES_INFO: Include subscription pricing information.  Returns calculated prices for different subscription plans with applied discounts. Only relevant for variants that are part of subscription offerings.
+                 UNKNOWN_REQUESTED_FIELD: Unknown requested field.
+                 WEIGHT_MEASUREMENT_UNIT_INFO: Include weight measurement unit information.  Returns the weight measurement unit (kg, lb, etc.) used for the variant. Useful for shipping calculations and product comparisons.
+Return type: PROMISE<SearchVariantsResponse>
+      - name: aggregationData  | type: AggregationData | description:  Aggregation results for faceted search. 
+          - name: aggregationData.results  | type: Array<AggregationResults> | description:  key = aggregation name (as derived from search request) 
+                - name: aggregationData.results[].fieldPath  | type: string | description:  Field to aggregate by as derived from search request 
+                - name: aggregationData.results[].name  | type: string | description:  User-defined name of aggregation as derived from search request 
+                - name: aggregationData.results[].type  | type: AggregationType | description:  Type of aggregation that must match provided kind as derived from search request 
+                    enum: 
+                         DATE_HISTOGRAM: An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.)
+                         NESTED: Multi-level aggregation, where each next aggregation is nested within previous one
+                         RANGE: An aggregation, where user can define set of ranges - each representing a bucket
+                         SCALAR: A single-value metric aggregation - e.g. min, max, sum, avg
+                       UNKNOWN_AGGREGATION_TYPE,   VALUE: An aggregation where result buckets are dynamically built - one per unique value
+                - ONE-OF: 
+                  - name: aggregationData.results[].dateHistogram  | type: DateHistogramResults | description:  Date histogram aggregation results 
+                      - name: aggregationData.results[].dateHistogram.results  | type: Array<DateHistogramResult> | description:  List of date histogram aggregations 
+                            - name: aggregationData.results[].dateHistogram.results[].count  | type: number | description:  Count of documents in the bucket 
+                            - name: aggregationData.results[].dateHistogram.results[].value  | type: string | description:  Date in ISO 8601 format 
+                  - name: aggregationData.results[].groupedByValue  | type: GroupByValueResults | description:  Group by value aggregation results 
+                      - name: aggregationData.results[].groupedByValue.results  | type: Array<NestedValueAggregationResult> | description:  List of value aggregations 
+                            - name: aggregationData.results[].groupedByValue.results[].nestedResults  | type: NestedAggregationResults | description:  Nested aggregations 
+                                - name: aggregationData.results[].groupedByValue.results[].nestedResults.fieldPath  | type: string | description:  Field to aggregate by, matches the one provided in request 
+                                - name: aggregationData.results[].groupedByValue.results[].nestedResults.name  | type: string | description:  User-defined name of aggregation, matches the one provided in request 
+                                - name: aggregationData.results[].groupedByValue.results[].nestedResults.type  | type: AggregationType | description:  Type of aggregation that matches result 
+                                - ONE-OF: 
+                                  - name: aggregationData.results[].groupedByValue.results[].nestedResults.ranges  | type: RangeResults | description:  Range aggregation results 
+                                      - name: aggregationData.results[].groupedByValue.results[].nestedResults.ranges.results  | type: Array<RangeAggregationResult> | description:  List of ranges returned in same order as requested 
+                                            - name: aggregationData.results[].groupedByValue.results[].nestedResults.ranges.results[].count  | type: number | description:  Count of entities in this range 
+                                            - name: aggregationData.results[].groupedByValue.results[].nestedResults.ranges.results[].from  | type: number | description:  Inclusive lower bound of the range 
+                                            - name: aggregationData.results[].groupedByValue.results[].nestedResults.ranges.results[].to  | type: number | description:  Exclusive upper bound of the range 
+                                  - name: aggregationData.results[].groupedByValue.results[].nestedResults.scalar  | type: AggregationResultsScalarResult | description:  Scalar aggregation results 
+                                      - name: aggregationData.results[].groupedByValue.results[].nestedResults.scalar.type  | type: ScalarType | description:  Type of scalar aggregation 
+                                          enum: 
+                                               COUNT_DISTINCT: Count of distinct values
+                                               MAX: Maximum value
+                                               MIN: Minimum value
+                                             UNKNOWN_SCALAR_TYPE
+                                      - name: aggregationData.results[].groupedByValue.results[].nestedResults.scalar.value  | type: number | description:  Value of the scalar aggregation 
+                                  - name: aggregationData.results[].groupedByValue.results[].nestedResults.values  | type: ValueResults | description:  Value aggregation results 
+                                      - name: aggregationData.results[].groupedByValue.results[].nestedResults.values.results  | type: Array<ValueAggregationResult> | description:  List of value aggregations 
+                                            - name: aggregationData.results[].groupedByValue.results[].nestedResults.values.results[].count  | type: number | description:  Count of entities with this value 
+                                            - name: aggregationData.results[].groupedByValue.results[].nestedResults.values.results[].value  | type: string | description:  Value of the field 
+                            - name: aggregationData.results[].groupedByValue.results[].value  | type: string | description:  Value of the field 
+                  - name: aggregationData.results[].nested  | type: NestedResults | description:  Nested aggregation results 
+                      - name: aggregationData.results[].nested.results  | type: Array<Results> | description:  List of nested aggregations 
+                            - name: aggregationData.results[].nested.results[].results  | type: Record<string, NestedResultValue> | description:  List of nested aggregations 
+                  - name: aggregationData.results[].ranges  | type: RangeResults | description:  Range aggregation results 
+                  - name: aggregationData.results[].scalar  | type: AggregationResultsScalarResult | description:  Scalar aggregation results 
+                  - name: aggregationData.results[].values  | type: ValueResults | description:  Value aggregation results 
+      - name: pagingMetadata  | type: CursorPagingMetadata | description:  Pagination information with cursors for next pages. 
+          - name: pagingMetadata.count  | type: number | description:  Number of items returned in the response. 
+          - name: pagingMetadata.cursors  | type: Cursors | description:  Cursor strings that point to the next page, previous page, or both. 
+              - name: pagingMetadata.cursors.next  | type: string | description:  Cursor string pointing to the next page in the list of results. 
+              - name: pagingMetadata.cursors.prev  | type: string | description:  Cursor pointing to the previous page in the list of results. 
+          - name: pagingMetadata.hasNext  | type: boolean | description:  Whether there are more pages to retrieve following the current page.  + `true`: Another page of results can be retrieved. + `false`: This is the last page. 
+      - name: variants  | type: Array<ReadOnlyVariant> | description:  Variants matching the search criteria. 
+            - name: variants[]._id  | type: string | description:  Variant GUID. 
+            - name: variants[].barcode  | type: string | description:  Barcode for the variant, typically used for point-of-sale systems and inventory management.  Common barcode formats include UPC, EAN, and Code 128. The barcode helps with quick product identification and checkout processes. 
+            - name: variants[].inventoryStatus  | type: V3InventoryStatus | description:  Current inventory and availability status. 
+                - name: variants[].inventoryStatus.inStock  | type: boolean | description:  Whether the variant is currently in stock and available for purchase. 
+                - name: variants[].inventoryStatus.preorderEnabled  | type: boolean | description:  Whether customers can place preorders for this variant when it's out of stock. 
+            - name: variants[].media  | type: V3ProductMedia | description:  Media associated with the variant.  Typically includes images, videos, or other media files specific to this variant. 
+                - name: variants[].media.altText  | type: string | description:  Image alt text. 
+                - name: variants[].media.displayName  | type: string | description:  Media display name. Allows to override the default media name. Can be passed only when `setBy: url`. 
+                - name: variants[].media.mediaType  | type: ProductMediaMediaType | description:  Media type. 
+                    enum: 
+                         IMAGE: Image media type.
+                       UNKNOWN_MEDIA_TYPE,   VIDEO: Video media type.
+                - name: variants[].media.thumbnail  | type: V3Thumbnail | description:  Media thumbnail. 
+                    - name: variants[].media.thumbnail.altText  | type: string | description:  Thumbnail alt text. 
+                    - name: variants[].media.thumbnail.height  | type: number | description:  Thumbnail height. 
+                    - name: variants[].media.thumbnail.url  | type: string | description:  Thumbnail URL. 
+                    - name: variants[].media.thumbnail.width  | type: number | description:  Thumbnail width. 
+                - name: variants[].media.uploadId  | type: string | description:  GUID used to upload media to Wix Media Manager. 
+                - ONE-OF: 
+                  - name: variants[].media._id  | type: string | description:  GUID of existing media from Wix Media Manager. 
+                  - name: variants[].media.url  | type: string | description:  Media URL. 
+                - ONE-OF: 
+                  - name: variants[].media.image  | type: string | description:  Product image. 
+                  - name: variants[].media.video  | type: string | description:  Product video. 
+            - name: variants[].optionChoices  | type: Array<V3OptionChoice> | description:  Product option choices that define this variant.  Each option choice represents a specific selection for a product option (like "Size: Large" or "Color: Red"). An empty list indicates this is the default variant of a product with no managed options. 
+                  - name: variants[].optionChoices[].optionChoiceIds  | type: V3OptionChoiceIds | description:  Option and choice identifiers. 
+                      - name: variants[].optionChoices[].optionChoiceIds.choiceId  | type: string | description:  Specific choice GUID within the option. 
+                      - name: variants[].optionChoices[].optionChoiceIds.optionId  | type: string | description:  Product option GUID. 
+                  - name: variants[].optionChoices[].optionChoiceNames  | type: V3OptionChoiceNames | description:  Human-readable option and choice names. 
+                      - name: variants[].optionChoices[].optionChoiceNames.choiceName  | type: string | description:  Display name of the chosen option value.  For example, "Large", "Red", or "Cotton". 
+                      - name: variants[].optionChoices[].optionChoiceNames.optionName  | type: string | description:  Display name of the product option.  For example, "Size", "Color", or "Material". 
+                      - name: variants[].optionChoices[].optionChoiceNames.renderType  | type: string | description:  Visual representation style for the option choice.  Determines how the option is displayed in the product selector UI. Common values include "TEXT_CHOICES", "COLOR_CHOICES", or "IMAGE_CHOICES". 
+            - name: variants[].price  | type: V3PriceInfo | description:  Pricing information for the variant. 
+                - name: variants[].price.actualPrice  | type: V3FixedMonetaryAmount | description:  Current selling price of the variant. 
+                    - name: variants[].price.actualPrice.amount  | type: string | description:  Monetary amount. For example, `"3.99"`, or `"-4.99"` for a negative amount. 
+                    - name: variants[].price.actualPrice.formattedAmount  | type: string | description:  Formatted monetary amount. For example, `"$3.99"`. 
+                - name: variants[].price.compareAtPrice  | type: V3FixedMonetaryAmount | description:  Original price before any discounts.  Used to show customers the savings when the variant is on sale. If not set, no original price is displayed. 
+            - name: variants[].productData  | type: ProductFields | description:  Product information for context and convenience.  Includes essential product details like name, visibility, and categories to avoid requiring separate product API calls when working with variants. 
+                - name: variants[].productData.currency  | type: string | description:  Currency used for pricing this product.  Three-letter currency code in ISO-4217 alphabetic format. Defaults to the site's currency setting unless specified in request headers. Returned only when you pass `"CURRENCY"` to the `fields` parameter. 
+                - name: variants[].productData.handle  | type: string | description:  A unique human-friendly identifier for the product.  The handle can be set by the user to ensure consistency across multiple platforms. 
+                - name: variants[].productData.mainCategoryId  | type: string | description:  Primary category assignment for the product.  Determines the main category used for navigation and organization. 
+                - name: variants[].productData.name  | type: string | description:  Product name displayed to customers. 
+                - name: variants[].productData.productId  | type: string | description:  Product GUID. 
+                - name: variants[].productData.productType  | type: V3ProductType | description:  Type of product determining available properties and behavior. 
+                    enum: 
+                         DIGITAL: Digital product.
+                         PHYSICAL: Physical product.
+                         UNKNOWN_PRODUCT_TYPE: Not implemented.
+                - name: variants[].productData.revision  | type: string | description:  Revision number, which increments by 1 each time the product is updated. To prevent conflicting changes, the current revision must be passed when updating the product. 
+                - name: variants[].productData.slug  | type: string | description:  URL-friendly identifier for the product.  Used in product page URLs and for SEO optimization. 
+                - name: variants[].productData.visible  | type: boolean | description:  Whether the product is visible to site visitors.  Default: `true` 
+                - name: variants[].productData.visibleInPos  | type: boolean | description:  Whether the product appears in point-of-sale systems.  Default: `true` Always `false` for digital products. 
+                - ONE-OF: 
+                  - name: variants[].productData.physicalProperties  | type: V3PhysicalProperties | description:  Physical product properties such as weight and dimensions.  Required when `productType` is `PHYSICAL`. 
+                      - name: variants[].productData.physicalProperties.weightMeasurementUnitInfo  | type: V3WeightMeasurementUnitInfo | description:  Weight measurement unit information for the product.  Defines the unit of measurement (kg, lb, etc.) used for product weight calculations. Returned only when you pass `"WEIGHT_MEASUREMENT_UNIT_INFO"` to the `fields` parameter. 
+                          - name: variants[].productData.physicalProperties.weightMeasurementUnitInfo.weightMeasurementUnit  | type: WeightUnit | description:  Unit of measurement for weight.  Standard units include kilograms (KG), pounds (LB), ounces (OZ), and grams (G). 
+                              enum: 
+                                   KG: Kilograms.
+                                   LB: Pounds.
+                                   UNSPECIFIED_WEIGHT_UNIT: Weight unit can't be classified due to an error.
+            - name: variants[].revenueDetails  | type: V3RevenueDetails | description:  Revenue and cost details for business analytics.  Includes cost, profit, and profit margin calculations. Returned only when you pass `"MERCHANT_DATA"` to the `fields` parameter. 
+                - name: variants[].revenueDetails.cost  | type: V3FixedMonetaryAmount | description:  Cost of the variant for profit calculations.  The amount you pay to produce or acquire this variant. 
+                - name: variants[].revenueDetails.profit  | type: V3FixedMonetaryAmount | description:  Profit amount calculated by subtracting cost from the discounted price. 
+                - name: variants[].revenueDetails.profitMargin  | type: number | description:  Profit margin as a percentage of the selling price.  Calculated by dividing profit by the discounted price. The result is rounded to 4 decimal places. A value of 0.25 represents a 25% profit margin. 
+            - name: variants[].sku  | type: string | description:  Stock keeping unit (SKU) for inventory tracking and identification.  The SKU is typically used for inventory management, order fulfillment, and product identification across different systems. 
+            - name: variants[].subscriptionPricesInfo  | type: V3SubscriptionPricesInfo | description:  Subscription pricing information when the variant is part of subscription plans.  Shows calculated prices after applying subscription discounts to the variant's price. Returned only when you pass `"SUBSCRIPTION_PRICES_INFO"` to the `fields` parameter. 
+                - name: variants[].subscriptionPricesInfo.subscriptionPrices  | type: Array<V3SubscriptionPrice> | description:  Pricing for different subscription plans.  Shows how the variant's price changes with different subscription intervals or discounts. 
+                      - name: variants[].subscriptionPricesInfo.subscriptionPrices[].price  | type: V3FixedMonetaryAmount | description:  Variant price with subscription discount applied. 
+                      - name: variants[].subscriptionPricesInfo.subscriptionPrices[].pricePerUnit  | type: V3SubscriptionPricePerUnit | description:  Price per unit for subscription pricing. 
+                          - name: variants[].subscriptionPricesInfo.subscriptionPrices[].pricePerUnit.description  | type: string | description:  Description of the subscription price per unit. 
+                          - name: variants[].subscriptionPricesInfo.subscriptionPrices[].pricePerUnit.value  | type: string | description:  Calculated price per unit for the subscription.  Takes into account the subscription discount and the variant's price per unit settings. 
+                      - name: variants[].subscriptionPricesInfo.subscriptionPrices[].subscriptionId  | type: string | description:  Subscription plan GUID. 
+            - name: variants[].visible  | type: boolean | description:  Whether the variant is visible to site visitors.  Default: `true` 
+            - ONE-OF: 
+              - name: variants[].digitalProperties  | type: V3VariantDigitalProperties | description:  Digital properties such as downloadable files.  Required when the product type is `DIGITAL`. 
+                  - name: variants[].digitalProperties.digitalFile  | type: V3SecuredMedia | description:  Digital file available for download after purchase.  The file that customers receive when they purchase this digital variant. 
+                      - name: variants[].digitalProperties.digitalFile._id  | type: string | description:  Media GUID in media manager. 
+                      - name: variants[].digitalProperties.digitalFile.fileName  | type: string | description:  Original file name. 
+                      - name: variants[].digitalProperties.digitalFile.fileSize  | type: string | description:  Original file size. 
+                      - name: variants[].digitalProperties.digitalFile.fileType  | type: SecuredMediaFileType | description:  File type. 
+                          enum: 
+                               SECURE_ARCHIVE: Secure archive file.
+                               SECURE_DOCUMENT: Secure document file.
+                               SECURE_MUSIC: Secure music file.
+                               SECURE_PICTURE: Secure picture file.
+                               SECURE_VIDEO: Secure video file.
+                               UNSPECIFIED: Unspecified file type.
+              - name: variants[].physicalProperties  | type: V3VariantPhysicalProperties | description:  Physical properties such as weight and dimensions.  Required when the product type is `PHYSICAL`. 
+                  - name: variants[].physicalProperties.pricePerUnit  | type: V3PricePerUnit | description:  Price per unit measurement information.  Allows customers to compare prices based on a standard unit (like price per kilogram or per liter). Useful for bulk products or items sold by weight or volume. 
+                      - name: variants[].physicalProperties.pricePerUnit.description  | type: string | description:  Human-readable description of the price per unit.  For example, "per kg" or "per liter". 
+                      - name: variants[].physicalProperties.pricePerUnit.settings  | type: V3PricePerUnitSettings | description:  Price per unit measurement settings.  Defines the unit of measurement for price comparison (e.g., per kilogram, per liter). The measurement unit must correspond to the unit set on the parent product. 
+                          - name: variants[].physicalProperties.pricePerUnit.settings.measurementUnit  | type: MeasurementUnit | description:  Measurement unit. For example, to define price per 100 grams, set this field to "G". 
+                              enum: CBM, CL, CM, FLOZ, FT, G, GAL, IN, KG, L, LB, M, MG, ML, MM, OZ, PT, QT, SQFT, SQM, UNSPECIFIED, YD
+                          - name: variants[].physicalProperties.pricePerUnit.settings.quantity  | type: number | description:  Quantity. For example, to define price per per 100 grams, set this field to `100`. 
+                      - name: variants[].physicalProperties.pricePerUnit.value  | type: string | description:  Calculated price per unit value.  Shows the variant's price normalized to the standard unit of measurement. For example, if a 500g variant costs $2 and the standard unit is 1kg, this value would be $4. 
+                  - name: variants[].physicalProperties.weight  | type: number | description:  Weight of the variant for shipping calculations.  Used for shipping cost calculations and fulfillment planning. Returned only when you pass `"WEIGHT_MEASUREMENT_UNIT_INFO"` to the `fields` parameter. 
+
+```
+</type_definition>
+</stores_readOnlyVariantsV3_searchVariants>