@wix/ditto-codegen-public 1.0.50 → 1.0.52

package/dist/docs-output/api-docs/stores-productsV3-updateProduct-doc.txt

@@ -0,0 +1,130 @@
+<stores_products_updateProduct>
+<purpose>Updates specified fields in a product. To update a single field across multiple products, use Bulk Update Product Property.</purpose>
+<use_cases>
+- Update product information such as name, description, or pricing
+- Modify product visibility settings
+- Update product inventory and stock tracking
+- Change product media and images
+- Update product SEO settings and metadata
+- Modify product options and variants
+- Update product collections and categories
+- Change product shipping and tax settings
+- Update product custom fields and properties
+- Modify product discount and pricing rules
+</use_cases>
+<method_declaration>
+products.updateProduct(_id, productUpdate)
+</method_declaration>
+<required_parameters>
+- _id: string - Product ID (generated automatically by the catalog)
+- product: UpdateProduct - Product info to update
+</required_parameters>
+<optional_parameters>
+None
+</optional_parameters>
+<import>import { products } from '@wix/stores'</import>
+<types>
+
+**UpdateProduct**
+Properties:
+- additionalInfoSections: AdditionalInfoSections[] - Additional text that the store owner can assign to the product (e.g. shipping details, refund policy, etc.).
+- brand: string - product brand.
+- costAndProfitData: CostAndProfitData - Cost and profit data.
+- description: string - description.
+- manageVariants: boolean - Whether variants are being managed for this product - enables unique SKU, price and weight per variant. Also affects inventory data. Once set to true, can be reset to false only if no variants exist. You cannot set manageVariants to true if more than 300 variants are defined.
+- name: string - Product name. Min: 1 character Max: 80 characters
+- priceData: PriceData - Price data.
+- pricePerUnitData: PricePerUnitData - price per unit data
+- productOptions: ProductOption[] - Options for this product.
+- productType: ProductType - Currently, only creating physical products ( "productType": "physical" ) is supported via the API.
+- ribbon: string - Product ribbon. Used to highlight relevant information about a product. For example, "Sale", "New Arrival", "Sold Out".
+- seoData: SeoSchema - Custom SEO data for the product.
+- sku: string - Stock keeping unit. If variant management is enabled, SKUs will be set per variant, and this field will be empty.
+- slug: string - A friendly URL name (generated automatically by the catalog when a product is created), can be updated.
+- visible: boolean - Whether the product is visible to site visitors.
+- weight: number - Product weight. If variant management is enabled, weight will be set per variant, and this field will be empty.
+
+**AdditionalInfoSections**
+Properties:
+- description: string - Product info section description
+- title: string - Product info section title
+
+**PriceData**
+Properties:
+- price: number - Product price
+
+**PricePerUnitData**
+Properties:
+- baseMeasurementUnit: BaseMeasurementUnit - Base measurement unit
+- baseQuantity: number - Base quantity
+- totalMeasurementUnit: MeasurementUnit - Total measurement unit
+- totalQuantity: number - Total quantity
+
+**ProductOption**
+Properties:
+- choices: Choice[] - Choices available for this option.
+- name: string - Option name
+
+**Choice**
+- description: string - Choice description.
+- value: string - Choice value
+
+**UpdateProductResponse**
+Properties:
+- product: Product - The updated product object.
+</types>
+<important_notes>
+- This method updates specified fields in a product
+- To update a single field across multiple products, use Bulk Update Product Property
+- Only the fields you specify in the productUpdate parameter will be updated
+- All other fields will remain unchanged
+- The method returns the updated product object
+- Product ID is required and cannot be updated
+- This method doesn't return any custom errors, but may return standard errors
+- **Required Permission**: In order to use this method, the app must have the permission scope named "SCOPE.STORES.PRODUCT_WRITE"
+</important_notes>
+
+<return_type>
+Promise<UpdateProductResponse>
+</return_type>
+
+<example_usage>
+```typescript
+import { products } from '@wix/stores';
+
+// Update a product
+const updatedProduct = await products.updateProduct('product-id', {
+  name: 'Updated Product Name',
+  description: 'Updated product description',
+  price: {
+    price: 29.99,
+    currency: 'USD'
+  },
+  // Add a promotional ribbon
+  ribbon: 'New Arrival'
+});
+
+// Update product with different ribbon
+const saleProduct = await products.updateProduct('product-id', {
+  ribbon: 'Sale'
+});
+
+// Remove ribbon from product
+const noRibbonProduct = await products.updateProduct('product-id', {
+  ribbon: '' // or null to remove ribbon
+});
+```
+</example_usage>
+
+<related_methods>
+- products.createProduct() - Method to create new products
+- products.getProduct() - Method to retrieve product details
+- products.deleteProduct() - Method to delete products
+- products.queryProducts() - Method to query products with filters
+- products.bulkUpdateProductsProperty() - Method to update single field across multiple products
+- products.addProductMedia() - Method to add media to products
+- products.removeProductMedia() - Method to remove media from products
+- products.addProductsToCollection() - Method to add products to collections
+- products.removeProductsFromCollection() - Method to remove products from collections
+</related_methods>
+</stores_products_updateProduct>