@wix/auto_sdk_stores_catalog-imports-v-3 1.0.19 → 1.0.21

package/build/cjs/index.typings.d.ts

@@ -113,18 +113,20 @@ interface ProductWithInventory extends ProductWithInventoryTypedPropertiesOneOf
      */
     taxGroupId?: string | null;
     /**
-     * Product options. Each option (like "Size" or "Color") creates variants when combined with other options.
+     * Product options, such as "Size" or "Color". Options define the ways a product can vary.
      *
-     * When you provide options, you must also provide the corresponding variants. Each variant must have exactly one choice for each option.
-     * To use existing [customizations](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/customizations-v3/introduction), pass their IDs. Otherwise, new customization entities are automatically created.
+     * When you provide options, you must also provide the corresponding variants. Each variant must have exactly one choice for each option. For more information, see [About Product Options and Variants](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/about-options-and-variants).
+     *
+     * Options are stored as reusable [customization](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/customizations-v3/introduction) entities. Pass an existing customization's ID to reuse it, or define options inline and new customization entities are created automatically.
      * @maxSize 6
      */
     options?: ConnectedOption[];
     /**
      * Product modifiers. Collect additional information from customers without creating variants.
      *
-     * Unlike options, modifiers don't affect inventory or create additional variants. Use them for customizations like gift messages or engraving text.
-     * To use existing [customizations](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/customizations-v3/introduction), pass their IDs. Otherwise, new customization entities are automatically created.
+     * Unlike options, modifiers don't affect inventory or create additional variants. Use them for things like gift messages or engraving text. For more information, see [About Product Options and Variants](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/about-options-and-variants).
+     *
+     * Modifiers are stored as reusable [customization](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/customizations-v3/introduction) entities. Pass an existing customization's ID to reuse it, or define modifiers inline and new customization entities are created automatically.
      * @maxSize 10
      */
     modifiers?: ConnectedModifier[];
@@ -172,8 +174,12 @@ interface ProductWithInventory extends ProductWithInventoryTypedPropertiesOneOf
      */
     handle?: string | null;
     /**
-     * Product variants. Each variant must reference all product options via its `choices` array.
-     * Each choice references an option using `optionChoiceNames` for all requests.
+     * Product variants. Each variant represents a specific purchasable version of a product defined by option choices.
+     *
+     * Each variant must reference all product options via its `choices` array, using `optionChoiceNames` in requests.
+     * Variants aren't auto-generated. You must explicitly provide each variant when creating products with options.
+     *
+     * For more information, see [About Product Options and Variants](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/about-options-and-variants).
      */
     variantsInfo?: VariantsInfo;
     /**
@@ -2106,12 +2112,12 @@ interface ProductMedia extends ProductMediaSetByOneOf, ProductMediaMediaOneOf {
      */
     url?: string;
     /**
-     * Product image.
+     * Image details. Populated when you provide a [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager) file ID in `set_by`.
      * @readonly
      */
     image?: string;
     /**
-     * Product video.
+     * Video details. Populated when you provide a Wix Media Manager file ID in `set_by`.
      * @readonly
      */
     video?: string;
@@ -2123,7 +2129,8 @@ interface ProductMedia extends ProductMediaSetByOneOf, ProductMediaMediaOneOf {
     altText?: string | null;
     /**
      * Media display name.
-     * Allows to override the default media name. Can be passed only when `setBy: url`.
+     *
+     * Overrides the default media name. Can be passed only when the media is set by a URL in `setBy``.
      * @maxLength 80
      */
     displayName?: string | null;
@@ -2161,12 +2168,12 @@ interface ProductMediaSetByOneOf {
 /** @oneof */
 interface ProductMediaMediaOneOf {
     /**
-     * Product image.
+     * Image details. Populated when you provide a [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager) file ID in `set_by`.
      * @readonly
      */
     image?: string;
     /**
-     * Product video.
+     * Video details. Populated when you provide a Wix Media Manager file ID in `set_by`.
      * @readonly
      */
     video?: string;
@@ -2215,7 +2222,9 @@ interface Thumbnail {
 }
 interface MediaItemsInfo {
     /**
-     * All media items (images, videos etc) associated with this product.
+     * All media items associated with this product.
+     *
+     * The first item in the array is automatically set as the product's main media.
      * @maxSize 15
      */
     items?: ProductMedia[];