@wix/auto_sdk_stores_catalog-imports-v-3 1.0.16 → 1.0.18

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

@@ -69,7 +69,7 @@ interface ProductWithInventory extends ProductWithInventoryTypedPropertiesOneOf
      */
     revision?: string | null;
     /**
-     * Product name.
+     * Product name. Translatable.
      * @minLength 1
      * @maxLength 80
      */
@@ -84,14 +84,14 @@ interface ProductWithInventory extends ProductWithInventoryTypedPropertiesOneOf
     /**
      * 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`
      */
@@ -108,25 +108,23 @@ interface ProductWithInventory extends ProductWithInventoryTypedPropertiesOneOf
     /** 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 buyer to customize product, e.g. select Color, Size and so on.
-     * 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.
-     * For existing options and choices provide ids only, all other data (e.g. names, title, types and so on) will be resolved for you by ids.
-     * If you don't have ids it's ok to omit them but provide all other data instead. For existing options ids will be resolved, not existing options will be created.
-     * *None*: you cannot change name of existing option via this endpoint but you can do it by calling CustomizationService
+     * Product options. Each option (like "Size" or "Color") creates variants when combined with other options.
+     *
+     * 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. Allows buyer to customize product, e.g. select Color, Size and so on similarly to `options` but with one main difference - `modifiers` never generate any variants.
-     * For existing modifiers and choices provide ids only, all other data (e.g. names, title, types and so on) will be resolved for you by ids.
-     * If you don't have ids it's ok to omit them but provide all other data instead. For existing modifiers ids will be resolved, not existing modifiers will be created.
-     * *None*: you cannot change name of existing modifier via this endpoint by passing id and changed name, if you pass id name will be ignored. If you want to update existing modifier name do it by calling CustomizationService
+     * 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.
      * @maxSize 10
      */
     modifiers?: ConnectedModifier[];
@@ -153,34 +151,41 @@ interface ProductWithInventory extends ProductWithInventoryTypedPropertiesOneOf
      */
     ribbon?: Ribbon;
     /**
-     * Main category ID.
+     * 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".
      * @format GUID
      */
     mainCategoryId?: string | null;
     /**
-     * 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
      */
     handle?: string | null;
-    /** Product variants. */
+    /**
+     * Product variants. Each variant must reference all product options via its `choices` array.
+     * Each choice references an option using `optionChoiceNames` for all requests.
+     */
     variantsInfo?: VariantsInfo;
-    /** Subscription details. */
+    /**
+     * 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;
     /**
      * 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](https://dev.wix.com/dc3/my-apps/) 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](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls.
      */
     extendedFields?: ExtendedFields;
 }
@@ -2078,6 +2083,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;
@@ -2768,9 +2774,9 @@ interface VariantWithInventoryTypedPropertiesOneOf {
     digitalProperties?: VariantDigitalProperties;
 }
 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 FixedMonetaryAmount {
@@ -2839,7 +2845,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 {
@@ -3200,7 +3209,7 @@ interface SubmitCatalogImportRequest {
 }
 interface SubmitCatalogImportResponse {
     /**
-     * Job ID for async operation tracking. Pass to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/get-async-job) or [List Async Job Items](https://dev.wix.com/docs/rest/business-management/async-job/list-async-job-items) to retrieve details and metadata
+     * Job ID for async operation tracking. Pass to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/get-async-job) or [List Async Job Items](https://dev.wix.com/docs/api-reference/business-management/async-job/list-async-job-items) to retrieve details and metadata
      * @format GUID
      */
     jobId?: string;