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

package/build/es/meta.d.mts

@@ -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-D4WyK7_Y.mjs';
+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-BmO0mCp5.mjs';
 import '@wix/sdk-types';
 
 /**
@@ -1784,14 +1784,14 @@ interface Product extends ProductTypedPropertiesOneOf {
     /**
      * Product description in HTML.
      *
-     * + When provided on create/update, this string must be a valid HTML. It will then be converted to rich content.
-     * + `plainDescription` is ignored when value is also passed to the `description` field.
+     * + When provided on create/update, this string must be valid HTML. It's then converted to rich content.
+     * + `plainDescription` is ignored when a value is also passed to the `description` field.
      * > **Note:** Returned only when you pass `"PLAIN_DESCRIPTION"` to the `fields` array in Products API requests.
      * @maxLength 16000
      */
     plainDescription?: string | null;
     /**
-     * Whether the product is visible to site visitors on the site.
+     * Whether the product is visible to site visitors.
      *
      * Default: `true`
      */
@@ -1808,34 +1808,35 @@ interface Product extends ProductTypedPropertiesOneOf {
     /** Product SEO data. */
     seoData?: SeoSchema;
     /**
-     * Tax group ID.
+     * [Tax group ID](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/extensions/tax/tax-groups/introduction). Used to apply specific tax rates to products.
      * @format GUID
      */
     taxGroupId?: string | null;
     /**
-     * Product options. Allows the customer to customize the product. For example, selecting color, size, and more.
+     * Product options. Each option (like "Size" or "Color") creates variants when combined with other options.
      *
-     * Always generates variants: every variant must have exactly one choice related to each option.
-     * Since options and variants tightly coupled and rely on each other they usually should be provided together in all operations.
+     * 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.
      * @maxSize 6
      */
     options?: ConnectedOption[];
     /**
-     * Product modifiers.
+     * Product modifiers. Collect additional information from customers without creating variants.
      *
-     * Allows the customer to customize product, e.g. select Color, Size and so on similarly to `options` but with one main difference - `modifiers` never generate any 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.
      * @maxSize 10
      */
     modifiers?: ConnectedModifier[];
     /**
-     * Product brand.
+     * Product [brand](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/brands-v3/introduction).
      *
      * + Pass `brand.name` to add a new brand while creating a product.
      * + Pass an existing brand's `id` to assign that brand to the product.
      */
     brand?: Brand;
     /**
-     * Product info section.
+     * Product [info section](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/info-sections-v3/introduction).
      *
      * + Pass `infoSection.uniqueName`, `infoSection.title`, and `infoSection.description` to add a new info section while creating a product.
      * + Pass an existing info section's `id` or `uniqueName` to assign that info section to the product.
@@ -1843,14 +1844,14 @@ interface Product extends ProductTypedPropertiesOneOf {
      */
     infoSections?: InfoSection[];
     /**
-     * Product ribbon.
+     * Product [ribbon](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/ribbons-v3/introduction).
      *
      * + Pass `ribbon.name` to add a new ribbon while creating a product.
      * + Pass an existing ribbon's `id` or `name` to assign that ribbon to the product.
      */
     ribbon?: Ribbon;
     /**
-     * List of categories that directly contain this product.
+     * List of [categories](https://dev.wix.com/docs/api-reference/business-management/categories/introduction) that directly contain this product.
      *
      * Updated automatically when a product is added/removed from a category, when an item is moved within a category, or when a category is deleted.
      * > **Note:** Returned only when you pass `"DIRECT_CATEGORIES_INFO"` to the `fields` array in Products API requests.
@@ -1858,13 +1859,13 @@ interface Product extends ProductTypedPropertiesOneOf {
      */
     directCategoriesInfo?: ProductCategoriesInfo;
     /**
-     * List of categories that directly contain this product, as well as their parent categories.
+     * List of [categories](https://dev.wix.com/docs/api-reference/business-management/categories/introduction) that directly contain this product, as well as their parent categories.
      * > **Note:** Returned only when you pass `"ALL_CATEGORIES_INFO"` to the `fields` array in Products API requests.
      * @readonly
      */
     allCategoriesInfo?: ProductCategoriesInfo;
     /**
-     * The ID of the product's primary direct category, which defines the product’s breadcrumbs path. For example, if the product's main category is "T-Shirts" (which is a subcategory of "Clothing"), the breadcrumbs path will be "Clothing > T-Shirts".
+     * The ID of the product's primary direct [category](https://dev.wix.com/docs/api-reference/business-management/categories/introduction), which defines the product’s breadcrumbs path. For example, if the product's main category is "T-Shirts" (which is a subcategory of "Clothing"), the breadcrumbs path will be "Clothing > T-Shirts".
      * @format GUID
      */
     mainCategoryId?: string | null;
@@ -1879,20 +1880,22 @@ 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;
     /**
-     * Product type.
+     * Product type: `PHYSICAL` for tangible goods that require shipping, or `DIGITAL` for downloadable content.
      *
-     * When passing `productType: PHYSICAL`, you must also pass `physicalProperties`.
+     * When passing `productType: PHYSICAL`, you must also pass `physicalProperties`. When passing `productType: DIGITAL`, you can optionally pass `digitalProperties` in each variant.
      * @immutable
      */
     productType?: ProductTypeWithLiterals;
     /**
      * 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.
+     *
+     * Unlike the auto-generated `id`, the handle can be set when creating a product. This is useful when re-importing products from other systems, as it provides a stable identifier across platforms. If not provided during creation, one is automatically generated. Can't be changed after creation.
      * @minLength 1
      * @maxLength 100
      * @readonly
@@ -1901,25 +1904,25 @@ interface Product extends ProductTypedPropertiesOneOf {
     /**
      * 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.
      *
-     * Defaults to the currency defined in the site settings, unless specified in `x-wix-currency` header.
+     * Defaults to the currency defined in the site settings, unless specified in the request's `x-wix-currency` header.
      * > **Note:** Returned only when you pass `"CURRENCY"` to the `fields` array in Products API requests.
      * @format CURRENCY
      * @readonly
      */
     currency?: string | null;
     /**
-     * Breadcrumbs of the `mainCategoryId`. Used to navigate to parent categories.
+     * Breadcrumbs of the `mainCategoryId`. Used to navigate to parent [categories](https://dev.wix.com/docs/api-reference/business-management/categories/introduction).
      * > **Note:** Returned only when you pass `"BREADCRUMBS_INFO"` to the `fields` array in Products API requests.
      * @readonly
      */
     breadcrumbsInfo?: BreadcrumbsInfo;
     /**
-     * Product actualPrice range - minimum and maximum prices of all product variants.
+     * Minimum and maximum current selling prices across all product variants.
      * @readonly
      */
     actualPriceRange?: PriceRange;
     /**
-     * Product compareAtPrice range - minimum and maximum compare at prices of all product variants.
+     * Minimum and maximum compare-at prices (original prices before discounts) across all product variants. Used to show savings to customers.
      * @readonly
      */
     compareAtPriceRange?: PriceRange;
@@ -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;
@@ -4386,7 +4394,7 @@ interface Ribbon {
 }
 interface ProductCategoriesInfo {
     /**
-     * A list of categories related to product.
+     * A list of categories related to the product.
      * @readonly
      * @maxSize 2000
      */
@@ -4399,14 +4407,14 @@ 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 a 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-a-category) sample flow.
      * @max 200
      */
     index?: number | null;
 }
 interface ProductCategoryIdsInfo {
     /**
-     * A list of category ids related to product.
+     * A list of category ids related to the product.
      * @readonly
      * @maxSize 2000
      * @format GUID
@@ -4646,9 +4654,11 @@ interface Variant extends VariantTypedPropertiesOneOf {
      */
     barcode?: string | null;
     /**
-     * List of choices that define the product's variant, which requires exactly one choice per product option.
+     * List of choices that define this variant. Each variant must have exactly one choice for each product option.
+     *
      * Must use `optionChoiceNames` in all requests this field is required.
-     * Empty only for default variants of unmanaged products.
+     *
+     * For products without options, this array is empty, representing a single "default variant".
      * @maxSize 6
      * @immutable
      */
@@ -4727,9 +4737,9 @@ interface OptionChoiceNames {
     renderType?: ProductOptionRenderTypeWithLiterals;
 }
 interface PriceInfo {
-    /** Variant price. Must be greater or equal to 0. */
+    /** Variant's current selling price. Must be greater than or equal to 0. */
     actualPrice?: FixedMonetaryAmount;
-    /** The compare-at-price represents the original price of a product before any discount. It is optional and should only be set if a discount applies. When set, it must be higher than the current price to reflect accurate savings. */
+    /** Original price before any discount, shown with a strikethrough in the UI of Wix sites. Only set this if a discount applies. When set, it should be higher than `actualPrice` to reflect savings. */
     compareAtPrice?: FixedMonetaryAmount;
 }
 interface RevenueDetails {
@@ -4784,7 +4794,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 {