@wix/auto_sdk_stores_read-only-variants-v-3 1.0.16 → 1.0.18

package/build/internal/cjs/meta.d.ts

@@ -1,10 +1,28 @@
-import { aJ as QueryVariantsRequest$1, aO as QueryVariantsResponse$1, aR as SearchVariantsRequest$1, a as SearchVariantsResponse$1 } from './stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-DmrKxIKF.js';
+import { aJ as QueryVariantsRequest$1, aO as QueryVariantsResponse$1, aR as SearchVariantsRequest$1, a as SearchVariantsResponse$1 } from './stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-Cq2knsK7.js';
 import '@wix/sdk-types';
 
+/**
+ * A read-only representation of a product variant with enhanced query capabilities.
+ *
+ * Product variants represent different options of a product, such as size, color, or material combinations.
+ * This read-only variant provides direct access to variant data without requiring nested product queries,
+ * making it ideal for inventory management, variant comparison, and e-commerce catalog displays.
+ *
+ * The variant includes both variant-specific information (like SKU, price, and option choices), as well as
+ * contextual product information (like product name, visibility, categories) for convenience.
+ */
 interface ReadOnlyVariant extends ReadOnlyVariantTypedPropertiesOneOf {
-    /** Physical properties. Must be passed when `productType: PHYSICAL` */
+    /**
+     * Physical properties such as weight and dimensions.
+     *
+     * Required when the product type is `PHYSICAL`.
+     */
     physicalProperties?: V3VariantPhysicalProperties;
-    /** Digital properties. Must be passed when `productType: DIGITAL` */
+    /**
+     * Digital properties such as downloadable files.
+     *
+     * Required when the product type is `DIGITAL`.
+     */
     digitalProperties?: V3VariantDigitalProperties;
     /**
      * Variant ID.
@@ -20,91 +38,113 @@ interface ReadOnlyVariant extends ReadOnlyVariantTypedPropertiesOneOf {
      */
     visible?: boolean | null;
     /**
-     * Variant SKU (stock keeping unit).
+     * 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.
      * @minLength 1
      * @maxLength 40
      * @readonly
      */
     sku?: string | null;
     /**
-     * Variant barcode.
+     * 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.
      * @minLength 1
      * @maxLength 40
      * @readonly
      */
     barcode?: string | null;
     /**
-     * List of option choices
-     * In case this list is empty, this is the default variant of an unmanaged product. - check if bridges need more than ids
+     * 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.
      * @maxSize 6
      * @readonly
      */
     optionChoices?: V3OptionChoice[];
     /**
-     * Variant price.
+     * Pricing information for the variant.
      * @readonly
      */
     price?: V3PriceInfo;
     /**
-     * Variant revenue details.
+     * Revenue and cost details for business analytics.
      *
-     * > **Note:** Returned only when the following conditions are met:
-     * > + You pass `"MERCHANT_DATA"` to the `fields` array in Products API requests.
-     * > + Your app has the required `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.
+     * Includes cost, profit, and profit margin calculations.
+     * Returned only when you pass `"MERCHANT_DATA"` to the `fields` parameter.
      * @readonly
      */
     revenueDetails?: V3RevenueDetails;
     /**
-     * Variant media.
+     * Media associated with the variant.
+     *
+     * Typically includes images, videos, or other media files specific to this variant.
      * @readonly
      */
     media?: V3ProductMedia;
     /**
-     * Subscription prices calculated by applying subscription discount to the variant `price.actualPrice`.
-     * > **Note:** Returned only when you pass `"SUBSCRIPTION_PRICES_INFO"` to the `fields` array in Products API requests.
+     * 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.
      * @readonly
      */
     subscriptionPricesInfo?: V3SubscriptionPricesInfo;
     /**
-     * Variant inventory status.
+     * Current inventory and availability status.
      * @readonly
      */
     inventoryStatus?: V3InventoryStatus;
     /**
-     * Product fields
+     * 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.
      * @readonly
      */
     productData?: ProductFields;
 }
 /** @oneof */
 interface ReadOnlyVariantTypedPropertiesOneOf {
-    /** Physical properties. Must be passed when `productType: PHYSICAL` */
+    /**
+     * Physical properties such as weight and dimensions.
+     *
+     * Required when the product type is `PHYSICAL`.
+     */
     physicalProperties?: V3VariantPhysicalProperties;
-    /** Digital properties. Must be passed when `productType: DIGITAL` */
+    /**
+     * Digital properties such as downloadable files.
+     *
+     * Required when the product type is `DIGITAL`.
+     */
     digitalProperties?: V3VariantDigitalProperties;
 }
 interface V3OptionChoice {
     /**
-     * Option and choice IDs.
+     * Option and choice identifiers.
      * @readonly
      */
     optionChoiceIds?: V3OptionChoiceIds;
     /**
-     * Option and choice names.
+     * Human-readable option and choice names.
      * @readonly
      */
     optionChoiceNames?: V3OptionChoiceNames;
 }
 interface V3OptionChoiceIds {
     /**
-     * Option ID.
+     * Product option ID.
      * @minLength 1
      * @maxLength 36
      * @readonly
      */
     optionId?: string;
     /**
-     * Choice ID.
+     * Specific choice ID within the option.
      * @format GUID
      * @readonly
      */
@@ -112,21 +152,28 @@ interface V3OptionChoiceIds {
 }
 interface V3OptionChoiceNames {
     /**
-     * Option name.
+     * Display name of the product option.
+     *
+     * For example, "Size", "Color", or "Material".
      * @minLength 1
      * @maxLength 50
      * @readonly
      */
     optionName?: string;
     /**
-     * Choice name.
+     * Display name of the chosen option value.
+     *
+     * For example, "Large", "Red", or "Cotton".
      * @minLength 1
      * @maxLength 50
      * @readonly
      */
     choiceName?: string;
     /**
-     * Render type.
+     * 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".
      * @readonly
      * @maxLength 50
      */
@@ -134,12 +181,15 @@ interface V3OptionChoiceNames {
 }
 interface V3PriceInfo {
     /**
-     * Variant price.
+     * Current selling price of the variant.
      * @readonly
      */
     actualPrice?: V3FixedMonetaryAmount;
     /**
-     * The compare-at-price represents the original price of a product before any discount.
+     * 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.
      * @readonly
      */
     compareAtPrice?: V3FixedMonetaryAmount;
@@ -160,18 +210,22 @@ interface V3FixedMonetaryAmount {
 }
 interface V3RevenueDetails {
     /**
-     * Item cost.
+     * Cost of the variant for profit calculations.
+     *
+     * The amount you pay to produce or acquire this variant.
      * @readonly
      */
     cost?: V3FixedMonetaryAmount;
     /**
-     * Profit. Calculated by reducing `cost` from `discountedPrice`.
+     * Profit amount calculated by subtracting cost from the discounted price.
      * @readonly
      */
     profit?: V3FixedMonetaryAmount;
     /**
-     * Profit Margin. Calculated by dividing `profit` by `discountedPrice`.
-     * The result is rounded to 4 decimal places.
+     * 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.
      * @readonly
      * @max 1
      */
@@ -340,7 +394,7 @@ declare enum ProductMediaMediaType {
 type ProductMediaMediaTypeWithLiterals = ProductMediaMediaType | 'UNKNOWN_MEDIA_TYPE' | 'IMAGE' | 'VIDEO';
 interface V3Thumbnail {
     /**
-     * Thumbnail url.
+     * Thumbnail URL.
      * @format WEB_URL
      * @readonly
      */
@@ -365,35 +419,45 @@ interface V3Thumbnail {
 }
 interface V3VariantPhysicalProperties {
     /**
-     * Variant shipping weight.
+     * 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.
      * @max 999999999.99
      * @readonly
      */
     weight?: number | null;
     /**
-     * Price per unit info, in order to show price per unit on the product page.
-     * For example if one sells cheese and defines 100g here then we know that buying this variant buyer receives 100g of cheese.
-     * But on product page price will be displayed for units defined on product level. See `pricePerUnit.value` to understand how it's calculated.
+     * 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.
      * @readonly
      */
     pricePerUnit?: V3PricePerUnit;
 }
 interface V3PricePerUnit {
     /**
-     * Price per unit data for this variant.
-     * `measurementUnit` value must correspond to the measurement unit set on the product.
+     * 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.
      * @readonly
      */
     settings?: V3PricePerUnitSettings;
     /**
-     * Calculated value of price per unit. Takes into account `pricePerUnit` settings of parent product, of this variant, and discounted price of variant.
-     * For example if discounted price is 2$, product's price per unit setting is 1 Kg, variant price per unit setting is 0.5 Kg then this value is 4$ (means variant weight is 0.5 Kg and it costs 2$ but we want to show price per 1 Kg so we show 4$).
+     * 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.
      * @readonly
      * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
      */
     value?: string;
     /**
-     * Price per unit description.
+     * Human-readable description of the price per unit.
+     *
+     * For example, "per kg" or "per liter".
      * @readonly
      * @maxLength 100
      */
@@ -443,7 +507,9 @@ declare enum MeasurementUnit {
 type MeasurementUnitWithLiterals = MeasurementUnit | 'UNSPECIFIED' | 'ML' | 'CL' | 'L' | 'CBM' | 'MG' | 'G' | 'KG' | 'MM' | 'CM' | 'M' | 'SQM' | 'OZ' | 'LB' | 'FLOZ' | 'PT' | 'QT' | 'GAL' | 'IN' | 'FT' | 'YD' | 'SQFT';
 interface V3VariantDigitalProperties {
     /**
-     * Digital file which will be downloaded by customer after successful purchase.
+     * Digital file available for download after purchase.
+     *
+     * The file that customers receive when they purchase this digital variant.
      * @readonly
      */
     digitalFile?: V3SecuredMedia;
@@ -496,7 +562,9 @@ declare enum SecuredMediaFileType {
 type SecuredMediaFileTypeWithLiterals = SecuredMediaFileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
 interface V3SubscriptionPricesInfo {
     /**
-     * Subscription prices.
+     * Pricing for different subscription plans.
+     *
+     * Shows how the variant's price changes with different subscription intervals or discounts.
      * @maxSize 6
      * @readonly
      */
@@ -504,31 +572,33 @@ interface V3SubscriptionPricesInfo {
 }
 interface V3SubscriptionPrice {
     /**
-     * Subscription ID.
+     * Subscription plan ID.
      * @format GUID
      * @readonly
      */
     subscriptionId?: string;
     /**
-     * Subscription price calculated by applying subscription discount to the variant `price.salePrice`
+     * Variant price with subscription discount applied.
      * @readonly
      */
     price?: V3FixedMonetaryAmount;
     /**
-     * Price per unit info.
+     * Price per unit for subscription pricing.
      * @readonly
      */
     pricePerUnit?: V3SubscriptionPricePerUnit;
 }
 interface V3SubscriptionPricePerUnit {
     /**
-     * Calculated value of price per unit. Takes into account `pricePerUnit` settings of parent product, `pricePerUnit` settings of this variant, and the variant subscription price.
+     * Calculated price per unit for the subscription.
+     *
+     * Takes into account the subscription discount and the variant's price per unit settings.
      * @readonly
      * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
      */
     value?: string;
     /**
-     * Price per unit description.
+     * Description of the subscription price per unit.
      * @readonly
      * @maxLength 20
      */
@@ -536,80 +606,87 @@ interface V3SubscriptionPricePerUnit {
 }
 interface V3InventoryStatus {
     /**
-     * Whether the variant is in stock.
+     * Whether the variant is currently in stock and available for purchase.
      * @readonly
      */
     inStock?: boolean;
     /**
-     * Whether preorder is enabled for this variant.
+     * Whether customers can place preorders for this variant when it's out of stock.
      * @readonly
      */
     preorderEnabled?: boolean;
 }
 interface ProductFields extends ProductFieldsTypedPropertiesOneOf {
     /**
-     * Physical properties.
+     * Physical product properties such as weight and dimensions.
      *
-     * Required when `productType: PHYSICAL`.
+     * Required when `productType` is `PHYSICAL`.
      */
     physicalProperties?: V3PhysicalProperties;
     /**
-     * product id
+     * Product ID.
      * @minLength 1
      * @maxLength 36
      * @readonly
      */
     productId?: string;
     /**
-     * Product name.
+     * Product name displayed to customers.
      * @minLength 1
      * @maxLength 80
      * @readonly
      */
     name?: string | null;
     /**
-     * product type
+     * Type of product determining available properties and behavior.
      * @readonly
      */
     productType?: V3ProductTypeWithLiterals;
     /**
-     * Product slug.
+     * URL-friendly identifier for the product.
+     *
+     * Used in product page URLs and for SEO optimization.
      * @format URL_SLUG
      * @readonly
      */
     slug?: string | null;
     /**
-     * Whether the product is visible to site visitors on the site.
+     * Whether the product is visible to site visitors.
      *
      * Default: `true`
      * @readonly
      */
     visible?: boolean | null;
     /**
-     * Whether the product is visible in POS (point of sale).
+     * Whether the product appears in point-of-sale systems.
      *
      * Default: `true`
-     * > **Note:** Always `false` for `productType: DIGITAL`.
+     * Always `false` for digital products.
      * @readonly
      */
     visibleInPos?: boolean | null;
     /**
-     * Main category ID.
+     * Primary category assignment for the product.
+     *
+     * Determines the main category used for navigation and organization.
      * @format GUID
      * @readonly
      */
     mainCategoryId?: string | null;
     /**
-     * Currency used for the pricing of this product, in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
+     * Currency used for pricing this product.
      *
-     * Defaults to the currency defined in the site settings, unless specified in `x-wix-currency` header.
-     * > **Note:** Returned only when you pass `"CURRENCY"` to the `fields` array in Products API requests.
+     * 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.
      * @format CURRENCY
      * @readonly
      */
     currency?: string | null;
     /**
-     * Product entity revision.
+     * 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.
      * @readonly
      */
     revision?: string | null;
@@ -617,9 +694,9 @@ interface ProductFields extends ProductFieldsTypedPropertiesOneOf {
 /** @oneof */
 interface ProductFieldsTypedPropertiesOneOf {
     /**
-     * Physical properties.
+     * Physical product properties such as weight and dimensions.
      *
-     * Required when `productType: PHYSICAL`.
+     * Required when `productType` is `PHYSICAL`.
      */
     physicalProperties?: V3PhysicalProperties;
 }
@@ -635,15 +712,19 @@ declare enum V3ProductType {
 type V3ProductTypeWithLiterals = V3ProductType | 'UNKNOWN_PRODUCT_TYPE' | 'PHYSICAL' | 'DIGITAL';
 interface V3PhysicalProperties {
     /**
-     * Weight measurement unit.
-     * > **Note:** Returned only when you pass `"WEIGHT_MEASUREMENT_UNIT_INFO"` to the `fields` array in Products API requests.
+     * 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.
      * @readonly
      */
     weightMeasurementUnitInfo?: V3WeightMeasurementUnitInfo;
 }
 interface V3WeightMeasurementUnitInfo {
     /**
-     * Weight measurement unit.
+     * Unit of measurement for weight.
+     *
+     * Standard units include kilograms (KG), pounds (LB), ounces (OZ), and grams (G).
      * @readonly
      */
     weightMeasurementUnit?: WeightUnitWithLiterals;
@@ -659,10 +740,11 @@ declare enum WeightUnit {
 /** @enumType */
 type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
 interface QueryVariantsRequest {
-    /** WQL expression. */
+    /** WQL expression for filtering variants. */
     query?: CursorQuery;
     /**
-     * A list of requested fields to be included in the response.
+     * List of additional fields to include in the response.
+     * See VariantOps.RequestedFields for available options.
      * @maxSize 100
      */
     fields?: RequestedFieldsWithLiterals[];
@@ -722,20 +804,43 @@ interface CursorPaging {
     cursor?: string | null;
 }
 declare enum RequestedFields {
-    /** Not implemented. */
+    /** Unknown requested field. */
     UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
+    /**
+     * 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.
+     */
     CURRENCY = "CURRENCY",
-    /** You can request merchant data only if you have the `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope. */
+    /**
+     * 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.
+     */
     MERCHANT_DATA = "MERCHANT_DATA",
+    /**
+     * Include subscription pricing information.
+     *
+     * Returns calculated prices for different subscription plans with applied discounts.
+     * Only relevant for variants that are part of subscription offerings.
+     */
     SUBSCRIPTION_PRICES_INFO = "SUBSCRIPTION_PRICES_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.
+     */
     WEIGHT_MEASUREMENT_UNIT_INFO = "WEIGHT_MEASUREMENT_UNIT_INFO"
 }
 /** @enumType */
 type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'CURRENCY' | 'MERCHANT_DATA' | 'SUBSCRIPTION_PRICES_INFO' | 'WEIGHT_MEASUREMENT_UNIT_INFO';
 interface QueryVariantsResponse {
-    /** List of ReadOnlyVariants. */
+    /** Variants matching the query criteria. */
     variants?: ReadOnlyVariant[];
-    /** Paging metadata */
+    /** Pagination information with cursors for next pages. */
     pagingMetadata?: CursorPagingMetadata;
 }
 interface CursorPagingMetadata {
@@ -764,10 +869,11 @@ interface Cursors {
     prev?: string | null;
 }
 interface SearchVariantsRequest {
-    /** WQL expression */
+    /** WQL expression for searching variants. */
     search?: CursorSearch;
     /**
-     * A list of requested fields to be included in the response.
+     * List of additional fields to include in the response.
+     * See VariantOps.RequestedFields for available options.
      * @maxSize 100
      */
     fields?: RequestedFieldsWithLiterals[];
@@ -1044,11 +1150,11 @@ declare enum Mode {
 /** @enumType */
 type ModeWithLiterals = Mode | 'OR' | 'AND';
 interface SearchVariantsResponse {
-    /** Variants which satisfy the provided query. */
+    /** Variants matching the search criteria. */
     variants?: ReadOnlyVariant[];
-    /** Paging metadata. Contains cursor which can be used in next query. */
+    /** Pagination information with cursors for next pages. */
     pagingMetadata?: CursorPagingMetadata;
-    /** Aggregation data. */
+    /** Aggregation results for faceted search. */
     aggregationData?: AggregationData;
 }
 interface AggregationData {

package/build/internal/cjs/meta.js

@@ -48,6 +48,18 @@ function resolveComWixStoresCatalogProductVariantsReaderApiV3ProductVariantsRead
         srcPath: "/stores/v3/products/search-variants",
         destPath: "/v3/products/search-variants"
       }
+    ],
+    _: [
+      {
+        srcPath: "/_api/product-variants-reader",
+        destPath: ""
+      }
+    ],
+    "*.dev.wix-code.com": [
+      {
+        srcPath: "/_api/product-variants-reader",
+        destPath: ""
+      }
     ]
   };
   return (0, import_rest_modules.resolveUrl)(Object.assign(opts, { domainToMappings }));