@wix/auto_sdk_stores_read-only-variants-v-3 1.0.44 → 1.0.45

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

@@ -1,4 +1,4 @@
-import { aX as QueryVariantsRequest$1, b0 as QueryVariantsResponse$1, b3 as SearchVariantsRequest$1, a as SearchVariantsResponse$1 } from './stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-11ZHjQPT.js';
+import { aX as QueryVariantsRequest$1, b0 as QueryVariantsResponse$1, b3 as SearchVariantsRequest$1, a as SearchVariantsResponse$1 } from './stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-DIjkz6cb.js';
 import '@wix/sdk-types';
 
 /**
@@ -1879,6 +1879,8 @@ interface Product extends ProductTypedPropertiesOneOf {
     costRange?: PriceRange;
     /**
      * Product inventory info.
+     *
+     * > **Note:** This field reflects the aggregated inventory status from the default location only. Use the [Inventory Items API](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/inventory-items-v3/introduction) to manage inventory for specific locations.
      * @readonly
      */
     inventory?: Inventory;
@@ -1892,7 +1894,8 @@ interface Product extends ProductTypedPropertiesOneOf {
     /**
      * A unique human-friendly identifier for the product.
      * Unlike the product ID, the handle can be set by the user to ensure consistency across multiple platforms.
-     * In case handle wasn't given, the handle will be automatically generated.
+     * This is particularly useful when re-importing products from other systems, as it provides a stable identifier.
+     * If no handle is provided, one is automatically generated.
      * @minLength 1
      * @maxLength 100
      * @readonly
@@ -1931,10 +1934,14 @@ interface Product extends ProductTypedPropertiesOneOf {
     /**
      * Custom extended fields for the product object.
      *
-     * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
+     * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls.
      */
     extendedFields?: ExtendedFields;
-    /** Product subscriptions. */
+    /**
+     * Product subscriptions.
+     *
+     * Subscription discounts are defined at the product level but apply to each variant's `actualPrice`. This means the final subscription price varies per variant based on the variant's base price.
+     */
     subscriptionDetails?: SubscriptionDetails;
     /**
      * The total number of variants for the product.
@@ -3842,6 +3849,7 @@ interface TextNodeStyle {
 interface Media {
     /**
      * Main media (image, video, etc.) associated with this product.
+     * Automatically set to the first item in the media list.
      * @readonly
      */
     main?: ProductMedia;
@@ -4399,7 +4407,7 @@ interface ProductCategory {
      */
     id?: string;
     /**
-     * Index location of the product within the category, which can be utilized for sorting products in a specific category. For detailed instructions on how to set this up, refer to the [Add and arrange products in category](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/sample-use-cases-and-flows#add-and-arrange-products-in-category) sample flow.
+     * Index location of the product within the category, which can be utilized for sorting products in a specific category. For detailed instructions on how to set this up, refer to the [Add and arrange products in category](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/sample-use-cases-and-flows#add-and-arrange-products-in-category) sample flow.
      * @max 200
      */
     index?: number | null;
@@ -4648,7 +4656,8 @@ interface Variant extends VariantTypedPropertiesOneOf {
     /**
      * List of choices that define the product's variant, which requires exactly one choice per product option.
      * Must use `optionChoiceNames` in all requests this field is required.
-     * Empty only for default variants of unmanaged products.
+     *
+     * For products without options (simple products), this array is empty. These products have a single "default variant" that represents the product itself.
      * @maxSize 6
      * @immutable
      */
@@ -4784,7 +4793,10 @@ interface PricePerUnit {
     description?: string | null;
 }
 interface VariantDigitalProperties {
-    /** Digital file which will be downloaded by customer after successful purchase. */
+    /**
+     * Digital file which will be downloaded by the buyer after successful purchase.
+     * Each variant can have a different digital file, allowing you to offer different content per variant.
+     */
     digitalFile?: SecuredMedia;
 }
 interface SecuredMedia {