{"id":"3cca6b29-350b-486d-bf2f-5b9816914afd","createdDate":"2026-01-19T14:27:41.780Z","updatedDate":"2026-01-19T14:27:41.780Z","resourceId":"9f553509-a896-4528-a129-a5174837b224","api":{"schema":{"object":{"displayName":"Product Object","slug":"product-object","legacyExamples":[{"title":"Product","content":"{\n \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-07-22T13:22:47.771Z\",\n \"updatedDate\": \"2024-07-22T13:51:49.970Z\",\n \"name\": \"Premium Coffee\",\n \"slug\": \"coffee\",\n \"url\": {\n \"relativePath\": \"/product-page/coffee\",\n \"url\": \"https://my.wixsite.com/food-store/product-page/coffee\"\n },\n \"description\": {\n \"nodes\": [\n {\n \"type\": \"PARAGRAPH\",\n \"id\": \"foo\",\n \"nodes\": [\n {\n \"type\": \"TEXT\",\n \"id\": \"\",\n \"nodes\": [],\n \"textData\": {\n \"text\": \"Tasty, high quality and eco friendly, in a beautiful gift box.\",\n \"decorations\": []\n }\n }\n ],\n \"paragraphData\": {\n \"textStyle\": {\n \"textAlignment\": \"AUTO\"\n }\n }\n }\n ],\n \"metadata\": {\n \"version\": 1,\n \"id\": \"fb97b2c1-a3ff-4319-be5f-bbb7fdf0776c\"\n }\n },\n \"plainDescription\": \"

Tasty, high quality and eco friendly, in a beautiful gift box.

\",\n \"visible\": false,\n \"visibleInPos\": false,\n \"media\": {\n \"main\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n \"itemsInfo\" : {\n \"items\": [\n {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n {\n \"id\": \"370e1a_8412ab11b3ad48bb8375a2ecb1cc8b4d~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_8412ab11b3ad48bb8375a2ecb1cc8b4d~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_8412ab11b3ad48bb8375a2ecb1cc8b4d~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"44682905-395a-4c18-8fab-e050725ba3f6\"\n }\n ]\n }\n },\n \"options\": [\n {\n \"id\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"name\": \"Size\",\n \"optionRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"4498b805-2aed-43fb-b478-989c906c19cd\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"S\",\n \"name\": \"S\",\n \"inStock\": true\n },\n {\n \"choiceId\": \"26394ab0-d81a-422f-a8c9-562f49a6b595\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"L\",\n \"name\": \"L\",\n \"inStock\": false\n }\n ]\n },\n \"key\": \"Size\"\n },\n {\n \"id\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"name\": \"Box color\",\n \"optionRenderType\": \"SWATCH_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"2e98f13b-ae65-4d30-96c5-ac3a6cf99d60\",\n \"linkedMedia\": [],\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"red\",\n \"name\": \"red\",\n \"colorCode\": \"#FF0000\",\n \"inStock\": true\n },\n {\n \"choiceId\": \"4876dcc7-817e-4c10-a6b2-4a4cc2e241e6\",\n \"linkedMedia\": [],\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"blue\",\n \"name\": \"blue\",\n \"colorCode\": \"#0000FF\",\n \"inStock\": false\n }\n ]\n },\n \"key\": \"Box color\"\n }\n ],\n \"modifiers\": [\n {\n \"id\": \"a3d249f0-a8da-425d-9ec1-3c51c795d927\",\n \"name\": \"Remove price tag\",\n \"modifierRenderType\": \"TEXT_CHOICES\",\n \"mandatory\": false,\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"3050481e-e177-4031-bbe9-be9b00af14b5\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"yes\",\n \"name\": \"yes\"\n },\n {\n \"choiceId\": \"ee729b74-d500-4594-aae5-b5a2e75bf5e7\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"no\",\n \"name\": \"no\"\n }\n ]\n },\n \"key\": \"Remove price tag\"\n }\n ],\n \"brand\": {\n \"id\": \"4a16d28d-1736-41f0-87d8-995f6d9a5bdd\",\n \"name\": \"EcoCoffee\"\n },\n \"infoSections\": [\n {\n \"id\": \"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\",\n \"uniqueName\": \"Coffee refund\",\n \"title\": \"Refund policy\",\n \"description\": {\n \"nodes\": [\n {\n \"type\": \"PARAGRAPH\",\n \"id\": \"xjkk51429\",\n \"nodes\": [\n {\n \"type\": \"TEXT\",\n \"id\": \"\",\n \"nodes\": [],\n \"textData\": {\n \"text\": \"2 weeks full refund unless you asked for engraving \",\n \"decorations\": []\n }\n }\n ],\n \"paragraphData\": {}\n }\n ],\n \"metadata\": {\n \"version\": 1\n },\n \"documentStyle\": {}\n },\n \"plainDescription\": \"

2 weeks full refund unless you asked for engraving

\"\n },\n {\n \"id\": \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\",\n \"uniqueName\": \"Origin\",\n \"title\": \"Made in\",\n \"description\": {\n \"nodes\": [\n {\n \"type\": \"PARAGRAPH\",\n \"id\": \"xjkk51429\",\n \"nodes\": [\n {\n \"type\": \"TEXT\",\n \"id\": \"\",\n \"nodes\": [],\n \"textData\": {\n \"text\": \"Brazil\",\n \"decorations\": []\n }\n }\n ]\n }\n ]\n },\n \"plainDescription\": \"

Brazil

\"\n }\n ],\n \"ribbon\": {\n \"id\": \"14585597-3302-4145-8da3-24a26d8346d6\",\n \"name\": \"New arrival\"\n },\n \"directCategoriesInfo\": {\n \"categories\": [\n {\n \"id\": \"583ae7fa-33de-44da-bf41-42ea52419e23\"\n },\n {\n \"id\": \"d25cbb88-ed1b-43e8-94df-2de9f9fec98e\"\n }\n ]\n },\n \"allCategoriesInfo\": {\n \"categories\": [\n {\n \"id\": \"a01525b3-7355-429f-9435-ae23195499f2\"\n },\n {\n \"id\": \"c1f8a77e-4c0e-4136-830e-a923a8bedadf\"\n },\n {\n \"id\": \"583ae7fa-33de-44da-bf41-42ea52419e23\"\n },\n {\n \"id\": \"d25cbb88-ed1b-43e8-94df-2de9f9fec98e\"\n }\n ]\n },\n \"mainCategoryId\": \"583ae7fa-33de-44da-bf41-42ea52419e23\",\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"9\",\n \"formattedAmount\": \"$9.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"costRange\": {\n \"minValue\": {\n \"amount\": \"0.0\",\n \"formattedAmount\": \"$0.00\"\n },\n \"maxValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": {\n \"quantity\": 1.0,\n \"measurementUnit\": \"KG\"\n },\n \"shippingWeightRange\": {\n \"minValue\": 0.2,\n \"maxValue\": 0.4\n },\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n }\n },\n \"currency\": \"USD\",\n \"breadcrumbsInfo\": {\n \"breadcrumbs\": [\n {\n \"categoryId\": \"a01525b3-7355-429f-9435-ae23195499f2\",\n \"categoryName\": \"Beverages\",\n \"categorySlug\": \"beverages\"\n },\n {\n \"categoryId\": \"c1f8a77e-4c0e-4136-830e-a923a8bedadf\",\n \"categoryName\": \"Coffee And Tea\",\n \"categorySlug\": \"coffee-and-tea\"\n },\n {\n \"categoryId\": \"583ae7fa-33de-44da-bf41-42ea52419e23\",\n \"categoryName\": \"Whole Bean Coffee\",\n \"categorySlug\": \"whole-bean-coffee\"\n }\n ]\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"0a186a72-d289-446a-aa51-adf125d30dc6\",\n \"visible\": true,\n \"sku\": \"c-s-r-1111\",\n \"barcode\": \"111111111\",\n \"choices\": [\n {\n \"optionChoiceIds\": {\n \"optionId\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"choiceId\": \"4498b805-2aed-43fb-b478-989c906c19cd\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Size\",\n \"choiceName\": \"S\",\n \"renderType\": \"TEXT_CHOICES\"\n }\n },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"2e98f13b-ae65-4d30-96c5-ac3a6cf99d60\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Box color\",\n \"choiceName\": \"red\",\n \"renderType\": \"SWATCH_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"compareAtPrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"actualPrice\": {\n \"amount\": \"9\",\n \"formattedAmount\": \"$9.00\"\n }\n },\n \"revenueDetails\": {\n \"cost\": {\n \"amount\": \"8\",\n \"formattedAmount\": \"$8.00\"\n },\n \"profit\": {\n \"amount\": \"1\",\n \"formattedAmount\": \"$1.00\"\n },\n \"profitMargin\": 0.1111\n },\n \"media\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n \"physicalProperties\": {\n \"weight\": 0.2,\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": 150.0,\n \"measurementUnit\": \"G\"\n },\n \"value\": \"60.00\",\n \"description\": \"$60.00/1 kg\"\n }\n },\n \"subscriptionPricesInfo\": {\n \"subscriptionPrices\": []\n }\n },\n {\n \"id\": \"5aace0e6-4bab-4d0e-a595-1bcaa01d2377\",\n \"visible\": true,\n \"barcode\": \"111111112\",\n \"choices\": [\n {\n \"optionChoiceIds\": {\n \"optionId\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"choiceId\": \"4498b805-2aed-43fb-b478-989c906c19cd\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Size\",\n \"choiceName\": \"S\",\n \"renderType\": \"TEXT_CHOICES\"\n }\n },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"4876dcc7-817e-4c10-a6b2-4a4cc2e241e6\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Box color\",\n \"choiceName\": \"blue\",\n \"renderType\": \"SWATCH_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"compareAtPrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"actualPrice\": {\n \"amount\": \"9.5\",\n \"formattedAmount\": \"$9.50\"\n }\n },\n \"revenueDetails\": {\n \"cost\": {\n \"amount\": \"8\",\n \"formattedAmount\": \"$8.00\"\n },\n \"profit\": {\n \"amount\": \"1.5\",\n \"formattedAmount\": \"$1.50\"\n },\n \"profitMargin\": 0.1579\n },\n \"media\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n \"physicalProperties\": {\n \"weight\": 0.2,\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": 150.0,\n \"measurementUnit\": \"G\"\n },\n \"value\": \"63.33\",\n \"description\": \"$63.33/1 kg\"\n }\n },\n \"subscriptionPricesInfo\": {\n \"subscriptionPrices\": []\n }\n },\n {\n \"id\": \"1d2acec3-5294-4521-a648-6f2ed5f58c43\",\n \"visible\": false,\n \"barcode\": \"111111113\",\n \"choices\": [\n {\n \"optionChoiceIds\": {\n \"optionId\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"choiceId\": \"26394ab0-d81a-422f-a8c9-562f49a6b595\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Size\",\n \"choiceName\": \"L\",\n \"renderType\": \"TEXT_CHOICES\"\n }\n },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"2e98f13b-ae65-4d30-96c5-ac3a6cf99d60\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Box color\",\n \"choiceName\": \"red\",\n \"renderType\": \"SWATCH_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"compareAtPrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"actualPrice\": {\n \"amount\": \"14\",\n \"formattedAmount\": \"$14.00\"\n }\n },\n \"revenueDetails\": {\n \"cost\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"profit\": {\n \"amount\": \"4\",\n \"formattedAmount\": \"$4.00\"\n },\n \"profitMargin\": 0.2857\n },\n \"media\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n \"physicalProperties\": {\n \"weight\": 0.4,\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": 300.0,\n \"measurementUnit\": \"G\"\n },\n \"value\": \"46.67\",\n \"description\": \"$46.67/1 kg\"\n }\n },\n \"subscriptionPricesInfo\": {\n \"subscriptionPrices\": []\n }\n },\n {\n \"id\": \"5c390d11-8d35-48e3-8037-428812e0426c\",\n \"visible\": true,\n \"barcode\": \"111111114\",\n \"choices\": [\n {\n \"optionChoiceIds\": {\n \"optionId\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"choiceId\": \"26394ab0-d81a-422f-a8c9-562f49a6b595\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Size\",\n \"choiceName\": \"L\",\n \"renderType\": \"TEXT_CHOICES\"\n }\n },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"4876dcc7-817e-4c10-a6b2-4a4cc2e241e6\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Box color\",\n \"choiceName\": \"blue\",\n \"renderType\": \"SWATCH_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"media\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n \"physicalProperties\": {\n \"weight\": 0.4,\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": 300.0,\n \"measurementUnit\": \"G\"\n },\n \"value\": \"50.00\",\n \"description\": \"$50.00/1 kg\"\n }\n },\n \"subscriptionPricesInfo\": {\n \"subscriptionPrices\": []\n }\n }\n ]\n }\n}\n"}],"sourceRepo":"git@github.com:wix-private/ecom.git","sdkData":{},"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product","description":"A product in a Wix Stores catalog.\n\nProducts can be physical goods that require shipping, or digital content that customers download. Each product has at least one variant, which represents a specific purchasable version with its own pricing, SKU, and inventory. Products with options (like size or color) have multiple variants.\n\nProducts can be associated with brands and ribbons, enhanced with info sections and extended fields, and organized into categories."},"methods":[{"summary":"Create Product","description":"Creates a new product.\n\nYou can also add a ribbon, brand, info sections, options, and modifiers in the same request.\n\n> **Notes:**\n> + This method doesn't create inventory items. Use [Create Product With Inventory](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/create-product-with-inventory) to create a product with inventory in a single call, or create inventory items separately using the [Inventory Items API](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/inventory-items-v3/introduction).\n> + When you create a product with inline options or modifiers (without referencing existing customization IDs), new standalone [Customization](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/customizations-v3/introduction) entities are automatically created. These can be reused across other products.","operationId":"wix.stores.catalog.v3.CatalogApi.CreateProduct","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.CreateProductResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateProductRequest","description":"","properties":{"product":{"description":"Product to create.\n\nAt least 1 variant must be provided, and each variant must have an item in the `choices` field for every item in `options`.\nIf `options` is empty, 1 default variant must be provided with an empty `choices` list.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product","summary":"product","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.SingleEntityOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["product","product.name","product.productType","product.variantsInfo","product.variantsInfo.variants","product.variantsInfo.variants.price","product.variantsInfo.variants.price.actualPrice","product.variantsInfo.variants.physicalProperties.pricePerUnit.settings.measurementUnit","product.variantsInfo.variants.digitalProperties.digitalFile","product.variantsInfo.variants.digitalProperties.digitalFile.id","product.physicalProperties.pricePerUnit.measurementUnit","product.subscriptionDetails.subscriptions","product.subscriptionDetails.subscriptions.title","product.subscriptionDetails.subscriptions.frequency","product.subscriptionDetails.subscriptions.discount.type","product.variantsInfo.variants.choices.optionChoiceIds.optionId","product.variantsInfo.variants.choices.optionChoiceIds.choiceId"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Product Created","description":"Triggered when a product is created.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_created","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.CreateProduct","methodName":"CreateProduct","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"MISSING_VARIANT_OPTION_CHOICE","description":"Variant's choice references a non-existent option. Every variant choice must reference an existing option in `options.id`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MISSING_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_VARIANT_OPTION_CHOICE","description":"Multiple variants have identical choices in `variantsInfo.variants.choices`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_PRODUCT_OPTIONS","description":"Multiple options have identical `name` and `optionRenderType`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_PRODUCT_OPTIONS"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_DEFAULT_VARIANT","description":"Product with multiple variants has a variant with empty `choices`. Only single-variant products can have empty choices.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_DEFAULT_VARIANT"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"VARIANTS_ARE_NOT_ALIGNED_WITH_PRODUCT","errorSchemaName":"com.wix.stores.catalog.product.api.v3.VariantsNotAlignedWithProduct","description":"Variants aren't aligned with the product. The variant `typedProperties` must match the `productType`, measurement units must align, and each variant must have exactly 1 choice for every option.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"VARIANTS_ARE_NOT_ALIGNED_WITH_PRODUCT"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"DUPLICATE_SLUG_ERROR","description":"There is already a product with this `slug`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_SLUG_ERROR"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"DIGITAL_FILE_NOT_FOUND_ERROR","description":"Couldn't find the digital file referenced in `variantsInfo.variants.digitalProperties`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DIGITAL_FILE_NOT_FOUND_ERROR"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"BARCODE_ALREADY_EXIST_ERROR","description":"There is already a variant with this `barcode`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"BARCODE_ALREADY_EXIST_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_BARCODE_ERROR","description":"Multiple variants have identical `barcode` in the request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_BARCODE_ERROR"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SKU_ALREADY_EXIST_ERROR","description":"There is already a variant with this `sku`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"SKU_ALREADY_EXIST_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_SKU_ERROR","description":"Multiple variants have identical `sku` in the request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_SKU_ERROR"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"VARIANT_ID_ALREADY_EXISTS","description":"Multiple variants have identical `id`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"VARIANT_ID_ALREADY_EXISTS"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION","description":"Subscription added to a digital product. Digital products can't have subscriptions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT","description":"All subscriptions are hidden for a subscription-only product. At least 1 subscription must be visible when `allowOneTimePurchases` is false.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT","description":"Subscription discount `amountOff` exceeds the minimum variant price.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS","description":"There is already a subscription with this `id`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PRODUCTS_LIMIT_EXCEEDED","description":"Number of products exceeds the server's limit of 50000.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRODUCTS_LIMIT_EXCEEDED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"PRODUCT_MEDIA_NOT_EXIST","description":"Couldn't find the media referenced in `options.choiceSettings.choices.media`. The media must exist in the product's `media` field.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRODUCT_MEDIA_NOT_EXIST"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ONLY_SPACES_STRING_ERROR","description":"Product `name` field contains only spaces.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ONLY_SPACES_STRING_ERROR"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"BRAND_CREATION_FAILED","description":"Brand creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"BRAND_CREATION_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"RIBBON_NOT_FOUND","description":"Couldn't find the ribbon.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"RIBBON_NOT_FOUND"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"RIBBON_CREATION_FAILED","description":"Ribbon creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"RIBBON_CREATION_FAILED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INFO_SECTION_CREATION_FAILED","description":"Info section creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INFO_SECTION_CREATION_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CUSTOMIZATION_NOT_EXIST","description":"Couldn't find the customization.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CUSTOMIZATION_NOT_EXIST"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"CUSTOMIZATIONS_CREATION_FAILED","description":"Customization creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CUSTOMIZATIONS_CREATION_FAILED"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED","description":"Failed to add customization choices.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CHOICE_NOT_EXIST","description":"Couldn't find the choice.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CHOICE_NOT_EXIST"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRODUCT_OPTION_NAME_AND_TYPE_REQUIRED","description":"Option is missing `name` or `type`. Options without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRODUCT_OPTION_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRODUCT_OPTION_CHOICE_NAME_AND_TYPE_REQUIRED","description":"Option choice is missing `name` or `type`. Choices without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRODUCT_OPTION_CHOICE_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MODIFIER_NAME_AND_TYPE_REQUIRED","description":"Modifier is missing `name` or `type`. Modifiers without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MODIFIER_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MODIFIER_CHOICE_NAME_AND_TYPE_REQUIRED","description":"Modifier choice is missing `name` or `type`. Choices without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MODIFIER_CHOICE_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TOO_MANY_OPTIONS_IN_REQUEST","description":"Number of options exceeds the server's limit.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"TOO_MANY_OPTIONS_IN_REQUEST"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE","description":"The `compareAtPrice` is lower than the `actualPrice`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"VARIANTS_TYPED_PROPERTIES_ARE_NOT_ALIGNED","description":"Variants have different `typedProperties` types. All variants must have the same type.","errorType":"VALIDATION","validationErrorData":{"ruleName":"VARIANTS_TYPED_PROPERTIES_ARE_NOT_ALIGNED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION_CHOICE","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionChoiceErrorData","description":"Variant choice doesn't exist in the product's option choices.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionErrorData","description":"Variant option doesn't exist in the product's options.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"SUBSCRIPTION_INVALID_AUTO_RENEWAL","description":"The `autoRenewal` field is set to false. Set the number of billing cycles in `billingCycles` to prevent automatic renewal instead.","errorType":"VALIDATION","validationErrorData":{"ruleName":"SUBSCRIPTION_INVALID_AUTO_RENEWAL"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DIGITAL_PRODUCT_CANNOT_BE_VISIBLE_IN_POS","description":"Digital product is marked as visible in POS. Digital products can't be visible in POS.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DIGITAL_PRODUCT_CANNOT_BE_VISIBLE_IN_POS"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DESCRIPTION_SIZE_TOO_BIG","description":"Product `description` field exceeds the maximum size of 32000 bytes.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DESCRIPTION_SIZE_TOO_BIG"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DUPLICATE_MEDIA_ERROR","errorSchemaName":"com.wix.stores.catalog.product.api.v3.DuplicateMediaIdAssignedToProduct","description":"Multiple media items have identical IDs. Each media ID must be unique.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DUPLICATE_MEDIA_ERROR"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"BRAND_MISSING_ID","description":"Brand is missing an `id`.","errorType":"VALIDATION","validationErrorData":{"ruleName":"BRAND_MISSING_ID"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRICE_PER_UNIT_NOT_ALIGNED","description":"Price per unit isn't aligned between product and variants.","errorType":"VALIDATION","validationErrorData":{"ruleName":"PRICE_PER_UNIT_NOT_ALIGNED"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_CREATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.CreateProductRequest","responseMessage":"wix.stores.catalog.v3.CreateProductResponse"},"legacyExamples":[{"name":"CreateProduct","type":"METHOD","content":{"title":"Create product with many different fields","request":"curl POST 'https://www.wixapis.com/stores/v3/products' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"fields\": [\n \"VARIANT_OPTION_CHOICE_NAMES\",\n \"MERCHANT_DATA\",\n \"INFO_SECTION\",\n \"MEDIA_ITEMS_INFO\",\n \"DESCRIPTION\",\n \"URL\",\n \"CURRENCY\",\n \"WEIGHT_MEASUREMENT_UNIT_INFO\"\n ],\n \"product\": {\n \"name\": \"Coffee\",\n \"description\": {\n \"nodes\": [\n {\n \"type\": \"PARAGRAPH\",\n \"id\": \"foo\",\n \"nodes\": [\n {\n \"type\": \"TEXT\",\n \"textData\": {\n \"text\": \"Tasty and eco friendly, in a beautiful gift box.\"\n }\n }\n ],\n \"paragraphData\": {\n \"textStyle\": {\n \"textAlignment\": \"AUTO\"\n }\n }\n }\n ],\n \"metadata\": {\n \"version\": 1,\n \"id\": \"fb97b2c1-a3ff-4319-be5f-bbb7fdf0776c\"\n }\n },\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"items\": [\n {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n {\n \"url\": \"https://example.jpeg\"\n }\n ]\n },\n \"options\": [\n {\n \"name\": \"Size\",\n \"optionRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceType\": \"CHOICE_TEXT\",\n \"name\": \"S\"\n },\n {\n \"choiceType\": \"CHOICE_TEXT\",\n \"name\": \"L\"\n }\n ]\n }\n },\n {\n \"name\": \"Box color\",\n \"optionRenderType\": \"SWATCH_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceType\": \"ONE_COLOR\",\n \"name\": \"red\",\n \"colorCode\": \"#FF0000\"\n },\n {\n \"choiceType\": \"ONE_COLOR\",\n \"name\": \"blue\",\n \"colorCode\": \"#0000FF\"\n }\n ]\n }\n }\n ],\n \"modifiers\": [\n {\n \"name\": \"Engraving\",\n \"modifierRenderType\": \"FREE_TEXT\",\n \"mandatory\": false,\n \"freeTextSettings\": {\n \"minCharCount\": 0,\n \"maxCharCount\": 499,\n \"title\": \"Would you like to engrave something on the box?\"\n }\n },\n {\n \"name\": \"Remove price tag\",\n \"modifierRenderType\": \"TEXT_CHOICES\",\n \"mandatory\": false,\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceType\": \"CHOICE_TEXT\",\n \"name\": \"yes\"\n },\n {\n \"choiceType\": \"CHOICE_TEXT\",\n \"name\": \"no\"\n }\n ]\n }\n }\n ],\n \"brand\": {\n \"name\": \"EcoCoffee\"\n },\n \"infoSections\": [\n {\n \"uniqueName\": \"Coffee refund\",\n \"title\": \"Refund policy\",\n \"description\": {\n \"nodes\": [\n {\n \"type\": \"PARAGRAPH\",\n \"id\": \"xjkk51429\",\n \"nodes\": [\n {\n \"type\": \"TEXT\",\n \"textData\": {\n \"text\": \"2 weeks full refund unless you asked for engraving \"\n }\n }\n ]\n }\n ],\n \"metadata\": {\n \"version\": 1\n }\n }\n }\n ],\n \"ribbon\": {\n \"name\": \"best seller\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": {\n \"quantity\": 1.0,\n \"measurementUnit\": \"KG\"\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"visible\": true,\n \"sku\": \"c-s-r-1111\",\n \"barcode\": \"111111111\",\n \"choices\": [\n {\n \"optionChoiceNames\": {\n \"optionName\": \"Size\",\n \"choiceName\": \"S\",\n \"renderType\": \"TEXT_CHOICES\"\n }\n },\n {\n \"optionChoiceNames\": {\n \"optionName\": \"Box color\",\n \"choiceName\": \"red\",\n \"renderType\": \"SWATCH_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"compareAtPrice\": {\n \"amount\": \"10\"\n },\n \"actualPrice\": {\n \"amount\": \"9\"\n }\n },\n \"revenueDetails\": {\n \"cost\": {\n \"amount\": \"8\"\n }\n },\n \"physicalProperties\": {\n \"weight\": 0.2,\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": 150.0,\n \"measurementUnit\": \"G\"\n }\n }\n }\n },\n {\n \"visible\": true,\n \"barcode\": \"111111112\",\n \"choices\": [\n {\n \"optionChoiceNames\": {\n \"optionName\": \"Size\",\n \"choiceName\": \"S\",\n \"renderType\": \"TEXT_CHOICES\"\n }\n },\n {\n \"optionChoiceNames\": {\n \"optionName\": \"Box color\",\n \"choiceName\": \"blue\",\n \"renderType\": \"SWATCH_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"compareAtPrice\": {\n \"amount\": \"10\"\n },\n \"actualPrice\": {\n \"amount\": \"9.5\"\n }\n },\n \"revenueDetails\": {\n \"cost\": {\n \"amount\": \"8\"\n }\n },\n \"physicalProperties\": {\n \"weight\": 0.2,\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": 150.0,\n \"measurementUnit\": \"G\"\n }\n }\n }\n },\n {\n \"visible\": false,\n \"barcode\": \"111111113\",\n \"choices\": [\n {\n \"optionChoiceNames\": {\n \"optionName\": \"Size\",\n \"choiceName\": \"L\",\n \"renderType\": \"TEXT_CHOICES\"\n }\n },\n {\n \"optionChoiceNames\": {\n \"optionName\": \"Box color\",\n \"choiceName\": \"red\",\n \"renderType\": \"SWATCH_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"compareAtPrice\": {\n \"amount\": \"15\"\n },\n \"actualPrice\": {\n \"amount\": \"14\"\n }\n },\n \"revenueDetails\": {\n \"cost\": {\n \"amount\": \"10\"\n }\n },\n \"physicalProperties\": {\n \"weight\": 0.4,\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": 300.0,\n \"measurementUnit\": \"G\"\n }\n }\n }\n },\n {\n \"visible\": true,\n \"barcode\": \"111111114\",\n \"choices\": [\n {\n \"optionChoiceNames\": {\n \"optionName\": \"Size\",\n \"choiceName\": \"L\",\n \"renderType\": \"TEXT_CHOICES\"\n }\n },\n {\n \"optionChoiceNames\": {\n \"optionName\": \"Box color\",\n \"choiceName\": \"blue\",\n \"renderType\": \"SWATCH_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"15\"\n }\n },\n \"physicalProperties\": {\n \"weight\": 0.4,\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": 300.0,\n \"measurementUnit\": \"G\"\n }\n }\n }\n }\n ]\n }\n }\n }'","response":"{\n \"product\": {\n \"id\": \"dff8dc87-05f8-462a-8e50-fc3575c64c22\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-07-22T13:22:47.771Z\",\n \"updatedDate\": \"2024-07-22T13:22:47.771Z\",\n \"name\": \"Coffee\",\n \"slug\": \"coffee\",\n \"url\": {\n \"relativePath\": \"/product-page/coffee\",\n \"url\": \"https://my.wixsite.com/food-store/product-page/coffee\"\n },\n \"description\": {\n \"nodes\": [\n {\n \"type\": \"PARAGRAPH\",\n \"id\": \"foo\",\n \"nodes\": [\n {\n \"type\": \"TEXT\",\n \"id\": \"\",\n \"nodes\": [],\n \"textData\": {\n \"text\": \"Tasty and eco friendly, in a beautiful gift box.\",\n \"decorations\": []\n }\n }\n ],\n \"paragraphData\": {\n \"textStyle\": {\n \"textAlignment\": \"AUTO\"\n }\n }\n }\n ],\n \"metadata\": {\n \"version\": 1,\n \"id\": \"fb97b2c1-a3ff-4319-be5f-bbb7fdf0776c\"\n }\n },\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n \"itemsInfo\" : {\n \"items\": [\n {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n {\n \"url\": \"https://example.jpeg\",\n \"uploadId\": \"44682905-395a-4c18-8fab-e050725ba3f6\"\n }\n ]\n }\n },\n \"options\": [\n {\n \"id\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"name\": \"Size\",\n \"optionRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"4498b805-2aed-43fb-b478-989c906c19cd\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"S\",\n \"name\": \"S\",\n \"inStock\": true\n },\n {\n \"choiceId\": \"26394ab0-d81a-422f-a8c9-562f49a6b595\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"L\",\n \"name\": \"L\",\n \"inStock\": false\n }\n ]\n },\n \"key\": \"Size\"\n },\n {\n \"id\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"name\": \"Box color\",\n \"optionRenderType\": \"SWATCH_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"2e98f13b-ae65-4d30-96c5-ac3a6cf99d60\",\n \"linkedMedia\": [],\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"red\",\n \"name\": \"red\",\n \"colorCode\": \"#FF0000\",\n \"inStock\": true\n },\n {\n \"choiceId\": \"4876dcc7-817e-4c10-a6b2-4a4cc2e241e6\",\n \"linkedMedia\": [],\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"blue\",\n \"name\": \"blue\",\n \"colorCode\": \"#0000FF\",\n \"inStock\": false\n }\n ]\n },\n \"key\": \"Box color\"\n }\n ],\n \"modifiers\": [\n {\n \"id\": \"1d628610-6963-43c0-862a-f823142b00a0\",\n \"name\": \"Engraving\",\n \"modifierRenderType\": \"FREE_TEXT\",\n \"mandatory\": false,\n \"freeTextSettings\": {\n \"minCharCount\": 0,\n \"maxCharCount\": 499,\n \"title\": \"Would you like to engrave something on the box?\",\n \"key\": \"Would you like to engrave something on the box?\"\n },\n \"key\": \"Engraving\"\n },\n {\n \"id\": \"a3d249f0-a8da-425d-9ec1-3c51c795d927\",\n \"name\": \"Remove price tag\",\n \"modifierRenderType\": \"TEXT_CHOICES\",\n \"mandatory\": false,\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"3050481e-e177-4031-bbe9-be9b00af14b5\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"yes\",\n \"name\": \"yes\"\n },\n {\n \"choiceId\": \"ee729b74-d500-4594-aae5-b5a2e75bf5e7\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"no\",\n \"name\": \"no\"\n }\n ]\n },\n \"key\": \"Remove price tag\"\n }\n ],\n \"brand\": {\n \"id\": \"4a16d28d-1736-41f0-87d8-995f6d9a5bdd\",\n \"name\": \"EcoCoffee\"\n },\n \"infoSections\": [\n {\n \"id\": \"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\",\n \"uniqueName\": \"Coffee refund\",\n \"title\": \"Refund policy\",\n \"description\": {\n \"nodes\": [\n {\n \"type\": \"PARAGRAPH\",\n \"id\": \"xjkk51429\",\n \"nodes\": [\n {\n \"type\": \"TEXT\",\n \"id\": \"\",\n \"nodes\": [],\n \"textData\": {\n \"text\": \"2 weeks full refund unless you asked for engraving \",\n \"decorations\": []\n }\n }\n ],\n \"paragraphData\": {}\n }\n ],\n \"metadata\": {\n \"version\": 1\n },\n \"documentStyle\": {}\n }\n }\n ],\n \"ribbon\": {\n \"id\": \"826aec2a-771b-45a6-9f72-392da18fd3bf\",\n \"name\": \"best seller\"\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"9\",\n \"formattedAmount\": \"$9.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"costRange\": {\n \"minValue\": {\n \"amount\": \"0.0\",\n \"formattedAmount\": \"$0.00\"\n },\n \"maxValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": {\n \"quantity\": 1.0,\n \"measurementUnit\": \"KG\"\n },\n \"shippingWeightRange\": {\n \"minValue\": 0.2,\n \"maxValue\": 0.4\n },\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n }\n },\n \"currency\": \"USD\",\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"0a186a72-d289-446a-aa51-adf125d30dc6\",\n \"visible\": true,\n \"sku\": \"c-s-r-1111\",\n \"barcode\": \"111111111\",\n \"choices\": [\n {\n \"optionChoiceIds\": {\n \"optionId\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"choiceId\": \"4498b805-2aed-43fb-b478-989c906c19cd\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Size\",\n \"choiceName\": \"S\",\n \"renderType\": \"TEXT_CHOICES\"\n }\n },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"2e98f13b-ae65-4d30-96c5-ac3a6cf99d60\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Box color\",\n \"choiceName\": \"red\",\n \"renderType\": \"SWATCH_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"compareAtPrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"actualPrice\": {\n \"amount\": \"9\",\n \"formattedAmount\": \"$9.00\"\n }\n },\n \"revenueDetails\": {\n \"cost\": {\n \"amount\": \"8\",\n \"formattedAmount\": \"$8.00\"\n },\n \"profit\": {\n \"amount\": \"1\",\n \"formattedAmount\": \"$1.00\"\n },\n \"profitMargin\": 0.1111\n },\n \"media\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n \"physicalProperties\": {\n \"weight\": 0.2,\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": 150.0,\n \"measurementUnit\": \"G\"\n },\n \"value\": \"60.00\",\n \"description\": \"$60.00/1 kg\"\n }\n }\n },\n {\n \"id\": \"5aace0e6-4bab-4d0e-a595-1bcaa01d2377\",\n \"visible\": true,\n \"barcode\": \"111111112\",\n \"choices\": [\n {\n \"optionChoiceIds\": {\n \"optionId\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"choiceId\": \"4498b805-2aed-43fb-b478-989c906c19cd\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Size\",\n \"choiceName\": \"S\",\n \"renderType\": \"TEXT_CHOICES\"\n }\n },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"4876dcc7-817e-4c10-a6b2-4a4cc2e241e6\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Box color\",\n \"choiceName\": \"blue\",\n \"renderType\": \"SWATCH_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"compareAtPrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"actualPrice\": {\n \"amount\": \"9.5\",\n \"formattedAmount\": \"$9.50\"\n }\n },\n \"revenueDetails\": {\n \"cost\": {\n \"amount\": \"8\",\n \"formattedAmount\": \"$8.00\"\n },\n \"profit\": {\n \"amount\": \"1.5\",\n \"formattedAmount\": \"$1.50\"\n },\n \"profitMargin\": 0.1579\n },\n \"media\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n \"physicalProperties\": {\n \"weight\": 0.2,\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": 150.0,\n \"measurementUnit\": \"G\"\n },\n \"value\": \"63.33\",\n \"description\": \"$63.33/1 kg\"\n }\n }\n },\n {\n \"id\": \"1d2acec3-5294-4521-a648-6f2ed5f58c43\",\n \"visible\": false,\n \"barcode\": \"111111113\",\n \"choices\": [\n {\n \"optionChoiceIds\": {\n \"optionId\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"choiceId\": \"26394ab0-d81a-422f-a8c9-562f49a6b595\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Size\",\n \"choiceName\": \"L\",\n \"renderType\": \"TEXT_CHOICES\"\n }\n },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"2e98f13b-ae65-4d30-96c5-ac3a6cf99d60\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Box color\",\n \"choiceName\": \"red\",\n \"renderType\": \"SWATCH_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"compareAtPrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"actualPrice\": {\n \"amount\": \"14\",\n \"formattedAmount\": \"$14.00\"\n }\n },\n \"revenueDetails\": {\n \"cost\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"profit\": {\n \"amount\": \"4\",\n \"formattedAmount\": \"$4.00\"\n },\n \"profitMargin\": 0.2857\n },\n \"media\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n \"physicalProperties\": {\n \"weight\": 0.4,\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": 300.0,\n \"measurementUnit\": \"G\"\n },\n \"value\": \"46.67\",\n \"description\": \"$46.67/1 kg\"\n }\n }\n },\n {\n \"id\": \"5c390d11-8d35-48e3-8037-428812e0426c\",\n \"visible\": true,\n \"barcode\": \"111111114\",\n \"choices\": [\n {\n \"optionChoiceIds\": {\n \"optionId\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"choiceId\": \"26394ab0-d81a-422f-a8c9-562f49a6b595\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Size\",\n \"choiceName\": \"L\",\n \"renderType\": \"TEXT_CHOICES\"\n }\n },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"4876dcc7-817e-4c10-a6b2-4a4cc2e241e6\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Box color\",\n \"choiceName\": \"blue\",\n \"renderType\": \"SWATCH_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"media\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n \"physicalProperties\": {\n \"weight\": 0.4,\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": 300.0,\n \"measurementUnit\": \"G\"\n },\n \"value\": \"50.00\",\n \"description\": \"$50.00/1 kg\"\n }\n }\n }\n ]\n }\n }\n}"}},{"name":"CreateProduct","type":"METHOD","order":2,"content":{"title":"Create product with subscriptions","request":"curl POST 'https://www.wixapis.com/stores/v3/products' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"fields\": [\n \"VARIANTS_INFO\",\n \"SUBSCRIPTION_PRICES_INFO\",\n \"CURRENCY\",\n \"WEIGHT_MEASUREMENT_UNIT_INFO\"\n ],\n \"product\": {\n \"name\": \"Chocolate bar\",\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {},\n \"variantsInfo\": {\n \"variants\": [\n {\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"15\"\n }\n },\n \"physicalProperties\": {\n \"weight\": 0.3\n }\n }\n ]\n },\n \"subscriptionDetails\": {\n \"allowOneTimePurchases\": true,\n \"subscriptions\": [\n {\n \"title\": \"Weekly subscription\",\n \"description\": \"Get a chocolate bar every week and save 20%!\",\n \"visible\": true,\n \"frequency\": \"WEEK\",\n \"interval\": 1,\n \"autoRenewal\": true,\n \"discount\": {\n \"type\": \"PERCENT\",\n \"percentOff\": 20\n }\n },\n {\n \"title\": \"Monthly subscription\",\n \"description\": \"Get a chocolate bar and save 1.5$ every month!\",\n \"visible\": true,\n \"frequency\": \"MONTH\",\n \"interval\": 1,\n \"billingCycles\": 12,\n \"discount\": {\n \"type\": \"AMOUNT\",\n \"amountOff\": \"1.5\"\n }\n },\n {\n \"title\": \"Diet subscription\",\n \"description\": \"At least once in a quarter, you deserve a chocolate bar!\",\n \"visible\": true,\n \"frequency\": \"MONTH\",\n \"interval\": 3,\n \"autoRenewal\": true\n }\n ]\n }\n }\n }'","response":"{\n \"product\": {\n \"id\": \"a81b20f4-e4a1-4133-a0c5-80c2fdfaf1b6\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-01T10:15:49.327Z\",\n \"updatedDate\": \"2025-01-01T10:15:49.327Z\",\n \"name\": \"Chocolate bar\",\n \"slug\": \"chocolate-bar-2\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": null,\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": {\n \"minValue\": 0.3,\n \"maxValue\": 0.3\n },\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": null,\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_bf658c08-d7de-4c6f-bb6e-c55c10a2026e\",\n \"currency\": null,\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"15.00\",\n \"formattedAmount\": \"$15.00\"\n },\n \"maxValue\": {\n \"amount\": \"15.00\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"15.00\",\n \"formattedAmount\": \"$15.00\"\n },\n \"maxValue\": {\n \"amount\": \"15.00\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"89945d4a-5ceb-4611-8bab-97f57f594169\",\n \"visible\": true,\n \"sku\": null,\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"15.00\",\n \"formattedAmount\": \"$15.00\"\n },\n \"compareAtPrice\": null\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": null,\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n },\n \"physicalProperties\": {\n \"weight\": 0.3,\n \"pricePerUnit\": null\n }\n }\n ]\n },\n \"subscriptionDetails\": {\n \"subscriptions\": [\n {\n \"id\": \"b40e2c2e-5f54-4bac-b835-9ded61b6369c\",\n \"title\": \"Weekly subscription\",\n \"description\": \"Get a chocolate bar every week and save 20%!\",\n \"visible\": true,\n \"frequency\": \"WEEK\",\n \"interval\": 1,\n \"autoRenewal\": true,\n \"discount\": {\n \"percentOff\": 20,\n \"type\": \"PERCENT\"\n }\n },\n {\n \"id\": \"e4fb0557-4ac9-49eb-8de5-cfa5b781211b\",\n \"title\": \"Monthly subscription\",\n \"description\": \"Get a chocolate bar and save 1.5$ every month!\",\n \"visible\": true,\n \"frequency\": \"MONTH\",\n \"interval\": 1,\n \"billingCycles\": 12,\n \"discount\": {\n \"amountOff\": \"1.5\",\n \"type\": \"AMOUNT\"\n }\n },\n {\n \"id\": \"ca75b678-0d68-4992-a7d7-414e37aca31a\",\n \"title\": \"Diet subscription\",\n \"description\": \"At least once in a quarter, you deserve a chocolate bar!\",\n \"visible\": true,\n \"frequency\": \"MONTH\",\n \"interval\": 3,\n \"autoRenewal\": true,\n \"discount\": null\n }\n ],\n \"allowOneTimePurchases\": true\n },\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735726549136000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n }\n}"}},{"name":"CreateProduct","type":"METHOD","order":4,"content":{"title":"Create a physical product with shipping details","description":"Create a physical product with weight, price per unit, and fulfiller settings","request":"curl POST 'https://www.wixapis.com/stores/v3/products?fields=CURRENCY&fields=WEIGHT_MEASUREMENT_UNIT_INFO' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"product\": {\n \"name\": \"Organic Green Tea\",\n \"visible\": true,\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": {\n \"quantity\": 100,\n \"measurementUnit\": \"G\"\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"visible\": true,\n \"sku\": \"TEA-GREEN-100G\",\n \"barcode\": \"8901234567890\",\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"12.99\"\n },\n \"compareAtPrice\": {\n \"amount\": \"15.99\"\n }\n },\n \"revenueDetails\": {\n \"cost\": {\n \"amount\": \"5.50\"\n }\n },\n \"physicalProperties\": {\n \"weight\": 0.12,\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": 100,\n \"measurementUnit\": \"G\"\n }\n }\n }\n }\n ]\n }\n }\n}'"}},{"name":"CreateProduct","type":"METHOD","order":3,"content":{"title":"Create a simple product with a `plainDescription`.","request":"curl -X POST \\\n'https://www.wixapis.com/stores/v3/products' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"fields\": [\n \"PLAIN_DESCRIPTION\"\n ],\n \"product\": {\n \"name\": \"Coffee\",\n \"plainDescription\": \"

Eco friendly, in a beautiful gift box.

\",\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {},\n \"variantsInfo\": {\n \"variants\": [\n {\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"15.00\"\n }\n },\n \"physicalProperties\": {}\n }\n ]\n }\n }\n }'","response":"{\n \"product\": {\n \"id\": \"0f232415-fa49-4ee1-b93f-4f13047114e2\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-07-09T14:49:05.609Z\",\n \"updatedDate\": \"2025-07-09T14:49:05.609Z\",\n \"numericId\": \"1752072545601000\",\n \"name\": \"Coffee\",\n \"slug\": \"coffee-3\",\n \"plainDescription\": \"

Eco friendly, in a beautiful gift box.

Eco friendly, in a beautiful gift box.

Eco friendly, in a beautiful gift box.

\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {},\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\",\n \"preorderAvailability\": \"NO_VARIANTS\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {},\n \"handle\": \"Product_bfd0f8f5-a798-47b8-b907-a50aade37be3\",\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"15\"\n },\n \"maxValue\": {\n \"amount\": \"15\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"0\"\n },\n \"maxValue\": {\n \"amount\": \"0\"\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"df935834-4caa-46dd-882e-f2e379757596\",\n \"visible\": true,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"15\"\n }\n },\n \"physicalProperties\": {},\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n }\n }\n ]\n },\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"entityEventSequence\": \"1\"\n }\n}"}},{"name":"CreateProduct","type":"METHOD","order":5,"content":{"title":"Create a digital product","description":"Create a digital product like an ebook or online course","request":"curl POST 'https://www.wixapis.com/stores/v3/products?fields=CURRENCY' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"product\": {\n \"name\": \"JavaScript Mastery Course\",\n \"visible\": true,\n \"productType\": \"DIGITAL\",\n \"variantsInfo\": {\n \"variants\": [\n {\n \"visible\": true,\n \"sku\": \"COURSE-JS-2024\",\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"49.99\"\n },\n \"compareAtPrice\": {\n \"amount\": \"79.99\"\n }\n },\n \"revenueDetails\": {\n \"cost\": {\n \"amount\": \"0\"\n }\n }\n }\n ]\n }\n }\n}'"}},{"name":"CreateProduct","type":"METHOD","order":1,"content":{"title":"Create minimal possible product","request":"curl POST 'https://www.wixapis.com/stores/v3/products' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"product\": {\n \"name\": \"Shopping bag\",\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {},\n \"variantsInfo\": {\n \"variants\": [\n {\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"0.5\"\n }\n },\n \"physicalProperties\": {}\n }\n ]\n }\n }\n}'","response":"{\n \"product\": {\n \"id\": \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-01T10:13:14.540Z\",\n \"updatedDate\": \"2025-01-01T10:13:14.540Z\",\n \"name\": \"Shopping bag\",\n \"slug\": \"shopping-bag\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": null,\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": null,\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_a7daf3a2-2a31-49b3-8a64-8264cd1006c7\",\n \"currency\": null,\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"75ba03bc-e56f-4b6d-be52-691eb2ed5fd7\",\n \"visible\": true,\n \"sku\": null,\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"compareAtPrice\": null\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": null,\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n },\n \"physicalProperties\": {\n \"weight\": null,\n \"pricePerUnit\": null\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735726394407000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n }\n}"}}],"commonMethodData":{"name":"create","itemField":"product"},"sdkData":{"signature":{"resolved":[{"field":{"path":"product"}},{"parent":{"name":"options","fields":[{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Create a digital product","description":"Create a digital product like an ebook or online course","content":"import { productsV3 } from \"@wix/stores\";\n\nconst product = {\n name: \"JavaScript Mastery Course\",\n visible: true,\n productType: \"DIGITAL\",\n variantsInfo: {\n variants: [\n {\n visible: true,\n sku: \"COURSE-JS-2024\",\n price: {\n actualPrice: {\n amount: \"49.99\"\n },\n compareAtPrice: {\n amount: \"79.99\"\n }\n },\n revenueDetails: {\n cost: {\n amount: \"0\"\n }\n }\n }\n ]\n }\n};\n\nconst options = {\n fields: [\"CURRENCY\"]\n};\n\nasync function createProduct() {\n const response = await productsV3.createProduct(product, options);\n}\n\n","order":5,"source":"manual"},{"title":"Create a physical product with shipping details","description":"Create a physical product with weight, price per unit, and fulfiller settings","content":"import { productsV3 } from \"@wix/stores\";\n\nconst product = {\n name: \"Organic Green Tea\",\n visible: true,\n productType: \"PHYSICAL\",\n physicalProperties: {\n pricePerUnit: {\n quantity: 100,\n measurementUnit: \"G\"\n }\n },\n variantsInfo: {\n variants: [\n {\n visible: true,\n sku: \"TEA-GREEN-100G\",\n barcode: \"8901234567890\",\n price: {\n actualPrice: {\n amount: \"12.99\"\n },\n compareAtPrice: {\n amount: \"15.99\"\n }\n },\n revenueDetails: {\n cost: {\n amount: \"5.50\"\n }\n },\n physicalProperties: {\n weight: 0.12,\n pricePerUnit: {\n settings: {\n quantity: 100,\n measurementUnit: \"G\"\n }\n }\n }\n }\n ]\n }\n};\n\nconst options = {\n fields: [\"CURRENCY\", \"WEIGHT_MEASUREMENT_UNIT_INFO\"]\n};\n\nasync function createProduct() {\n const response = await productsV3.createProduct(product, options);\n}\n\n","order":4,"source":"manual"},{"title":"Create a product with options, modifiers, and variants","description":"","content":"import { productsV3 } from \"@wix/stores\";\n\nconst product = {\n name: \"Coffee\",\n description: {\n nodes: [\n {\n type: \"PARAGRAPH\",\n id: \"foo\",\n nodes: [\n {\n type: \"TEXT\",\n textData: {\n text: \"Tasty and eco friendly, in a beautiful gift box.\"\n }\n }\n ],\n paragraphData: {\n textStyle: {\n textAlignment: \"AUTO\"\n }\n }\n }\n ],\n metadata: {\n version: 1,\n id: \"fb97b2c1-a3ff-4319-be5f-bbb7fdf0776c\"\n }\n },\n visible: true,\n visibleInPos: true,\n media: {\n items: [\n {\n id: \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n {\n url: \"https://example.jpeg\"\n }\n ]\n },\n options: [\n {\n name: \"Size\",\n optionRenderType: \"TEXT_CHOICES\",\n choicesSettings: {\n choices: [\n {\n choiceType: \"CHOICE_TEXT\",\n name: \"S\"\n },\n {\n choiceType: \"CHOICE_TEXT\",\n name: \"L\"\n }\n ]\n }\n },\n {\n name: \"Box color\",\n optionRenderType: \"SWATCH_CHOICES\",\n choicesSettings: {\n choices: [\n {\n choiceType: \"ONE_COLOR\",\n name: \"red\",\n colorCode: \"#FF0000\"\n },\n {\n choiceType: \"ONE_COLOR\",\n name: \"blue\",\n colorCode: \"#0000FF\"\n }\n ]\n }\n }\n ],\n modifiers: [\n {\n name: \"Engraving\",\n modifierRenderType: \"FREE_TEXT\",\n mandatory: false,\n freeTextSettings: {\n minCharCount: 0,\n maxCharCount: 499,\n title: \"Would you like to engrave something on the box?\"\n }\n },\n {\n name: \"Remove price tag\",\n modifierRenderType: \"TEXT_CHOICES\",\n mandatory: false,\n choicesSettings: {\n choices: [\n {\n choiceType: \"CHOICE_TEXT\",\n name: \"yes\"\n },\n {\n choiceType: \"CHOICE_TEXT\",\n name: \"no\"\n }\n ]\n }\n }\n ],\n brand: {\n name: \"EcoCoffee\"\n },\n infoSections: [\n {\n uniqueName: \"Coffee refund\",\n title: \"Refund policy\",\n description: {\n nodes: [\n {\n type: \"PARAGRAPH\",\n id: \"xjkk51429\",\n nodes: [\n {\n type: \"TEXT\",\n textData: {\n text: \"2 weeks full refund unless you asked for engraving \"\n }\n }\n ]\n }\n ],\n metadata: {\n version: 1\n }\n }\n }\n ],\n ribbon: {\n name: \"best seller\"\n },\n productType: \"PHYSICAL\",\n physicalProperties: {\n pricePerUnit: {\n quantity: 1.0,\n measurementUnit: \"KG\"\n }\n },\n variantsInfo: {\n variants: [\n {\n visible: true,\n sku: \"c-s-r-1111\",\n barcode: \"111111111\",\n choices: [\n {\n optionChoiceNames: {\n optionName: \"Size\",\n choiceName: \"S\",\n renderType: \"TEXT_CHOICES\"\n }\n },\n {\n optionChoiceNames: {\n optionName: \"Box color\",\n choiceName: \"red\",\n renderType: \"SWATCH_CHOICES\"\n }\n }\n ],\n price: {\n compareAtPrice: {\n amount: \"10\"\n },\n actualPrice: {\n amount: \"9\"\n }\n },\n revenueDetails: {\n cost: {\n amount: \"8\"\n }\n },\n physicalProperties: {\n weight: 0.2,\n pricePerUnit: {\n settings: {\n quantity: 150.0,\n measurementUnit: \"G\"\n }\n }\n }\n },\n {\n visible: true,\n barcode: \"111111112\",\n choices: [\n {\n optionChoiceNames: {\n optionName: \"Size\",\n choiceName: \"S\",\n renderType: \"TEXT_CHOICES\"\n }\n },\n {\n optionChoiceNames: {\n optionName: \"Box color\",\n choiceName: \"blue\",\n renderType: \"SWATCH_CHOICES\"\n }\n }\n ],\n price: {\n compareAtPrice: {\n amount: \"10\"\n },\n actualPrice: {\n amount: \"9.5\"\n }\n },\n revenueDetails: {\n cost: {\n amount: \"8\"\n }\n },\n physicalProperties: {\n weight: 0.2,\n pricePerUnit: {\n settings: {\n quantity: 150.0,\n measurementUnit: \"G\"\n }\n }\n }\n },\n {\n visible: false,\n barcode: \"111111113\",\n choices: [\n {\n optionChoiceNames: {\n optionName: \"Size\",\n choiceName: \"L\",\n renderType: \"TEXT_CHOICES\"\n }\n },\n {\n optionChoiceNames: {\n optionName: \"Box color\",\n choiceName: \"red\",\n renderType: \"SWATCH_CHOICES\"\n }\n }\n ],\n price: {\n compareAtPrice: {\n amount: \"15\"\n },\n actualPrice: {\n amount: \"14\"\n }\n },\n revenueDetails: {\n cost: {\n amount: \"10\"\n }\n },\n physicalProperties: {\n weight: 0.4,\n pricePerUnit: {\n settings: {\n quantity: 300.0,\n measurementUnit: \"G\"\n }\n }\n }\n },\n {\n visible: true,\n barcode: \"111111114\",\n choices: [\n {\n optionChoiceNames: {\n optionName: \"Size\",\n choiceName: \"L\",\n renderType: \"TEXT_CHOICES\"\n }\n },\n {\n optionChoiceNames: {\n optionName: \"Box color\",\n choiceName: \"blue\",\n renderType: \"SWATCH_CHOICES\"\n }\n }\n ],\n price: {\n actualPrice: {\n amount: \"15\"\n }\n },\n physicalProperties: {\n weight: 0.4,\n pricePerUnit: {\n settings: {\n quantity: 300.0,\n measurementUnit: \"G\"\n }\n }\n }\n }\n ]\n }\n};\n\nconst options = {\n fields: [\n \"VARIANT_OPTION_CHOICE_NAMES\",\n \"MERCHANT_DATA\",\n \"INFO_SECTION\",\n \"MEDIA_ITEMS_INFO\",\n \"DESCRIPTION\",\n \"URL\",\n \"CURRENCY\",\n \"WEIGHT_MEASUREMENT_UNIT_INFO\"\n ]\n};\n\nasync function createProduct() {\n const response = await productsV3.createProduct(product, options);\n}\n\n","order":3,"source":"manual"},{"title":"Create a product with subscriptions","description":"","content":"import { productsV3 } from \"@wix/stores\";\n\nconst product = {\n name: \"Chocolate bar\",\n productType: \"PHYSICAL\",\n physicalProperties: {},\n variantsInfo: {\n variants: [\n {\n price: {\n actualPrice: {\n amount: \"15\"\n }\n },\n physicalProperties: {\n weight: 0.3\n }\n }\n ]\n },\n subscriptionDetails: {\n allowOneTimePurchases: true,\n subscriptions: [\n {\n title: \"Weekly subscription\",\n description: \"Get a chocolate bar every week and save 20%!\",\n visible: true,\n frequency: \"WEEK\",\n interval: 1,\n autoRenewal: true,\n discount: {\n type: \"PERCENT\",\n percentOff: 20\n }\n },\n {\n title: \"Monthly subscription\",\n description: \"Get a chocolate bar and save 1.5$ every month!\",\n visible: true,\n frequency: \"MONTH\",\n interval: 1,\n billingCycles: 12,\n discount: {\n type: \"AMOUNT\",\n amountOff: \"1.5\"\n }\n },\n {\n title: \"Diet subscription\",\n description: \"At least once in a quarter, you deserve a chocolate bar!\",\n visible: true,\n frequency: \"MONTH\",\n interval: 3,\n autoRenewal: true\n }\n ]\n }\n};\n\nconst options = {\n fields: [\n \"SUBSCRIPTION_PRICES_INFO\",\n \"CURRENCY\",\n \"WEIGHT_MEASUREMENT_UNIT_INFO\"\n ]\n};\n\nasync function createProduct() {\n const response = await productsV3.createProduct(product, options);\n}\n\n","order":2,"source":"manual"},{"title":"Create a basic product","description":"","content":"import { productsV3 } from \"@wix/stores\";\n\nconst product = {\n name: \"Shopping bag\",\n productType: \"PHYSICAL\",\n physicalProperties: {},\n variantsInfo: {\n variants: [\n {\n price: {\n actualPrice: {\n amount: \"0.5\"\n }\n },\n physicalProperties: {}\n }\n ]\n }\n};\n\nasync function createProduct() {\n const response = await productsV3.createProduct(product);\n}\n\n","order":1,"source":"manual"},{"title":"createProduct (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function CreateProduct() {\n const response = await myWixClient.productsV3.CreateProduct();\n};","order":6,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Create Product","slugifiedName":"create-product"},"permissionScopes":[{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}],"isAdminMethod":true},{"summary":"Get Product","description":"Retrieves a product.\n\n> **Note:**\n> To retrieve a non-visible product (`visible: false`), your app must have the 'Product v3 read admin' (`SCOPE.STORES.PRODUCT_READ_ADMIN`) permission scope.","operationId":"wix.stores.catalog.v3.CatalogApi.GetProduct","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"productId","description":"Product ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"fields","in":"query","description":"Fields to include in the response.","required":false,"schema":{"description":"Fields to include in the response.","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.SingleEntityOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.GetProductResponse","description":""}},"deprecated":false,"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"NO_PERMISSION_TO_READ_MERCHANT_DATA","description":"The [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities) used to call the method doesn't have the required permissions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"NO_PERMISSION_TO_READ_MERCHANT_DATA"},"name":null},{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"NO_PERMISSION_TO_INCLUDE_NOT_VISIBLE_PRODUCTS","description":"The [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities) used to call the method doesn't have the required permissions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"NO_PERMISSION_TO_INCLUDE_NOT_VISIBLE_PRODUCTS"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_READ","WIX_STORES.PRODUCT_READ_NON_VISIBLE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.GetProductRequest","responseMessage":"wix.stores.catalog.v3.GetProductResponse"},"legacyExamples":[{"name":"GetProduct","type":"METHOD","order":1,"content":{"title":"Get minimal product data","request":"curl -X GET \\\n 'https://www.wixapis.com/stores/v3/products/9e8924aa-c3f2-4fe6-bc98-ace47295c52d' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"product\": {\n \"id\": \"789e6969-6eb4-4799-aacb-e207037564c4\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-02T07:36:01.066Z\",\n \"updatedDate\": \"2025-01-02T07:36:01.066Z\",\n \"name\": \"Shopping bag\",\n \"slug\": \"shopping-bag-1\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": null,\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": null,\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_f3e89a8b-5865-47de-86fa-cd923c2586e5\",\n \"currency\": null,\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"a3c6d6b2-4265-4e9a-8406-cafd4a61fb06\",\n \"visible\": true,\n \"sku\": null,\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"compareAtPrice\": null\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": null,\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735803361054000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n },\n \"inventoryResults\": {\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"2937f8d3-3439-4e46-83ab-7a83e4e37da1\",\n \"originalIndex\": 0,\n \"success\": true,\n \"error\": null\n },\n \"item\": null\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n },\n \"error\": null\n }\n}"}},{"name":"GetProduct","type":"METHOD","content":{"title":"Get Product with all fields","request":"curl -X GET \\\n 'https://www.wixapis.com/stores/v3/products/9e8924aa-c3f2-4fe6-bc98-ace47295c52d?fields=VARIANTS_INFO&fields=VARIANT_OPTION_CHOICE_NAMES&fields=MERCHANT_DATA&fields=INFO_SECTION&fields=URL&fields=CURRENCY&fields=WEIGHT_MEASUREMENT_UNIT_INFO&fields=BREADCRUMBS_INFO&fields=MEDIA_ITEMS_INFO&fields=DESCRIPTION&fields=DIRECT_CATEGORIES_INFO&fields=ALL_CATEGORIES_INFO' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{{\n \"product\": {\n \"id\": \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-01T10:13:14.540Z\",\n \"updatedDate\": \"2025-01-01T10:13:15.689Z\",\n \"name\": \"Shopping bag\",\n \"slug\": \"shopping-bag\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": {\n \"items\": []\n }\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": {\n \"categories\": [\n {\n \"id\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"index\": null\n }\n ]\n },\n \"allCategoriesInfo\": {\n \"categories\": [\n {\n \"id\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"index\": null\n }\n ]\n },\n \"mainCategoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"directCategoryIdsInfo\": {\n \"categoryIds\": [\n \"1aecdc65-176f-4f07-a846-77a8d5079eb5\"\n ]\n },\n \"costRange\": {\n \"minValue\": {\n \"amount\": \"0.00\",\n \"formattedAmount\": \"$0.00\"\n },\n \"maxValue\": {\n \"amount\": \"0.00\",\n \"formattedAmount\": \"$0.00\"\n }\n },\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n },\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_a7daf3a2-2a31-49b3-8a64-8264cd1006c7\",\n \"currency\": \"USD\",\n \"breadcrumbsInfo\": {\n \"breadcrumbs\": [\n {\n \"categoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"categoryName\": \"All Products\",\n \"categorySlug\": \"all-products\"\n }\n ]\n },\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.50\",\n \"formattedAmount\": \"$0.50\"\n },\n \"maxValue\": {\n \"amount\": \"0.50\",\n \"formattedAmount\": \"$0.50\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.50\",\n \"formattedAmount\": \"$0.50\"\n },\n \"maxValue\": {\n \"amount\": \"0.50\",\n \"formattedAmount\": \"$0.50\"\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"75ba03bc-e56f-4b6d-be52-691eb2ed5fd7\",\n \"visible\": true,\n \"sku\": null,\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"0.50\",\n \"formattedAmount\": \"$0.50\"\n },\n \"compareAtPrice\": null\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": {\n \"subscriptionPrices\": []\n },\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n },\n \"physicalProperties\": {\n \"weight\": null,\n \"pricePerUnit\": null\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735726394407000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": {\n \"minSubscriptionPrice\": null,\n \"minSubscriptionPricePerUnit\": null,\n \"pricePerUnitData\": null,\n \"sku\": null,\n \"weight\": null,\n \"revenueDetails\": null,\n \"actualPrice\": {\n \"amount\": \"0.50\",\n \"formattedAmount\": \"$0.50\"\n },\n \"compareAtPrice\": null\n }\n }\n }"}}],"commonMethodData":{"name":"get","itemField":"product"},"sdkData":{"signature":{"resolved":[{"field":{"path":"productId"}},{"parent":{"name":"options","fields":[{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Get a product with all fields","description":"Retrieve a product with all optional field projections including variants, media, categories, and pricing information","content":"import { productsV3 } from \"@wix/stores\";\n\nconst productId = \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\";\n\nconst options = {\n fields: [\n \"VARIANTS_INFO\",\n \"VARIANT_OPTION_CHOICE_NAMES\",\n \"MERCHANT_DATA\",\n \"INFO_SECTION\",\n \"URL\",\n \"CURRENCY\",\n \"WEIGHT_MEASUREMENT_UNIT_INFO\",\n \"BREADCRUMBS_INFO\",\n \"MEDIA_ITEMS_INFO\",\n \"DESCRIPTION\",\n \"DIRECT_CATEGORIES_INFO\",\n \"ALL_CATEGORIES_INFO\"\n ]\n};\n\nasync function getProduct() {\n const response = await productsV3.getProduct(productId, options);\n}\n\n/* Promise resolves to:\n * {\n * \"_id\": \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n * \"revision\": \"1\",\n * \"name\": \"Shopping bag\",\n * \"slug\": \"shopping-bag\",\n * \"visible\": true,\n * \"productType\": \"PHYSICAL\",\n * \"currency\": \"USD\",\n * \"directCategoriesInfo\": {\n * \"categories\": [\n * { \"id\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\" }\n * ]\n * },\n * \"allCategoriesInfo\": {\n * \"categories\": [\n * { \"id\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\" }\n * ]\n * },\n * \"breadcrumbsInfo\": {\n * \"breadcrumbs\": [\n * {\n * \"categoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n * \"categoryName\": \"All Products\",\n * \"categorySlug\": \"all-products\"\n * }\n * ]\n * },\n * \"physicalProperties\": {\n * \"weightMeasurementUnitInfo\": {\n * \"weightMeasurementUnit\": \"KG\"\n * }\n * },\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"0.50\", \"formattedAmount\": \"$0.50\" },\n * \"maxValue\": { \"amount\": \"0.50\", \"formattedAmount\": \"$0.50\" }\n * },\n * \"variantsInfo\": {\n * \"variants\": [\n * {\n * \"_id\": \"75ba03bc-e56f-4b6d-be52-691eb2ed5fd7\",\n * \"visible\": true,\n * \"price\": {\n * \"actualPrice\": { \"amount\": \"0.50\", \"formattedAmount\": \"$0.50\" }\n * },\n * \"inventoryStatus\": {\n * \"inStock\": false,\n * \"preorderEnabled\": false\n * }\n * }\n * ]\n * }\n * }\n */\n\n","order":1,"source":"manual"},{"title":"getProduct (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function GetProduct() {\n const response = await myWixClient.productsV3.GetProduct();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"get","path":"/v3/products/{productId}","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/stores","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products","destinationPath":"/v3/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products","destinationPath":"/v3/bulk/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"www._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://blocks.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://create.editorx/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"create.editorx","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wixapps.net/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://*.dev.wix-code.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://_/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products-with-inventory","destinationPath":"/v3/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products-with-inventory","destinationPath":"/v3/bulk/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/all-products-category","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/all-products-category","destinationPath":"/v3/all-products-category","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}}],"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"NO_PERMISSION_TO_READ_MERCHANT_DATA","description":"The [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities) used to call the method doesn't have the required permissions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"NO_PERMISSION_TO_READ_MERCHANT_DATA"},"name":null},{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"NO_PERMISSION_TO_INCLUDE_NOT_VISIBLE_PRODUCTS","description":"The [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities) used to call the method doesn't have the required permissions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"NO_PERMISSION_TO_INCLUDE_NOT_VISIBLE_PRODUCTS"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_READ","WIX_STORES.PRODUCT_READ_NON_VISIBLE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.GetProductRequest","responseMessage":"wix.stores.catalog.v3.GetProductResponse"},"legacyExamples":[{"name":"GetProduct","type":"METHOD","order":1,"content":{"title":"Get minimal product data","request":"curl -X GET \\\n 'https://www.wixapis.com/stores/v3/products/9e8924aa-c3f2-4fe6-bc98-ace47295c52d' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"product\": {\n \"id\": \"789e6969-6eb4-4799-aacb-e207037564c4\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-02T07:36:01.066Z\",\n \"updatedDate\": \"2025-01-02T07:36:01.066Z\",\n \"name\": \"Shopping bag\",\n \"slug\": \"shopping-bag-1\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": null,\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": null,\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_f3e89a8b-5865-47de-86fa-cd923c2586e5\",\n \"currency\": null,\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"a3c6d6b2-4265-4e9a-8406-cafd4a61fb06\",\n \"visible\": true,\n \"sku\": null,\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"compareAtPrice\": null\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": null,\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735803361054000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n },\n \"inventoryResults\": {\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"2937f8d3-3439-4e46-83ab-7a83e4e37da1\",\n \"originalIndex\": 0,\n \"success\": true,\n \"error\": null\n },\n \"item\": null\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n },\n \"error\": null\n }\n}"}},{"name":"GetProduct","type":"METHOD","content":{"title":"Get Product with all fields","request":"curl -X GET \\\n 'https://www.wixapis.com/stores/v3/products/9e8924aa-c3f2-4fe6-bc98-ace47295c52d?fields=VARIANTS_INFO&fields=VARIANT_OPTION_CHOICE_NAMES&fields=MERCHANT_DATA&fields=INFO_SECTION&fields=URL&fields=CURRENCY&fields=WEIGHT_MEASUREMENT_UNIT_INFO&fields=BREADCRUMBS_INFO&fields=MEDIA_ITEMS_INFO&fields=DESCRIPTION&fields=DIRECT_CATEGORIES_INFO&fields=ALL_CATEGORIES_INFO' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{{\n \"product\": {\n \"id\": \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-01T10:13:14.540Z\",\n \"updatedDate\": \"2025-01-01T10:13:15.689Z\",\n \"name\": \"Shopping bag\",\n \"slug\": \"shopping-bag\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": {\n \"items\": []\n }\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": {\n \"categories\": [\n {\n \"id\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"index\": null\n }\n ]\n },\n \"allCategoriesInfo\": {\n \"categories\": [\n {\n \"id\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"index\": null\n }\n ]\n },\n \"mainCategoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"directCategoryIdsInfo\": {\n \"categoryIds\": [\n \"1aecdc65-176f-4f07-a846-77a8d5079eb5\"\n ]\n },\n \"costRange\": {\n \"minValue\": {\n \"amount\": \"0.00\",\n \"formattedAmount\": \"$0.00\"\n },\n \"maxValue\": {\n \"amount\": \"0.00\",\n \"formattedAmount\": \"$0.00\"\n }\n },\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n },\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_a7daf3a2-2a31-49b3-8a64-8264cd1006c7\",\n \"currency\": \"USD\",\n \"breadcrumbsInfo\": {\n \"breadcrumbs\": [\n {\n \"categoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"categoryName\": \"All Products\",\n \"categorySlug\": \"all-products\"\n }\n ]\n },\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.50\",\n \"formattedAmount\": \"$0.50\"\n },\n \"maxValue\": {\n \"amount\": \"0.50\",\n \"formattedAmount\": \"$0.50\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.50\",\n \"formattedAmount\": \"$0.50\"\n },\n \"maxValue\": {\n \"amount\": \"0.50\",\n \"formattedAmount\": \"$0.50\"\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"75ba03bc-e56f-4b6d-be52-691eb2ed5fd7\",\n \"visible\": true,\n \"sku\": null,\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"0.50\",\n \"formattedAmount\": \"$0.50\"\n },\n \"compareAtPrice\": null\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": {\n \"subscriptionPrices\": []\n },\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n },\n \"physicalProperties\": {\n \"weight\": null,\n \"pricePerUnit\": null\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735726394407000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": {\n \"minSubscriptionPrice\": null,\n \"minSubscriptionPricePerUnit\": null,\n \"pricePerUnitData\": null,\n \"sku\": null,\n \"weight\": null,\n \"revenueDetails\": null,\n \"actualPrice\": {\n \"amount\": \"0.50\",\n \"formattedAmount\": \"$0.50\"\n },\n \"compareAtPrice\": null\n }\n }\n }"}}],"commonMethodData":{"name":"get","itemField":"product"},"sdkData":{"signature":{"resolved":[{"field":{"path":"productId"}},{"parent":{"name":"options","fields":[{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Get a product with all fields","description":"Retrieve a product with all optional field projections including variants, media, categories, and pricing information","content":"import { productsV3 } from \"@wix/stores\";\n\nconst productId = \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\";\n\nconst options = {\n fields: [\n \"VARIANTS_INFO\",\n \"VARIANT_OPTION_CHOICE_NAMES\",\n \"MERCHANT_DATA\",\n \"INFO_SECTION\",\n \"URL\",\n \"CURRENCY\",\n \"WEIGHT_MEASUREMENT_UNIT_INFO\",\n \"BREADCRUMBS_INFO\",\n \"MEDIA_ITEMS_INFO\",\n \"DESCRIPTION\",\n \"DIRECT_CATEGORIES_INFO\",\n \"ALL_CATEGORIES_INFO\"\n ]\n};\n\nasync function getProduct() {\n const response = await productsV3.getProduct(productId, options);\n}\n\n/* Promise resolves to:\n * {\n * \"_id\": \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n * \"revision\": \"1\",\n * \"name\": \"Shopping bag\",\n * \"slug\": \"shopping-bag\",\n * \"visible\": true,\n * \"productType\": \"PHYSICAL\",\n * \"currency\": \"USD\",\n * \"directCategoriesInfo\": {\n * \"categories\": [\n * { \"id\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\" }\n * ]\n * },\n * \"allCategoriesInfo\": {\n * \"categories\": [\n * { \"id\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\" }\n * ]\n * },\n * \"breadcrumbsInfo\": {\n * \"breadcrumbs\": [\n * {\n * \"categoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n * \"categoryName\": \"All Products\",\n * \"categorySlug\": \"all-products\"\n * }\n * ]\n * },\n * \"physicalProperties\": {\n * \"weightMeasurementUnitInfo\": {\n * \"weightMeasurementUnit\": \"KG\"\n * }\n * },\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"0.50\", \"formattedAmount\": \"$0.50\" },\n * \"maxValue\": { \"amount\": \"0.50\", \"formattedAmount\": \"$0.50\" }\n * },\n * \"variantsInfo\": {\n * \"variants\": [\n * {\n * \"_id\": \"75ba03bc-e56f-4b6d-be52-691eb2ed5fd7\",\n * \"visible\": true,\n * \"price\": {\n * \"actualPrice\": { \"amount\": \"0.50\", \"formattedAmount\": \"$0.50\" }\n * },\n * \"inventoryStatus\": {\n * \"inStock\": false,\n * \"preorderEnabled\": false\n * }\n * }\n * ]\n * }\n * }\n */\n\n","order":1,"source":"manual"},{"title":"getProduct (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function GetProduct() {\n const response = await myWixClient.productsV3.GetProduct();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Get Product","slugifiedName":"get-product"},"permissionScopes":[{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"}],"isAdminMethod":false},{"summary":"Delete Product","description":"Deletes a product.","operationId":"wix.stores.catalog.v3.CatalogApi.DeleteProduct","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"productId","description":"Product ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.DeleteProductResponse","description":""}},"deprecated":false,"x-wix-docs":{"triggeredEvents":[{"title":"Product Deleted","description":"Triggered when a product is deleted.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_deleted","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.DeleteProduct","methodName":"DeleteProduct","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_DELETE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.DeleteProductRequest","responseMessage":"wix.stores.catalog.v3.DeleteProductResponse"},"legacyExamples":[{"name":"DeleteProduct","type":"METHOD","content":{"title":"Delete product","request":"curl -X DELETE \\\n 'https://www.wixapis.com/stores/v3/products/d17bb5c4-e10f-4b83-ae97-f27f2edc18f1' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{}"}}],"commonMethodData":{"name":"delete"},"sdkData":{"signature":{"resolved":[{"field":{"path":"productId"}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"deleteProduct","description":"","content":"import { productsV3 } from '@wix/stores';\n\nasync function deleteProduct(productId) {\n const response = await productsV3.deleteProduct(productId);\n};","order":1,"source":"generated"},{"title":"deleteProduct (with elevated permissions)","description":"","content":"import { productsV3 } from '@wix/stores';\nimport { auth } from '@wix/essentials';\n\nasync function myDeleteProductMethod(productId) {\n const elevatedDeleteProduct = auth.elevate(productsV3.deleteProduct);\n const response = await elevatedDeleteProduct(productId);\n}","order":4,"source":"generated"},{"title":"deleteProduct (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function deleteProduct(productId) {\n const response = await myWixClient.productsV3.deleteProduct(productId);\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"delete","path":"/v3/products/{productId}","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/stores","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products","destinationPath":"/v3/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products","destinationPath":"/v3/bulk/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"www._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://blocks.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://create.editorx/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"create.editorx","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wixapps.net/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://*.dev.wix-code.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://_/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products-with-inventory","destinationPath":"/v3/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products-with-inventory","destinationPath":"/v3/bulk/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/all-products-category","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/all-products-category","destinationPath":"/v3/all-products-category","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}}],"triggeredEvents":[{"title":"Product Deleted","description":"Triggered when a product is deleted.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_deleted","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.DeleteProduct","methodName":"DeleteProduct","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_DELETE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.DeleteProductRequest","responseMessage":"wix.stores.catalog.v3.DeleteProductResponse"},"legacyExamples":[{"name":"DeleteProduct","type":"METHOD","content":{"title":"Delete product","request":"curl -X DELETE \\\n 'https://www.wixapis.com/stores/v3/products/d17bb5c4-e10f-4b83-ae97-f27f2edc18f1' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{}"}}],"commonMethodData":{"name":"delete"},"sdkData":{"signature":{"resolved":[{"field":{"path":"productId"}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"deleteProduct","description":"","content":"import { productsV3 } from '@wix/stores';\n\nasync function deleteProduct(productId) {\n const response = await productsV3.deleteProduct(productId);\n};","order":1,"source":"generated"},{"title":"deleteProduct (with elevated permissions)","description":"","content":"import { productsV3 } from '@wix/stores';\nimport { auth } from '@wix/essentials';\n\nasync function myDeleteProductMethod(productId) {\n const elevatedDeleteProduct = auth.elevate(productsV3.deleteProduct);\n const response = await elevatedDeleteProduct(productId);\n}","order":4,"source":"generated"},{"title":"deleteProduct (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function deleteProduct(productId) {\n const response = await myWixClient.productsV3.deleteProduct(productId);\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Delete Product","slugifiedName":"delete-product"},"permissionScopes":[{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}],"isAdminMethod":true},{"summary":"Update Product","description":"Updates a product.\n\nEach time the product is updated, `revision` increments by 1.\nThe current `revision` must be passed when updating the product.\nThis ensures you're working with the latest product and prevents unintended overwrites.\n\n>**Notes:**\n> + To update array fields like `options`, `modifiers`, `variantsInfo.variants`, and any others, you must pass the entire existing array. Passing only the changed item overwrites the entire array, not just merge the single change.\n> + To update `variantsInfo.variants` you must also pass `options` and vice versa. This is because variants and options are mutually dependent and must be aligned.\n> + To update existing `variantsInfo.variants`, make sure to provide `variantsInfo.variants.id`. If no ID is passed, a variant is created with a new ID.\n> + Updating media per variant isn't supported. Instead, assign media items to product option choices using the `linkedMedia` field. You must use preexisting product media.","operationId":"wix.stores.catalog.v3.CatalogApi.UpdateProduct","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"product.id","description":"Product ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.UpdateProductResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateProductRequest","description":"","properties":{"product":{"description":"Product to update.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product","summary":"product","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.SingleEntityOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["product","product.id","product.revision","product.variantsInfo.variants.price","product.variantsInfo.variants.price.actualPrice","product.variantsInfo.variants.physicalProperties.pricePerUnit.settings.measurementUnit","product.variantsInfo.variants.digitalProperties.digitalFile","product.variantsInfo.variants.digitalProperties.digitalFile.id","product.variantsInfo.variants.choices.optionChoiceIds.optionId","product.variantsInfo.variants.choices.optionChoiceIds.choiceId","product.physicalProperties.pricePerUnit.measurementUnit","product.subscriptionDetails.subscriptions.title","product.subscriptionDetails.subscriptions.frequency","product.subscriptionDetails.subscriptions.discount.type"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_updated","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.UpdateProduct","methodName":"UpdateProduct","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"MISSING_VARIANT_OPTION_CHOICE","description":"Every variant's choice must reference an existing option in `options.id`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MISSING_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_VARIANT_OPTION_CHOICE","description":"Multiple variants have identical choices in `variantsInfo.variants.choices`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_PRODUCT_OPTIONS","description":"Multiple options have identical `name` and `optionRenderType`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_PRODUCT_OPTIONS"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_DEFAULT_VARIANT","description":"Product with multiple variants has a variant with empty `choices`. Only single-variant products can have empty choices.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_DEFAULT_VARIANT"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FIELD_MASK_VALUE_NOT_SUPPORTED","errorSchemaName":"com.wix.stores.catalog.product.api.v3.UnsupportedFieldMasks","description":"Update field mask includes read-only fields.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"FIELD_MASK_VALUE_NOT_SUPPORTED"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"VARIANTS_ARE_NOT_ALIGNED_WITH_PRODUCT","errorSchemaName":"com.wix.stores.catalog.product.api.v3.VariantsNotAlignedWithProduct","description":"Variants aren't aligned with the product. The variant `typedProperties` must match the `productType`, measurement units must align, and each variant must have exactly 1 choice for every option.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"VARIANTS_ARE_NOT_ALIGNED_WITH_PRODUCT"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"DUPLICATE_SLUG_ERROR","description":"There is already a product with this `slug`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_SLUG_ERROR"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"DIGITAL_FILE_NOT_FOUND_ERROR","description":"Couldn't find the digital file referenced in `variantsInfo.variants.digitalProperties`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DIGITAL_FILE_NOT_FOUND_ERROR"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"BARCODE_ALREADY_EXIST_ERROR","description":"There is already a variant with this `barcode`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"BARCODE_ALREADY_EXIST_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_BARCODE_ERROR","description":"Multiple variants have identical `barcode` in the request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_BARCODE_ERROR"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SKU_ALREADY_EXIST_ERROR","description":"There is already a variant with this `sku`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"SKU_ALREADY_EXIST_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_SKU_ERROR","description":"Multiple variants have identical `sku` in the request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_SKU_ERROR"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"VARIANT_ID_ALREADY_EXISTS","description":"Multiple variants have identical `id`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"VARIANT_ID_ALREADY_EXISTS"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION","description":"Subscription added to a digital product. Digital products can't have subscriptions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT","description":"All subscriptions are hidden for a subscription-only product. At least 1 subscription must be visible when `allowOneTimePurchases` is false.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT","description":"Subscription discount `amountOff` exceeds the minimum variant price.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS","description":"Multiple subscriptions have identical IDs.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PREORDER_VALIDATION_ERROR","description":"Variant enabled for preorder on a subscription product. Products with subscriptions can't have preorder variants.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PREORDER_VALIDATION_ERROR"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"BRAND_CREATION_FAILED","description":"Brand creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"BRAND_CREATION_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"RIBBON_NOT_FOUND","description":"Couldn't find the ribbon.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"RIBBON_NOT_FOUND"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INFO_SECTION_ERROR_OCCURRED","description":"Info section update failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INFO_SECTION_ERROR_OCCURRED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CUSTOMIZATION_NOT_EXIST","description":"Couldn't find the customization.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CUSTOMIZATION_NOT_EXIST"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED","description":"Failed to add customization choices.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CHOICE_NOT_EXIST","description":"Couldn't find the choice.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CHOICE_NOT_EXIST"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR","description":"Field mask includes fields not provided in the request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE","description":"The `compareAtPrice` is lower than the `actualPrice`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"VARIANTS_TYPED_PROPERTIES_ARE_NOT_ALIGNED","description":"Variants have different `typedProperties` types. All variants must have the same type.","errorType":"VALIDATION","validationErrorData":{"ruleName":"VARIANTS_TYPED_PROPERTIES_ARE_NOT_ALIGNED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_OPTIONS_ON_UPDATE_VARIANTS","description":"Update request includes `variants` but is missing `options`. Both must be provided together.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_OPTIONS_ON_UPDATE_VARIANTS"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION_CHOICE","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionChoiceErrorData","description":"Variant choice doesn't exist in the product's option choices.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionErrorData","description":"Variant option doesn't exist in the product's options.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"SUBSCRIPTION_INVALID_AUTO_RENEWAL","description":"The `autoRenewal` field is set to false. Set the number of billing cycles in `billingCycles` to prevent automatic renewal instead.","errorType":"VALIDATION","validationErrorData":{"ruleName":"SUBSCRIPTION_INVALID_AUTO_RENEWAL"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DIGITAL_PRODUCT_CANNOT_BE_VISIBLE_IN_POS","description":"Digital product is marked as visible in POS. Digital products can't be visible in POS.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DIGITAL_PRODUCT_CANNOT_BE_VISIBLE_IN_POS"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DESCRIPTION_SIZE_TOO_BIG","description":"Product `description` field exceeds the maximum size of 32000 bytes.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DESCRIPTION_SIZE_TOO_BIG"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DUPLICATE_MEDIA_ERROR","errorSchemaName":"com.wix.stores.catalog.product.api.v3.DuplicateMediaIdAssignedToProduct","description":"Multiple media items have identical IDs. Each media ID must be unique.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DUPLICATE_MEDIA_ERROR"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"BRAND_MISSING_ID","description":"Brand is missing an `id`.","errorType":"VALIDATION","validationErrorData":{"ruleName":"BRAND_MISSING_ID"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRICE_PER_UNIT_NOT_ALIGNED","description":"Price per unit isn't aligned between product and variants.","errorType":"VALIDATION","validationErrorData":{"ruleName":"PRICE_PER_UNIT_NOT_ALIGNED"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.UpdateProductRequest","responseMessage":"wix.stores.catalog.v3.UpdateProductResponse"},"legacyExamples":[{"name":"UpdateProduct","type":"METHOD","order":2,"content":{"title":"Update product's main and choice images","request":"curl -X PATCH \\\n 'https://www.wixapis.com/stores/v3/products/def25830-7627-4c6c-bde6-4df21d0c6605' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"product\": {\n \"id\": \"def25830-7627-4c6c-bde6-4df21d0c6605\",\n \"revision\": \"3\",\n \"media\": {\n \"main\": {\n \"url\": \"https://static.wixstatic.com/media/abc123_mainimage456~mv2.png\",\n \"altText\": \"Sample Product main image\"\n },\n \"itemsInfo\": {\n \"items\": [\n {\n \"url\": \"https://static.wixstatic.com/media/abc123_mainimage456~mv2.png\",\n \"altText\": \"Sample Product main image\"\n },\n {\n \"url\": \"https://static.wixstatic.com/media/abc123_choiceimage789~mv2.jpg\",\n \"altText\": \"Medium size image\"\n }\n ]\n }\n },\n \"options\": [\n {\n \"id\": \"d7579f10-4bd7-450c-9a13-91b513b1328c\",\n \"name\": \"size\",\n \"key\": \"size\",\n \"optionRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"41c9d242-65fe-4330-a8c1-caaded437018\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Medium\",\n \"name\": \"Medium\",\n \"visible\": true,\n \"inStock\": false,\n \"linkedMedia\": [\n {\n \"url\": \"https://static.wixstatic.com/media/abc123_choiceimage789~mv2.jpg\",\n \"altText\": \"Medium size image\"\n }\n ]\n }\n ]\n }\n }\n ],\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"3f3db5ba-c8da-461f-982a-5f83316db8a1\",\n \"visible\": true,\n \"choices\": [\n {\n \"optionChoiceIds\": {\n \"optionId\": \"d7579f10-4bd7-450c-9a13-91b513b1328c\",\n \"choiceId\": \"41c9d242-65fe-4330-a8c1-caaded437018\"\n },\n \"optionChoiceNames\": {\n \"choiceName\": \"Medium\",\n \"optionName\": \"Size\",\n \"renderType\": \"TEXT_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"10\"\n }\n },\n \"physicalProperties\": {},\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n }\n }\n ]\n }\n }\n }'","response":"{\n \"product\": {\n \"id\": \"def25830-7627-4c6c-bde6-4df21d0c6605\",\n \"revision\": \"4\",\n \"createdDate\": \"2025-07-13T10:55:26.934Z\",\n \"updatedDate\": \"2025-07-13T11:08:45.429Z\",\n \"numericId\": \"1752404126931000\",\n \"name\": \"Sample Product\",\n \"slug\": \"sample-product\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": {\n \"url\": \"https://static.wixstatic.com/media/abc123_mainimage456~mv2.png\",\n \"altText\": \"Sample Product main image\",\n \"mediaType\": \"IMAGE\",\n \"uploadId\": \"b0aece2a-26d8-427f-bcc0-7e943bfd0909\"\n }\n },\n \"options\": [\n {\n \"id\": \"d7579f10-4bd7-450c-9a13-91b513b1328c\",\n \"name\": \"size\",\n \"optionRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"41c9d242-65fe-4330-a8c1-caaded437018\",\n \"linkedMedia\": [\n {\n \"url\": \"https://static.wixstatic.com/media/abc123_choiceimage789~mv2.jpg\",\n \"altText\": \"Medium size image\",\n \"mediaType\": \"IMAGE\",\n \"uploadId\": \"7cca4c27-3667-41af-b17c-256ab6c325fc\"\n }\n ],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Medium\",\n \"name\": \"Medium\",\n \"inStock\": false,\n \"visible\": true\n }\n ]\n },\n \"key\": \"size\"\n }\n ],\n \"modifiers\": [],\n \"infoSections\": [],\n \"mainCategoryId\": \"9107571a-a4ab-467d-b98f-77851bd5116c\",\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\",\n \"preorderAvailability\": \"NO_VARIANTS\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {},\n \"handle\": \"Product_7d434376-78c8-449f-883c-2f31e0a4fa74\",\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"10\"\n },\n \"maxValue\": {\n \"amount\": \"10\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"0\"\n },\n \"maxValue\": {\n \"amount\": \"0\"\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"3f3db5ba-c8da-461f-982a-5f83316db8a1\",\n \"visible\": true,\n \"choices\": [\n {\n \"optionChoiceIds\": {\n \"optionId\": \"d7579f10-4bd7-450c-9a13-91b513b1328c\",\n \"choiceId\": \"41c9d242-65fe-4330-a8c1-caaded437018\"\n }\n }\n ],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"10\"\n }\n },\n \"media\": {\n \"url\": \"https://static.wixstatic.com/media/abc123_mainimage456~mv2.png\",\n \"altText\": \"Sample Product main image\",\n \"mediaType\": \"IMAGE\",\n \"uploadId\": \"b0aece2a-26d8-427f-bcc0-7e943bfd0909\"\n },\n \"physicalProperties\": {},\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n }\n }\n ]\n },\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"entityEventSequence\": \"11\"\n }\n}"}},{"name":"UpdateProduct","type":"METHOD","order":1,"content":{"title":"Update product name","request":"curl PATCH 'https://www.wixapis.com/stores/v3/products/9e8924aa-c3f2-4fe6-bc98-ace47295c52d' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"product\": {\n \"id\": \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n \"revision\": \"2\",\n \"name\": \"Shopping bag\"\n }\n }'","response":"{\n \"product\": {\n \"id\": \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n \"revision\": \"3\",\n \"createdDate\": \"2025-01-01T10:13:14.540Z\",\n \"updatedDate\": \"2025-01-01T12:59:03.102Z\",\n \"name\": \"Shopping bag\",\n \"slug\": \"shopping-bag\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": null,\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_a7daf3a2-2a31-49b3-8a64-8264cd1006c7\",\n \"currency\": null,\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"75ba03bc-e56f-4b6d-be52-691eb2ed5fd7\",\n \"visible\": true,\n \"sku\": null,\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"compareAtPrice\": null\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": null,\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n },\n \"physicalProperties\": {\n \"weight\": null,\n \"pricePerUnit\": null\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735726394407000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n }\n}"}},{"name":"UpdateProduct","type":"METHOD","content":{"title":"Update product","description":"Update different product fields. Pass only fields that you want to update.","request":"curl PATCH 'https://www.wixapis.com/stores/v3/products/93f2e5ab-60a5-4173-babb-9198fc52bdd3' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"fields\": [\n \"VARIANT_OPTION_CHOICE_NAMES\",\n \"MERCHANT_DATA\",\n \"INFO_SECTION\",\n \"DESCRIPTION\",\n \"URL\",\n \"CURRENCY\",\n \"WEIGHT_MEASUREMENT_UNIT_INFO\"\n ],\n \"product\": {\n \"id\": \"93f2e5ab-60a5-4173-babb-9198fc52bdd3\",\n \"revision\": \"3\",\n \"name\": \"Premium Coffee\",\n \"description\": {\n \"nodes\": [\n {\n \"type\": \"PARAGRAPH\",\n \"id\": \"foo\",\n \"nodes\": [\n {\n \"type\": \"TEXT\",\n \"textData\": {\n \"text\": \"Tasty, high quality and eco friendly, in a beautiful gift box.\"\n }\n }\n ],\n \"paragraphData\": {\n \"textStyle\": {\n \"textAlignment\": \"AUTO\"\n }\n }\n }\n ],\n \"metadata\": {\n \"version\": 1,\n \"id\": \"fb97b2c1-a3ff-4319-be5f-bbb7fdf0776c\"\n }\n },\n \"visible\": false,\n \"visibleInPos\": false,\n \"infoSections\": [\n {\n \"id\": \"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\"\n },\n {\n \"uniqueName\": \"Origin\",\n \"title\": \"Made in\",\n \"description\": {\n \"nodes\": [\n {\n \"type\": \"PARAGRAPH\",\n \"id\": \"xjkk51429\",\n \"nodes\": [\n {\n \"type\": \"TEXT\",\n \"id\": \"\",\n \"nodes\": [],\n \"textData\": {\n \"text\": \"Brazil\",\n \"decorations\": []\n }\n }\n ]\n }\n ]\n }\n }\n ],\n \"ribbon\": {\n \"name\": \"New arrival\"\n }\n }\n }'","response":"{\n \"product\": {\n \"id\": \"93f2e5ab-60a5-4173-babb-9198fc52bdd3\",\n \"revision\": \"4\",\n \"createdDate\": \"2025-01-01T09:50:31.438Z\",\n \"updatedDate\": \"2025-01-02T07:14:02.734Z\",\n \"name\": \"Premium Coffee\",\n \"slug\": \"coffee\",\n \"url\": {\n \"relativePath\": \"/product-page/coffee\",\n \"url\": \"https://mysite.wixstudio.com/my-site-79/product-page/coffee\"\n },\n \"description\": {\n \"nodes\": [\n {\n \"type\": \"PARAGRAPH\",\n \"id\": \"foo\",\n \"nodes\": [\n {\n \"type\": \"TEXT\",\n \"id\": \"\",\n \"nodes\": [],\n \"style\": null\n }\n ],\n \"style\": null\n }\n ],\n \"metadata\": {\n \"version\": 1,\n \"createdTimestamp\": null,\n \"updatedTimestamp\": null,\n \"id\": \"fb97b2c1-a3ff-4319-be5f-bbb7fdf0776c\"\n },\n \"documentStyle\": null\n },\n \"plainDescription\": null,\n \"visible\": false,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": {\n \"id\": \"ad3eb492-9d35-4f47-8a1f-cb7bd8a4e66d\",\n \"name\": \"New arrival\"\n },\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"directCategoryIdsInfo\": null,\n \"costRange\": {\n \"minValue\": {\n \"amount\": \"0.00\",\n \"formattedAmount\": \"$0.00\"\n },\n \"maxValue\": {\n \"amount\": \"0.00\",\n \"formattedAmount\": \"$0.00\"\n }\n },\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n },\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_be600651-94cf-42ad-881f-3bd69fb4a320\",\n \"currency\": \"USD\",\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"d44f6c3f-e641-4e54-9cb3-5796e58fa1cd\",\n \"visible\": true,\n \"sku\": \"12345\",\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"compareAtPrice\": null\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": null,\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735725031408000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n }\n}"}}],"commonMethodData":{"name":"update","itemField":"product"},"sdkData":{"signature":{"resolved":[{"field":{"path":"product.id"}},{"field":{"path":"product"}},{"parent":{"name":"options","fields":[{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Update a product's details","description":"Update product name, description, visibility, info sections, and ribbon.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst productId = \"93f2e5ab-60a5-4173-babb-9198fc52bdd3\";\n\nconst product = {\n id: \"93f2e5ab-60a5-4173-babb-9198fc52bdd3\",\n revision: \"3\",\n name: \"Premium Coffee\",\n description: {\n nodes: [\n {\n type: \"PARAGRAPH\",\n id: \"foo\",\n nodes: [\n {\n type: \"TEXT\",\n textData: {\n text: \"Tasty, high quality and eco friendly, in a beautiful gift box.\"\n }\n }\n ],\n paragraphData: {\n textStyle: {\n textAlignment: \"AUTO\"\n }\n }\n }\n ],\n metadata: {\n version: 1,\n id: \"fb97b2c1-a3ff-4319-be5f-bbb7fdf0776c\"\n }\n },\n visible: false,\n visibleInPos: false,\n infoSections: [\n {\n id: \"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\"\n },\n {\n uniqueName: \"Origin\",\n title: \"Made in\",\n description: {\n nodes: [\n {\n type: \"PARAGRAPH\",\n id: \"xjkk51429\",\n nodes: [\n {\n type: \"TEXT\",\n id: \"\",\n nodes: [],\n textData: {\n text: \"Brazil\",\n decorations: []\n }\n }\n ]\n }\n ]\n }\n }\n ],\n ribbon: {\n name: \"New arrival\"\n }\n};\n\nconst options = {\n fields: [\n \"VARIANT_OPTION_CHOICE_NAMES\",\n \"MERCHANT_DATA\",\n \"INFO_SECTION\",\n \"DESCRIPTION\",\n \"URL\",\n \"CURRENCY\",\n \"WEIGHT_MEASUREMENT_UNIT_INFO\"\n ]\n};\n\nasync function updateProduct() {\n const response = await productsV3.updateProduct(productId, product, options);\n}\n\n/* Promise resolves to:\n * {\n * \"_id\": \"93f2e5ab-60a5-4173-babb-9198fc52bdd3\",\n * \"revision\": \"4\",\n * \"name\": \"Premium Coffee\",\n * \"slug\": \"premium-coffee\",\n * \"url\": \"https://example.com/product-page/premium-coffee\",\n * \"description\": {\n * \"nodes\": [{ \"type\": \"PARAGRAPH\", \"id\": \"foo\", \"nodes\": [{ \"type\": \"TEXT\", \"textData\": { \"text\": \"Tasty, high quality and eco friendly, in a beautiful gift box.\" } }] }],\n * \"metadata\": { \"version\": 1, \"id\": \"fb97b2c1-a3ff-4319-be5f-bbb7fdf0776c\" }\n * },\n * \"visible\": false,\n * \"visibleInPos\": false,\n * \"productType\": \"PHYSICAL\",\n * \"currency\": \"EUR\",\n * \"infoSections\": [\n * { \"_id\": \"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\", \"uniqueName\": \"Refund policy\", \"title\": \"Refund policy\" },\n * { \"_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\", \"uniqueName\": \"Origin\", \"title\": \"Made in\" }\n * ],\n * \"ribbon\": { \"_id\": \"new-arrival-ribbon-id\", \"name\": \"New Arrival\" },\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"9.00\", \"formattedAmount\": \"€9.00\" },\n * \"maxValue\": { \"amount\": \"15.00\", \"formattedAmount\": \"€15.00\" }\n * },\n * \"physicalProperties\": {\n * \"weightMeasurementUnitInfo\": { \"weightMeasurementUnit\": \"KG\" }\n * }\n * }\n */\n\n","order":3,"source":"manual"},{"title":"Update a product's main and choice images","description":"","content":"import { productsV3 } from \"@wix/stores\";\n\nconst productId = \"def25830-7627-4c6c-bde6-4df21d0c6605\";\n\nconst product = {\n id: \"def25830-7627-4c6c-bde6-4df21d0c6605\",\n revision: \"3\",\n media: {\n main: {\n url: \"https://static.wixstatic.com/media/abc123_mainimage456~mv2.png\",\n altText: \"Sample Product main image\"\n },\n itemsInfo: {\n items: [\n {\n url: \"https://static.wixstatic.com/media/abc123_mainimage456~mv2.png\",\n altText: \"Sample Product main image\"\n },\n {\n url: \"https://static.wixstatic.com/media/abc123_choiceimage789~mv2.jpg\",\n altText: \"Medium size image\"\n }\n ]\n }\n },\n options: [\n {\n id: \"d7579f10-4bd7-450c-9a13-91b513b1328c\",\n name: \"size\",\n key: \"size\",\n optionRenderType: \"TEXT_CHOICES\",\n choicesSettings: {\n choices: [\n {\n choiceId: \"41c9d242-65fe-4330-a8c1-caaded437018\",\n choiceType: \"CHOICE_TEXT\",\n key: \"Medium\",\n name: \"Medium\",\n visible: true,\n inStock: false,\n linkedMedia: [\n {\n url: \"https://static.wixstatic.com/media/abc123_choiceimage789~mv2.jpg\",\n altText: \"Medium size image\"\n }\n ]\n }\n ]\n }\n }\n ],\n variantsInfo: {\n variants: [\n {\n id: \"3f3db5ba-c8da-461f-982a-5f83316db8a1\",\n visible: true,\n choices: [\n {\n optionChoiceIds: {\n optionId: \"d7579f10-4bd7-450c-9a13-91b513b1328c\",\n choiceId: \"41c9d242-65fe-4330-a8c1-caaded437018\"\n },\n optionChoiceNames: {\n choiceName: \"Medium\",\n optionName: \"Size\",\n renderType: \"TEXT_CHOICES\"\n }\n }\n ],\n price: {\n actualPrice: {\n amount: \"10\"\n }\n },\n physicalProperties: {},\n inventoryStatus: {\n inStock: false,\n preorderEnabled: false\n }\n }\n ]\n }\n};\n\nasync function updateProduct() {\n const response = await productsV3.updateProduct(productId, product);\n}\n\n/* Promise resolves to:\n * {\n * \"_id\": \"def25830-7627-4c6c-bde6-4df21d0c6605\",\n * \"revision\": \"4\",\n * \"name\": \"Sample Product\",\n * \"slug\": \"sample-product\",\n * \"visible\": true,\n * \"media\": {\n * \"main\": {\n * \"url\": \"https://static.wixstatic.com/media/abc123_mainimage456~mv2.png\",\n * \"altText\": \"Sample Product main image\",\n * \"mediaType\": \"IMAGE\"\n * },\n * \"itemsInfo\": {\n * \"items\": [\n * { \"url\": \"https://static.wixstatic.com/media/abc123_mainimage456~mv2.png\", \"altText\": \"Sample Product main image\", \"mediaType\": \"IMAGE\" },\n * { \"url\": \"https://static.wixstatic.com/media/abc123_choiceimage789~mv2.jpg\", \"altText\": \"Medium size image\", \"mediaType\": \"IMAGE\" }\n * ]\n * }\n * },\n * \"options\": [\n * {\n * \"_id\": \"d7579f10-4bd7-450c-9a13-91b513b1328c\",\n * \"name\": \"size\",\n * \"optionRenderType\": \"TEXT_CHOICES\",\n * \"choicesSettings\": {\n * \"choices\": [\n * {\n * \"choiceId\": \"41c9d242-65fe-4330-a8c1-caaded437018\",\n * \"choiceType\": \"CHOICE_TEXT\",\n * \"name\": \"Medium\",\n * \"visible\": true,\n * \"linkedMedia\": [{ \"url\": \"https://static.wixstatic.com/media/abc123_choiceimage789~mv2.jpg\", \"altText\": \"Medium size image\" }]\n * }\n * ]\n * }\n * }\n * ],\n * \"productType\": \"PHYSICAL\",\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"10\" },\n * \"maxValue\": { \"amount\": \"10\" }\n * },\n * \"variantsInfo\": {\n * \"variants\": [\n * {\n * \"_id\": \"3f3db5ba-c8da-461f-982a-5f83316db8a1\",\n * \"visible\": true,\n * \"price\": { \"actualPrice\": { \"amount\": \"10\" } },\n * \"inventoryStatus\": { \"inStock\": false, \"preorderEnabled\": false }\n * }\n * ]\n * }\n * }\n */\n\n","order":2,"source":"manual"},{"title":"Update a product's name","description":"","content":"import { productsV3 } from \"@wix/stores\";\n\nconst productId = \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\";\n\nconst product = {\n id: \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n revision: \"2\",\n name: \"Shopping bag\"\n};\n\nasync function updateProduct() {\n const response = await productsV3.updateProduct(productId, product);\n}\n\n/* Promise resolves to:\n * {\n * \"_id\": \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n * \"revision\": \"3\",\n * \"name\": \"Shopping bag\",\n * \"slug\": \"shopping-bag\",\n * \"visible\": true,\n * \"productType\": \"PHYSICAL\",\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"0.5\" },\n * \"maxValue\": { \"amount\": \"0.5\" }\n * },\n * \"variantsInfo\": {\n * \"variants\": [\n * {\n * \"_id\": \"6f52f714-bd4b-4c48-97cd-207cbf8233f9\",\n * \"visible\": true,\n * \"price\": {\n * \"actualPrice\": { \"amount\": \"0.5\" }\n * }\n * }\n * ]\n * }\n * }\n */\n\n","order":1,"source":"manual"},{"title":"updateProduct (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function UpdateProduct() {\n const response = await myWixClient.productsV3.UpdateProduct();\n};","order":4,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"patch","path":"/v3/products/{product.id}","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/stores","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products","destinationPath":"/v3/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products","destinationPath":"/v3/bulk/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"www._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://blocks.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://create.editorx/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"create.editorx","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wixapps.net/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://*.dev.wix-code.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://_/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products-with-inventory","destinationPath":"/v3/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products-with-inventory","destinationPath":"/v3/bulk/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/all-products-category","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/all-products-category","destinationPath":"/v3/all-products-category","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}}],"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_updated","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.UpdateProduct","methodName":"UpdateProduct","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"MISSING_VARIANT_OPTION_CHOICE","description":"Every variant's choice must reference an existing option in `options.id`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MISSING_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_VARIANT_OPTION_CHOICE","description":"Multiple variants have identical choices in `variantsInfo.variants.choices`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_PRODUCT_OPTIONS","description":"Multiple options have identical `name` and `optionRenderType`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_PRODUCT_OPTIONS"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_DEFAULT_VARIANT","description":"Product with multiple variants has a variant with empty `choices`. Only single-variant products can have empty choices.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_DEFAULT_VARIANT"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FIELD_MASK_VALUE_NOT_SUPPORTED","errorSchemaName":"com.wix.stores.catalog.product.api.v3.UnsupportedFieldMasks","description":"Update field mask includes read-only fields.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"FIELD_MASK_VALUE_NOT_SUPPORTED"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"VARIANTS_ARE_NOT_ALIGNED_WITH_PRODUCT","errorSchemaName":"com.wix.stores.catalog.product.api.v3.VariantsNotAlignedWithProduct","description":"Variants aren't aligned with the product. The variant `typedProperties` must match the `productType`, measurement units must align, and each variant must have exactly 1 choice for every option.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"VARIANTS_ARE_NOT_ALIGNED_WITH_PRODUCT"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"DUPLICATE_SLUG_ERROR","description":"There is already a product with this `slug`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_SLUG_ERROR"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"DIGITAL_FILE_NOT_FOUND_ERROR","description":"Couldn't find the digital file referenced in `variantsInfo.variants.digitalProperties`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DIGITAL_FILE_NOT_FOUND_ERROR"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"BARCODE_ALREADY_EXIST_ERROR","description":"There is already a variant with this `barcode`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"BARCODE_ALREADY_EXIST_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_BARCODE_ERROR","description":"Multiple variants have identical `barcode` in the request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_BARCODE_ERROR"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SKU_ALREADY_EXIST_ERROR","description":"There is already a variant with this `sku`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"SKU_ALREADY_EXIST_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_SKU_ERROR","description":"Multiple variants have identical `sku` in the request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_SKU_ERROR"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"VARIANT_ID_ALREADY_EXISTS","description":"Multiple variants have identical `id`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"VARIANT_ID_ALREADY_EXISTS"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION","description":"Subscription added to a digital product. Digital products can't have subscriptions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT","description":"All subscriptions are hidden for a subscription-only product. At least 1 subscription must be visible when `allowOneTimePurchases` is false.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT","description":"Subscription discount `amountOff` exceeds the minimum variant price.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS","description":"Multiple subscriptions have identical IDs.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PREORDER_VALIDATION_ERROR","description":"Variant enabled for preorder on a subscription product. Products with subscriptions can't have preorder variants.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PREORDER_VALIDATION_ERROR"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"BRAND_CREATION_FAILED","description":"Brand creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"BRAND_CREATION_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"RIBBON_NOT_FOUND","description":"Couldn't find the ribbon.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"RIBBON_NOT_FOUND"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INFO_SECTION_ERROR_OCCURRED","description":"Info section update failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INFO_SECTION_ERROR_OCCURRED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CUSTOMIZATION_NOT_EXIST","description":"Couldn't find the customization.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CUSTOMIZATION_NOT_EXIST"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED","description":"Failed to add customization choices.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CHOICE_NOT_EXIST","description":"Couldn't find the choice.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CHOICE_NOT_EXIST"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR","description":"Field mask includes fields not provided in the request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE","description":"The `compareAtPrice` is lower than the `actualPrice`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"VARIANTS_TYPED_PROPERTIES_ARE_NOT_ALIGNED","description":"Variants have different `typedProperties` types. All variants must have the same type.","errorType":"VALIDATION","validationErrorData":{"ruleName":"VARIANTS_TYPED_PROPERTIES_ARE_NOT_ALIGNED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_OPTIONS_ON_UPDATE_VARIANTS","description":"Update request includes `variants` but is missing `options`. Both must be provided together.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_OPTIONS_ON_UPDATE_VARIANTS"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION_CHOICE","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionChoiceErrorData","description":"Variant choice doesn't exist in the product's option choices.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionErrorData","description":"Variant option doesn't exist in the product's options.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"SUBSCRIPTION_INVALID_AUTO_RENEWAL","description":"The `autoRenewal` field is set to false. Set the number of billing cycles in `billingCycles` to prevent automatic renewal instead.","errorType":"VALIDATION","validationErrorData":{"ruleName":"SUBSCRIPTION_INVALID_AUTO_RENEWAL"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DIGITAL_PRODUCT_CANNOT_BE_VISIBLE_IN_POS","description":"Digital product is marked as visible in POS. Digital products can't be visible in POS.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DIGITAL_PRODUCT_CANNOT_BE_VISIBLE_IN_POS"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DESCRIPTION_SIZE_TOO_BIG","description":"Product `description` field exceeds the maximum size of 32000 bytes.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DESCRIPTION_SIZE_TOO_BIG"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DUPLICATE_MEDIA_ERROR","errorSchemaName":"com.wix.stores.catalog.product.api.v3.DuplicateMediaIdAssignedToProduct","description":"Multiple media items have identical IDs. Each media ID must be unique.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DUPLICATE_MEDIA_ERROR"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"BRAND_MISSING_ID","description":"Brand is missing an `id`.","errorType":"VALIDATION","validationErrorData":{"ruleName":"BRAND_MISSING_ID"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRICE_PER_UNIT_NOT_ALIGNED","description":"Price per unit isn't aligned between product and variants.","errorType":"VALIDATION","validationErrorData":{"ruleName":"PRICE_PER_UNIT_NOT_ALIGNED"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.UpdateProductRequest","responseMessage":"wix.stores.catalog.v3.UpdateProductResponse"},"legacyExamples":[{"name":"UpdateProduct","type":"METHOD","order":2,"content":{"title":"Update product's main and choice images","request":"curl -X PATCH \\\n 'https://www.wixapis.com/stores/v3/products/def25830-7627-4c6c-bde6-4df21d0c6605' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"product\": {\n \"id\": \"def25830-7627-4c6c-bde6-4df21d0c6605\",\n \"revision\": \"3\",\n \"media\": {\n \"main\": {\n \"url\": \"https://static.wixstatic.com/media/abc123_mainimage456~mv2.png\",\n \"altText\": \"Sample Product main image\"\n },\n \"itemsInfo\": {\n \"items\": [\n {\n \"url\": \"https://static.wixstatic.com/media/abc123_mainimage456~mv2.png\",\n \"altText\": \"Sample Product main image\"\n },\n {\n \"url\": \"https://static.wixstatic.com/media/abc123_choiceimage789~mv2.jpg\",\n \"altText\": \"Medium size image\"\n }\n ]\n }\n },\n \"options\": [\n {\n \"id\": \"d7579f10-4bd7-450c-9a13-91b513b1328c\",\n \"name\": \"size\",\n \"key\": \"size\",\n \"optionRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"41c9d242-65fe-4330-a8c1-caaded437018\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Medium\",\n \"name\": \"Medium\",\n \"visible\": true,\n \"inStock\": false,\n \"linkedMedia\": [\n {\n \"url\": \"https://static.wixstatic.com/media/abc123_choiceimage789~mv2.jpg\",\n \"altText\": \"Medium size image\"\n }\n ]\n }\n ]\n }\n }\n ],\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"3f3db5ba-c8da-461f-982a-5f83316db8a1\",\n \"visible\": true,\n \"choices\": [\n {\n \"optionChoiceIds\": {\n \"optionId\": \"d7579f10-4bd7-450c-9a13-91b513b1328c\",\n \"choiceId\": \"41c9d242-65fe-4330-a8c1-caaded437018\"\n },\n \"optionChoiceNames\": {\n \"choiceName\": \"Medium\",\n \"optionName\": \"Size\",\n \"renderType\": \"TEXT_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"10\"\n }\n },\n \"physicalProperties\": {},\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n }\n }\n ]\n }\n }\n }'","response":"{\n \"product\": {\n \"id\": \"def25830-7627-4c6c-bde6-4df21d0c6605\",\n \"revision\": \"4\",\n \"createdDate\": \"2025-07-13T10:55:26.934Z\",\n \"updatedDate\": \"2025-07-13T11:08:45.429Z\",\n \"numericId\": \"1752404126931000\",\n \"name\": \"Sample Product\",\n \"slug\": \"sample-product\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": {\n \"url\": \"https://static.wixstatic.com/media/abc123_mainimage456~mv2.png\",\n \"altText\": \"Sample Product main image\",\n \"mediaType\": \"IMAGE\",\n \"uploadId\": \"b0aece2a-26d8-427f-bcc0-7e943bfd0909\"\n }\n },\n \"options\": [\n {\n \"id\": \"d7579f10-4bd7-450c-9a13-91b513b1328c\",\n \"name\": \"size\",\n \"optionRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"41c9d242-65fe-4330-a8c1-caaded437018\",\n \"linkedMedia\": [\n {\n \"url\": \"https://static.wixstatic.com/media/abc123_choiceimage789~mv2.jpg\",\n \"altText\": \"Medium size image\",\n \"mediaType\": \"IMAGE\",\n \"uploadId\": \"7cca4c27-3667-41af-b17c-256ab6c325fc\"\n }\n ],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Medium\",\n \"name\": \"Medium\",\n \"inStock\": false,\n \"visible\": true\n }\n ]\n },\n \"key\": \"size\"\n }\n ],\n \"modifiers\": [],\n \"infoSections\": [],\n \"mainCategoryId\": \"9107571a-a4ab-467d-b98f-77851bd5116c\",\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\",\n \"preorderAvailability\": \"NO_VARIANTS\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {},\n \"handle\": \"Product_7d434376-78c8-449f-883c-2f31e0a4fa74\",\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"10\"\n },\n \"maxValue\": {\n \"amount\": \"10\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"0\"\n },\n \"maxValue\": {\n \"amount\": \"0\"\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"3f3db5ba-c8da-461f-982a-5f83316db8a1\",\n \"visible\": true,\n \"choices\": [\n {\n \"optionChoiceIds\": {\n \"optionId\": \"d7579f10-4bd7-450c-9a13-91b513b1328c\",\n \"choiceId\": \"41c9d242-65fe-4330-a8c1-caaded437018\"\n }\n }\n ],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"10\"\n }\n },\n \"media\": {\n \"url\": \"https://static.wixstatic.com/media/abc123_mainimage456~mv2.png\",\n \"altText\": \"Sample Product main image\",\n \"mediaType\": \"IMAGE\",\n \"uploadId\": \"b0aece2a-26d8-427f-bcc0-7e943bfd0909\"\n },\n \"physicalProperties\": {},\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n }\n }\n ]\n },\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"entityEventSequence\": \"11\"\n }\n}"}},{"name":"UpdateProduct","type":"METHOD","order":1,"content":{"title":"Update product name","request":"curl PATCH 'https://www.wixapis.com/stores/v3/products/9e8924aa-c3f2-4fe6-bc98-ace47295c52d' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"product\": {\n \"id\": \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n \"revision\": \"2\",\n \"name\": \"Shopping bag\"\n }\n }'","response":"{\n \"product\": {\n \"id\": \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n \"revision\": \"3\",\n \"createdDate\": \"2025-01-01T10:13:14.540Z\",\n \"updatedDate\": \"2025-01-01T12:59:03.102Z\",\n \"name\": \"Shopping bag\",\n \"slug\": \"shopping-bag\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": null,\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_a7daf3a2-2a31-49b3-8a64-8264cd1006c7\",\n \"currency\": null,\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"75ba03bc-e56f-4b6d-be52-691eb2ed5fd7\",\n \"visible\": true,\n \"sku\": null,\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"compareAtPrice\": null\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": null,\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n },\n \"physicalProperties\": {\n \"weight\": null,\n \"pricePerUnit\": null\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735726394407000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n }\n}"}},{"name":"UpdateProduct","type":"METHOD","content":{"title":"Update product","description":"Update different product fields. Pass only fields that you want to update.","request":"curl PATCH 'https://www.wixapis.com/stores/v3/products/93f2e5ab-60a5-4173-babb-9198fc52bdd3' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"fields\": [\n \"VARIANT_OPTION_CHOICE_NAMES\",\n \"MERCHANT_DATA\",\n \"INFO_SECTION\",\n \"DESCRIPTION\",\n \"URL\",\n \"CURRENCY\",\n \"WEIGHT_MEASUREMENT_UNIT_INFO\"\n ],\n \"product\": {\n \"id\": \"93f2e5ab-60a5-4173-babb-9198fc52bdd3\",\n \"revision\": \"3\",\n \"name\": \"Premium Coffee\",\n \"description\": {\n \"nodes\": [\n {\n \"type\": \"PARAGRAPH\",\n \"id\": \"foo\",\n \"nodes\": [\n {\n \"type\": \"TEXT\",\n \"textData\": {\n \"text\": \"Tasty, high quality and eco friendly, in a beautiful gift box.\"\n }\n }\n ],\n \"paragraphData\": {\n \"textStyle\": {\n \"textAlignment\": \"AUTO\"\n }\n }\n }\n ],\n \"metadata\": {\n \"version\": 1,\n \"id\": \"fb97b2c1-a3ff-4319-be5f-bbb7fdf0776c\"\n }\n },\n \"visible\": false,\n \"visibleInPos\": false,\n \"infoSections\": [\n {\n \"id\": \"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\"\n },\n {\n \"uniqueName\": \"Origin\",\n \"title\": \"Made in\",\n \"description\": {\n \"nodes\": [\n {\n \"type\": \"PARAGRAPH\",\n \"id\": \"xjkk51429\",\n \"nodes\": [\n {\n \"type\": \"TEXT\",\n \"id\": \"\",\n \"nodes\": [],\n \"textData\": {\n \"text\": \"Brazil\",\n \"decorations\": []\n }\n }\n ]\n }\n ]\n }\n }\n ],\n \"ribbon\": {\n \"name\": \"New arrival\"\n }\n }\n }'","response":"{\n \"product\": {\n \"id\": \"93f2e5ab-60a5-4173-babb-9198fc52bdd3\",\n \"revision\": \"4\",\n \"createdDate\": \"2025-01-01T09:50:31.438Z\",\n \"updatedDate\": \"2025-01-02T07:14:02.734Z\",\n \"name\": \"Premium Coffee\",\n \"slug\": \"coffee\",\n \"url\": {\n \"relativePath\": \"/product-page/coffee\",\n \"url\": \"https://mysite.wixstudio.com/my-site-79/product-page/coffee\"\n },\n \"description\": {\n \"nodes\": [\n {\n \"type\": \"PARAGRAPH\",\n \"id\": \"foo\",\n \"nodes\": [\n {\n \"type\": \"TEXT\",\n \"id\": \"\",\n \"nodes\": [],\n \"style\": null\n }\n ],\n \"style\": null\n }\n ],\n \"metadata\": {\n \"version\": 1,\n \"createdTimestamp\": null,\n \"updatedTimestamp\": null,\n \"id\": \"fb97b2c1-a3ff-4319-be5f-bbb7fdf0776c\"\n },\n \"documentStyle\": null\n },\n \"plainDescription\": null,\n \"visible\": false,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": {\n \"id\": \"ad3eb492-9d35-4f47-8a1f-cb7bd8a4e66d\",\n \"name\": \"New arrival\"\n },\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"directCategoryIdsInfo\": null,\n \"costRange\": {\n \"minValue\": {\n \"amount\": \"0.00\",\n \"formattedAmount\": \"$0.00\"\n },\n \"maxValue\": {\n \"amount\": \"0.00\",\n \"formattedAmount\": \"$0.00\"\n }\n },\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n },\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_be600651-94cf-42ad-881f-3bd69fb4a320\",\n \"currency\": \"USD\",\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"d44f6c3f-e641-4e54-9cb3-5796e58fa1cd\",\n \"visible\": true,\n \"sku\": \"12345\",\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"compareAtPrice\": null\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": null,\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735725031408000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n }\n}"}}],"commonMethodData":{"name":"update","itemField":"product"},"sdkData":{"signature":{"resolved":[{"field":{"path":"product.id"}},{"field":{"path":"product"}},{"parent":{"name":"options","fields":[{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Update a product's details","description":"Update product name, description, visibility, info sections, and ribbon.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst productId = \"93f2e5ab-60a5-4173-babb-9198fc52bdd3\";\n\nconst product = {\n id: \"93f2e5ab-60a5-4173-babb-9198fc52bdd3\",\n revision: \"3\",\n name: \"Premium Coffee\",\n description: {\n nodes: [\n {\n type: \"PARAGRAPH\",\n id: \"foo\",\n nodes: [\n {\n type: \"TEXT\",\n textData: {\n text: \"Tasty, high quality and eco friendly, in a beautiful gift box.\"\n }\n }\n ],\n paragraphData: {\n textStyle: {\n textAlignment: \"AUTO\"\n }\n }\n }\n ],\n metadata: {\n version: 1,\n id: \"fb97b2c1-a3ff-4319-be5f-bbb7fdf0776c\"\n }\n },\n visible: false,\n visibleInPos: false,\n infoSections: [\n {\n id: \"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\"\n },\n {\n uniqueName: \"Origin\",\n title: \"Made in\",\n description: {\n nodes: [\n {\n type: \"PARAGRAPH\",\n id: \"xjkk51429\",\n nodes: [\n {\n type: \"TEXT\",\n id: \"\",\n nodes: [],\n textData: {\n text: \"Brazil\",\n decorations: []\n }\n }\n ]\n }\n ]\n }\n }\n ],\n ribbon: {\n name: \"New arrival\"\n }\n};\n\nconst options = {\n fields: [\n \"VARIANT_OPTION_CHOICE_NAMES\",\n \"MERCHANT_DATA\",\n \"INFO_SECTION\",\n \"DESCRIPTION\",\n \"URL\",\n \"CURRENCY\",\n \"WEIGHT_MEASUREMENT_UNIT_INFO\"\n ]\n};\n\nasync function updateProduct() {\n const response = await productsV3.updateProduct(productId, product, options);\n}\n\n/* Promise resolves to:\n * {\n * \"_id\": \"93f2e5ab-60a5-4173-babb-9198fc52bdd3\",\n * \"revision\": \"4\",\n * \"name\": \"Premium Coffee\",\n * \"slug\": \"premium-coffee\",\n * \"url\": \"https://example.com/product-page/premium-coffee\",\n * \"description\": {\n * \"nodes\": [{ \"type\": \"PARAGRAPH\", \"id\": \"foo\", \"nodes\": [{ \"type\": \"TEXT\", \"textData\": { \"text\": \"Tasty, high quality and eco friendly, in a beautiful gift box.\" } }] }],\n * \"metadata\": { \"version\": 1, \"id\": \"fb97b2c1-a3ff-4319-be5f-bbb7fdf0776c\" }\n * },\n * \"visible\": false,\n * \"visibleInPos\": false,\n * \"productType\": \"PHYSICAL\",\n * \"currency\": \"EUR\",\n * \"infoSections\": [\n * { \"_id\": \"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\", \"uniqueName\": \"Refund policy\", \"title\": \"Refund policy\" },\n * { \"_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\", \"uniqueName\": \"Origin\", \"title\": \"Made in\" }\n * ],\n * \"ribbon\": { \"_id\": \"new-arrival-ribbon-id\", \"name\": \"New Arrival\" },\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"9.00\", \"formattedAmount\": \"€9.00\" },\n * \"maxValue\": { \"amount\": \"15.00\", \"formattedAmount\": \"€15.00\" }\n * },\n * \"physicalProperties\": {\n * \"weightMeasurementUnitInfo\": { \"weightMeasurementUnit\": \"KG\" }\n * }\n * }\n */\n\n","order":3,"source":"manual"},{"title":"Update a product's main and choice images","description":"","content":"import { productsV3 } from \"@wix/stores\";\n\nconst productId = \"def25830-7627-4c6c-bde6-4df21d0c6605\";\n\nconst product = {\n id: \"def25830-7627-4c6c-bde6-4df21d0c6605\",\n revision: \"3\",\n media: {\n main: {\n url: \"https://static.wixstatic.com/media/abc123_mainimage456~mv2.png\",\n altText: \"Sample Product main image\"\n },\n itemsInfo: {\n items: [\n {\n url: \"https://static.wixstatic.com/media/abc123_mainimage456~mv2.png\",\n altText: \"Sample Product main image\"\n },\n {\n url: \"https://static.wixstatic.com/media/abc123_choiceimage789~mv2.jpg\",\n altText: \"Medium size image\"\n }\n ]\n }\n },\n options: [\n {\n id: \"d7579f10-4bd7-450c-9a13-91b513b1328c\",\n name: \"size\",\n key: \"size\",\n optionRenderType: \"TEXT_CHOICES\",\n choicesSettings: {\n choices: [\n {\n choiceId: \"41c9d242-65fe-4330-a8c1-caaded437018\",\n choiceType: \"CHOICE_TEXT\",\n key: \"Medium\",\n name: \"Medium\",\n visible: true,\n inStock: false,\n linkedMedia: [\n {\n url: \"https://static.wixstatic.com/media/abc123_choiceimage789~mv2.jpg\",\n altText: \"Medium size image\"\n }\n ]\n }\n ]\n }\n }\n ],\n variantsInfo: {\n variants: [\n {\n id: \"3f3db5ba-c8da-461f-982a-5f83316db8a1\",\n visible: true,\n choices: [\n {\n optionChoiceIds: {\n optionId: \"d7579f10-4bd7-450c-9a13-91b513b1328c\",\n choiceId: \"41c9d242-65fe-4330-a8c1-caaded437018\"\n },\n optionChoiceNames: {\n choiceName: \"Medium\",\n optionName: \"Size\",\n renderType: \"TEXT_CHOICES\"\n }\n }\n ],\n price: {\n actualPrice: {\n amount: \"10\"\n }\n },\n physicalProperties: {},\n inventoryStatus: {\n inStock: false,\n preorderEnabled: false\n }\n }\n ]\n }\n};\n\nasync function updateProduct() {\n const response = await productsV3.updateProduct(productId, product);\n}\n\n/* Promise resolves to:\n * {\n * \"_id\": \"def25830-7627-4c6c-bde6-4df21d0c6605\",\n * \"revision\": \"4\",\n * \"name\": \"Sample Product\",\n * \"slug\": \"sample-product\",\n * \"visible\": true,\n * \"media\": {\n * \"main\": {\n * \"url\": \"https://static.wixstatic.com/media/abc123_mainimage456~mv2.png\",\n * \"altText\": \"Sample Product main image\",\n * \"mediaType\": \"IMAGE\"\n * },\n * \"itemsInfo\": {\n * \"items\": [\n * { \"url\": \"https://static.wixstatic.com/media/abc123_mainimage456~mv2.png\", \"altText\": \"Sample Product main image\", \"mediaType\": \"IMAGE\" },\n * { \"url\": \"https://static.wixstatic.com/media/abc123_choiceimage789~mv2.jpg\", \"altText\": \"Medium size image\", \"mediaType\": \"IMAGE\" }\n * ]\n * }\n * },\n * \"options\": [\n * {\n * \"_id\": \"d7579f10-4bd7-450c-9a13-91b513b1328c\",\n * \"name\": \"size\",\n * \"optionRenderType\": \"TEXT_CHOICES\",\n * \"choicesSettings\": {\n * \"choices\": [\n * {\n * \"choiceId\": \"41c9d242-65fe-4330-a8c1-caaded437018\",\n * \"choiceType\": \"CHOICE_TEXT\",\n * \"name\": \"Medium\",\n * \"visible\": true,\n * \"linkedMedia\": [{ \"url\": \"https://static.wixstatic.com/media/abc123_choiceimage789~mv2.jpg\", \"altText\": \"Medium size image\" }]\n * }\n * ]\n * }\n * }\n * ],\n * \"productType\": \"PHYSICAL\",\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"10\" },\n * \"maxValue\": { \"amount\": \"10\" }\n * },\n * \"variantsInfo\": {\n * \"variants\": [\n * {\n * \"_id\": \"3f3db5ba-c8da-461f-982a-5f83316db8a1\",\n * \"visible\": true,\n * \"price\": { \"actualPrice\": { \"amount\": \"10\" } },\n * \"inventoryStatus\": { \"inStock\": false, \"preorderEnabled\": false }\n * }\n * ]\n * }\n * }\n */\n\n","order":2,"source":"manual"},{"title":"Update a product's name","description":"","content":"import { productsV3 } from \"@wix/stores\";\n\nconst productId = \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\";\n\nconst product = {\n id: \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n revision: \"2\",\n name: \"Shopping bag\"\n};\n\nasync function updateProduct() {\n const response = await productsV3.updateProduct(productId, product);\n}\n\n/* Promise resolves to:\n * {\n * \"_id\": \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n * \"revision\": \"3\",\n * \"name\": \"Shopping bag\",\n * \"slug\": \"shopping-bag\",\n * \"visible\": true,\n * \"productType\": \"PHYSICAL\",\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"0.5\" },\n * \"maxValue\": { \"amount\": \"0.5\" }\n * },\n * \"variantsInfo\": {\n * \"variants\": [\n * {\n * \"_id\": \"6f52f714-bd4b-4c48-97cd-207cbf8233f9\",\n * \"visible\": true,\n * \"price\": {\n * \"actualPrice\": { \"amount\": \"0.5\" }\n * }\n * }\n * ]\n * }\n * }\n */\n\n","order":1,"source":"manual"},{"title":"updateProduct (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function UpdateProduct() {\n const response = await myWixClient.productsV3.UpdateProduct();\n};","order":4,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Update Product","slugifiedName":"update-product"},"permissionScopes":[{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}],"isAdminMethod":true},{"summary":"Query Products","description":"Retrieves a list of up to 100 products, given the provided filtering, sorting, and cursor paging.\nPass supported values to the `fields` array in the request to include those fields in the response.\n\nTo learn about working with _Query_ endpoints, see\n[API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language),\nand [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).\n\nLearn more about the differences between [_Query_ and _Search_](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-search-query-and-list-methods) methods.\n\n> **Notes:**\n> + To retrieve a non-visible product (`visible: false`), your app must have the 'Product v3 read admin' (`SCOPE.STORES.PRODUCT_READ_ADMIN`) permission scope.\n> + This method does not return variant data. To retrieve variant data, call [Get Product](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/get-product) or [Get Product By Slug](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/get-product-by-slug) for each product individually, or use the [Read-Only Variants API](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/read-only-variants-v3/introduction) for variant-centric queries.","operationId":"wix.stores.catalog.v3.CatalogApi.QueryProducts","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.QueryProductsResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryProductsRequest","description":"","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.CursorQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.MultipleEntitiesOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"NO_PERMISSION_TO_READ_MERCHANT_DATA","description":"The [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities) used to call the method doesn't have the required permissions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"NO_PERMISSION_TO_READ_MERCHANT_DATA"},"name":null},{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"NO_PERMISSION_TO_INCLUDE_NOT_VISIBLE_PRODUCTS","description":"The [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities) used to call the method doesn't have the required permissions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"NO_PERMISSION_TO_INCLUDE_NOT_VISIBLE_PRODUCTS"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_READ","WIX_STORES.PRODUCT_READ_NON_VISIBLE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.QueryProductsRequest","responseMessage":"wix.stores.catalog.v3.QueryProductsResponse"},"legacyExamples":[{"name":"QueryProducts","type":"METHOD","content":{"title":"Query Products","description":"Query Products with filter by ids and sort by creation date","request":"curl POST 'https://www.wixapis.com/stores/v3/products/query' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"fields\": [],\n \"query\": {\n \"sort\": [\n {\n \"order\": \"ASC\",\n \"field_name\": \"createdDate\"\n }\n ],\n \"filter\": {\n \"id\": {\n \"$in\": [\n \"dd093852-35c6-4e09-a22c-4a5f175b2b1c\",\n \"35bb39e5-83aa-4930-b5c4-54db7b886a6e\"\n ]\n }\n }\n }\n }'","response":"{\n \"products\": [\n {\n \"id\": \"35bb39e5-83aa-4930-b5c4-54db7b886a6e\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-01T13:43:49.222Z\",\n \"updatedDate\": \"2025-01-01T13:43:51.660Z\",\n \"name\": \"Chocolate bar\",\n \"slug\": \"chocolate-bar-6\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": false,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": null,\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_9e11b825-593c-4246-9ea9-cf48aec71361\",\n \"currency\": null,\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"6\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"6\",\n \"formattedAmount\": null\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"7\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"7\",\n \"formattedAmount\": null\n }\n },\n \"variantsInfo\": null,\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735739029162001\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n },\n {\n \"id\": \"dd093852-35c6-4e09-a22c-4a5f175b2b1c\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-01T13:43:49.222Z\",\n \"updatedDate\": \"2025-01-01T13:43:52.324Z\",\n \"name\": \"Coffee\",\n \"slug\": \"coffee-3\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": null,\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_33ea6950-e6e3-4155-9ef6-8f4a90022a94\",\n \"currency\": null,\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": null\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": null\n }\n },\n \"variantsInfo\": null,\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735739029162000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"cursors\": {\n \"next\": null,\n \"prev\": null\n },\n \"hasNext\": false\n }\n}"}}],"commonMethodData":{"name":"query","itemField":"product"},"sdkData":{"signature":{"resolved":[{"field":{"path":"query"}},{"parent":{"name":"options","fields":[{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"queryProducts","description":"","content":"import { productsV3 } from '@wix/stores';\n\nasync function queryProducts() {\n const { items } = await productsV3.queryProducts().find();\n};","order":1,"source":"generated"},{"title":"queryProducts (with elevated permissions)","description":"","content":"import { productsV3 } from '@wix/stores';\nimport { auth } from '@wix/essentials';\n\nasync function myQueryProductsMethod(query, options) {\n const elevatedQueryProducts = auth.elevate(productsV3.queryProducts);\n const response = await elevatedQueryProducts(query, options);\n}","order":4,"source":"generated"},{"title":"queryProducts (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function queryProducts() {\n const { items } = await myWixClient.productsV3.queryProducts().find();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","queryMethodData":{"queryFieldsCapabilitiesMap":{"id":{"operators":["$eq","$ne","$exists","$in","$hasSome","$startsWith","$gt","$lt","$lte","$gte"],"sort":[]},"handle":{"operators":["$eq","$ne","$exists","$in","$hasSome","$startsWith","$gt","$lt","$lte","$gte"],"sort":[]},"options.id":{"operators":["$eq","$ne","$exists","$in","$hasSome","$startsWith","$gt","$lt","$lte","$gte"],"sort":[]},"slug":{"operators":["$eq","$ne","$exists","$in","$hasSome","$startsWith","$gt","$lt","$lte","$gte"],"sort":["ASC","DESC"]},"createdDate":{"operators":["$eq","$ne","$exists","$in","$hasSome","$lt","$lte","$gt","$gte"],"sort":["ASC","DESC"]},"updatedDate":{"operators":["$eq","$ne","$exists","$in","$hasSome","$lt","$lte","$gt","$gte"],"sort":["ASC","DESC"]},"visible":{"operators":["$eq","$ne","$exists","$in","$hasSome"],"sort":["ASC","DESC"]}}}},"httpMethod":"post","path":"/v3/products/query","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/stores","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products","destinationPath":"/v3/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products","destinationPath":"/v3/bulk/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"www._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://blocks.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://create.editorx/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"create.editorx","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wixapps.net/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://*.dev.wix-code.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://_/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products-with-inventory","destinationPath":"/v3/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products-with-inventory","destinationPath":"/v3/bulk/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/all-products-category","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/all-products-category","destinationPath":"/v3/all-products-category","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}}],"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"NO_PERMISSION_TO_READ_MERCHANT_DATA","description":"The [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities) used to call the method doesn't have the required permissions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"NO_PERMISSION_TO_READ_MERCHANT_DATA"},"name":null},{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"NO_PERMISSION_TO_INCLUDE_NOT_VISIBLE_PRODUCTS","description":"The [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities) used to call the method doesn't have the required permissions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"NO_PERMISSION_TO_INCLUDE_NOT_VISIBLE_PRODUCTS"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_READ","WIX_STORES.PRODUCT_READ_NON_VISIBLE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.QueryProductsRequest","responseMessage":"wix.stores.catalog.v3.QueryProductsResponse"},"legacyExamples":[{"name":"QueryProducts","type":"METHOD","content":{"title":"Query Products","description":"Query Products with filter by ids and sort by creation date","request":"curl POST 'https://www.wixapis.com/stores/v3/products/query' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"fields\": [],\n \"query\": {\n \"sort\": [\n {\n \"order\": \"ASC\",\n \"field_name\": \"createdDate\"\n }\n ],\n \"filter\": {\n \"id\": {\n \"$in\": [\n \"dd093852-35c6-4e09-a22c-4a5f175b2b1c\",\n \"35bb39e5-83aa-4930-b5c4-54db7b886a6e\"\n ]\n }\n }\n }\n }'","response":"{\n \"products\": [\n {\n \"id\": \"35bb39e5-83aa-4930-b5c4-54db7b886a6e\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-01T13:43:49.222Z\",\n \"updatedDate\": \"2025-01-01T13:43:51.660Z\",\n \"name\": \"Chocolate bar\",\n \"slug\": \"chocolate-bar-6\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": false,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": null,\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_9e11b825-593c-4246-9ea9-cf48aec71361\",\n \"currency\": null,\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"6\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"6\",\n \"formattedAmount\": null\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"7\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"7\",\n \"formattedAmount\": null\n }\n },\n \"variantsInfo\": null,\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735739029162001\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n },\n {\n \"id\": \"dd093852-35c6-4e09-a22c-4a5f175b2b1c\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-01T13:43:49.222Z\",\n \"updatedDate\": \"2025-01-01T13:43:52.324Z\",\n \"name\": \"Coffee\",\n \"slug\": \"coffee-3\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": null,\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_33ea6950-e6e3-4155-9ef6-8f4a90022a94\",\n \"currency\": null,\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": null\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": null\n }\n },\n \"variantsInfo\": null,\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735739029162000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"cursors\": {\n \"next\": null,\n \"prev\": null\n },\n \"hasNext\": false\n }\n}"}}],"commonMethodData":{"name":"query","itemField":"product"},"sdkData":{"signature":{"resolved":[{"field":{"path":"query"}},{"parent":{"name":"options","fields":[{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"queryProducts","description":"","content":"import { productsV3 } from '@wix/stores';\n\nasync function queryProducts() {\n const { items } = await productsV3.queryProducts().find();\n};","order":1,"source":"generated"},{"title":"queryProducts (with elevated permissions)","description":"","content":"import { productsV3 } from '@wix/stores';\nimport { auth } from '@wix/essentials';\n\nasync function myQueryProductsMethod(query, options) {\n const elevatedQueryProducts = auth.elevate(productsV3.queryProducts);\n const response = await elevatedQueryProducts(query, options);\n}","order":4,"source":"generated"},{"title":"queryProducts (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function queryProducts() {\n const { items } = await myWixClient.productsV3.queryProducts().find();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","queryMethodData":{"queryFieldsCapabilitiesMap":{"id":{"operators":["$eq","$ne","$exists","$in","$hasSome","$startsWith","$gt","$lt","$lte","$gte"],"sort":[]},"handle":{"operators":["$eq","$ne","$exists","$in","$hasSome","$startsWith","$gt","$lt","$lte","$gte"],"sort":[]},"options.id":{"operators":["$eq","$ne","$exists","$in","$hasSome","$startsWith","$gt","$lt","$lte","$gte"],"sort":[]},"slug":{"operators":["$eq","$ne","$exists","$in","$hasSome","$startsWith","$gt","$lt","$lte","$gte"],"sort":["ASC","DESC"]},"createdDate":{"operators":["$eq","$ne","$exists","$in","$hasSome","$lt","$lte","$gt","$gte"],"sort":["ASC","DESC"]},"updatedDate":{"operators":["$eq","$ne","$exists","$in","$hasSome","$lt","$lte","$gt","$gte"],"sort":["ASC","DESC"]},"visible":{"operators":["$eq","$ne","$exists","$in","$hasSome"],"sort":["ASC","DESC"]}}},"contentLink":{"displayName":"Query Products","slugifiedName":"query-products"},"permissionScopes":[{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"}],"isAdminMethod":false},{"summary":"Search Products","description":"Retrieves a list of up to 100 products, given the provided filtering, search expression, sorting, and cursor paging.\nPass supported values to the `fields` array in the request to include those fields in the response.\n\nTo learn about working with _Search_ endpoints, see\n[API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language),\nand [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).\n\nLearn more about the differences between [_Query_ and _Search_](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-search-query-and-list-methods) methods.\n\n> **Notes:**\n> + When using free-text search, you must specify which fields to search using the `search.fields` parameter.\n> + To retrieve a non-visible product (`visible: false`), your app must have the 'Product v3 read admin' (`SCOPE.STORES.PRODUCT_READ_ADMIN`) permission scope.\n> + This method does not return variant data. To retrieve variant data, call [Get Product](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/get-product) or [Get Product By Slug](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/get-product-by-slug) for each product individually, or use the [Read-Only Variants API](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/read-only-variants-v3/introduction) for variant-centric queries.","operationId":"wix.stores.catalog.v3.CatalogApi.SearchProducts","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.SearchProductsResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"SearchProductsRequest","description":"","properties":{"search":{"description":"Search options.","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.CursorSearch","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.MultipleEntitiesOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"NO_PERMISSION_TO_READ_MERCHANT_DATA","description":"The [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities) used to call the method doesn't have the required permissions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"NO_PERMISSION_TO_READ_MERCHANT_DATA"},"name":null},{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"NO_PERMISSION_TO_INCLUDE_NOT_VISIBLE_PRODUCTS","description":"The [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities) used to call the method doesn't have the required permissions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"NO_PERMISSION_TO_INCLUDE_NOT_VISIBLE_PRODUCTS"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_READ","WIX_STORES.PRODUCT_READ_NON_VISIBLE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.SearchProductsRequest","responseMessage":"wix.stores.catalog.v3.SearchProductsResponse"},"legacyExamples":[{"name":"SearchProducts","type":"METHOD","order":2,"content":{"title":"SearchProducts by free text","description":"Enter search expression and find it in `name`, `description` or `variants.sku`","request":"curl POST 'https://www.wixapis.com/stores/v3/products/search' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"fields\": [\n \"WEIGHT_MEASUREMENT_UNIT_INFO\",\n \"CURRENCY\"\n ],\n \"search\": {\n \"search\": {\n \"expression\": \"tea\"\n }\n }\n }'","response":"{\n \"products\": [\n {\n \"id\": \"077eac80-16be-4ca6-96e9-4ffd9b271e1f\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-02T09:09:25.910Z\",\n \"updatedDate\": \"2025-01-02T09:09:27.461Z\",\n \"name\": \"Tea box\",\n \"slug\": \"tea-box-1\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [\n {\n \"id\": \"3e85ff44-3763-4946-b9f3-993fd4c5c771\",\n \"name\": \"Size\",\n \"optionRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"0b649a04-b73b-492e-b3c9-315c621b5bd8\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"s\",\n \"name\": \"s\",\n \"inStock\": false,\n \"visible\": true\n },\n {\n \"choiceId\": \"15ef4e3a-d501-493b-a1ae-51456378cba7\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"l\",\n \"name\": \"l\",\n \"inStock\": false,\n \"visible\": true\n }\n ]\n },\n \"key\": \"Size\"\n }\n ],\n \"modifiers\": [],\n \"brand\": {\n \"id\": \"c0d3bf32-45bb-47ea-a3fe-668242bbba6c\",\n \"name\": \"tea-time\"\n },\n \"infoSections\": [],\n \"ribbon\": {\n \"id\": \"1ffac9ba-f8d7-4b59-a518-767f3e481851\",\n \"name\": \"best seller\"\n },\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": {\n \"quantity\": 100,\n \"measurementUnit\": \"G\"\n },\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": {\n \"minValue\": 0.4,\n \"maxValue\": 0.5\n },\n \"pricePerUnitRange\": {\n \"minValue\": {\n \"value\": \"16.00\",\n \"description\": \"$16.00 / 100 g\"\n },\n \"maxValue\": {\n \"value\": \"20.00\",\n \"description\": \"$20.00 / 100 g\"\n }\n },\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n },\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_3f7f580e-1cf2-4396-bfbf-b9079b78b45b\",\n \"currency\": \"USD\",\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"16.00\",\n \"formattedAmount\": \"$16.00\"\n },\n \"maxValue\": {\n \"amount\": \"20.00\",\n \"formattedAmount\": \"$20.00\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"16.00\",\n \"formattedAmount\": \"$16.00\"\n },\n \"maxValue\": {\n \"amount\": \"25.00\",\n \"formattedAmount\": \"$25.00\"\n }\n },\n \"variantsInfo\": null,\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735808965731000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 2\n },\n \"minVariantPriceInfo\": null\n },\n {\n \"id\": \"f97afbc9-5e37-4c51-803e-777516e6ef85\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-02T08:58:28.666Z\",\n \"updatedDate\": \"2025-01-02T08:58:31.452Z\",\n \"name\": \"Tea box\",\n \"slug\": \"tea-box\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [\n {\n \"id\": \"3e85ff44-3763-4946-b9f3-993fd4c5c771\",\n \"name\": \"Size\",\n \"optionRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"0b649a04-b73b-492e-b3c9-315c621b5bd8\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"s\",\n \"name\": \"s\",\n \"inStock\": false,\n \"visible\": true\n },\n {\n \"choiceId\": \"15ef4e3a-d501-493b-a1ae-51456378cba7\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"l\",\n \"name\": \"l\",\n \"inStock\": false,\n \"visible\": true\n }\n ]\n },\n \"key\": \"Size\"\n }\n ],\n \"modifiers\": [],\n \"brand\": {\n \"id\": \"c0d3bf32-45bb-47ea-a3fe-668242bbba6c\",\n \"name\": \"tea-time\"\n },\n \"infoSections\": [],\n \"ribbon\": {\n \"id\": \"1ffac9ba-f8d7-4b59-a518-767f3e481851\",\n \"name\": \"best seller\"\n },\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n },\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_946bd7ec-78d0-4511-8757-68925290afe1\",\n \"currency\": \"USD\",\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"16.00\",\n \"formattedAmount\": \"$16.00\"\n },\n \"maxValue\": {\n \"amount\": \"20.00\",\n \"formattedAmount\": \"$20.00\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"16.00\",\n \"formattedAmount\": \"$16.00\"\n },\n \"maxValue\": {\n \"amount\": \"25.00\",\n \"formattedAmount\": \"$25.00\"\n }\n },\n \"variantsInfo\": null,\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735808308117000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 2\n },\n \"minVariantPriceInfo\": null\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"cursors\": {\n \"next\": null,\n \"prev\": null\n },\n \"hasNext\": false\n },\n \"aggregationData\": null\n}"}},{"name":"SearchProducts","type":"METHOD","content":{"title":"SearchProducts with filters","description":"Shows examples of supported filters. Pay attention that when filtering by `allCategoriesInfo.categories`, `directCategoriesInfo.categories` or `variantsInfo.variants` you have to use `$matchItems` operator. `$matchAll` is not supported for any other fields.","request":"curl POST 'https://www.wixapis.com/stores/catalog/v3/products/search' \\\n-H 'Content-Type: application/json;charset=UTF-8' \\\n-H 'Authorization: ' \\\n--data-binary '{\n \"fields\": [\n \"ALL_CATEGORIES_INFO\",\n \"WEIGHT_MEASUREMENT_UNIT_INFO\",\n \"CURRENCY\"\n ],\n \"search\": {\n \"filter\": {\n \"$and\": [\n {\n \"allCategoriesInfo.categories\": {\n \"$matchItems\": [\n {\n \"id\": {\n \"$eq\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\"\n }\n }\n ]\n }\n },\n {\n \"productType\": {\n \"$eq\": \"PHYSICAL\"\n }\n },\n {\n \"visible\": {\n \"$eq\": true\n }\n },\n {\n \"brand.id\": {\n \"$eq\": \"c0d3bf32-45bb-47ea-a3fe-668242bbba6c\"\n }\n },\n {\n \"actualPriceRange.minValue.amount\": {\n \"$gt\": 3\n }\n },\n {\n \"actualPriceRange.minValue.amount\": {\n \"$lt\": 120\n }\n },\n {\n \"inventory.availabilityStatus\": {\n \"$in\": [\n \"OUT_OF_STOCK\",\n \"PARTIALLY_OUT_OF_STOCK\"\n ]\n }\n }\n ]\n }\n }\n }'","response":"{\n \"products\": [\n {\n \"id\": \"f97afbc9-5e37-4c51-803e-777516e6ef85\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-02T08:58:28.666Z\",\n \"updatedDate\": \"2025-01-02T08:58:31.452Z\",\n \"name\": \"Tea box\",\n \"slug\": \"tea-box\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [\n {\n \"id\": \"3e85ff44-3763-4946-b9f3-993fd4c5c771\",\n \"name\": \"Size\",\n \"optionRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"0b649a04-b73b-492e-b3c9-315c621b5bd8\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"s\",\n \"name\": \"s\",\n \"inStock\": false,\n \"visible\": true\n },\n {\n \"choiceId\": \"15ef4e3a-d501-493b-a1ae-51456378cba7\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"l\",\n \"name\": \"l\",\n \"inStock\": false,\n \"visible\": true\n }\n ]\n },\n \"key\": \"Size\"\n }\n ],\n \"modifiers\": [],\n \"brand\": {\n \"id\": \"c0d3bf32-45bb-47ea-a3fe-668242bbba6c\",\n \"name\": \"tea-time\"\n },\n \"infoSections\": [],\n \"ribbon\": {\n \"id\": \"1ffac9ba-f8d7-4b59-a518-767f3e481851\",\n \"name\": \"best sellter\"\n },\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": {\n \"categories\": [\n {\n \"id\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"index\": null\n }\n ]\n },\n \"mainCategoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n },\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_946bd7ec-78d0-4511-8757-68925290afe1\",\n \"currency\": \"USD\",\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"16.00\",\n \"formattedAmount\": \"$16.00\"\n },\n \"maxValue\": {\n \"amount\": \"20.00\",\n \"formattedAmount\": \"$20.00\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"16.00\",\n \"formattedAmount\": \"$16.00\"\n },\n \"maxValue\": {\n \"amount\": \"25.00\",\n \"formattedAmount\": \"$25.00\"\n }\n },\n \"variantsInfo\": null,\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735808308117000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 2\n },\n \"minVariantPriceInfo\": null\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {\n \"next\": null,\n \"prev\": null\n },\n \"hasNext\": false\n },\n \"aggregationData\": null\n}"}},{"name":"SearchProducts","type":"METHOD","order":5,"content":{"title":"SearchProducts: count aggregation","description":"Returns number of products assigned to info sections","request":"curl POST 'https://www.wixapis.com/stores/v3/products/search' \\\n-H 'Content-Type: application/json;charset=UTF-8' \\\n-H 'Authorization: ' \\\n-d '{\n \"search\": {\n \"aggregations\": [\n {\n \"name\": \"count per info section\",\n \"type\": \"VALUE\",\n \"field_path\": \"infoSections.id\",\n \"value\": {}\n }\n ],\n \"cursorPaging\": {\n \"limit\": 0\n }\n }\n }'","response":"{\n \"products\": [],\n \"pagingMetadata\": {\n \"count\": 0,\n \"cursors\": {},\n \"hasNext\": false\n },\n \"aggregationData\": {\n \"results\": [\n {\n \"name\": \"count per info section\",\n \"type\": \"VALUE\",\n \"fieldPath\": \"infoSections.id\",\n \"values\": {\n \"results\": [\n {\n \"value\": \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\",\n \"count\": 1\n },\n {\n \"value\": \"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\",\n \"count\": 1\n }\n ]\n }\n }\n ]\n }\n}"}},{"name":"SearchProducts","type":"METHOD","order":3,"content":{"title":"SearchProducts: filter and sort by createdDate","request":"curl POST 'https://www.wixapis.com/stores/v3/products/search' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"fields\": [\n \"WEIGHT_MEASUREMENT_UNIT_INFO\",\n \"CURRENCY\"\n ],\n \"search\": {\n \"sort\": [\n {\n \"field_name\": \"createdDate\",\n \"order\": \"DESC\"\n }\n ],\n \"filter\": {\n \"createdDate\": {\n \"$gt\": \"2024-07-22T13:22:45\"\n }\n },\n \"cursorPaging\": {\n \"limit\": 2\n }\n }\n }'","response":"{\n \"products\": [\n {\n \"id\": \"ac491fa2-f5fc-479f-9123-65bc32d1ad28\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-07-22T14:23:18.780Z\",\n \"updatedDate\": \"2024-07-22T14:25:06.539Z\",\n \"name\": \"Chocolate bar\",\n \"slug\": \"chocolate-bar\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {},\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"mainCategoryId\": \"643721c3-446e-47f3-87ee-0a58d6842d48\",\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"shippingWeightRange\": {\n \"minValue\": 0.3,\n \"maxValue\": 0.3\n },\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n }\n },\n \"currency\": \"USD\",\n \"subscriptionDetails\": {\n \"subscriptions\": [\n {\n \"id\": \"79851453-0d41-4330-913f-3085904bfa8d\",\n \"title\": \"Weekly subscription\",\n \"description\": \"Get a chocolate bar every week and save 20%!\",\n \"visible\": true,\n \"frequency\": \"WEEK\",\n \"interval\": 1,\n \"autoRenewal\": true,\n \"discount\": {\n \"percentOff\": 20.0,\n \"type\": \"PERCENT\"\n }\n },\n {\n \"id\": \"85c4a167-4c6a-4d6d-9abd-ea654266cfdd\",\n \"title\": \"Monthly subscription\",\n \"description\": \"Get a chocolate bar and save 1.5$ every month!\",\n \"visible\": true,\n \"frequency\": \"MONTH\",\n \"interval\": 1,\n \"billingCycles\": 12,\n \"discount\": {\n \"amountOff\": \"1.5\",\n \"type\": \"AMOUNT\"\n }\n },\n {\n \"id\": \"349a646c-3325-4c65-912e-460e4c4751d6\",\n \"title\": \"Diet subscription\",\n \"description\": \"At least once in a quarter, you deserve a chocolate bar!\",\n \"visible\": true,\n \"frequency\": \"MONTH\",\n \"interval\": 3,\n \"autoRenewal\": true\n }\n ],\n \"allowOneTimePurchases\": true\n }\n },\n {\n \"id\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-07-22T14:04:05.787Z\",\n \"updatedDate\": \"2024-07-22T14:27:55.176Z\",\n \"name\": \"Recyclable Shopping bag\",\n \"slug\": \"shopping-bag\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {},\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"mainCategoryId\": \"643721c3-446e-47f3-87ee-0a58d6842d48\",\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": \"$0.50\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": \"$0.50\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": \"$0.50\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": \"$0.50\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n }\n },\n \"currency\": \"USD\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"cursors\": {\n \"next\": \"acfbebca4bba1dc2a0e8193e3a51a5d49dbe576c.EhoKC2NyZWF0ZWREYXRlEAEaCREAsDEbrA15QhIJGgUaAzEuMCABEioaJhokZGQ4MTg4ODgtZThiOC00ZmI2LTkxN2UtZWM2NDUyODM1NWYxIAEiMQovCgtjcmVhdGVkRGF0ZRIgKh4KHAoDJGd0EhUaEzIwMjQtMDctMjJUMTM6MjI6NDVQAloobmlsZS93aXguc3RvcmVzLmNhdGFsb2cudjMucHJvZHVjdC1wb2N2M2ImCiRjYzdhNGEyOC05YTliLTRjZTAtODE0Mi0yYzllMWYxZTQ5Mjc\"\n },\n \"hasNext\": true\n }\n}"}},{"name":"SearchProducts","type":"METHOD","order":1,"content":{"title":"SearchProducts with filter by variants","request":"curl POST 'https://www.wixapis.com/stores/v3/products/search' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"fields\": [\n \"WEIGHT_MEASUREMENT_UNIT_INFO\",\n \"CURRENCY\"\n ],\n \"search\": {\n \"filter\": {\n \"variantsInfo.variants\": {\n \"$matchItems\": [\n {\n \"visible\": {\n \"$eq\": true\n }\n },\n {\n \"price.actualPrice.amount\": {\n \"$gt\": 1\n }\n },\n {\n \"price.actualPrice.amount\": {\n \"$lt\": 100\n }\n },\n {\n \"sku\": {\n \"$eq\": \"5555\"\n }\n },\n {\n \"barcode\": {\n \"$eq\": \"987\"\n }\n },\n {\n \"choices.optionChoiceIds.optionId\": {\n \"$hasSome\": [\n \"3e85ff44-3763-4946-b9f3-993fd4c5c771\"\n ]\n }\n },\n {\n \"choices.optionChoiceIds.choiceId\": {\n \"$hasSome\": [\n \"0b649a04-b73b-492e-b3c9-315c621b5bd8\"\n ]\n }\n }\n ]\n }\n }\n }\n }'","response":"{\n \"products\": [\n {\n \"id\": \"86c2ac9b-d93f-489c-bfbf-056bb710c276\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-02T09:02:37.777Z\",\n \"updatedDate\": \"2025-01-02T09:02:40.074Z\",\n \"name\": \"Apples\",\n \"slug\": \"apples\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [\n {\n \"id\": \"3e85ff44-3763-4946-b9f3-993fd4c5c771\",\n \"name\": \"Size\",\n \"optionRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"0b649a04-b73b-492e-b3c9-315c621b5bd8\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"s\",\n \"name\": \"s\",\n \"inStock\": false,\n \"visible\": true\n },\n {\n \"choiceId\": \"15ef4e3a-d501-493b-a1ae-51456378cba7\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"l\",\n \"name\": \"l\",\n \"inStock\": false,\n \"visible\": true\n }\n ]\n },\n \"key\": \"Size\"\n }\n ],\n \"modifiers\": [],\n \"brand\": {\n \"id\": \"10f3067e-5109-438f-baf0-30b80ad3ab14\",\n \"name\": \"granny smith\"\n },\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n },\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_afcc2f71-d90a-4fd7-9539-b53fcf4e803e\",\n \"currency\": \"USD\",\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"16.00\",\n \"formattedAmount\": \"$16.00\"\n },\n \"maxValue\": {\n \"amount\": \"20.00\",\n \"formattedAmount\": \"$20.00\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"16.00\",\n \"formattedAmount\": \"$16.00\"\n },\n \"maxValue\": {\n \"amount\": \"25.00\",\n \"formattedAmount\": \"$25.00\"\n }\n },\n \"variantsInfo\": null,\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735808557728000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 2\n },\n \"minVariantPriceInfo\": null\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {\n \"next\": null,\n \"prev\": null\n },\n \"hasNext\": false\n },\n \"aggregationData\": null\n}"}},{"name":"SearchProducts","type":"METHOD","order":4,"content":{"title":"SearchProducts: min and max aggregations","description":"Returns min and max variant prices across all products","request":"curl POST 'https://www.wixapis.com/stores/v3/products/search' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"search\": {\n \"aggregations\": [\n {\n \"type\": \"SCALAR\",\n \"name\": \"min_price\",\n \"field_path\": \"variantsInfo.variants.price.actualPrice.amount\",\n \"scalar\": {\n \"type\": \"MIN\"\n }\n },\n {\n \"type\": \"SCALAR\",\n \"name\": \"max_price\",\n \"field_path\": \"variantsInfo.variants.price.actualPrice.amount\",\n \"scalar\": {\n \"type\": \"MAX\"\n }\n }\n ],\n \"sort\": [],\n \"cursorPaging\": {\n \"limit\": 0\n }\n },\n \"fields\": []\n }'","response":"{\n \"products\": [],\n \"pagingMetadata\": {\n \"count\": 0,\n \"cursors\": {},\n \"hasNext\": false\n },\n \"aggregationData\": {\n \"results\": [\n {\n \"name\": \"min_price\",\n \"type\": \"SCALAR\",\n \"fieldPath\": \"variantsInfo.variants.price.actualPrice.amount\",\n \"scalar\": {\n \"type\": \"MIN\",\n \"value\": 0.5\n }\n },\n {\n \"name\": \"max_price\",\n \"type\": \"SCALAR\",\n \"fieldPath\": \"variantsInfo.variants.price.actualPrice.amount\",\n \"scalar\": {\n \"type\": \"MAX\",\n \"value\": 15.0\n }\n }\n ]\n }\n}"}}],"commonMethodData":{"name":"search","itemField":"product"},"sdkData":{"signature":{"resolved":[{"field":{"path":"search"}},{"parent":{"name":"options","fields":[{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Search products and count per info section","description":"Get a count of how many products are associated with each info section ID.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst options = {\n search: {\n aggregations: [\n {\n name: \"count per info section\",\n type: \"VALUE\",\n fieldPath: \"infoSections.id\",\n value: {}\n }\n ],\n cursorPaging: {\n limit: 0\n }\n }\n};\n\nasync function searchProducts() {\n const response = await productsV3.searchProducts(options);\n}\n\n/* Promise resolves to:\n * {\n * \"products\": [],\n * \"pagingMetadata\": {\n * \"count\": 10,\n * \"cursors\": {},\n * \"hasNext\": false\n * },\n * \"aggregationData\": {\n * \"results\": [\n * {\n * \"name\": \"count per info section\",\n * \"type\": \"VALUE\",\n * \"fieldPath\": \"infoSections.id\",\n * \"values\": {\n * \"results\": [\n * { \"value\": \"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\", \"count\": 3 },\n * { \"value\": \"68926019-a825-41da-9360-a9931ba78d68\", \"count\": 2 }\n * ]\n * }\n * }\n * ]\n * }\n * }\n */\n\n","order":5,"source":"manual"},{"title":"Search products and get price range aggregation","description":"Calculate the minimum and maximum variant prices across the entire catalog without returning products.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst options = {\n fields: [],\n search: {\n aggregations: [\n {\n type: \"SCALAR\",\n name: \"min_price\",\n fieldPath: \"variantsInfo.variants.price.actualPrice.amount\",\n scalar: {\n type: \"MIN\"\n }\n },\n {\n type: \"SCALAR\",\n name: \"max_price\",\n fieldPath: \"variantsInfo.variants.price.actualPrice.amount\",\n scalar: {\n type: \"MAX\"\n }\n }\n ],\n sort: [],\n cursorPaging: {\n limit: 0\n }\n }\n};\n\nasync function searchProducts() {\n const response = await productsV3.searchProducts(options);\n}\n\n/* Promise resolves to:\n * {\n * \"products\": [],\n * \"pagingMetadata\": {\n * \"count\": 10,\n * \"cursors\": {},\n * \"hasNext\": false\n * },\n * \"aggregationData\": {\n * \"results\": [\n * {\n * \"name\": \"min_price\",\n * \"type\": \"SCALAR\",\n * \"fieldPath\": \"variantsInfo.variants.price.actualPrice.amount\",\n * \"scalar\": { \"type\": \"MIN\", \"value\": 0.5 }\n * },\n * {\n * \"name\": \"max_price\",\n * \"type\": \"SCALAR\",\n * \"fieldPath\": \"variantsInfo.variants.price.actualPrice.amount\",\n * \"scalar\": { \"type\": \"MAX\", \"value\": 30 }\n * }\n * ]\n * }\n * }\n */\n\n","order":4,"source":"manual"},{"title":"Search products with pagination","description":"Find products created after July 22, 2024, sorted newest first, returning 2 results per page.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst options = {\n fields: [\n \"WEIGHT_MEASUREMENT_UNIT_INFO\",\n \"CURRENCY\"\n ],\n search: {\n sort: [\n {\n fieldName: \"createdDate\",\n order: \"DESC\"\n }\n ],\n filter: {\n createdDate: {\n $gt: \"2024-07-22T13:22:45\"\n }\n },\n cursorPaging: {\n limit: 2\n }\n }\n};\n\nasync function searchProducts() {\n const response = await productsV3.searchProducts(options);\n}\n\n/* Promise resolves to:\n * {\n * \"products\": [\n * {\n * \"_id\": \"726c1ca9-4998-454f-9d1f-e73bd9edd38c\",\n * \"revision\": \"1\",\n * \"name\": \"Coffee\",\n * \"slug\": \"coffee\",\n * \"visible\": true,\n * \"productType\": \"PHYSICAL\",\n * \"currency\": \"EUR\",\n * \"physicalProperties\": {\n * \"weightMeasurementUnitInfo\": { \"weightMeasurementUnit\": \"KG\" }\n * },\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"9.00\", \"formattedAmount\": \"€9.00\" },\n * \"maxValue\": { \"amount\": \"15.00\", \"formattedAmount\": \"€15.00\" }\n * }\n * },\n * {\n * \"_id\": \"032647c0-005a-47a7-b6b6-d428300fdbe6\",\n * \"revision\": \"2\",\n * \"name\": \"Chocolate bar\",\n * \"slug\": \"chocolate-bar\",\n * \"visible\": true,\n * \"productType\": \"PHYSICAL\",\n * \"currency\": \"EUR\",\n * \"physicalProperties\": {\n * \"weightMeasurementUnitInfo\": { \"weightMeasurementUnit\": \"KG\" }\n * },\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"6.00\", \"formattedAmount\": \"€6.00\" },\n * \"maxValue\": { \"amount\": \"6.00\", \"formattedAmount\": \"€6.00\" }\n * }\n * }\n * ],\n * \"pagingMetadata\": {\n * \"count\": 2,\n * \"cursors\": { \"next\": \"eyJmaWVsZE5hbWUiOiJjcmVhdGVkRGF0ZSIsIm9yZGVyIjoiREVTQyJ9\" },\n * \"hasNext\": true\n * }\n * }\n */\n\n","order":3,"source":"manual"},{"title":"Search products by text","description":"Find products containing \"tea\" in searchable fields like name or description.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst options = {\n fields: [\n \"WEIGHT_MEASUREMENT_UNIT_INFO\",\n \"CURRENCY\"\n ],\n search: {\n search: {\n expression: \"tea\"\n }\n }\n};\n\nasync function searchProducts() {\n const response = await productsV3.searchProducts(options);\n}\n\n/* Promise resolves to:\n * {\n * \"products\": [\n * {\n * \"_id\": \"61fc09a8-d1cf-412a-9f34-3e50334c0fdb\",\n * \"revision\": \"1\",\n * \"name\": \"Coffee\",\n * \"slug\": \"coffee-2\",\n * \"visible\": true,\n * \"productType\": \"PHYSICAL\",\n * \"currency\": \"EUR\",\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"15\", \"formattedAmount\": \"€15.00\" },\n * \"maxValue\": { \"amount\": \"15\", \"formattedAmount\": \"€15.00\" }\n * }\n * }\n * ],\n * \"pagingMetadata\": {\n * \"count\": 3,\n * \"cursors\": {},\n * \"hasNext\": false\n * }\n * }\n */\n\n","order":2,"source":"manual"},{"title":"Search products by variant properties","description":"Find products with visible variants priced between $1-$100, matching a specific SKU, barcode, and option choice.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst options = {\n fields: [\n \"WEIGHT_MEASUREMENT_UNIT_INFO\",\n \"CURRENCY\"\n ],\n search: {\n filter: {\n \"variantsInfo.variants\": {\n $matchItems: [\n {\n visible: {\n $eq: true\n }\n },\n {\n \"price.actualPrice.amount\": {\n $gt: 1\n }\n },\n {\n \"price.actualPrice.amount\": {\n $lt: 100\n }\n },\n {\n sku: {\n $eq: \"5555\"\n }\n },\n {\n barcode: {\n $eq: \"987\"\n }\n },\n {\n \"choices.optionChoiceIds.optionId\": {\n $hasSome: [\n \"3e85ff44-3763-4946-b9f3-993fd4c5c771\"\n ]\n }\n },\n {\n \"choices.optionChoiceIds.choiceId\": {\n $hasSome: [\n \"0b649a04-b73b-492e-b3c9-315c621b5bd8\"\n ]\n }\n }\n ]\n }\n }\n }\n};\n\nasync function searchProducts() {\n const response = await productsV3.searchProducts(options);\n}\n\n/* Promise resolves to:\n * {\n * \"products\": [\n * {\n * \"_id\": \"726c1ca9-4998-454f-9d1f-e73bd9edd38c\",\n * \"revision\": \"1\",\n * \"name\": \"Coffee\",\n * \"slug\": \"coffee\",\n * \"visible\": true,\n * \"productType\": \"PHYSICAL\",\n * \"currency\": \"EUR\",\n * \"physicalProperties\": {\n * \"shippingWeightRange\": { \"minValue\": 0.2, \"maxValue\": 0.4 },\n * \"weightMeasurementUnitInfo\": { \"weightMeasurementUnit\": \"KG\" }\n * },\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"9.00\", \"formattedAmount\": \"€9.00\" },\n * \"maxValue\": { \"amount\": \"15.00\", \"formattedAmount\": \"€15.00\" }\n * }\n * }\n * ],\n * \"pagingMetadata\": {\n * \"count\": 1,\n * \"cursors\": {},\n * \"hasNext\": false\n * }\n * }\n */\n\n","order":1,"source":"manual"},{"title":"searchProducts (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function SearchProducts() {\n const response = await myWixClient.productsV3.SearchProducts();\n};","order":6,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","searchMethodData":{"searchFieldsCapabilitiesMap":{"allCategoriesInfo.categories":{"operators":["$matchItems"],"sort":[],"aggregatable":true,"searchable":false},"directCategoriesInfo.categories":{"operators":["$matchItems"],"sort":[],"aggregatable":true,"searchable":false},"variantsInfo.variants":{"operators":["$matchItems"],"sort":[],"aggregatable":true,"searchable":false},"infoSections.id":{"operators":["$hasAll","$hasSome"],"sort":[],"aggregatable":true,"searchable":false},"infoSections.uniqueName":{"operators":["$hasAll","$hasSome"],"sort":[],"aggregatable":true,"searchable":false},"modifiers.id":{"operators":["$hasAll","$hasSome"],"sort":[],"aggregatable":true,"searchable":false},"modifiers.choicesSettings.choices.choiceId":{"operators":["$hasAll","$hasSome"],"sort":[],"aggregatable":true,"searchable":false},"modifiers.choicesSettings.choices.name":{"operators":["$hasAll","$hasSome"],"sort":[],"aggregatable":true,"searchable":false},"modifiers.name":{"operators":["$hasAll","$hasSome"],"sort":[],"aggregatable":true,"searchable":false},"options.id":{"operators":["$hasAll","$hasSome"],"sort":[],"aggregatable":true,"searchable":false},"options.choicesSettings.choices.choiceId":{"operators":["$hasAll","$hasSome"],"sort":[],"aggregatable":true,"searchable":false},"options.choicesSettings.choices.name":{"operators":["$hasAll","$hasSome"],"sort":[],"aggregatable":true,"searchable":false},"options.name":{"operators":["$hasAll","$hasSome"],"sort":[],"aggregatable":true,"searchable":false},"id":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":[],"aggregatable":true,"searchable":false},"brand.id":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":[],"aggregatable":true,"searchable":false},"brand.name":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":[],"aggregatable":true,"searchable":false},"handle":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":[],"aggregatable":true,"searchable":false},"inventory.availabilityStatus":{"operators":["$eq","$ne","$exists","$in","$any"],"sort":[],"aggregatable":true,"searchable":false},"inventory.preorderAvailability":{"operators":["$eq","$ne","$exists","$in","$any"],"sort":[],"aggregatable":true,"searchable":false},"inventory.preorderStatus":{"operators":["$eq","$ne","$exists","$in","$any"],"sort":[],"aggregatable":true,"searchable":false},"physicalProperties.deliveryProfileId":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":[],"aggregatable":true,"searchable":true},"physicalProperties.fulfillerId":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":[],"aggregatable":true,"searchable":false},"productType":{"operators":["$eq","$ne","$exists","$in","$any"],"sort":[],"aggregatable":true,"searchable":false},"ribbon.id":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":[],"aggregatable":true,"searchable":false},"ribbon.name":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":[],"aggregatable":true,"searchable":false},"slug":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":[],"aggregatable":true,"searchable":false},"subscriptionDetails.allowOneTimePurchases":{"operators":["$eq","$ne","$exists","$in","$any"],"sort":[],"aggregatable":true,"searchable":false},"taxGroupId":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":[],"aggregatable":true,"searchable":false},"visible":{"operators":["$eq","$ne","$exists","$in","$any"],"sort":[],"aggregatable":true,"searchable":false},"visibleInPos":{"operators":["$eq","$ne","$exists","$in","$any"],"sort":[],"aggregatable":true,"searchable":false},"createdDate":{"operators":["$eq","$ne","$exists","$in","$any","$lt","$lte","$gt","$gte"],"sort":["ASC","DESC"],"aggregatable":true,"searchable":false},"updatedDate":{"operators":["$eq","$ne","$exists","$in","$any","$lt","$lte","$gt","$gte"],"sort":["ASC","DESC"],"aggregatable":true,"searchable":false},"actualPriceRange.maxValue.amount":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":["ASC","DESC"],"aggregatable":true,"searchable":false},"actualPriceRange.minValue.amount":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":["ASC","DESC"],"aggregatable":true,"searchable":false},"compareAtPriceRange.maxValue.amount":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":["ASC","DESC"],"aggregatable":true,"searchable":false},"compareAtPriceRange.minValue.amount":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":["ASC","DESC"],"aggregatable":true,"searchable":false},"minVariantPriceInfo.sku":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":["ASC","DESC"],"aggregatable":true,"searchable":true},"name":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":["ASC","DESC"],"aggregatable":true,"searchable":true},"physicalProperties.shippingWeightRange.maxValue":{"operators":["$eq","$ne","$exists","$in","$any","$lt","$lte","$gt","$gte"],"sort":["ASC","DESC"],"aggregatable":true,"searchable":false},"physicalProperties.shippingWeightRange.minValue":{"operators":["$eq","$ne","$exists","$in","$any","$lt","$lte","$gt","$gte"],"sort":["ASC","DESC"],"aggregatable":true,"searchable":false},"description":{"operators":{},"sort":{},"aggregatable":false,"searchable":true},"directCategoryIdsInfo.categoryIds":{"operators":{},"sort":{},"aggregatable":false,"searchable":true},"physicalProperties.shippingGroupId":{"operators":{},"sort":{},"aggregatable":false,"searchable":true},"variantsInfo.variants.sku":{"operators":{},"sort":{},"aggregatable":false,"searchable":true}},"searchAggregrableFields":["_createdDate","_id","_updatedDate","actualPriceRange.maxValue.amount","actualPriceRange.minValue.amount","allCategoriesInfo.categories","allCategoriesInfo.categories._id","allCategoriesInfo.categories.index","brand._id","brand.name","compareAtPriceRange.maxValue.amount","compareAtPriceRange.minValue.amount","directCategoriesInfo.categories","directCategoriesInfo.categories._id","directCategoriesInfo.categories.index","flattenModifiers","flattenOptions","handle","importId","infoSections._id","infoSections.uniqueName","inventory.availabilityStatus","inventory.preorderAvailability","inventory.preorderStatus","minVariantPriceInfo.sku","modifiers._id","modifiers.choicesSettings.choices.choiceId","modifiers.choicesSettings.choices.name","modifiers.name","name","numericId","options._id","options.choicesSettings.choices.choiceId","options.choicesSettings.choices.name","options.name","physicalProperties.deliveryProfileId","physicalProperties.fulfillerId","physicalProperties.shippingGroupId","physicalProperties.shippingWeightRange.maxValue","physicalProperties.shippingWeightRange.minValue","productType","ribbon._id","ribbon.name","slug","subscriptionDetails.allowOneTimePurchases","taxGroupId","variantsInfo.variants","variantsInfo.variants.barcode","variantsInfo.variants.choices.optionChoiceIds.choiceId","variantsInfo.variants.choices.optionChoiceIds.optionId","variantsInfo.variants.physicalProperties.weight","variantsInfo.variants.price.actualPrice.amount","variantsInfo.variants.price.compareAtPrice.amount","variantsInfo.variants.sku","variantsInfo.variants.visible","visible","visibleInPos"]}},"httpMethod":"post","path":"/v3/products/search","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/stores","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products","destinationPath":"/v3/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products","destinationPath":"/v3/bulk/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"www._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://blocks.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://create.editorx/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"create.editorx","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wixapps.net/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://*.dev.wix-code.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://_/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products-with-inventory","destinationPath":"/v3/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products-with-inventory","destinationPath":"/v3/bulk/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/all-products-category","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/all-products-category","destinationPath":"/v3/all-products-category","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}}],"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"NO_PERMISSION_TO_READ_MERCHANT_DATA","description":"The [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities) used to call the method doesn't have the required permissions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"NO_PERMISSION_TO_READ_MERCHANT_DATA"},"name":null},{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"NO_PERMISSION_TO_INCLUDE_NOT_VISIBLE_PRODUCTS","description":"The [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities) used to call the method doesn't have the required permissions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"NO_PERMISSION_TO_INCLUDE_NOT_VISIBLE_PRODUCTS"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_READ","WIX_STORES.PRODUCT_READ_NON_VISIBLE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.SearchProductsRequest","responseMessage":"wix.stores.catalog.v3.SearchProductsResponse"},"legacyExamples":[{"name":"SearchProducts","type":"METHOD","order":2,"content":{"title":"SearchProducts by free text","description":"Enter search expression and find it in `name`, `description` or `variants.sku`","request":"curl POST 'https://www.wixapis.com/stores/v3/products/search' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"fields\": [\n \"WEIGHT_MEASUREMENT_UNIT_INFO\",\n \"CURRENCY\"\n ],\n \"search\": {\n \"search\": {\n \"expression\": \"tea\"\n }\n }\n }'","response":"{\n \"products\": [\n {\n \"id\": \"077eac80-16be-4ca6-96e9-4ffd9b271e1f\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-02T09:09:25.910Z\",\n \"updatedDate\": \"2025-01-02T09:09:27.461Z\",\n \"name\": \"Tea box\",\n \"slug\": \"tea-box-1\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [\n {\n \"id\": \"3e85ff44-3763-4946-b9f3-993fd4c5c771\",\n \"name\": \"Size\",\n \"optionRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"0b649a04-b73b-492e-b3c9-315c621b5bd8\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"s\",\n \"name\": \"s\",\n \"inStock\": false,\n \"visible\": true\n },\n {\n \"choiceId\": \"15ef4e3a-d501-493b-a1ae-51456378cba7\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"l\",\n \"name\": \"l\",\n \"inStock\": false,\n \"visible\": true\n }\n ]\n },\n \"key\": \"Size\"\n }\n ],\n \"modifiers\": [],\n \"brand\": {\n \"id\": \"c0d3bf32-45bb-47ea-a3fe-668242bbba6c\",\n \"name\": \"tea-time\"\n },\n \"infoSections\": [],\n \"ribbon\": {\n \"id\": \"1ffac9ba-f8d7-4b59-a518-767f3e481851\",\n \"name\": \"best seller\"\n },\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": {\n \"quantity\": 100,\n \"measurementUnit\": \"G\"\n },\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": {\n \"minValue\": 0.4,\n \"maxValue\": 0.5\n },\n \"pricePerUnitRange\": {\n \"minValue\": {\n \"value\": \"16.00\",\n \"description\": \"$16.00 / 100 g\"\n },\n \"maxValue\": {\n \"value\": \"20.00\",\n \"description\": \"$20.00 / 100 g\"\n }\n },\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n },\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_3f7f580e-1cf2-4396-bfbf-b9079b78b45b\",\n \"currency\": \"USD\",\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"16.00\",\n \"formattedAmount\": \"$16.00\"\n },\n \"maxValue\": {\n \"amount\": \"20.00\",\n \"formattedAmount\": \"$20.00\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"16.00\",\n \"formattedAmount\": \"$16.00\"\n },\n \"maxValue\": {\n \"amount\": \"25.00\",\n \"formattedAmount\": \"$25.00\"\n }\n },\n \"variantsInfo\": null,\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735808965731000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 2\n },\n \"minVariantPriceInfo\": null\n },\n {\n \"id\": \"f97afbc9-5e37-4c51-803e-777516e6ef85\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-02T08:58:28.666Z\",\n \"updatedDate\": \"2025-01-02T08:58:31.452Z\",\n \"name\": \"Tea box\",\n \"slug\": \"tea-box\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [\n {\n \"id\": \"3e85ff44-3763-4946-b9f3-993fd4c5c771\",\n \"name\": \"Size\",\n \"optionRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"0b649a04-b73b-492e-b3c9-315c621b5bd8\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"s\",\n \"name\": \"s\",\n \"inStock\": false,\n \"visible\": true\n },\n {\n \"choiceId\": \"15ef4e3a-d501-493b-a1ae-51456378cba7\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"l\",\n \"name\": \"l\",\n \"inStock\": false,\n \"visible\": true\n }\n ]\n },\n \"key\": \"Size\"\n }\n ],\n \"modifiers\": [],\n \"brand\": {\n \"id\": \"c0d3bf32-45bb-47ea-a3fe-668242bbba6c\",\n \"name\": \"tea-time\"\n },\n \"infoSections\": [],\n \"ribbon\": {\n \"id\": \"1ffac9ba-f8d7-4b59-a518-767f3e481851\",\n \"name\": \"best seller\"\n },\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n },\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_946bd7ec-78d0-4511-8757-68925290afe1\",\n \"currency\": \"USD\",\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"16.00\",\n \"formattedAmount\": \"$16.00\"\n },\n \"maxValue\": {\n \"amount\": \"20.00\",\n \"formattedAmount\": \"$20.00\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"16.00\",\n \"formattedAmount\": \"$16.00\"\n },\n \"maxValue\": {\n \"amount\": \"25.00\",\n \"formattedAmount\": \"$25.00\"\n }\n },\n \"variantsInfo\": null,\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735808308117000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 2\n },\n \"minVariantPriceInfo\": null\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"cursors\": {\n \"next\": null,\n \"prev\": null\n },\n \"hasNext\": false\n },\n \"aggregationData\": null\n}"}},{"name":"SearchProducts","type":"METHOD","content":{"title":"SearchProducts with filters","description":"Shows examples of supported filters. Pay attention that when filtering by `allCategoriesInfo.categories`, `directCategoriesInfo.categories` or `variantsInfo.variants` you have to use `$matchItems` operator. `$matchAll` is not supported for any other fields.","request":"curl POST 'https://www.wixapis.com/stores/catalog/v3/products/search' \\\n-H 'Content-Type: application/json;charset=UTF-8' \\\n-H 'Authorization: ' \\\n--data-binary '{\n \"fields\": [\n \"ALL_CATEGORIES_INFO\",\n \"WEIGHT_MEASUREMENT_UNIT_INFO\",\n \"CURRENCY\"\n ],\n \"search\": {\n \"filter\": {\n \"$and\": [\n {\n \"allCategoriesInfo.categories\": {\n \"$matchItems\": [\n {\n \"id\": {\n \"$eq\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\"\n }\n }\n ]\n }\n },\n {\n \"productType\": {\n \"$eq\": \"PHYSICAL\"\n }\n },\n {\n \"visible\": {\n \"$eq\": true\n }\n },\n {\n \"brand.id\": {\n \"$eq\": \"c0d3bf32-45bb-47ea-a3fe-668242bbba6c\"\n }\n },\n {\n \"actualPriceRange.minValue.amount\": {\n \"$gt\": 3\n }\n },\n {\n \"actualPriceRange.minValue.amount\": {\n \"$lt\": 120\n }\n },\n {\n \"inventory.availabilityStatus\": {\n \"$in\": [\n \"OUT_OF_STOCK\",\n \"PARTIALLY_OUT_OF_STOCK\"\n ]\n }\n }\n ]\n }\n }\n }'","response":"{\n \"products\": [\n {\n \"id\": \"f97afbc9-5e37-4c51-803e-777516e6ef85\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-02T08:58:28.666Z\",\n \"updatedDate\": \"2025-01-02T08:58:31.452Z\",\n \"name\": \"Tea box\",\n \"slug\": \"tea-box\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [\n {\n \"id\": \"3e85ff44-3763-4946-b9f3-993fd4c5c771\",\n \"name\": \"Size\",\n \"optionRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"0b649a04-b73b-492e-b3c9-315c621b5bd8\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"s\",\n \"name\": \"s\",\n \"inStock\": false,\n \"visible\": true\n },\n {\n \"choiceId\": \"15ef4e3a-d501-493b-a1ae-51456378cba7\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"l\",\n \"name\": \"l\",\n \"inStock\": false,\n \"visible\": true\n }\n ]\n },\n \"key\": \"Size\"\n }\n ],\n \"modifiers\": [],\n \"brand\": {\n \"id\": \"c0d3bf32-45bb-47ea-a3fe-668242bbba6c\",\n \"name\": \"tea-time\"\n },\n \"infoSections\": [],\n \"ribbon\": {\n \"id\": \"1ffac9ba-f8d7-4b59-a518-767f3e481851\",\n \"name\": \"best sellter\"\n },\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": {\n \"categories\": [\n {\n \"id\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"index\": null\n }\n ]\n },\n \"mainCategoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n },\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_946bd7ec-78d0-4511-8757-68925290afe1\",\n \"currency\": \"USD\",\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"16.00\",\n \"formattedAmount\": \"$16.00\"\n },\n \"maxValue\": {\n \"amount\": \"20.00\",\n \"formattedAmount\": \"$20.00\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"16.00\",\n \"formattedAmount\": \"$16.00\"\n },\n \"maxValue\": {\n \"amount\": \"25.00\",\n \"formattedAmount\": \"$25.00\"\n }\n },\n \"variantsInfo\": null,\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735808308117000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 2\n },\n \"minVariantPriceInfo\": null\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {\n \"next\": null,\n \"prev\": null\n },\n \"hasNext\": false\n },\n \"aggregationData\": null\n}"}},{"name":"SearchProducts","type":"METHOD","order":5,"content":{"title":"SearchProducts: count aggregation","description":"Returns number of products assigned to info sections","request":"curl POST 'https://www.wixapis.com/stores/v3/products/search' \\\n-H 'Content-Type: application/json;charset=UTF-8' \\\n-H 'Authorization: ' \\\n-d '{\n \"search\": {\n \"aggregations\": [\n {\n \"name\": \"count per info section\",\n \"type\": \"VALUE\",\n \"field_path\": \"infoSections.id\",\n \"value\": {}\n }\n ],\n \"cursorPaging\": {\n \"limit\": 0\n }\n }\n }'","response":"{\n \"products\": [],\n \"pagingMetadata\": {\n \"count\": 0,\n \"cursors\": {},\n \"hasNext\": false\n },\n \"aggregationData\": {\n \"results\": [\n {\n \"name\": \"count per info section\",\n \"type\": \"VALUE\",\n \"fieldPath\": \"infoSections.id\",\n \"values\": {\n \"results\": [\n {\n \"value\": \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\",\n \"count\": 1\n },\n {\n \"value\": \"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\",\n \"count\": 1\n }\n ]\n }\n }\n ]\n }\n}"}},{"name":"SearchProducts","type":"METHOD","order":3,"content":{"title":"SearchProducts: filter and sort by createdDate","request":"curl POST 'https://www.wixapis.com/stores/v3/products/search' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"fields\": [\n \"WEIGHT_MEASUREMENT_UNIT_INFO\",\n \"CURRENCY\"\n ],\n \"search\": {\n \"sort\": [\n {\n \"field_name\": \"createdDate\",\n \"order\": \"DESC\"\n }\n ],\n \"filter\": {\n \"createdDate\": {\n \"$gt\": \"2024-07-22T13:22:45\"\n }\n },\n \"cursorPaging\": {\n \"limit\": 2\n }\n }\n }'","response":"{\n \"products\": [\n {\n \"id\": \"ac491fa2-f5fc-479f-9123-65bc32d1ad28\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-07-22T14:23:18.780Z\",\n \"updatedDate\": \"2024-07-22T14:25:06.539Z\",\n \"name\": \"Chocolate bar\",\n \"slug\": \"chocolate-bar\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {},\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"mainCategoryId\": \"643721c3-446e-47f3-87ee-0a58d6842d48\",\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"shippingWeightRange\": {\n \"minValue\": 0.3,\n \"maxValue\": 0.3\n },\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n }\n },\n \"currency\": \"USD\",\n \"subscriptionDetails\": {\n \"subscriptions\": [\n {\n \"id\": \"79851453-0d41-4330-913f-3085904bfa8d\",\n \"title\": \"Weekly subscription\",\n \"description\": \"Get a chocolate bar every week and save 20%!\",\n \"visible\": true,\n \"frequency\": \"WEEK\",\n \"interval\": 1,\n \"autoRenewal\": true,\n \"discount\": {\n \"percentOff\": 20.0,\n \"type\": \"PERCENT\"\n }\n },\n {\n \"id\": \"85c4a167-4c6a-4d6d-9abd-ea654266cfdd\",\n \"title\": \"Monthly subscription\",\n \"description\": \"Get a chocolate bar and save 1.5$ every month!\",\n \"visible\": true,\n \"frequency\": \"MONTH\",\n \"interval\": 1,\n \"billingCycles\": 12,\n \"discount\": {\n \"amountOff\": \"1.5\",\n \"type\": \"AMOUNT\"\n }\n },\n {\n \"id\": \"349a646c-3325-4c65-912e-460e4c4751d6\",\n \"title\": \"Diet subscription\",\n \"description\": \"At least once in a quarter, you deserve a chocolate bar!\",\n \"visible\": true,\n \"frequency\": \"MONTH\",\n \"interval\": 3,\n \"autoRenewal\": true\n }\n ],\n \"allowOneTimePurchases\": true\n }\n },\n {\n \"id\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-07-22T14:04:05.787Z\",\n \"updatedDate\": \"2024-07-22T14:27:55.176Z\",\n \"name\": \"Recyclable Shopping bag\",\n \"slug\": \"shopping-bag\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {},\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"mainCategoryId\": \"643721c3-446e-47f3-87ee-0a58d6842d48\",\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": \"$0.50\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": \"$0.50\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": \"$0.50\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": \"$0.50\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n }\n },\n \"currency\": \"USD\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"cursors\": {\n \"next\": \"acfbebca4bba1dc2a0e8193e3a51a5d49dbe576c.EhoKC2NyZWF0ZWREYXRlEAEaCREAsDEbrA15QhIJGgUaAzEuMCABEioaJhokZGQ4MTg4ODgtZThiOC00ZmI2LTkxN2UtZWM2NDUyODM1NWYxIAEiMQovCgtjcmVhdGVkRGF0ZRIgKh4KHAoDJGd0EhUaEzIwMjQtMDctMjJUMTM6MjI6NDVQAloobmlsZS93aXguc3RvcmVzLmNhdGFsb2cudjMucHJvZHVjdC1wb2N2M2ImCiRjYzdhNGEyOC05YTliLTRjZTAtODE0Mi0yYzllMWYxZTQ5Mjc\"\n },\n \"hasNext\": true\n }\n}"}},{"name":"SearchProducts","type":"METHOD","order":1,"content":{"title":"SearchProducts with filter by variants","request":"curl POST 'https://www.wixapis.com/stores/v3/products/search' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"fields\": [\n \"WEIGHT_MEASUREMENT_UNIT_INFO\",\n \"CURRENCY\"\n ],\n \"search\": {\n \"filter\": {\n \"variantsInfo.variants\": {\n \"$matchItems\": [\n {\n \"visible\": {\n \"$eq\": true\n }\n },\n {\n \"price.actualPrice.amount\": {\n \"$gt\": 1\n }\n },\n {\n \"price.actualPrice.amount\": {\n \"$lt\": 100\n }\n },\n {\n \"sku\": {\n \"$eq\": \"5555\"\n }\n },\n {\n \"barcode\": {\n \"$eq\": \"987\"\n }\n },\n {\n \"choices.optionChoiceIds.optionId\": {\n \"$hasSome\": [\n \"3e85ff44-3763-4946-b9f3-993fd4c5c771\"\n ]\n }\n },\n {\n \"choices.optionChoiceIds.choiceId\": {\n \"$hasSome\": [\n \"0b649a04-b73b-492e-b3c9-315c621b5bd8\"\n ]\n }\n }\n ]\n }\n }\n }\n }'","response":"{\n \"products\": [\n {\n \"id\": \"86c2ac9b-d93f-489c-bfbf-056bb710c276\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-02T09:02:37.777Z\",\n \"updatedDate\": \"2025-01-02T09:02:40.074Z\",\n \"name\": \"Apples\",\n \"slug\": \"apples\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [\n {\n \"id\": \"3e85ff44-3763-4946-b9f3-993fd4c5c771\",\n \"name\": \"Size\",\n \"optionRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"0b649a04-b73b-492e-b3c9-315c621b5bd8\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"s\",\n \"name\": \"s\",\n \"inStock\": false,\n \"visible\": true\n },\n {\n \"choiceId\": \"15ef4e3a-d501-493b-a1ae-51456378cba7\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"l\",\n \"name\": \"l\",\n \"inStock\": false,\n \"visible\": true\n }\n ]\n },\n \"key\": \"Size\"\n }\n ],\n \"modifiers\": [],\n \"brand\": {\n \"id\": \"10f3067e-5109-438f-baf0-30b80ad3ab14\",\n \"name\": \"granny smith\"\n },\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n },\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_afcc2f71-d90a-4fd7-9539-b53fcf4e803e\",\n \"currency\": \"USD\",\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"16.00\",\n \"formattedAmount\": \"$16.00\"\n },\n \"maxValue\": {\n \"amount\": \"20.00\",\n \"formattedAmount\": \"$20.00\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"16.00\",\n \"formattedAmount\": \"$16.00\"\n },\n \"maxValue\": {\n \"amount\": \"25.00\",\n \"formattedAmount\": \"$25.00\"\n }\n },\n \"variantsInfo\": null,\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735808557728000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 2\n },\n \"minVariantPriceInfo\": null\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {\n \"next\": null,\n \"prev\": null\n },\n \"hasNext\": false\n },\n \"aggregationData\": null\n}"}},{"name":"SearchProducts","type":"METHOD","order":4,"content":{"title":"SearchProducts: min and max aggregations","description":"Returns min and max variant prices across all products","request":"curl POST 'https://www.wixapis.com/stores/v3/products/search' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"search\": {\n \"aggregations\": [\n {\n \"type\": \"SCALAR\",\n \"name\": \"min_price\",\n \"field_path\": \"variantsInfo.variants.price.actualPrice.amount\",\n \"scalar\": {\n \"type\": \"MIN\"\n }\n },\n {\n \"type\": \"SCALAR\",\n \"name\": \"max_price\",\n \"field_path\": \"variantsInfo.variants.price.actualPrice.amount\",\n \"scalar\": {\n \"type\": \"MAX\"\n }\n }\n ],\n \"sort\": [],\n \"cursorPaging\": {\n \"limit\": 0\n }\n },\n \"fields\": []\n }'","response":"{\n \"products\": [],\n \"pagingMetadata\": {\n \"count\": 0,\n \"cursors\": {},\n \"hasNext\": false\n },\n \"aggregationData\": {\n \"results\": [\n {\n \"name\": \"min_price\",\n \"type\": \"SCALAR\",\n \"fieldPath\": \"variantsInfo.variants.price.actualPrice.amount\",\n \"scalar\": {\n \"type\": \"MIN\",\n \"value\": 0.5\n }\n },\n {\n \"name\": \"max_price\",\n \"type\": \"SCALAR\",\n \"fieldPath\": \"variantsInfo.variants.price.actualPrice.amount\",\n \"scalar\": {\n \"type\": \"MAX\",\n \"value\": 15.0\n }\n }\n ]\n }\n}"}}],"commonMethodData":{"name":"search","itemField":"product"},"sdkData":{"signature":{"resolved":[{"field":{"path":"search"}},{"parent":{"name":"options","fields":[{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Search products and count per info section","description":"Get a count of how many products are associated with each info section ID.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst options = {\n search: {\n aggregations: [\n {\n name: \"count per info section\",\n type: \"VALUE\",\n fieldPath: \"infoSections.id\",\n value: {}\n }\n ],\n cursorPaging: {\n limit: 0\n }\n }\n};\n\nasync function searchProducts() {\n const response = await productsV3.searchProducts(options);\n}\n\n/* Promise resolves to:\n * {\n * \"products\": [],\n * \"pagingMetadata\": {\n * \"count\": 10,\n * \"cursors\": {},\n * \"hasNext\": false\n * },\n * \"aggregationData\": {\n * \"results\": [\n * {\n * \"name\": \"count per info section\",\n * \"type\": \"VALUE\",\n * \"fieldPath\": \"infoSections.id\",\n * \"values\": {\n * \"results\": [\n * { \"value\": \"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\", \"count\": 3 },\n * { \"value\": \"68926019-a825-41da-9360-a9931ba78d68\", \"count\": 2 }\n * ]\n * }\n * }\n * ]\n * }\n * }\n */\n\n","order":5,"source":"manual"},{"title":"Search products and get price range aggregation","description":"Calculate the minimum and maximum variant prices across the entire catalog without returning products.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst options = {\n fields: [],\n search: {\n aggregations: [\n {\n type: \"SCALAR\",\n name: \"min_price\",\n fieldPath: \"variantsInfo.variants.price.actualPrice.amount\",\n scalar: {\n type: \"MIN\"\n }\n },\n {\n type: \"SCALAR\",\n name: \"max_price\",\n fieldPath: \"variantsInfo.variants.price.actualPrice.amount\",\n scalar: {\n type: \"MAX\"\n }\n }\n ],\n sort: [],\n cursorPaging: {\n limit: 0\n }\n }\n};\n\nasync function searchProducts() {\n const response = await productsV3.searchProducts(options);\n}\n\n/* Promise resolves to:\n * {\n * \"products\": [],\n * \"pagingMetadata\": {\n * \"count\": 10,\n * \"cursors\": {},\n * \"hasNext\": false\n * },\n * \"aggregationData\": {\n * \"results\": [\n * {\n * \"name\": \"min_price\",\n * \"type\": \"SCALAR\",\n * \"fieldPath\": \"variantsInfo.variants.price.actualPrice.amount\",\n * \"scalar\": { \"type\": \"MIN\", \"value\": 0.5 }\n * },\n * {\n * \"name\": \"max_price\",\n * \"type\": \"SCALAR\",\n * \"fieldPath\": \"variantsInfo.variants.price.actualPrice.amount\",\n * \"scalar\": { \"type\": \"MAX\", \"value\": 30 }\n * }\n * ]\n * }\n * }\n */\n\n","order":4,"source":"manual"},{"title":"Search products with pagination","description":"Find products created after July 22, 2024, sorted newest first, returning 2 results per page.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst options = {\n fields: [\n \"WEIGHT_MEASUREMENT_UNIT_INFO\",\n \"CURRENCY\"\n ],\n search: {\n sort: [\n {\n fieldName: \"createdDate\",\n order: \"DESC\"\n }\n ],\n filter: {\n createdDate: {\n $gt: \"2024-07-22T13:22:45\"\n }\n },\n cursorPaging: {\n limit: 2\n }\n }\n};\n\nasync function searchProducts() {\n const response = await productsV3.searchProducts(options);\n}\n\n/* Promise resolves to:\n * {\n * \"products\": [\n * {\n * \"_id\": \"726c1ca9-4998-454f-9d1f-e73bd9edd38c\",\n * \"revision\": \"1\",\n * \"name\": \"Coffee\",\n * \"slug\": \"coffee\",\n * \"visible\": true,\n * \"productType\": \"PHYSICAL\",\n * \"currency\": \"EUR\",\n * \"physicalProperties\": {\n * \"weightMeasurementUnitInfo\": { \"weightMeasurementUnit\": \"KG\" }\n * },\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"9.00\", \"formattedAmount\": \"€9.00\" },\n * \"maxValue\": { \"amount\": \"15.00\", \"formattedAmount\": \"€15.00\" }\n * }\n * },\n * {\n * \"_id\": \"032647c0-005a-47a7-b6b6-d428300fdbe6\",\n * \"revision\": \"2\",\n * \"name\": \"Chocolate bar\",\n * \"slug\": \"chocolate-bar\",\n * \"visible\": true,\n * \"productType\": \"PHYSICAL\",\n * \"currency\": \"EUR\",\n * \"physicalProperties\": {\n * \"weightMeasurementUnitInfo\": { \"weightMeasurementUnit\": \"KG\" }\n * },\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"6.00\", \"formattedAmount\": \"€6.00\" },\n * \"maxValue\": { \"amount\": \"6.00\", \"formattedAmount\": \"€6.00\" }\n * }\n * }\n * ],\n * \"pagingMetadata\": {\n * \"count\": 2,\n * \"cursors\": { \"next\": \"eyJmaWVsZE5hbWUiOiJjcmVhdGVkRGF0ZSIsIm9yZGVyIjoiREVTQyJ9\" },\n * \"hasNext\": true\n * }\n * }\n */\n\n","order":3,"source":"manual"},{"title":"Search products by text","description":"Find products containing \"tea\" in searchable fields like name or description.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst options = {\n fields: [\n \"WEIGHT_MEASUREMENT_UNIT_INFO\",\n \"CURRENCY\"\n ],\n search: {\n search: {\n expression: \"tea\"\n }\n }\n};\n\nasync function searchProducts() {\n const response = await productsV3.searchProducts(options);\n}\n\n/* Promise resolves to:\n * {\n * \"products\": [\n * {\n * \"_id\": \"61fc09a8-d1cf-412a-9f34-3e50334c0fdb\",\n * \"revision\": \"1\",\n * \"name\": \"Coffee\",\n * \"slug\": \"coffee-2\",\n * \"visible\": true,\n * \"productType\": \"PHYSICAL\",\n * \"currency\": \"EUR\",\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"15\", \"formattedAmount\": \"€15.00\" },\n * \"maxValue\": { \"amount\": \"15\", \"formattedAmount\": \"€15.00\" }\n * }\n * }\n * ],\n * \"pagingMetadata\": {\n * \"count\": 3,\n * \"cursors\": {},\n * \"hasNext\": false\n * }\n * }\n */\n\n","order":2,"source":"manual"},{"title":"Search products by variant properties","description":"Find products with visible variants priced between $1-$100, matching a specific SKU, barcode, and option choice.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst options = {\n fields: [\n \"WEIGHT_MEASUREMENT_UNIT_INFO\",\n \"CURRENCY\"\n ],\n search: {\n filter: {\n \"variantsInfo.variants\": {\n $matchItems: [\n {\n visible: {\n $eq: true\n }\n },\n {\n \"price.actualPrice.amount\": {\n $gt: 1\n }\n },\n {\n \"price.actualPrice.amount\": {\n $lt: 100\n }\n },\n {\n sku: {\n $eq: \"5555\"\n }\n },\n {\n barcode: {\n $eq: \"987\"\n }\n },\n {\n \"choices.optionChoiceIds.optionId\": {\n $hasSome: [\n \"3e85ff44-3763-4946-b9f3-993fd4c5c771\"\n ]\n }\n },\n {\n \"choices.optionChoiceIds.choiceId\": {\n $hasSome: [\n \"0b649a04-b73b-492e-b3c9-315c621b5bd8\"\n ]\n }\n }\n ]\n }\n }\n }\n};\n\nasync function searchProducts() {\n const response = await productsV3.searchProducts(options);\n}\n\n/* Promise resolves to:\n * {\n * \"products\": [\n * {\n * \"_id\": \"726c1ca9-4998-454f-9d1f-e73bd9edd38c\",\n * \"revision\": \"1\",\n * \"name\": \"Coffee\",\n * \"slug\": \"coffee\",\n * \"visible\": true,\n * \"productType\": \"PHYSICAL\",\n * \"currency\": \"EUR\",\n * \"physicalProperties\": {\n * \"shippingWeightRange\": { \"minValue\": 0.2, \"maxValue\": 0.4 },\n * \"weightMeasurementUnitInfo\": { \"weightMeasurementUnit\": \"KG\" }\n * },\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"9.00\", \"formattedAmount\": \"€9.00\" },\n * \"maxValue\": { \"amount\": \"15.00\", \"formattedAmount\": \"€15.00\" }\n * }\n * }\n * ],\n * \"pagingMetadata\": {\n * \"count\": 1,\n * \"cursors\": {},\n * \"hasNext\": false\n * }\n * }\n */\n\n","order":1,"source":"manual"},{"title":"searchProducts (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function SearchProducts() {\n const response = await myWixClient.productsV3.SearchProducts();\n};","order":6,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","searchMethodData":{"searchFieldsCapabilitiesMap":{"allCategoriesInfo.categories":{"operators":["$matchItems"],"sort":[],"aggregatable":true,"searchable":false},"directCategoriesInfo.categories":{"operators":["$matchItems"],"sort":[],"aggregatable":true,"searchable":false},"variantsInfo.variants":{"operators":["$matchItems"],"sort":[],"aggregatable":true,"searchable":false},"infoSections.id":{"operators":["$hasAll","$hasSome"],"sort":[],"aggregatable":true,"searchable":false},"infoSections.uniqueName":{"operators":["$hasAll","$hasSome"],"sort":[],"aggregatable":true,"searchable":false},"modifiers.id":{"operators":["$hasAll","$hasSome"],"sort":[],"aggregatable":true,"searchable":false},"modifiers.choicesSettings.choices.choiceId":{"operators":["$hasAll","$hasSome"],"sort":[],"aggregatable":true,"searchable":false},"modifiers.choicesSettings.choices.name":{"operators":["$hasAll","$hasSome"],"sort":[],"aggregatable":true,"searchable":false},"modifiers.name":{"operators":["$hasAll","$hasSome"],"sort":[],"aggregatable":true,"searchable":false},"options.id":{"operators":["$hasAll","$hasSome"],"sort":[],"aggregatable":true,"searchable":false},"options.choicesSettings.choices.choiceId":{"operators":["$hasAll","$hasSome"],"sort":[],"aggregatable":true,"searchable":false},"options.choicesSettings.choices.name":{"operators":["$hasAll","$hasSome"],"sort":[],"aggregatable":true,"searchable":false},"options.name":{"operators":["$hasAll","$hasSome"],"sort":[],"aggregatable":true,"searchable":false},"id":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":[],"aggregatable":true,"searchable":false},"brand.id":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":[],"aggregatable":true,"searchable":false},"brand.name":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":[],"aggregatable":true,"searchable":false},"handle":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":[],"aggregatable":true,"searchable":false},"inventory.availabilityStatus":{"operators":["$eq","$ne","$exists","$in","$any"],"sort":[],"aggregatable":true,"searchable":false},"inventory.preorderAvailability":{"operators":["$eq","$ne","$exists","$in","$any"],"sort":[],"aggregatable":true,"searchable":false},"inventory.preorderStatus":{"operators":["$eq","$ne","$exists","$in","$any"],"sort":[],"aggregatable":true,"searchable":false},"physicalProperties.deliveryProfileId":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":[],"aggregatable":true,"searchable":true},"physicalProperties.fulfillerId":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":[],"aggregatable":true,"searchable":false},"productType":{"operators":["$eq","$ne","$exists","$in","$any"],"sort":[],"aggregatable":true,"searchable":false},"ribbon.id":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":[],"aggregatable":true,"searchable":false},"ribbon.name":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":[],"aggregatable":true,"searchable":false},"slug":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":[],"aggregatable":true,"searchable":false},"subscriptionDetails.allowOneTimePurchases":{"operators":["$eq","$ne","$exists","$in","$any"],"sort":[],"aggregatable":true,"searchable":false},"taxGroupId":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":[],"aggregatable":true,"searchable":false},"visible":{"operators":["$eq","$ne","$exists","$in","$any"],"sort":[],"aggregatable":true,"searchable":false},"visibleInPos":{"operators":["$eq","$ne","$exists","$in","$any"],"sort":[],"aggregatable":true,"searchable":false},"createdDate":{"operators":["$eq","$ne","$exists","$in","$any","$lt","$lte","$gt","$gte"],"sort":["ASC","DESC"],"aggregatable":true,"searchable":false},"updatedDate":{"operators":["$eq","$ne","$exists","$in","$any","$lt","$lte","$gt","$gte"],"sort":["ASC","DESC"],"aggregatable":true,"searchable":false},"actualPriceRange.maxValue.amount":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":["ASC","DESC"],"aggregatable":true,"searchable":false},"actualPriceRange.minValue.amount":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":["ASC","DESC"],"aggregatable":true,"searchable":false},"compareAtPriceRange.maxValue.amount":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":["ASC","DESC"],"aggregatable":true,"searchable":false},"compareAtPriceRange.minValue.amount":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":["ASC","DESC"],"aggregatable":true,"searchable":false},"minVariantPriceInfo.sku":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":["ASC","DESC"],"aggregatable":true,"searchable":true},"name":{"operators":["$eq","$ne","$exists","$in","$any","$begins","$gt","$lt","$lte","$gte"],"sort":["ASC","DESC"],"aggregatable":true,"searchable":true},"physicalProperties.shippingWeightRange.maxValue":{"operators":["$eq","$ne","$exists","$in","$any","$lt","$lte","$gt","$gte"],"sort":["ASC","DESC"],"aggregatable":true,"searchable":false},"physicalProperties.shippingWeightRange.minValue":{"operators":["$eq","$ne","$exists","$in","$any","$lt","$lte","$gt","$gte"],"sort":["ASC","DESC"],"aggregatable":true,"searchable":false},"description":{"operators":{},"sort":{},"aggregatable":false,"searchable":true},"directCategoryIdsInfo.categoryIds":{"operators":{},"sort":{},"aggregatable":false,"searchable":true},"physicalProperties.shippingGroupId":{"operators":{},"sort":{},"aggregatable":false,"searchable":true},"variantsInfo.variants.sku":{"operators":{},"sort":{},"aggregatable":false,"searchable":true}},"searchAggregrableFields":["_createdDate","_id","_updatedDate","actualPriceRange.maxValue.amount","actualPriceRange.minValue.amount","allCategoriesInfo.categories","allCategoriesInfo.categories._id","allCategoriesInfo.categories.index","brand._id","brand.name","compareAtPriceRange.maxValue.amount","compareAtPriceRange.minValue.amount","directCategoriesInfo.categories","directCategoriesInfo.categories._id","directCategoriesInfo.categories.index","flattenModifiers","flattenOptions","handle","importId","infoSections._id","infoSections.uniqueName","inventory.availabilityStatus","inventory.preorderAvailability","inventory.preorderStatus","minVariantPriceInfo.sku","modifiers._id","modifiers.choicesSettings.choices.choiceId","modifiers.choicesSettings.choices.name","modifiers.name","name","numericId","options._id","options.choicesSettings.choices.choiceId","options.choicesSettings.choices.name","options.name","physicalProperties.deliveryProfileId","physicalProperties.fulfillerId","physicalProperties.shippingGroupId","physicalProperties.shippingWeightRange.maxValue","physicalProperties.shippingWeightRange.minValue","productType","ribbon._id","ribbon.name","slug","subscriptionDetails.allowOneTimePurchases","taxGroupId","variantsInfo.variants","variantsInfo.variants.barcode","variantsInfo.variants.choices.optionChoiceIds.choiceId","variantsInfo.variants.choices.optionChoiceIds.optionId","variantsInfo.variants.physicalProperties.weight","variantsInfo.variants.price.actualPrice.amount","variantsInfo.variants.price.compareAtPrice.amount","variantsInfo.variants.sku","variantsInfo.variants.visible","visible","visibleInPos"]},"contentLink":{"displayName":"Search Products","slugifiedName":"search-products"},"permissionScopes":[{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"}],"isAdminMethod":false},{"summary":"Count Products","description":"Counts the number of products that match the provided filtering.","operationId":"wix.stores.catalog.v3.CatalogApi.CountProducts","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.CountProductsResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CountProductsRequest","description":"","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","$ref":"#/components/schemas/google.protobuf.Struct","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Free text to match in searchable fields.","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnNonVisibleProducts":{"description":"Whether to return non-visible products (`visible:false`). Your app must have the 'Product v3 read admin' (`SCOPE.STORES.PRODUCT_READ_ADMIN`) permission scope.\n\nDefault: `false`","title":"returnNonVisibleProducts","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"NO_PERMISSION_TO_READ_MERCHANT_DATA","description":"The [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities) used to call the method doesn't have the required permissions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"NO_PERMISSION_TO_READ_MERCHANT_DATA"},"name":null},{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"NO_PERMISSION_TO_INCLUDE_NOT_VISIBLE_PRODUCTS","description":"The [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities) used to call the method doesn't have the required permissions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"NO_PERMISSION_TO_INCLUDE_NOT_VISIBLE_PRODUCTS"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_READ","WIX_STORES.PRODUCT_READ_NON_VISIBLE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.CountProductsRequest","responseMessage":"wix.stores.catalog.v3.CountProductsResponse"},"legacyExamples":[{"name":"CountProducts","type":"METHOD","content":{"title":"CountProducts that satisfy filter or search","request":"curl POST 'https://www.wixapis.com/stores/v3/products/count' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"$and\": [\n {\n \"allCategoriesInfo.categories\": {\n \"$matchItems\": [\n {\n \"id\": {\n \"$eq\": \"643721c3-446e-47f3-87ee-0a58d6842d48\"\n }\n }\n ]\n }\n },\n {\n \"productType\": {\n \"$eq\": \"PHYSICAL\"\n }\n },\n {\n \"visible\": {\n \"$eq\": false\n }\n },\n {\n \"brand.id\": {\n \"$eq\": \"4a16d28d-1736-41f0-87d8-995f6d9a5bdd\"\n }\n },\n {\n \"infoSections.id\": {\n \"$hasSome\": [\n \"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\"\n ]\n }\n },\n {\n \"actualPriceRange.minValue.amount\": {\n \"$gt\": 3\n }\n },\n {\n \"actualPriceRange.minValue.amount\": {\n \"$lt\": 120\n }\n },\n {\n \"inventory.availabilityStatus\": {\n \"$in\": [\n \"OUT_OF_STOCK\",\n \"PARTIALLY_OUT_OF_STOCK\"\n ]\n }\n },\n {\n \"options.choicesSettings.choices.choiceId\": {\n \"$hasSome\": [\n \"4498b805-2aed-43fb-b478-989c906c19cd\"\n ]\n }\n }\n ]\n }'","response":"{\n \"count\": 1\n}"}}],"commonMethodData":{"name":"count"},"sdkData":{"signature":{"resolved":[{"parent":{"name":"options","fields":[{"path":"filter"},{"path":"search"},{"path":"returnNonVisibleProducts"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Count products with filter conditions","description":"Count products with multiple filter conditions including category, type, visibility, brand, info sections, price range, inventory status, and options","content":"import { productsV3 } from \"@wix/stores\";\n\nconst filter = {\n $and: [\n {\n \"allCategoriesInfo.categories\": {\n $matchItems: [\n {\n id: {\n $eq: \"643721c3-446e-47f3-87ee-0a58d6842d48\"\n }\n }\n ]\n }\n },\n {\n productType: {\n $eq: \"PHYSICAL\"\n }\n },\n {\n visible: {\n $eq: false\n }\n },\n {\n \"brand.id\": {\n $eq: \"4a16d28d-1736-41f0-87d8-995f6d9a5bdd\"\n }\n },\n {\n \"infoSections.id\": {\n $hasSome: [\"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\"]\n }\n },\n {\n \"actualPriceRange.minValue.amount\": {\n $gt: 3\n }\n },\n {\n \"actualPriceRange.minValue.amount\": {\n $lt: 120\n }\n },\n {\n \"inventory.availabilityStatus\": {\n $in: [\"OUT_OF_STOCK\", \"PARTIALLY_OUT_OF_STOCK\"]\n }\n },\n {\n \"options.choicesSettings.choices.choiceId\": {\n $hasSome: [\"4498b805-2aed-43fb-b478-989c906c19cd\"]\n }\n }\n ]\n};\n\nasync function countProducts() {\n const response = await productsV3.countProducts({ filter });\n}\n\n/* Promise resolves to:\n * {\n * \"count\": 1\n * }\n */\n\n","order":1,"source":"manual"},{"title":"countProducts (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function CountProducts() {\n const response = await myWixClient.productsV3.CountProducts();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/products/count","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/stores","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products","destinationPath":"/v3/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products","destinationPath":"/v3/bulk/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"www._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://blocks.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://create.editorx/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"create.editorx","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wixapps.net/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://*.dev.wix-code.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://_/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products-with-inventory","destinationPath":"/v3/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products-with-inventory","destinationPath":"/v3/bulk/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/all-products-category","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/all-products-category","destinationPath":"/v3/all-products-category","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}}],"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"NO_PERMISSION_TO_READ_MERCHANT_DATA","description":"The [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities) used to call the method doesn't have the required permissions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"NO_PERMISSION_TO_READ_MERCHANT_DATA"},"name":null},{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"NO_PERMISSION_TO_INCLUDE_NOT_VISIBLE_PRODUCTS","description":"The [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities) used to call the method doesn't have the required permissions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"NO_PERMISSION_TO_INCLUDE_NOT_VISIBLE_PRODUCTS"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_READ","WIX_STORES.PRODUCT_READ_NON_VISIBLE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.CountProductsRequest","responseMessage":"wix.stores.catalog.v3.CountProductsResponse"},"legacyExamples":[{"name":"CountProducts","type":"METHOD","content":{"title":"CountProducts that satisfy filter or search","request":"curl POST 'https://www.wixapis.com/stores/v3/products/count' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"$and\": [\n {\n \"allCategoriesInfo.categories\": {\n \"$matchItems\": [\n {\n \"id\": {\n \"$eq\": \"643721c3-446e-47f3-87ee-0a58d6842d48\"\n }\n }\n ]\n }\n },\n {\n \"productType\": {\n \"$eq\": \"PHYSICAL\"\n }\n },\n {\n \"visible\": {\n \"$eq\": false\n }\n },\n {\n \"brand.id\": {\n \"$eq\": \"4a16d28d-1736-41f0-87d8-995f6d9a5bdd\"\n }\n },\n {\n \"infoSections.id\": {\n \"$hasSome\": [\n \"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\"\n ]\n }\n },\n {\n \"actualPriceRange.minValue.amount\": {\n \"$gt\": 3\n }\n },\n {\n \"actualPriceRange.minValue.amount\": {\n \"$lt\": 120\n }\n },\n {\n \"inventory.availabilityStatus\": {\n \"$in\": [\n \"OUT_OF_STOCK\",\n \"PARTIALLY_OUT_OF_STOCK\"\n ]\n }\n },\n {\n \"options.choicesSettings.choices.choiceId\": {\n \"$hasSome\": [\n \"4498b805-2aed-43fb-b478-989c906c19cd\"\n ]\n }\n }\n ]\n }'","response":"{\n \"count\": 1\n}"}}],"commonMethodData":{"name":"count"},"sdkData":{"signature":{"resolved":[{"parent":{"name":"options","fields":[{"path":"filter"},{"path":"search"},{"path":"returnNonVisibleProducts"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Count products with filter conditions","description":"Count products with multiple filter conditions including category, type, visibility, brand, info sections, price range, inventory status, and options","content":"import { productsV3 } from \"@wix/stores\";\n\nconst filter = {\n $and: [\n {\n \"allCategoriesInfo.categories\": {\n $matchItems: [\n {\n id: {\n $eq: \"643721c3-446e-47f3-87ee-0a58d6842d48\"\n }\n }\n ]\n }\n },\n {\n productType: {\n $eq: \"PHYSICAL\"\n }\n },\n {\n visible: {\n $eq: false\n }\n },\n {\n \"brand.id\": {\n $eq: \"4a16d28d-1736-41f0-87d8-995f6d9a5bdd\"\n }\n },\n {\n \"infoSections.id\": {\n $hasSome: [\"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\"]\n }\n },\n {\n \"actualPriceRange.minValue.amount\": {\n $gt: 3\n }\n },\n {\n \"actualPriceRange.minValue.amount\": {\n $lt: 120\n }\n },\n {\n \"inventory.availabilityStatus\": {\n $in: [\"OUT_OF_STOCK\", \"PARTIALLY_OUT_OF_STOCK\"]\n }\n },\n {\n \"options.choicesSettings.choices.choiceId\": {\n $hasSome: [\"4498b805-2aed-43fb-b478-989c906c19cd\"]\n }\n }\n ]\n};\n\nasync function countProducts() {\n const response = await productsV3.countProducts({ filter });\n}\n\n/* Promise resolves to:\n * {\n * \"count\": 1\n * }\n */\n\n","order":1,"source":"manual"},{"title":"countProducts (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function CountProducts() {\n const response = await myWixClient.productsV3.CountProducts();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Count Products","slugifiedName":"count-products"},"permissionScopes":[{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"}],"isAdminMethod":false},{"summary":"Bulk Create Products","description":"Creates up to 100 products.\n\n>**Note:**\n> The following limits apply to the total number of creatable entities in a single request.\n>\n> + `options`: 100\n> + `modifiers`: 100\n> + `infoSections`: 100\n> + `variantsInfo.variants`: 1000\n>\n> For example, you can create 10 products with up to 10 options for each product (10 x 10 = 100), or 1 product with 100 options.\n> Alternatively, you can create 100 products with up to 10 variants in each (100 x 10 = 1000), or 1 product with 1000 variants.","operationId":"wix.stores.catalog.v3.CatalogApi.BulkCreateProducts","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkCreateProductsResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkCreateProductsRequest","description":"","properties":{"products":{"description":"List of products to create.","minItems":1,"maxItems":100,"title":"products","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the full product entities in the response.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.MultipleEntitiesOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["products","products.name","products.productType","products.variantsInfo","products.variantsInfo.variants","products.variantsInfo.variants.price","products.variantsInfo.variants.price.actualPrice","products.variantsInfo.variants.physicalProperties.pricePerUnit.settings.measurementUnit","products.variantsInfo.variants.digitalProperties.digitalFile","products.variantsInfo.variants.digitalProperties.digitalFile.id","products.physicalProperties.pricePerUnit.measurementUnit","products.subscriptionDetails.subscriptions","products.subscriptionDetails.subscriptions.title","products.subscriptionDetails.subscriptions.frequency","products.subscriptionDetails.subscriptions.discount.type","products.variantsInfo.variants.choices.optionChoiceIds.optionId","products.variantsInfo.variants.choices.optionChoiceIds.choiceId"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Product Created","description":"Triggered when a product is created.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_created","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.BulkCreateProducts","methodName":"BulkCreateProducts","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"MISSING_VARIANT_OPTION_CHOICE","description":"Every variant's choice must reference an existing option in `options.id`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MISSING_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_VARIANT_OPTION_CHOICE","description":"Multiple variants have identical choices in `variantsInfo.variants.choices`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_PRODUCT_OPTIONS","description":"Multiple options have identical `name` and `optionRenderType`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_PRODUCT_OPTIONS"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_DEFAULT_VARIANT","description":"Product with multiple variants has a variant with empty `choices`. Only single-variant products can have empty choices.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_DEFAULT_VARIANT"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"VARIANTS_ARE_NOT_ALIGNED_WITH_PRODUCT","errorSchemaName":"com.wix.stores.catalog.product.api.v3.VariantsNotAlignedWithProduct","description":"Variants aren't aligned with the product. The variant `typedProperties` must match the `productType`, measurement units must align, and each variant must have exactly 1 choice for every option.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"VARIANTS_ARE_NOT_ALIGNED_WITH_PRODUCT"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"DUPLICATE_SLUG_ERROR","description":"There is already a product with this `slug`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_SLUG_ERROR"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"DIGITAL_FILE_NOT_FOUND_ERROR","errorSchemaName":"com.wix.stores.catalog.product.api.v3.InvalidDigitalFileIds","description":"Couldn't find the digital file referenced in `variantsInfo.variants.digitalProperties`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DIGITAL_FILE_NOT_FOUND_ERROR"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"BARCODE_ALREADY_EXIST_ERROR","description":"There is already a variant with this `barcode`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"BARCODE_ALREADY_EXIST_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_BARCODE_ERROR","description":"Multiple variants have identical `barcode` in the request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_BARCODE_ERROR"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SKU_ALREADY_EXIST_ERROR","description":"There is already a variant with this `sku`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"SKU_ALREADY_EXIST_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_SKU_ERROR","description":"Multiple variants have identical `sku` in the request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_SKU_ERROR"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"VARIANT_ID_ALREADY_EXISTS","description":"Multiple variants have identical `id`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"VARIANT_ID_ALREADY_EXISTS"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION","description":"Subscription added to a digital product. Digital products can't have subscriptions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT","description":"All subscriptions are hidden for a subscription-only product. At least 1 subscription must be visible when `allowOneTimePurchases` is false.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT","description":"Subscription discount `amountOff` exceeds the minimum variant price.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS","description":"There is already a subscription with this `id`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PRODUCTS_LIMIT_EXCEEDED","description":"Number of products exceeds the server's limit of 50000.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRODUCTS_LIMIT_EXCEEDED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"PRODUCT_MEDIA_NOT_EXIST","description":"Couldn't find the media referenced in `options.choiceSettings.choices.media`. The media must exist in the product's `media` field.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRODUCT_MEDIA_NOT_EXIST"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ONLY_SPACES_STRING_ERROR","description":"Product `name` field contains only spaces.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ONLY_SPACES_STRING_ERROR"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"BRAND_CREATION_FAILED","description":"Brand creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"BRAND_CREATION_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"RIBBON_NOT_FOUND","description":"Couldn't find the ribbon.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"RIBBON_NOT_FOUND"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"RIBBON_CREATION_FAILED","description":"Ribbon creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"RIBBON_CREATION_FAILED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INFO_SECTION_CREATION_FAILED","description":"Info section creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INFO_SECTION_CREATION_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CUSTOMIZATION_NOT_EXIST","description":"Couldn't find the customization.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CUSTOMIZATION_NOT_EXIST"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"CUSTOMIZATIONS_CREATION_FAILED","description":"Customization creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CUSTOMIZATIONS_CREATION_FAILED"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED","description":"Failed to add customization choices.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CHOICE_NOT_EXIST","description":"Couldn't find the choice.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CHOICE_NOT_EXIST"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRODUCT_OPTION_NAME_AND_TYPE_REQUIRED","description":"Option is missing `name` or `type`. Options without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRODUCT_OPTION_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRODUCT_OPTION_CHOICE_NAME_AND_TYPE_REQUIRED","description":"Option choice is missing `name` or `type`. Choices without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRODUCT_OPTION_CHOICE_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MODIFIER_NAME_AND_TYPE_REQUIRED","description":"Modifier is missing `name` or `type`. Modifiers without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MODIFIER_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MODIFIER_CHOICE_NAME_AND_TYPE_REQUIRED","description":"Modifier choice is missing `name` or `type`. Choices without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MODIFIER_CHOICE_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TOO_MANY_OPTIONS_IN_REQUEST","description":"Number of options exceeds the server's limit.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"TOO_MANY_OPTIONS_IN_REQUEST"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE","description":"The `compareAtPrice` is lower than the `actualPrice`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"VARIANTS_TYPED_PROPERTIES_ARE_NOT_ALIGNED","description":"Variants have different `typedProperties` types. All variants must have the same type.","errorType":"VALIDATION","validationErrorData":{"ruleName":"VARIANTS_TYPED_PROPERTIES_ARE_NOT_ALIGNED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"SUBSCRIPTION_INVALID_AUTO_RENEWAL","description":"The `autoRenewal` field is set to false. Set the number of billing cycles in `billingCycles` to prevent automatic renewal instead.","errorType":"VALIDATION","validationErrorData":{"ruleName":"SUBSCRIPTION_INVALID_AUTO_RENEWAL"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DIGITAL_PRODUCT_CANNOT_BE_VISIBLE_IN_POS","description":"Digital product is marked as visible in POS. Digital products can't be visible in POS.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DIGITAL_PRODUCT_CANNOT_BE_VISIBLE_IN_POS"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DESCRIPTION_SIZE_TOO_BIG","description":"Product `description` field exceeds the maximum size of 32000 bytes.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DESCRIPTION_SIZE_TOO_BIG"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DUPLICATE_MEDIA_ERROR","errorSchemaName":"com.wix.stores.catalog.product.api.v3.DuplicateMediaIdAssignedToProduct","description":"Multiple media items have identical IDs. Each media ID must be unique.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DUPLICATE_MEDIA_ERROR"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"ID_NOT_ALLOWED_IN_REQUEST","description":"Request includes the `id` field. For this operation, `id` is auto-generated and can't be passed in the request.","errorType":"VALIDATION","validationErrorData":{"ruleName":"ID_NOT_ALLOWED_IN_REQUEST"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"BRAND_MISSING_ID","description":"Brand is missing an `id`.","errorType":"VALIDATION","validationErrorData":{"ruleName":"BRAND_MISSING_ID"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRICE_PER_UNIT_NOT_ALIGNED","description":"Price per unit isn't aligned between product and variants.","errorType":"VALIDATION","validationErrorData":{"ruleName":"PRICE_PER_UNIT_NOT_ALIGNED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION_CHOICE","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionChoiceErrorData","description":"Variant choice doesn't exist in the product's option choices.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionErrorData","description":"Variant option doesn't exist in the product's options.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_CREATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkCreateProductsRequest","responseMessage":"wix.stores.catalog.v3.BulkCreateProductsResponse"},"legacyExamples":[{"name":"BulkCreateProducts","type":"METHOD","content":{"title":"Bulk create products","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/create' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"fields\": [\n \"CURRENCY\"\n ],\n \"products\": [\n {\n \"name\": \"Coffee\",\n \"variantsInfo\": {\n \"variants\": [\n {\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"sku\": \"12345\"\n }\n ]\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {}\n },\n {\n \"name\": \"Chocolate bar\",\n \"visible\": false,\n \"variantsInfo\": {\n \"variants\": [\n {\n \"price\": {\n \"compareAtPrice\": {\n \"amount\": \"7.00\",\n \"formattedAmount\": \"$7.00\"\n },\n \"actualPrice\": {\n \"amount\": \"6.00\",\n \"formattedAmount\": \"$6.00\"\n }\n }\n }\n ]\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {}\n }\n ],\n \"returnEntity\": true\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"93f2e5ab-60a5-4173-babb-9198fc52bdd3\",\n \"originalIndex\": 0,\n \"success\": true,\n \"error\": null\n },\n \"item\": {\n \"id\": \"93f2e5ab-60a5-4173-babb-9198fc52bdd3\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-01T09:50:31.438Z\",\n \"updatedDate\": \"2025-01-01T09:50:31.438Z\",\n \"name\": \"Coffee\",\n \"slug\": \"coffee\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": null,\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": null,\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_be600651-94cf-42ad-881f-3bd69fb4a320\",\n \"currency\": null,\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"d44f6c3f-e641-4e54-9cb3-5796e58fa1cd\",\n \"visible\": true,\n \"sku\": \"12345\",\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"compareAtPrice\": null\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": null,\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735725031408000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"932a7008-c31e-43a9-9ba9-d042ad79fd3e\",\n \"originalIndex\": 1,\n \"success\": true,\n \"error\": null\n },\n \"item\": {\n \"id\": \"932a7008-c31e-43a9-9ba9-d042ad79fd3e\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-01T09:50:31.438Z\",\n \"updatedDate\": \"2025-01-01T09:50:31.438Z\",\n \"name\": \"Chocolate bar\",\n \"slug\": \"chocolate-bar\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": false,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": null,\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": null,\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_b42607d1-bc36-44e7-a2a9-127be6ee3625\",\n \"currency\": null,\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"6.00\",\n \"formattedAmount\": \"$6.00\"\n },\n \"maxValue\": {\n \"amount\": \"6.00\",\n \"formattedAmount\": \"$6.00\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"7.00\",\n \"formattedAmount\": \"$7.00\"\n },\n \"maxValue\": {\n \"amount\": \"7.00\",\n \"formattedAmount\": \"$7.00\"\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"2eae6a6b-05d3-46ba-85a0-2cf9e6cdd4a7\",\n \"visible\": true,\n \"sku\": null,\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"6.00\",\n \"formattedAmount\": \"$6.00\"\n },\n \"compareAtPrice\": {\n \"amount\": \"7.00\",\n \"formattedAmount\": \"$7.00\"\n }\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": null,\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735725031408001\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"commonMethodData":{"name":"bulkCreate","itemField":"products"},"sdkData":{"signature":{"resolved":[{"field":{"path":"products"}},{"parent":{"name":"options","fields":[{"path":"returnEntity"},{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Bulk create products","description":"","content":"import { productsV3 } from \"@wix/stores\";\n\nconst products = [\n {\n name: \"Coffee\",\n variantsInfo: {\n variants: [\n {\n price: {\n actualPrice: {\n amount: \"10.00\",\n formattedAmount: \"$10.00\",\n },\n },\n sku: \"12345\",\n },\n ],\n },\n productType: \"PHYSICAL\",\n physicalProperties: {},\n },\n {\n name: \"Chocolate bar\",\n visible: false,\n variantsInfo: {\n variants: [\n {\n price: {\n compareAtPrice: {\n amount: \"7.00\",\n formattedAmount: \"$7.00\",\n },\n actualPrice: {\n amount: \"6.00\",\n formattedAmount: \"$6.00\",\n },\n },\n },\n ],\n },\n productType: \"PHYSICAL\",\n physicalProperties: {},\n },\n];\n\nconst options = {\n fields: [\"CURRENCY\"],\n returnEntity: true,\n};\n\nasync function bulkCreateProducts() {\n const response = await productsV3.bulkCreateProducts(products, options);\n}\n","order":1,"source":"manual"},{"title":"bulkCreateProducts (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function BulkCreateProducts() {\n const response = await myWixClient.productsV3.BulkCreateProducts();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products/create","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/stores","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products","destinationPath":"/v3/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products","destinationPath":"/v3/bulk/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"www._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://blocks.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://create.editorx/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"create.editorx","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wixapps.net/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://*.dev.wix-code.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://_/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products-with-inventory","destinationPath":"/v3/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products-with-inventory","destinationPath":"/v3/bulk/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/all-products-category","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/all-products-category","destinationPath":"/v3/all-products-category","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}}],"triggeredEvents":[{"title":"Product Created","description":"Triggered when a product is created.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_created","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.BulkCreateProducts","methodName":"BulkCreateProducts","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"MISSING_VARIANT_OPTION_CHOICE","description":"Every variant's choice must reference an existing option in `options.id`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MISSING_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_VARIANT_OPTION_CHOICE","description":"Multiple variants have identical choices in `variantsInfo.variants.choices`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_PRODUCT_OPTIONS","description":"Multiple options have identical `name` and `optionRenderType`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_PRODUCT_OPTIONS"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_DEFAULT_VARIANT","description":"Product with multiple variants has a variant with empty `choices`. Only single-variant products can have empty choices.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_DEFAULT_VARIANT"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"VARIANTS_ARE_NOT_ALIGNED_WITH_PRODUCT","errorSchemaName":"com.wix.stores.catalog.product.api.v3.VariantsNotAlignedWithProduct","description":"Variants aren't aligned with the product. The variant `typedProperties` must match the `productType`, measurement units must align, and each variant must have exactly 1 choice for every option.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"VARIANTS_ARE_NOT_ALIGNED_WITH_PRODUCT"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"DUPLICATE_SLUG_ERROR","description":"There is already a product with this `slug`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_SLUG_ERROR"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"DIGITAL_FILE_NOT_FOUND_ERROR","errorSchemaName":"com.wix.stores.catalog.product.api.v3.InvalidDigitalFileIds","description":"Couldn't find the digital file referenced in `variantsInfo.variants.digitalProperties`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DIGITAL_FILE_NOT_FOUND_ERROR"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"BARCODE_ALREADY_EXIST_ERROR","description":"There is already a variant with this `barcode`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"BARCODE_ALREADY_EXIST_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_BARCODE_ERROR","description":"Multiple variants have identical `barcode` in the request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_BARCODE_ERROR"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SKU_ALREADY_EXIST_ERROR","description":"There is already a variant with this `sku`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"SKU_ALREADY_EXIST_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_SKU_ERROR","description":"Multiple variants have identical `sku` in the request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_SKU_ERROR"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"VARIANT_ID_ALREADY_EXISTS","description":"Multiple variants have identical `id`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"VARIANT_ID_ALREADY_EXISTS"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION","description":"Subscription added to a digital product. Digital products can't have subscriptions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT","description":"All subscriptions are hidden for a subscription-only product. At least 1 subscription must be visible when `allowOneTimePurchases` is false.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT","description":"Subscription discount `amountOff` exceeds the minimum variant price.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS","description":"There is already a subscription with this `id`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PRODUCTS_LIMIT_EXCEEDED","description":"Number of products exceeds the server's limit of 50000.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRODUCTS_LIMIT_EXCEEDED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"PRODUCT_MEDIA_NOT_EXIST","description":"Couldn't find the media referenced in `options.choiceSettings.choices.media`. The media must exist in the product's `media` field.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRODUCT_MEDIA_NOT_EXIST"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ONLY_SPACES_STRING_ERROR","description":"Product `name` field contains only spaces.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ONLY_SPACES_STRING_ERROR"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"BRAND_CREATION_FAILED","description":"Brand creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"BRAND_CREATION_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"RIBBON_NOT_FOUND","description":"Couldn't find the ribbon.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"RIBBON_NOT_FOUND"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"RIBBON_CREATION_FAILED","description":"Ribbon creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"RIBBON_CREATION_FAILED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INFO_SECTION_CREATION_FAILED","description":"Info section creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INFO_SECTION_CREATION_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CUSTOMIZATION_NOT_EXIST","description":"Couldn't find the customization.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CUSTOMIZATION_NOT_EXIST"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"CUSTOMIZATIONS_CREATION_FAILED","description":"Customization creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CUSTOMIZATIONS_CREATION_FAILED"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED","description":"Failed to add customization choices.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CHOICE_NOT_EXIST","description":"Couldn't find the choice.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CHOICE_NOT_EXIST"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRODUCT_OPTION_NAME_AND_TYPE_REQUIRED","description":"Option is missing `name` or `type`. Options without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRODUCT_OPTION_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRODUCT_OPTION_CHOICE_NAME_AND_TYPE_REQUIRED","description":"Option choice is missing `name` or `type`. Choices without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRODUCT_OPTION_CHOICE_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MODIFIER_NAME_AND_TYPE_REQUIRED","description":"Modifier is missing `name` or `type`. Modifiers without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MODIFIER_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MODIFIER_CHOICE_NAME_AND_TYPE_REQUIRED","description":"Modifier choice is missing `name` or `type`. Choices without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MODIFIER_CHOICE_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TOO_MANY_OPTIONS_IN_REQUEST","description":"Number of options exceeds the server's limit.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"TOO_MANY_OPTIONS_IN_REQUEST"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE","description":"The `compareAtPrice` is lower than the `actualPrice`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"VARIANTS_TYPED_PROPERTIES_ARE_NOT_ALIGNED","description":"Variants have different `typedProperties` types. All variants must have the same type.","errorType":"VALIDATION","validationErrorData":{"ruleName":"VARIANTS_TYPED_PROPERTIES_ARE_NOT_ALIGNED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"SUBSCRIPTION_INVALID_AUTO_RENEWAL","description":"The `autoRenewal` field is set to false. Set the number of billing cycles in `billingCycles` to prevent automatic renewal instead.","errorType":"VALIDATION","validationErrorData":{"ruleName":"SUBSCRIPTION_INVALID_AUTO_RENEWAL"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DIGITAL_PRODUCT_CANNOT_BE_VISIBLE_IN_POS","description":"Digital product is marked as visible in POS. Digital products can't be visible in POS.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DIGITAL_PRODUCT_CANNOT_BE_VISIBLE_IN_POS"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DESCRIPTION_SIZE_TOO_BIG","description":"Product `description` field exceeds the maximum size of 32000 bytes.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DESCRIPTION_SIZE_TOO_BIG"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DUPLICATE_MEDIA_ERROR","errorSchemaName":"com.wix.stores.catalog.product.api.v3.DuplicateMediaIdAssignedToProduct","description":"Multiple media items have identical IDs. Each media ID must be unique.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DUPLICATE_MEDIA_ERROR"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"ID_NOT_ALLOWED_IN_REQUEST","description":"Request includes the `id` field. For this operation, `id` is auto-generated and can't be passed in the request.","errorType":"VALIDATION","validationErrorData":{"ruleName":"ID_NOT_ALLOWED_IN_REQUEST"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"BRAND_MISSING_ID","description":"Brand is missing an `id`.","errorType":"VALIDATION","validationErrorData":{"ruleName":"BRAND_MISSING_ID"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRICE_PER_UNIT_NOT_ALIGNED","description":"Price per unit isn't aligned between product and variants.","errorType":"VALIDATION","validationErrorData":{"ruleName":"PRICE_PER_UNIT_NOT_ALIGNED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION_CHOICE","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionChoiceErrorData","description":"Variant choice doesn't exist in the product's option choices.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionErrorData","description":"Variant option doesn't exist in the product's options.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_CREATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkCreateProductsRequest","responseMessage":"wix.stores.catalog.v3.BulkCreateProductsResponse"},"legacyExamples":[{"name":"BulkCreateProducts","type":"METHOD","content":{"title":"Bulk create products","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/create' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"fields\": [\n \"CURRENCY\"\n ],\n \"products\": [\n {\n \"name\": \"Coffee\",\n \"variantsInfo\": {\n \"variants\": [\n {\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"sku\": \"12345\"\n }\n ]\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {}\n },\n {\n \"name\": \"Chocolate bar\",\n \"visible\": false,\n \"variantsInfo\": {\n \"variants\": [\n {\n \"price\": {\n \"compareAtPrice\": {\n \"amount\": \"7.00\",\n \"formattedAmount\": \"$7.00\"\n },\n \"actualPrice\": {\n \"amount\": \"6.00\",\n \"formattedAmount\": \"$6.00\"\n }\n }\n }\n ]\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {}\n }\n ],\n \"returnEntity\": true\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"93f2e5ab-60a5-4173-babb-9198fc52bdd3\",\n \"originalIndex\": 0,\n \"success\": true,\n \"error\": null\n },\n \"item\": {\n \"id\": \"93f2e5ab-60a5-4173-babb-9198fc52bdd3\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-01T09:50:31.438Z\",\n \"updatedDate\": \"2025-01-01T09:50:31.438Z\",\n \"name\": \"Coffee\",\n \"slug\": \"coffee\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": null,\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": null,\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_be600651-94cf-42ad-881f-3bd69fb4a320\",\n \"currency\": null,\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"d44f6c3f-e641-4e54-9cb3-5796e58fa1cd\",\n \"visible\": true,\n \"sku\": \"12345\",\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"compareAtPrice\": null\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": null,\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735725031408000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"932a7008-c31e-43a9-9ba9-d042ad79fd3e\",\n \"originalIndex\": 1,\n \"success\": true,\n \"error\": null\n },\n \"item\": {\n \"id\": \"932a7008-c31e-43a9-9ba9-d042ad79fd3e\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-01T09:50:31.438Z\",\n \"updatedDate\": \"2025-01-01T09:50:31.438Z\",\n \"name\": \"Chocolate bar\",\n \"slug\": \"chocolate-bar\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": false,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": null,\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": null,\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_b42607d1-bc36-44e7-a2a9-127be6ee3625\",\n \"currency\": null,\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"6.00\",\n \"formattedAmount\": \"$6.00\"\n },\n \"maxValue\": {\n \"amount\": \"6.00\",\n \"formattedAmount\": \"$6.00\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"7.00\",\n \"formattedAmount\": \"$7.00\"\n },\n \"maxValue\": {\n \"amount\": \"7.00\",\n \"formattedAmount\": \"$7.00\"\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"2eae6a6b-05d3-46ba-85a0-2cf9e6cdd4a7\",\n \"visible\": true,\n \"sku\": null,\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"6.00\",\n \"formattedAmount\": \"$6.00\"\n },\n \"compareAtPrice\": {\n \"amount\": \"7.00\",\n \"formattedAmount\": \"$7.00\"\n }\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": null,\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735725031408001\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"commonMethodData":{"name":"bulkCreate","itemField":"products"},"sdkData":{"signature":{"resolved":[{"field":{"path":"products"}},{"parent":{"name":"options","fields":[{"path":"returnEntity"},{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Bulk create products","description":"","content":"import { productsV3 } from \"@wix/stores\";\n\nconst products = [\n {\n name: \"Coffee\",\n variantsInfo: {\n variants: [\n {\n price: {\n actualPrice: {\n amount: \"10.00\",\n formattedAmount: \"$10.00\",\n },\n },\n sku: \"12345\",\n },\n ],\n },\n productType: \"PHYSICAL\",\n physicalProperties: {},\n },\n {\n name: \"Chocolate bar\",\n visible: false,\n variantsInfo: {\n variants: [\n {\n price: {\n compareAtPrice: {\n amount: \"7.00\",\n formattedAmount: \"$7.00\",\n },\n actualPrice: {\n amount: \"6.00\",\n formattedAmount: \"$6.00\",\n },\n },\n },\n ],\n },\n productType: \"PHYSICAL\",\n physicalProperties: {},\n },\n];\n\nconst options = {\n fields: [\"CURRENCY\"],\n returnEntity: true,\n};\n\nasync function bulkCreateProducts() {\n const response = await productsV3.bulkCreateProducts(products, options);\n}\n","order":1,"source":"manual"},{"title":"bulkCreateProducts (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function BulkCreateProducts() {\n const response = await myWixClient.productsV3.BulkCreateProducts();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Create Products","slugifiedName":"bulk-create-products"},"permissionScopes":[{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}],"isAdminMethod":true},{"summary":"Bulk Delete Products","description":"Deletes multiple products.","operationId":"wix.stores.catalog.v3.CatalogApi.BulkDeleteProducts","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkDeleteProductsResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkDeleteProductsRequest","description":"","properties":{"productIds":{"description":"IDs of products to delete.","minLength":1,"maxLength":36,"minItems":1,"maxItems":100,"title":"productIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["productIds"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Product Deleted","description":"Triggered when a product is deleted.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_deleted","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.BulkDeleteProducts","methodName":"BulkDeleteProducts","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DUPLICATE_PRODUCT_IDS_REQUEST","description":"Multiple products have identical IDs in the request.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DUPLICATE_PRODUCT_IDS_REQUEST"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_DELETE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkDeleteProductsRequest","responseMessage":"wix.stores.catalog.v3.BulkDeleteProductsResponse"},"legacyExamples":[{"name":"BulkDeleteProducts","type":"METHOD","content":{"title":"Bulk delete products by ids from store","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/delete' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"productIds\": [\n \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"ac491fa2-f5fc-479f-9123-65bc32d1ad28\"\n ]\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"ac491fa2-f5fc-479f-9123-65bc32d1ad28\",\n \"originalIndex\": 1,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"commonMethodData":{"name":"bulkDelete"},"sdkData":{"signature":{"resolved":[{"field":{"path":"productIds"}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Bulk delete products by ID","description":"","content":"import { productsV3 } from \"@wix/stores\";\n\nconst productIds = [\n \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"ac491fa2-f5fc-479f-9123-65bc32d1ad28\"\n];\n\nasync function bulkDeleteProducts() {\n const response = await productsV3.bulkDeleteProducts(productIds);\n}\n\n/* Promise resolves to:\n * {\n * \"results\": [\n * {\n * \"itemMetadata\": {\n * \"id\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n * \"originalIndex\": 0,\n * \"success\": true\n * }\n * },\n * {\n * \"itemMetadata\": {\n * \"id\": \"ac491fa2-f5fc-479f-9123-65bc32d1ad28\",\n * \"originalIndex\": 1,\n * \"success\": true\n * }\n * }\n * ],\n * \"bulkActionMetadata\": {\n * \"totalSuccesses\": 2,\n * \"totalFailures\": 0\n * }\n * }\n */\n\n","order":1,"source":"manual"},{"title":"bulkDeleteProducts (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function BulkDeleteProducts() {\n const response = await myWixClient.productsV3.BulkDeleteProducts();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products/delete","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/stores","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products","destinationPath":"/v3/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products","destinationPath":"/v3/bulk/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"www._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://blocks.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://create.editorx/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"create.editorx","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wixapps.net/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://*.dev.wix-code.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://_/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products-with-inventory","destinationPath":"/v3/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products-with-inventory","destinationPath":"/v3/bulk/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/all-products-category","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/all-products-category","destinationPath":"/v3/all-products-category","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}}],"triggeredEvents":[{"title":"Product Deleted","description":"Triggered when a product is deleted.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_deleted","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.BulkDeleteProducts","methodName":"BulkDeleteProducts","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DUPLICATE_PRODUCT_IDS_REQUEST","description":"Multiple products have identical IDs in the request.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DUPLICATE_PRODUCT_IDS_REQUEST"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_DELETE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkDeleteProductsRequest","responseMessage":"wix.stores.catalog.v3.BulkDeleteProductsResponse"},"legacyExamples":[{"name":"BulkDeleteProducts","type":"METHOD","content":{"title":"Bulk delete products by ids from store","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/delete' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"productIds\": [\n \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"ac491fa2-f5fc-479f-9123-65bc32d1ad28\"\n ]\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"ac491fa2-f5fc-479f-9123-65bc32d1ad28\",\n \"originalIndex\": 1,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"commonMethodData":{"name":"bulkDelete"},"sdkData":{"signature":{"resolved":[{"field":{"path":"productIds"}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Bulk delete products by ID","description":"","content":"import { productsV3 } from \"@wix/stores\";\n\nconst productIds = [\n \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"ac491fa2-f5fc-479f-9123-65bc32d1ad28\"\n];\n\nasync function bulkDeleteProducts() {\n const response = await productsV3.bulkDeleteProducts(productIds);\n}\n\n/* Promise resolves to:\n * {\n * \"results\": [\n * {\n * \"itemMetadata\": {\n * \"id\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n * \"originalIndex\": 0,\n * \"success\": true\n * }\n * },\n * {\n * \"itemMetadata\": {\n * \"id\": \"ac491fa2-f5fc-479f-9123-65bc32d1ad28\",\n * \"originalIndex\": 1,\n * \"success\": true\n * }\n * }\n * ],\n * \"bulkActionMetadata\": {\n * \"totalSuccesses\": 2,\n * \"totalFailures\": 0\n * }\n * }\n */\n\n","order":1,"source":"manual"},{"title":"bulkDeleteProducts (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function BulkDeleteProducts() {\n const response = await myWixClient.productsV3.BulkDeleteProducts();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Delete Products","slugifiedName":"bulk-delete-products"},"permissionScopes":[{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}],"isAdminMethod":true},{"summary":"Bulk Update Products","description":"Updates up to 100 products.\n\n>**Note:**\n> The following limits apply to the total number of updatable entities in a single request.\n> For example, you can update 10 products with up to 10 options for each product (10 x 10 = 100), or one product with 100 options.\n> Alternatively, you can update 100 products with up to 10 variants in each (100 x 10 = 1000), or one product with 1000 variants.\n> + `options`: 100\n> + `modifiers`: 100\n> + `infoSections`: 100\n> + `variantsInfo.variants`: 1000","operationId":"wix.stores.catalog.v3.CatalogApi.BulkUpdateProducts","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkUpdateProductsResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkUpdateProductsRequest","description":"","properties":{"products":{"description":"List of products to update.","minItems":1,"maxItems":100,"title":"products","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.v3.MaskedProduct"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the full product entities in the response.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.MultipleEntitiesOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["products","products.product","products.product.id","products.product.revision","products.product.variantsInfo.variants.price","products.product.variantsInfo.variants.price.actualPrice","products.product.variantsInfo.variants.physicalProperties.pricePerUnit.settings.measurementUnit","products.product.variantsInfo.variants.digitalProperties.digitalFile","products.product.variantsInfo.variants.digitalProperties.digitalFile.id","products.product.variantsInfo.variants.choices.optionChoiceIds.optionId","products.product.variantsInfo.variants.choices.optionChoiceIds.choiceId","products.product.physicalProperties.pricePerUnit.measurementUnit","products.product.subscriptionDetails.subscriptions.title","products.product.subscriptionDetails.subscriptions.frequency","products.product.subscriptionDetails.subscriptions.discount.type"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_updated","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.BulkUpdateProducts","methodName":"BulkUpdateProducts","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"TOO_MANY_VARIANTS","description":"Number of variants exceeds the server's limit of 1000 per request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"TOO_MANY_VARIANTS"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"MISSING_VARIANT_OPTION_CHOICE","description":"Every variant's choice must reference an existing option in `options.id`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MISSING_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_VARIANT_OPTION_CHOICE","description":"Multiple variants have identical choices in `variantsInfo.variants.choices`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_PRODUCT_OPTIONS","description":"Multiple options have identical `name` and `optionRenderType`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_PRODUCT_OPTIONS"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_DEFAULT_VARIANT","description":"Product with multiple variants has a variant with empty `choices`. Only single-variant products can have empty choices.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_DEFAULT_VARIANT"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FIELD_MASK_VALUE_NOT_SUPPORTED","errorSchemaName":"com.wix.stores.catalog.product.api.v3.UnsupportedFieldMasks","description":"Update field mask includes read-only fields.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"FIELD_MASK_VALUE_NOT_SUPPORTED"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"VARIANTS_ARE_NOT_ALIGNED_WITH_PRODUCT","errorSchemaName":"com.wix.stores.catalog.product.api.v3.VariantsNotAlignedWithProduct","description":"Variants aren't aligned with the product. The variant `typedProperties` must match the `productType`, measurement units must align, and each variant must have exactly 1 choice for every option.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"VARIANTS_ARE_NOT_ALIGNED_WITH_PRODUCT"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"DUPLICATE_SLUG_ERROR","description":"There is already a product with this `slug`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_SLUG_ERROR"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"DIGITAL_FILE_NOT_FOUND_ERROR","description":"Couldn't find the digital file referenced in `variantsInfo.variants.digitalProperties`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DIGITAL_FILE_NOT_FOUND_ERROR"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"BARCODE_ALREADY_EXIST_ERROR","description":"There is already a variant with this `barcode`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"BARCODE_ALREADY_EXIST_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_BARCODE_ERROR","description":"Multiple variants have identical `barcode` in the request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_BARCODE_ERROR"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SKU_ALREADY_EXIST_ERROR","description":"There is already a variant with this `sku`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"SKU_ALREADY_EXIST_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_SKU_ERROR","description":"Multiple variants have identical `sku` in the request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_SKU_ERROR"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"VARIANT_ID_ALREADY_EXISTS","description":"Multiple variants have identical `id`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"VARIANT_ID_ALREADY_EXISTS"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION","description":"Subscription added to a digital product. Digital products can't have subscriptions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT","description":"All subscriptions are hidden for a subscription-only product. At least 1 subscription must be visible when `allowOneTimePurchases` is false.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT","description":"Subscription discount `amountOff` exceeds the minimum variant price.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS","description":"Multiple subscriptions have identical IDs.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PREORDER_VALIDATION_ERROR","description":"Variant enabled for preorder on a subscription product. Products with subscriptions can't have preorder variants.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PREORDER_VALIDATION_ERROR"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"BRAND_CREATION_FAILED","description":"Brand creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"BRAND_CREATION_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"RIBBON_NOT_FOUND","description":"Couldn't find the ribbon.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"RIBBON_NOT_FOUND"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INFO_SECTION_ERROR_OCCURRED","description":"Info section update failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INFO_SECTION_ERROR_OCCURRED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CUSTOMIZATION_NOT_EXIST","description":"Couldn't find the customization.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CUSTOMIZATION_NOT_EXIST"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED","description":"Failed to add customization choices.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CHOICE_NOT_EXIST","description":"Couldn't find the choice.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CHOICE_NOT_EXIST"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TOO_MANY_OPTIONS_IN_REQUEST","description":"Number of options exceeds the server's limit.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"TOO_MANY_OPTIONS_IN_REQUEST"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR","description":"Field mask includes fields not provided in the request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE","description":"The `compareAtPrice` is lower than the `actualPrice`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"VARIANTS_TYPED_PROPERTIES_ARE_NOT_ALIGNED","description":"Variants have different `typedProperties` types. All variants must have the same type.","errorType":"VALIDATION","validationErrorData":{"ruleName":"VARIANTS_TYPED_PROPERTIES_ARE_NOT_ALIGNED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_OPTIONS_ON_UPDATE_VARIANTS","description":"Update request includes `variants` but is missing `options`. Both must be provided together.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_OPTIONS_ON_UPDATE_VARIANTS"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"SUBSCRIPTION_INVALID_AUTO_RENEWAL","description":"The `autoRenewal` field is set to false. Set the number of billing cycles in `billingCycles` to prevent automatic renewal instead.","errorType":"VALIDATION","validationErrorData":{"ruleName":"SUBSCRIPTION_INVALID_AUTO_RENEWAL"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DIGITAL_PRODUCT_CANNOT_BE_VISIBLE_IN_POS","description":"Digital product is marked as visible in POS. Digital products can't be visible in POS.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DIGITAL_PRODUCT_CANNOT_BE_VISIBLE_IN_POS"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DESCRIPTION_SIZE_TOO_BIG","description":"Product `description` field exceeds the maximum size of 32000 bytes.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DESCRIPTION_SIZE_TOO_BIG"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DUPLICATE_MEDIA_ERROR","errorSchemaName":"com.wix.stores.catalog.product.api.v3.DuplicateMediaIdAssignedToProduct","description":"Multiple media items have identical IDs. Each media ID must be unique.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DUPLICATE_MEDIA_ERROR"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"BRAND_MISSING_ID","description":"Brand is missing an `id`.","errorType":"VALIDATION","validationErrorData":{"ruleName":"BRAND_MISSING_ID"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DUPLICATE_PRODUCT_IDS_REQUEST","description":"Multiple products have identical IDs in the request.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DUPLICATE_PRODUCT_IDS_REQUEST"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRICE_PER_UNIT_NOT_ALIGNED","description":"Price per unit isn't aligned between product and variants.","errorType":"VALIDATION","validationErrorData":{"ruleName":"PRICE_PER_UNIT_NOT_ALIGNED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION_CHOICE","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionChoiceErrorData","description":"Variant choice doesn't exist in the product's option choices.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionErrorData","description":"Variant option doesn't exist in the product's options.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkUpdateProductsRequest","responseMessage":"wix.stores.catalog.v3.BulkUpdateProductsResponse"},"legacyExamples":[{"name":"BulkUpdateProducts","type":"METHOD","content":{"title":"Bulk update products","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/update' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n {\n \"fields\": [\n \"CURRENCY\",\n \"INFO_SECTION\",\n \"MERCHANT_DATA\",\n \"SUBSCRIPTION_PRICES_INFO\",\n \"WEIGHT_MEASUREMENT_UNIT_INFO\"\n ]\n },\n \"products\": [\n {\n \"product\": {\n \"id\": \"93f2e5ab-60a5-4173-babb-9198fc52bdd3\",\n \"revision\": \"2\",\n \"name\": \"Premium Coffee\"\n }\n },\n {\n \"product\": {\n \"id\": \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n \"revision\": \"3\",\n \"visible\": true\n }\n }\n ],\n \"returnEntity\": true\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"93f2e5ab-60a5-4173-babb-9198fc52bdd3\",\n \"originalIndex\": 0,\n \"success\": true,\n \"error\": null\n },\n \"item\": {\n \"id\": \"93f2e5ab-60a5-4173-babb-9198fc52bdd3\",\n \"revision\": \"3\",\n \"createdDate\": \"2025-01-01T09:50:31.438Z\",\n \"updatedDate\": \"2025-01-02T07:09:20.093Z\",\n \"name\": \"Coffee\",\n \"slug\": \"coffee\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"directCategoryIdsInfo\": null,\n \"costRange\": {\n \"minValue\": {\n \"amount\": \"0.00\",\n \"formattedAmount\": \"$0.00\"\n },\n \"maxValue\": {\n \"amount\": \"0.00\",\n \"formattedAmount\": \"$0.00\"\n }\n },\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n },\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_be600651-94cf-42ad-881f-3bd69fb4a320\",\n \"currency\": \"USD\",\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"d44f6c3f-e641-4e54-9cb3-5796e58fa1cd\",\n \"visible\": true,\n \"sku\": \"12345\",\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"compareAtPrice\": null\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": {\n \"subscriptionPrices\": []\n },\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735725031408000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n \"originalIndex\": 1,\n \"success\": true,\n \"error\": null\n },\n \"item\": {\n \"id\": \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n \"revision\": \"4\",\n \"createdDate\": \"2025-01-01T10:13:14.540Z\",\n \"updatedDate\": \"2025-01-02T07:09:20.093Z\",\n \"name\": \"Shopping bag\",\n \"slug\": \"shopping-bag\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"directCategoryIdsInfo\": null,\n \"costRange\": {\n \"minValue\": {\n \"amount\": \"0.00\",\n \"formattedAmount\": \"$0.00\"\n },\n \"maxValue\": {\n \"amount\": \"0.00\",\n \"formattedAmount\": \"$0.00\"\n }\n },\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n },\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_a7daf3a2-2a31-49b3-8a64-8264cd1006c7\",\n \"currency\": \"USD\",\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.50\",\n \"formattedAmount\": \"$0.50\"\n },\n \"maxValue\": {\n \"amount\": \"0.50\",\n \"formattedAmount\": \"$0.50\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.50\",\n \"formattedAmount\": \"$0.50\"\n },\n \"maxValue\": {\n \"amount\": \"0.50\",\n \"formattedAmount\": \"$0.50\"\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"75ba03bc-e56f-4b6d-be52-691eb2ed5fd7\",\n \"visible\": true,\n \"sku\": null,\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"0.50\",\n \"formattedAmount\": \"$0.50\"\n },\n \"compareAtPrice\": null\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": {\n \"subscriptionPrices\": []\n },\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n },\n \"physicalProperties\": {\n \"weight\": null,\n \"pricePerUnit\": null\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735726394407000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"commonMethodData":{"name":"bulkUpdate","itemField":"products"},"sdkData":{"signature":{"resolved":[{"field":{"path":"products"}},{"parent":{"name":"options","fields":[{"path":"returnEntity"},{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Bulk update products","description":"","content":"import { productsV3 } from \"@wix/stores\";\n\nconst products = [\n {\n product: {\n id: \"93f2e5ab-60a5-4173-babb-9198fc52bdd3\",\n revision: \"2\",\n name: \"Premium Coffee\"\n }\n },\n {\n product: {\n id: \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n revision: \"3\",\n visible: true\n }\n }\n];\n\nconst options = {\n fields: [\n \"CURRENCY\",\n \"INFO_SECTION\",\n \"MERCHANT_DATA\",\n \"SUBSCRIPTION_PRICES_INFO\",\n \"WEIGHT_MEASUREMENT_UNIT_INFO\"\n ],\n returnEntity: true\n};\n\nasync function bulkUpdateProducts() {\n const response = await productsV3.bulkUpdateProducts(products, options);\n}\n\n/* Promise resolves to:\n * {\n * \"results\": [\n * {\n * \"itemMetadata\": { \"originalIndex\": 0, \"success\": true, \"_id\": \"93f2e5ab-60a5-4173-babb-9198fc52bdd3\" },\n * \"item\": {\n * \"_id\": \"93f2e5ab-60a5-4173-babb-9198fc52bdd3\",\n * \"revision\": \"3\",\n * \"name\": \"Premium Coffee\",\n * \"slug\": \"coffee-3\",\n * \"visible\": true,\n * \"productType\": \"PHYSICAL\",\n * \"currency\": \"EUR\",\n * \"physicalProperties\": { \"weightMeasurementUnitInfo\": { \"weightMeasurementUnit\": \"KG\" } },\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"10.00\", \"formattedAmount\": \"€10.00\" },\n * \"maxValue\": { \"amount\": \"10.00\", \"formattedAmount\": \"€10.00\" }\n * }\n * }\n * },\n * {\n * \"itemMetadata\": { \"originalIndex\": 1, \"success\": true, \"_id\": \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\" },\n * \"item\": {\n * \"_id\": \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n * \"revision\": \"4\",\n * \"name\": \"Chocolate bar\",\n * \"slug\": \"chocolate-bar-3\",\n * \"visible\": true,\n * \"productType\": \"PHYSICAL\",\n * \"currency\": \"EUR\",\n * \"physicalProperties\": { \"weightMeasurementUnitInfo\": { \"weightMeasurementUnit\": \"KG\" } },\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"6.00\", \"formattedAmount\": \"€6.00\" },\n * \"maxValue\": { \"amount\": \"6.00\", \"formattedAmount\": \"€6.00\" }\n * }\n * }\n * }\n * ],\n * \"bulkActionMetadata\": { \"totalSuccesses\": 2, \"totalFailures\": 0 }\n * }\n */\n\n","order":1,"source":"manual"},{"title":"bulkUpdateProducts (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function BulkUpdateProducts() {\n const response = await myWixClient.productsV3.BulkUpdateProducts();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products/update","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/stores","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products","destinationPath":"/v3/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products","destinationPath":"/v3/bulk/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"www._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://blocks.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://create.editorx/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"create.editorx","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wixapps.net/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://*.dev.wix-code.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://_/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products-with-inventory","destinationPath":"/v3/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products-with-inventory","destinationPath":"/v3/bulk/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/all-products-category","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/all-products-category","destinationPath":"/v3/all-products-category","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}}],"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_updated","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.BulkUpdateProducts","methodName":"BulkUpdateProducts","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"TOO_MANY_VARIANTS","description":"Number of variants exceeds the server's limit of 1000 per request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"TOO_MANY_VARIANTS"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"MISSING_VARIANT_OPTION_CHOICE","description":"Every variant's choice must reference an existing option in `options.id`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MISSING_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_VARIANT_OPTION_CHOICE","description":"Multiple variants have identical choices in `variantsInfo.variants.choices`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_PRODUCT_OPTIONS","description":"Multiple options have identical `name` and `optionRenderType`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_PRODUCT_OPTIONS"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_DEFAULT_VARIANT","description":"Product with multiple variants has a variant with empty `choices`. Only single-variant products can have empty choices.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_DEFAULT_VARIANT"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FIELD_MASK_VALUE_NOT_SUPPORTED","errorSchemaName":"com.wix.stores.catalog.product.api.v3.UnsupportedFieldMasks","description":"Update field mask includes read-only fields.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"FIELD_MASK_VALUE_NOT_SUPPORTED"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"VARIANTS_ARE_NOT_ALIGNED_WITH_PRODUCT","errorSchemaName":"com.wix.stores.catalog.product.api.v3.VariantsNotAlignedWithProduct","description":"Variants aren't aligned with the product. The variant `typedProperties` must match the `productType`, measurement units must align, and each variant must have exactly 1 choice for every option.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"VARIANTS_ARE_NOT_ALIGNED_WITH_PRODUCT"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"DUPLICATE_SLUG_ERROR","description":"There is already a product with this `slug`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_SLUG_ERROR"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"DIGITAL_FILE_NOT_FOUND_ERROR","description":"Couldn't find the digital file referenced in `variantsInfo.variants.digitalProperties`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DIGITAL_FILE_NOT_FOUND_ERROR"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"BARCODE_ALREADY_EXIST_ERROR","description":"There is already a variant with this `barcode`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"BARCODE_ALREADY_EXIST_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_BARCODE_ERROR","description":"Multiple variants have identical `barcode` in the request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_BARCODE_ERROR"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SKU_ALREADY_EXIST_ERROR","description":"There is already a variant with this `sku`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"SKU_ALREADY_EXIST_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_SKU_ERROR","description":"Multiple variants have identical `sku` in the request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_SKU_ERROR"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"VARIANT_ID_ALREADY_EXISTS","description":"Multiple variants have identical `id`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"VARIANT_ID_ALREADY_EXISTS"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION","description":"Subscription added to a digital product. Digital products can't have subscriptions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT","description":"All subscriptions are hidden for a subscription-only product. At least 1 subscription must be visible when `allowOneTimePurchases` is false.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT","description":"Subscription discount `amountOff` exceeds the minimum variant price.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS","description":"Multiple subscriptions have identical IDs.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PREORDER_VALIDATION_ERROR","description":"Variant enabled for preorder on a subscription product. Products with subscriptions can't have preorder variants.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PREORDER_VALIDATION_ERROR"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"BRAND_CREATION_FAILED","description":"Brand creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"BRAND_CREATION_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"RIBBON_NOT_FOUND","description":"Couldn't find the ribbon.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"RIBBON_NOT_FOUND"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INFO_SECTION_ERROR_OCCURRED","description":"Info section update failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INFO_SECTION_ERROR_OCCURRED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CUSTOMIZATION_NOT_EXIST","description":"Couldn't find the customization.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CUSTOMIZATION_NOT_EXIST"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED","description":"Failed to add customization choices.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CHOICE_NOT_EXIST","description":"Couldn't find the choice.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CHOICE_NOT_EXIST"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TOO_MANY_OPTIONS_IN_REQUEST","description":"Number of options exceeds the server's limit.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"TOO_MANY_OPTIONS_IN_REQUEST"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR","description":"Field mask includes fields not provided in the request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE","description":"The `compareAtPrice` is lower than the `actualPrice`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"VARIANTS_TYPED_PROPERTIES_ARE_NOT_ALIGNED","description":"Variants have different `typedProperties` types. All variants must have the same type.","errorType":"VALIDATION","validationErrorData":{"ruleName":"VARIANTS_TYPED_PROPERTIES_ARE_NOT_ALIGNED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_OPTIONS_ON_UPDATE_VARIANTS","description":"Update request includes `variants` but is missing `options`. Both must be provided together.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_OPTIONS_ON_UPDATE_VARIANTS"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"SUBSCRIPTION_INVALID_AUTO_RENEWAL","description":"The `autoRenewal` field is set to false. Set the number of billing cycles in `billingCycles` to prevent automatic renewal instead.","errorType":"VALIDATION","validationErrorData":{"ruleName":"SUBSCRIPTION_INVALID_AUTO_RENEWAL"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DIGITAL_PRODUCT_CANNOT_BE_VISIBLE_IN_POS","description":"Digital product is marked as visible in POS. Digital products can't be visible in POS.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DIGITAL_PRODUCT_CANNOT_BE_VISIBLE_IN_POS"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DESCRIPTION_SIZE_TOO_BIG","description":"Product `description` field exceeds the maximum size of 32000 bytes.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DESCRIPTION_SIZE_TOO_BIG"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DUPLICATE_MEDIA_ERROR","errorSchemaName":"com.wix.stores.catalog.product.api.v3.DuplicateMediaIdAssignedToProduct","description":"Multiple media items have identical IDs. Each media ID must be unique.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DUPLICATE_MEDIA_ERROR"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"BRAND_MISSING_ID","description":"Brand is missing an `id`.","errorType":"VALIDATION","validationErrorData":{"ruleName":"BRAND_MISSING_ID"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DUPLICATE_PRODUCT_IDS_REQUEST","description":"Multiple products have identical IDs in the request.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DUPLICATE_PRODUCT_IDS_REQUEST"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRICE_PER_UNIT_NOT_ALIGNED","description":"Price per unit isn't aligned between product and variants.","errorType":"VALIDATION","validationErrorData":{"ruleName":"PRICE_PER_UNIT_NOT_ALIGNED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION_CHOICE","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionChoiceErrorData","description":"Variant choice doesn't exist in the product's option choices.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionErrorData","description":"Variant option doesn't exist in the product's options.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkUpdateProductsRequest","responseMessage":"wix.stores.catalog.v3.BulkUpdateProductsResponse"},"legacyExamples":[{"name":"BulkUpdateProducts","type":"METHOD","content":{"title":"Bulk update products","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/update' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n {\n \"fields\": [\n \"CURRENCY\",\n \"INFO_SECTION\",\n \"MERCHANT_DATA\",\n \"SUBSCRIPTION_PRICES_INFO\",\n \"WEIGHT_MEASUREMENT_UNIT_INFO\"\n ]\n },\n \"products\": [\n {\n \"product\": {\n \"id\": \"93f2e5ab-60a5-4173-babb-9198fc52bdd3\",\n \"revision\": \"2\",\n \"name\": \"Premium Coffee\"\n }\n },\n {\n \"product\": {\n \"id\": \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n \"revision\": \"3\",\n \"visible\": true\n }\n }\n ],\n \"returnEntity\": true\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"93f2e5ab-60a5-4173-babb-9198fc52bdd3\",\n \"originalIndex\": 0,\n \"success\": true,\n \"error\": null\n },\n \"item\": {\n \"id\": \"93f2e5ab-60a5-4173-babb-9198fc52bdd3\",\n \"revision\": \"3\",\n \"createdDate\": \"2025-01-01T09:50:31.438Z\",\n \"updatedDate\": \"2025-01-02T07:09:20.093Z\",\n \"name\": \"Coffee\",\n \"slug\": \"coffee\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"directCategoryIdsInfo\": null,\n \"costRange\": {\n \"minValue\": {\n \"amount\": \"0.00\",\n \"formattedAmount\": \"$0.00\"\n },\n \"maxValue\": {\n \"amount\": \"0.00\",\n \"formattedAmount\": \"$0.00\"\n }\n },\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n },\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_be600651-94cf-42ad-881f-3bd69fb4a320\",\n \"currency\": \"USD\",\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"d44f6c3f-e641-4e54-9cb3-5796e58fa1cd\",\n \"visible\": true,\n \"sku\": \"12345\",\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"compareAtPrice\": null\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": {\n \"subscriptionPrices\": []\n },\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735725031408000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n \"originalIndex\": 1,\n \"success\": true,\n \"error\": null\n },\n \"item\": {\n \"id\": \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n \"revision\": \"4\",\n \"createdDate\": \"2025-01-01T10:13:14.540Z\",\n \"updatedDate\": \"2025-01-02T07:09:20.093Z\",\n \"name\": \"Shopping bag\",\n \"slug\": \"shopping-bag\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"directCategoryIdsInfo\": null,\n \"costRange\": {\n \"minValue\": {\n \"amount\": \"0.00\",\n \"formattedAmount\": \"$0.00\"\n },\n \"maxValue\": {\n \"amount\": \"0.00\",\n \"formattedAmount\": \"$0.00\"\n }\n },\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n },\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_a7daf3a2-2a31-49b3-8a64-8264cd1006c7\",\n \"currency\": \"USD\",\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.50\",\n \"formattedAmount\": \"$0.50\"\n },\n \"maxValue\": {\n \"amount\": \"0.50\",\n \"formattedAmount\": \"$0.50\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.50\",\n \"formattedAmount\": \"$0.50\"\n },\n \"maxValue\": {\n \"amount\": \"0.50\",\n \"formattedAmount\": \"$0.50\"\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"75ba03bc-e56f-4b6d-be52-691eb2ed5fd7\",\n \"visible\": true,\n \"sku\": null,\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"0.50\",\n \"formattedAmount\": \"$0.50\"\n },\n \"compareAtPrice\": null\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": {\n \"subscriptionPrices\": []\n },\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n },\n \"physicalProperties\": {\n \"weight\": null,\n \"pricePerUnit\": null\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735726394407000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"commonMethodData":{"name":"bulkUpdate","itemField":"products"},"sdkData":{"signature":{"resolved":[{"field":{"path":"products"}},{"parent":{"name":"options","fields":[{"path":"returnEntity"},{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Bulk update products","description":"","content":"import { productsV3 } from \"@wix/stores\";\n\nconst products = [\n {\n product: {\n id: \"93f2e5ab-60a5-4173-babb-9198fc52bdd3\",\n revision: \"2\",\n name: \"Premium Coffee\"\n }\n },\n {\n product: {\n id: \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n revision: \"3\",\n visible: true\n }\n }\n];\n\nconst options = {\n fields: [\n \"CURRENCY\",\n \"INFO_SECTION\",\n \"MERCHANT_DATA\",\n \"SUBSCRIPTION_PRICES_INFO\",\n \"WEIGHT_MEASUREMENT_UNIT_INFO\"\n ],\n returnEntity: true\n};\n\nasync function bulkUpdateProducts() {\n const response = await productsV3.bulkUpdateProducts(products, options);\n}\n\n/* Promise resolves to:\n * {\n * \"results\": [\n * {\n * \"itemMetadata\": { \"originalIndex\": 0, \"success\": true, \"_id\": \"93f2e5ab-60a5-4173-babb-9198fc52bdd3\" },\n * \"item\": {\n * \"_id\": \"93f2e5ab-60a5-4173-babb-9198fc52bdd3\",\n * \"revision\": \"3\",\n * \"name\": \"Premium Coffee\",\n * \"slug\": \"coffee-3\",\n * \"visible\": true,\n * \"productType\": \"PHYSICAL\",\n * \"currency\": \"EUR\",\n * \"physicalProperties\": { \"weightMeasurementUnitInfo\": { \"weightMeasurementUnit\": \"KG\" } },\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"10.00\", \"formattedAmount\": \"€10.00\" },\n * \"maxValue\": { \"amount\": \"10.00\", \"formattedAmount\": \"€10.00\" }\n * }\n * }\n * },\n * {\n * \"itemMetadata\": { \"originalIndex\": 1, \"success\": true, \"_id\": \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\" },\n * \"item\": {\n * \"_id\": \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n * \"revision\": \"4\",\n * \"name\": \"Chocolate bar\",\n * \"slug\": \"chocolate-bar-3\",\n * \"visible\": true,\n * \"productType\": \"PHYSICAL\",\n * \"currency\": \"EUR\",\n * \"physicalProperties\": { \"weightMeasurementUnitInfo\": { \"weightMeasurementUnit\": \"KG\" } },\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"6.00\", \"formattedAmount\": \"€6.00\" },\n * \"maxValue\": { \"amount\": \"6.00\", \"formattedAmount\": \"€6.00\" }\n * }\n * }\n * }\n * ],\n * \"bulkActionMetadata\": { \"totalSuccesses\": 2, \"totalFailures\": 0 }\n * }\n */\n\n","order":1,"source":"manual"},{"title":"bulkUpdateProducts (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function BulkUpdateProducts() {\n const response = await myWixClient.productsV3.BulkUpdateProducts();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Update Products","slugifiedName":"bulk-update-products"},"permissionScopes":[{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}],"isAdminMethod":true},{"summary":"Bulk Add Info Sections To Products","description":"Adds [info sections](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/info-sections-v3/introduction) to multiple products.","operationId":"wix.stores.catalog.v3.CatalogApi.BulkAddInfoSectionsToProducts","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkAddInfoSectionsToProductsResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkAddInfoSectionsToProductsRequest","description":"","properties":{"products":{"description":"List of product IDs and revisions.","minItems":1,"maxItems":100,"title":"products","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.v3.ProductIdWithRevision"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"infoSectionIds":{"description":"List of IDs of info sections to add.","format":"GUID","minItems":1,"maxItems":10,"title":"infoSectionIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the full updated product entities in the response.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.MultipleEntitiesOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["products","infoSectionIds"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_updated","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.BulkAddInfoSectionsToProducts","methodName":"BulkAddInfoSectionsToProducts","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TOO_MANY_INFO_SECTIONS_ERROR","description":"Number of info sections exceeds the server's limit of 10 per product.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"TOO_MANY_INFO_SECTIONS_ERROR"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkAddInfoSectionsToProductsRequest","responseMessage":"wix.stores.catalog.v3.BulkAddInfoSectionsToProductsResponse"},"legacyExamples":[{"name":"BulkAddInfoSectionsToProducts","type":"METHOD","content":{"title":"Bulk add info sections to products","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/add-info-sections' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"fields\": [\n ],\n \"infoSectionIds\": [\n \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\",\n \"1dac2b73-3592-4d80-9a6e-4892caf4e058\"\n ],\n \"products\": [\n {\n \"productId\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"revision\": \"8\"\n },\n {\n \"productId\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"revision\": \"5\"\n }\n ],\n \"returnEntity\": true\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"item\": {\n \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"revision\": \"9\",\n \"createdDate\": \"2024-07-22T13:22:47.771Z\",\n \"updatedDate\": \"2024-07-22T16:38:05.649Z\",\n \"name\": \"Premium Coffee\",\n \"slug\": \"coffee\",\n \"visible\": false,\n \"visibleInPos\": false,\n \"media\": {\n \"main\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n \"items\": [\n {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n {\n \"id\": \"370e1a_8412ab11b3ad48bb8375a2ecb1cc8b4d~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_8412ab11b3ad48bb8375a2ecb1cc8b4d~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_8412ab11b3ad48bb8375a2ecb1cc8b4d~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"44682905-395a-4c18-8fab-e050725ba3f6\"\n }\n ]\n },\n \"options\": [\n {\n \"id\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"name\": \"Size\",\n \"optionRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"4498b805-2aed-43fb-b478-989c906c19cd\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"S\",\n \"name\": \"S\",\n \"inStock\": true\n },\n {\n \"choiceId\": \"26394ab0-d81a-422f-a8c9-562f49a6b595\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"L\",\n \"name\": \"L\",\n \"inStock\": false\n }\n ]\n },\n \"key\": \"Size\"\n },\n {\n \"id\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"name\": \"Box color\",\n \"optionRenderType\": \"SWATCH_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"2e98f13b-ae65-4d30-96c5-ac3a6cf99d60\",\n \"linkedMedia\": [],\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"red\",\n \"name\": \"red\",\n \"colorCode\": \"#FF0000\",\n \"inStock\": true\n },\n {\n \"choiceId\": \"4876dcc7-817e-4c10-a6b2-4a4cc2e241e6\",\n \"linkedMedia\": [],\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"blue\",\n \"name\": \"blue\",\n \"colorCode\": \"#0000FF\",\n \"inStock\": false\n }\n ]\n },\n \"key\": \"Box color\"\n }\n ],\n \"modifiers\": [\n {\n \"id\": \"a3d249f0-a8da-425d-9ec1-3c51c795d927\",\n \"name\": \"Remove price tag\",\n \"modifierRenderType\": \"TEXT_CHOICES\",\n \"mandatory\": false,\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"3050481e-e177-4031-bbe9-be9b00af14b5\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"yes\",\n \"name\": \"yes\"\n },\n {\n \"choiceId\": \"ee729b74-d500-4594-aae5-b5a2e75bf5e7\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"no\",\n \"name\": \"no\"\n }\n ]\n },\n \"key\": \"Remove price tag\"\n }\n ],\n \"brand\": {\n \"id\": \"4a16d28d-1736-41f0-87d8-995f6d9a5bdd\",\n \"name\": \"EcoCoffee\"\n },\n \"infoSections\": [\n {\n \"id\": \"1dac2b73-3592-4d80-9a6e-4892caf4e058\"\n },\n {\n \"id\": \"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\"\n },\n {\n \"id\": \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\"\n }\n ],\n \"ribbon\": {\n \"id\": \"14585597-3302-4145-8da3-24a26d8346d6\",\n \"name\": \"New arrival\"\n },\n \"mainCategoryId\": \"643721c3-446e-47f3-87ee-0a58d6842d48\",\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"6\"\n },\n \"maxValue\": {\n \"amount\": \"6\"\n }\n },\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"5\"\n },\n \"maxValue\": {\n \"amount\": \"5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": {\n \"quantity\": 1.0,\n \"measurementUnit\": \"KG\"\n },\n \"shippingWeightRange\": {\n \"minValue\": 0.1,\n \"maxValue\": 0.1\n }\n },\n \"flattenOptions\": [],\n \"flattenModifiers\": []\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"item\": {\n \"id\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"revision\": \"6\",\n \"createdDate\": \"2024-07-22T14:04:05.787Z\",\n \"updatedDate\": \"2024-07-22T16:38:05.649Z\",\n \"name\": \"Recyclable Shopping bag\",\n \"slug\": \"shopping-bag\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"items\": []\n },\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [\n {\n \"id\": \"1dac2b73-3592-4d80-9a6e-4892caf4e058\"\n },\n {\n \"id\": \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\"\n }\n ],\n \"mainCategoryId\": \"643721c3-446e-47f3-87ee-0a58d6842d48\",\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {},\n \"flattenOptions\": [],\n \"flattenModifiers\": []\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sdkData":{"signature":{"resolved":[{"field":{"path":"products"}},{"parent":{"name":"options","fields":[{"path":"infoSectionIds"},{"path":"returnEntity"},{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Bulk add info sections to products","description":"","content":"import { productsV3 } from \"@wix/stores\";\n\nconst products = [\n {\n productId: \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n revision: \"8\"\n },\n {\n productId: \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n revision: \"5\"\n }\n];\n\nconst options = {\n infoSectionIds: [\n \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\",\n \"1dac2b73-3592-4d80-9a6e-4892caf4e058\"\n ],\n returnEntity: true\n};\n\nasync function bulkAddInfoSectionsToProducts() {\n const response = await productsV3.bulkAddInfoSectionsToProducts(\n products,\n options\n );\n}\n\n/* Promise resolves to:\n * {\n * \"results\": [\n * {\n * \"itemMetadata\": {\n * \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n * \"originalIndex\": 0,\n * \"success\": true\n * },\n * \"item\": {\n * \"_id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n * \"revision\": \"9\",\n * \"name\": \"Premium Coffee\",\n * \"infoSections\": [\n * { \"id\": \"1dac2b73-3592-4d80-9a6e-4892caf4e058\" },\n * { \"id\": \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\" }\n * ]\n * }\n * }\n * ],\n * \"bulkActionMetadata\": {\n * \"totalSuccesses\": 2,\n * \"totalFailures\": 0\n * }\n * }\n */\n","order":1,"source":"manual"},{"title":"bulkAddInfoSectionsToProducts (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function BulkAddInfoSectionsToProducts() {\n const response = await myWixClient.productsV3.BulkAddInfoSectionsToProducts();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products/add-info-sections","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/stores","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products","destinationPath":"/v3/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products","destinationPath":"/v3/bulk/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"www._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://blocks.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://create.editorx/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"create.editorx","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wixapps.net/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://*.dev.wix-code.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://_/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products-with-inventory","destinationPath":"/v3/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products-with-inventory","destinationPath":"/v3/bulk/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/all-products-category","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/all-products-category","destinationPath":"/v3/all-products-category","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}}],"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_updated","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.BulkAddInfoSectionsToProducts","methodName":"BulkAddInfoSectionsToProducts","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TOO_MANY_INFO_SECTIONS_ERROR","description":"Number of info sections exceeds the server's limit of 10 per product.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"TOO_MANY_INFO_SECTIONS_ERROR"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkAddInfoSectionsToProductsRequest","responseMessage":"wix.stores.catalog.v3.BulkAddInfoSectionsToProductsResponse"},"legacyExamples":[{"name":"BulkAddInfoSectionsToProducts","type":"METHOD","content":{"title":"Bulk add info sections to products","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/add-info-sections' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"fields\": [\n ],\n \"infoSectionIds\": [\n \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\",\n \"1dac2b73-3592-4d80-9a6e-4892caf4e058\"\n ],\n \"products\": [\n {\n \"productId\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"revision\": \"8\"\n },\n {\n \"productId\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"revision\": \"5\"\n }\n ],\n \"returnEntity\": true\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"item\": {\n \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"revision\": \"9\",\n \"createdDate\": \"2024-07-22T13:22:47.771Z\",\n \"updatedDate\": \"2024-07-22T16:38:05.649Z\",\n \"name\": \"Premium Coffee\",\n \"slug\": \"coffee\",\n \"visible\": false,\n \"visibleInPos\": false,\n \"media\": {\n \"main\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n \"items\": [\n {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n {\n \"id\": \"370e1a_8412ab11b3ad48bb8375a2ecb1cc8b4d~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_8412ab11b3ad48bb8375a2ecb1cc8b4d~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_8412ab11b3ad48bb8375a2ecb1cc8b4d~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"44682905-395a-4c18-8fab-e050725ba3f6\"\n }\n ]\n },\n \"options\": [\n {\n \"id\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"name\": \"Size\",\n \"optionRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"4498b805-2aed-43fb-b478-989c906c19cd\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"S\",\n \"name\": \"S\",\n \"inStock\": true\n },\n {\n \"choiceId\": \"26394ab0-d81a-422f-a8c9-562f49a6b595\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"L\",\n \"name\": \"L\",\n \"inStock\": false\n }\n ]\n },\n \"key\": \"Size\"\n },\n {\n \"id\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"name\": \"Box color\",\n \"optionRenderType\": \"SWATCH_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"2e98f13b-ae65-4d30-96c5-ac3a6cf99d60\",\n \"linkedMedia\": [],\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"red\",\n \"name\": \"red\",\n \"colorCode\": \"#FF0000\",\n \"inStock\": true\n },\n {\n \"choiceId\": \"4876dcc7-817e-4c10-a6b2-4a4cc2e241e6\",\n \"linkedMedia\": [],\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"blue\",\n \"name\": \"blue\",\n \"colorCode\": \"#0000FF\",\n \"inStock\": false\n }\n ]\n },\n \"key\": \"Box color\"\n }\n ],\n \"modifiers\": [\n {\n \"id\": \"a3d249f0-a8da-425d-9ec1-3c51c795d927\",\n \"name\": \"Remove price tag\",\n \"modifierRenderType\": \"TEXT_CHOICES\",\n \"mandatory\": false,\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"3050481e-e177-4031-bbe9-be9b00af14b5\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"yes\",\n \"name\": \"yes\"\n },\n {\n \"choiceId\": \"ee729b74-d500-4594-aae5-b5a2e75bf5e7\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"no\",\n \"name\": \"no\"\n }\n ]\n },\n \"key\": \"Remove price tag\"\n }\n ],\n \"brand\": {\n \"id\": \"4a16d28d-1736-41f0-87d8-995f6d9a5bdd\",\n \"name\": \"EcoCoffee\"\n },\n \"infoSections\": [\n {\n \"id\": \"1dac2b73-3592-4d80-9a6e-4892caf4e058\"\n },\n {\n \"id\": \"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\"\n },\n {\n \"id\": \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\"\n }\n ],\n \"ribbon\": {\n \"id\": \"14585597-3302-4145-8da3-24a26d8346d6\",\n \"name\": \"New arrival\"\n },\n \"mainCategoryId\": \"643721c3-446e-47f3-87ee-0a58d6842d48\",\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"6\"\n },\n \"maxValue\": {\n \"amount\": \"6\"\n }\n },\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"5\"\n },\n \"maxValue\": {\n \"amount\": \"5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": {\n \"quantity\": 1.0,\n \"measurementUnit\": \"KG\"\n },\n \"shippingWeightRange\": {\n \"minValue\": 0.1,\n \"maxValue\": 0.1\n }\n },\n \"flattenOptions\": [],\n \"flattenModifiers\": []\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"item\": {\n \"id\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"revision\": \"6\",\n \"createdDate\": \"2024-07-22T14:04:05.787Z\",\n \"updatedDate\": \"2024-07-22T16:38:05.649Z\",\n \"name\": \"Recyclable Shopping bag\",\n \"slug\": \"shopping-bag\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"items\": []\n },\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [\n {\n \"id\": \"1dac2b73-3592-4d80-9a6e-4892caf4e058\"\n },\n {\n \"id\": \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\"\n }\n ],\n \"mainCategoryId\": \"643721c3-446e-47f3-87ee-0a58d6842d48\",\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {},\n \"flattenOptions\": [],\n \"flattenModifiers\": []\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sdkData":{"signature":{"resolved":[{"field":{"path":"products"}},{"parent":{"name":"options","fields":[{"path":"infoSectionIds"},{"path":"returnEntity"},{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Bulk add info sections to products","description":"","content":"import { productsV3 } from \"@wix/stores\";\n\nconst products = [\n {\n productId: \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n revision: \"8\"\n },\n {\n productId: \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n revision: \"5\"\n }\n];\n\nconst options = {\n infoSectionIds: [\n \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\",\n \"1dac2b73-3592-4d80-9a6e-4892caf4e058\"\n ],\n returnEntity: true\n};\n\nasync function bulkAddInfoSectionsToProducts() {\n const response = await productsV3.bulkAddInfoSectionsToProducts(\n products,\n options\n );\n}\n\n/* Promise resolves to:\n * {\n * \"results\": [\n * {\n * \"itemMetadata\": {\n * \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n * \"originalIndex\": 0,\n * \"success\": true\n * },\n * \"item\": {\n * \"_id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n * \"revision\": \"9\",\n * \"name\": \"Premium Coffee\",\n * \"infoSections\": [\n * { \"id\": \"1dac2b73-3592-4d80-9a6e-4892caf4e058\" },\n * { \"id\": \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\" }\n * ]\n * }\n * }\n * ],\n * \"bulkActionMetadata\": {\n * \"totalSuccesses\": 2,\n * \"totalFailures\": 0\n * }\n * }\n */\n","order":1,"source":"manual"},{"title":"bulkAddInfoSectionsToProducts (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function BulkAddInfoSectionsToProducts() {\n const response = await myWixClient.productsV3.BulkAddInfoSectionsToProducts();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Add Info Sections To Products","slugifiedName":"bulk-add-info-sections-to-products"},"permissionScopes":[{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}],"isAdminMethod":true},{"summary":"Bulk Add Info Sections To Products By Filter","description":"Adds [info sections](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/info-sections-v3/introduction) to multiple products, given the provided filter and search expression.","operationId":"wix.stores.catalog.v3.CatalogApi.BulkAddInfoSectionsToProductsByFilter","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkAddInfoSectionsToProductsByFilterResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkAddInfoSectionsToProductsByFilterRequest","description":"","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","$ref":"#/components/schemas/google.protobuf.Struct","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"infoSectionIds":{"description":"IDs of the info sections to add.","format":"GUID","minItems":1,"maxItems":10,"title":"infoSectionIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Free text to match in searchable fields.","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["filter","infoSectionIds"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_updated","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.BulkAddInfoSectionsToProductsByFilter","methodName":"BulkAddInfoSectionsToProductsByFilter","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TOO_MANY_INFO_SECTIONS_ERROR","description":"Number of info sections exceeds the server's limit of 10 per product.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"TOO_MANY_INFO_SECTIONS_ERROR"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkAddInfoSectionsToProductsByFilterRequest","responseMessage":"wix.stores.catalog.v3.BulkAddInfoSectionsToProductsByFilterResponse"},"legacyExamples":[{"name":"BulkAddInfoSectionsToProductsByFilter","type":"METHOD","content":{"title":"Bulk add info sections to products by filter","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/add-info-sections' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"filter\": {\n \"createdDate\": {\n \"$gt\": \"2024-07-22T13:22:45\"\n }\n },\n \"infoSectionIds\": [\n \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\",\n \"1dac2b73-3592-4d80-9a6e-4892caf4e058\"\n ]\n }'","response":"{\n \"jobId\": \"6ed9c722-a611-4f38-8b7d-1f2221e914ca\"\n}"}}],"sdkData":{"signature":{"resolved":[{"field":{"path":"filter"}},{"parent":{"name":"options","fields":[{"path":"infoSectionIds"},{"path":"search"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Bulk add info sections to products by filter","description":"Add info sections to all products created after a specific date.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst filter = {\n createdDate: {\n $gt: \"2024-07-22T13:22:45\"\n }\n};\n\nconst options = {\n infoSectionIds: [\n \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\",\n \"1dac2b73-3592-4d80-9a6e-4892caf4e058\"\n ]\n};\n\nasync function bulkAddInfoSectionsToProductsByFilter() {\n const response = await productsV3.bulkAddInfoSectionsToProductsByFilter(filter, options);\n}\n\n/* Promise resolves to:\n * {\n * \"jobId\": \"6ed9c722-a611-4f38-8b7d-1f2221e914ca\"\n * }\n */\n\n","order":1,"source":"manual"},{"title":"bulkAddInfoSectionsToProductsByFilter (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function BulkAddInfoSectionsToProductsByFilter() {\n const response = await myWixClient.productsV3.BulkAddInfoSectionsToProductsByFilter();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products/add-info-sections-by-filter","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/stores","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products","destinationPath":"/v3/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products","destinationPath":"/v3/bulk/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"www._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://blocks.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://create.editorx/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"create.editorx","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wixapps.net/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://*.dev.wix-code.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://_/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products-with-inventory","destinationPath":"/v3/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products-with-inventory","destinationPath":"/v3/bulk/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/all-products-category","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/all-products-category","destinationPath":"/v3/all-products-category","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}}],"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_updated","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.BulkAddInfoSectionsToProductsByFilter","methodName":"BulkAddInfoSectionsToProductsByFilter","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TOO_MANY_INFO_SECTIONS_ERROR","description":"Number of info sections exceeds the server's limit of 10 per product.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"TOO_MANY_INFO_SECTIONS_ERROR"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkAddInfoSectionsToProductsByFilterRequest","responseMessage":"wix.stores.catalog.v3.BulkAddInfoSectionsToProductsByFilterResponse"},"legacyExamples":[{"name":"BulkAddInfoSectionsToProductsByFilter","type":"METHOD","content":{"title":"Bulk add info sections to products by filter","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/add-info-sections' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"filter\": {\n \"createdDate\": {\n \"$gt\": \"2024-07-22T13:22:45\"\n }\n },\n \"infoSectionIds\": [\n \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\",\n \"1dac2b73-3592-4d80-9a6e-4892caf4e058\"\n ]\n }'","response":"{\n \"jobId\": \"6ed9c722-a611-4f38-8b7d-1f2221e914ca\"\n}"}}],"sdkData":{"signature":{"resolved":[{"field":{"path":"filter"}},{"parent":{"name":"options","fields":[{"path":"infoSectionIds"},{"path":"search"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Bulk add info sections to products by filter","description":"Add info sections to all products created after a specific date.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst filter = {\n createdDate: {\n $gt: \"2024-07-22T13:22:45\"\n }\n};\n\nconst options = {\n infoSectionIds: [\n \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\",\n \"1dac2b73-3592-4d80-9a6e-4892caf4e058\"\n ]\n};\n\nasync function bulkAddInfoSectionsToProductsByFilter() {\n const response = await productsV3.bulkAddInfoSectionsToProductsByFilter(filter, options);\n}\n\n/* Promise resolves to:\n * {\n * \"jobId\": \"6ed9c722-a611-4f38-8b7d-1f2221e914ca\"\n * }\n */\n\n","order":1,"source":"manual"},{"title":"bulkAddInfoSectionsToProductsByFilter (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function BulkAddInfoSectionsToProductsByFilter() {\n const response = await myWixClient.productsV3.BulkAddInfoSectionsToProductsByFilter();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Add Info Sections To Products By Filter","slugifiedName":"bulk-add-info-sections-to-products-by-filter"},"permissionScopes":[{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}],"isAdminMethod":true},{"summary":"Bulk Add Products To Categories By Filter","description":"Adds multiple products to up to 5 categories, given the provided filter and search expression.\n\nLearn more about the [Categories API](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/categories/introduction).","operationId":"wix.stores.catalog.v3.CatalogApi.BulkAddProductsToCategoriesByFilter","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkAddProductsToCategoriesByFilterResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkAddProductsToCategoriesByFilterRequest","description":"","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","$ref":"#/components/schemas/google.protobuf.Struct","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"categoryIds":{"description":"IDs of the categories to which products will be added.","format":"GUID","minItems":1,"maxItems":5,"title":"categoryIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Free text to match in searchable fields.","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["categoryIds"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["CATEGORIES.CATEGORY_ADD_ITEM"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkAddProductsToCategoriesByFilterRequest","responseMessage":"wix.stores.catalog.v3.BulkAddProductsToCategoriesByFilterResponse"},"legacyExamples":[{"name":"BulkAddProductsToCategoriesByFilter","type":"METHOD","content":{"title":"Bulk add products to categories by filter","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/add-to-categories-by-filter' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"categoryIds\": [\n \"7a083f69-3d3e-4cfd-a3ef-43fe68e967e5\"\n ],\n \"filter\": {\n \"productType\": \"PHYSICAL\"\n },\n \"search\": {\n \"expression\": \"Summer\"\n }\n }'","response":"{\n \"jobId\": \"b201b3e0-c8f5-413b-8128-2b4af598c71d\"\n}"}}],"sdkData":{"signature":{"resolved":[{"parent":{"name":"options","fields":[{"path":"filter"},{"path":"categoryIds"},{"path":"search"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Bulk add products to categories by filter","description":"Add all physical products containing \"Summer\" in their name to a category.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst options = {\n categoryIds: [\n \"7a083f69-3d3e-4cfd-a3ef-43fe68e967e5\"\n ],\n filter: {\n productType: \"PHYSICAL\"\n },\n search: {\n expression: \"Summer\"\n }\n};\n\nasync function bulkAddProductsToCategoriesByFilter() {\n const response = await productsV3.bulkAddProductsToCategoriesByFilter(options);\n}\n\n/* Promise resolves to:\n * {\n * \"jobId\": \"b201b3e0-c8f5-413b-8128-2b4af598c71d\"\n * }\n */\n\n","order":1,"source":"manual"},{"title":"bulkAddProductsToCategoriesByFilter (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function BulkAddProductsToCategoriesByFilter() {\n const response = await myWixClient.productsV3.BulkAddProductsToCategoriesByFilter();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products/add-to-categories-by-filter","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/stores","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products","destinationPath":"/v3/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products","destinationPath":"/v3/bulk/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"www._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://blocks.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://create.editorx/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"create.editorx","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wixapps.net/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://*.dev.wix-code.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://_/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products-with-inventory","destinationPath":"/v3/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products-with-inventory","destinationPath":"/v3/bulk/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/all-products-category","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/all-products-category","destinationPath":"/v3/all-products-category","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}}],"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["CATEGORIES.CATEGORY_ADD_ITEM"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkAddProductsToCategoriesByFilterRequest","responseMessage":"wix.stores.catalog.v3.BulkAddProductsToCategoriesByFilterResponse"},"legacyExamples":[{"name":"BulkAddProductsToCategoriesByFilter","type":"METHOD","content":{"title":"Bulk add products to categories by filter","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/add-to-categories-by-filter' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"categoryIds\": [\n \"7a083f69-3d3e-4cfd-a3ef-43fe68e967e5\"\n ],\n \"filter\": {\n \"productType\": \"PHYSICAL\"\n },\n \"search\": {\n \"expression\": \"Summer\"\n }\n }'","response":"{\n \"jobId\": \"b201b3e0-c8f5-413b-8128-2b4af598c71d\"\n}"}}],"sdkData":{"signature":{"resolved":[{"parent":{"name":"options","fields":[{"path":"filter"},{"path":"categoryIds"},{"path":"search"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Bulk add products to categories by filter","description":"Add all physical products containing \"Summer\" in their name to a category.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst options = {\n categoryIds: [\n \"7a083f69-3d3e-4cfd-a3ef-43fe68e967e5\"\n ],\n filter: {\n productType: \"PHYSICAL\"\n },\n search: {\n expression: \"Summer\"\n }\n};\n\nasync function bulkAddProductsToCategoriesByFilter() {\n const response = await productsV3.bulkAddProductsToCategoriesByFilter(options);\n}\n\n/* Promise resolves to:\n * {\n * \"jobId\": \"b201b3e0-c8f5-413b-8128-2b4af598c71d\"\n * }\n */\n\n","order":1,"source":"manual"},{"title":"bulkAddProductsToCategoriesByFilter (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function BulkAddProductsToCategoriesByFilter() {\n const response = await myWixClient.productsV3.BulkAddProductsToCategoriesByFilter();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Add Products To Categories By Filter","slugifiedName":"bulk-add-products-to-categories-by-filter"},"permissionScopes":[{"name":"Category item write","scopeId":"SCOPE.CATEGORIES.CATEGORY_ITEM_WRITE"}],"isAdminMethod":true},{"summary":"Bulk Adjust Product Variants By Filter","description":"Adjusts the prices and costs of multiple variants by a specified amount or percentage, given the provided filter and search expression.\n\nUse this method to apply bulk pricing changes, such as increasing all prices by 10%, without setting explicit values. Use [Bulk Update Product Variants By Filter](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/bulk-update-product-variants-by-filter) to set explicit values instead.\n\nThe following variant fields can be increased or decreased:\n+ `compareAtPrice` - Original price before discounts\n+ `actualPrice` - Current selling price\n+ `cost` - Merchant's cost to acquire/produce the item\n+ `compareAtPriceDiscount` - Discount percentage applied to compare-at price","operationId":"wix.stores.catalog.v3.CatalogApi.BulkAdjustProductVariantsByFilter","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkAdjustProductVariantsByFilterResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkAdjustProductVariantsByFilterRequest","description":"","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","$ref":"#/components/schemas/google.protobuf.Struct","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cost":{"description":"Cost adjustment.","$ref":"#/components/schemas/wix.stores.catalog.v3.AdjustValue","summary":"cost","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rounding":{"description":"Rounding strategy of new calculated prices.\n\n+ `NO_ROUNDING`: Calculated prices will be saved without rounding to keep max possible precision.\n+ `CURRENCY_PRECISION`: Calculated prices will be rounded according to the currency's precision requirements. For example. `$3.5555` will be saved as `$3.56`; `¥3.5555` will be saved as `¥4`.\n+ `NEAREST_WHOLE_NUMBER`: Calculated prices will be rounded to the nearest whole number.","title":"rounding","type":"string","$ref":"#/components/schemas/wix.stores.catalog.v3.BulkAdjustProductVariantsByFilterRequest.RoundingStrategy","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Free text to match in searchable fields.","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actualPrice":{"description":"Actual price adjustment.","$ref":"#/components/schemas/wix.stores.catalog.v3.AdjustValue","summary":"actualPrice","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"compareAtPrice":{"description":"Compare at price adjustment.","$ref":"#/components/schemas/wix.stores.catalog.v3.AdjustValue","summary":"compareAtPrice","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"compareAtPriceDiscount":{"description":"Set variant actualPrice from compareAtPrice by applying provided discount to it.\nif compare-at-price doesn't exist, actualPrice will be set to compareAtPrice and the discount will be calculated from it.\nFor example variant compareAtPrice 100$, variant actualPrice is 95$, requested `compareAtPriceDiscount.percentage` is 10, then old actual price ignored and new actual price set to 90 (100$ - 10%).","$ref":"#/components/schemas/wix.stores.catalog.v3.UnsignedAdjustValue","summary":"compareAtPriceDiscount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["filter"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_updated","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.BulkAdjustProductVariantsByFilter","methodName":"BulkAdjustProductVariantsByFilter","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"ADJUSTED_ACTUAL_PRICE_OUT_OF_RANGE","description":"Adjusted `actualPrice` is outside the valid range.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ADJUSTED_ACTUAL_PRICE_OUT_OF_RANGE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"ADJUSTED_COMPARE_AT_PRICE_OUT_OF_RANGE","description":"Adjusted `compareAtPrice` is outside the valid range.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ADJUSTED_COMPARE_AT_PRICE_OUT_OF_RANGE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"ADJUSTED_COST_OUT_OF_RANGE","description":"Adjusted `cost` is outside the valid range.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ADJUSTED_COST_OUT_OF_RANGE"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CANNOT_ADJUST_PRICE_RESTRICTED_VARIANT","description":"Price adjustment attempted for a restricted variant. Price can't be adjusted for variants with restrictions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CANNOT_ADJUST_PRICE_RESTRICTED_VARIANT"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"NO_VARIANT_ADJUSTMENTS_PASSED","description":"No adjustment values provided. At least 1 adjustment value is required.","errorType":"VALIDATION","validationErrorData":{"ruleName":"NO_VARIANT_ADJUSTMENTS_PASSED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INVALID_PRICES_ADJUSTMENTS","description":"Both price fields and `compareAtPriceDiscount` provided. The `actualPrice` and `compareAtPrice` can't be combined with `compareAtPriceDiscount`.","errorType":"VALIDATION","validationErrorData":{"ruleName":"INVALID_PRICES_ADJUSTMENTS"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION_CHOICE","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionChoiceErrorData","description":"Variant choice doesn't exist in the product's option choices.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionErrorData","description":"Variant option doesn't exist in the product's options.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkAdjustProductVariantsByFilterRequest","responseMessage":"wix.stores.catalog.v3.BulkAdjustProductVariantsByFilterResponse"},"legacyExamples":[{"name":"BulkAdjustProductVariantsByFilter","type":"METHOD","content":{"title":"Bulk adjust product variants by filter","description":"Decreases the actual price, compare at price, and cost of all product variants that were created after July 22nd, 2024.","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/adjust-variants-by-filter' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"filter\": {\n \"createdDate\": {\n \"$gt\": \"2024-07-22T13:22:45\"\n }\n },\n \"actualPrice\": {\n \"amount\": \"-1\"\n },\n \"compareAtPrice\": {\n \"amount\": \"-1\"\n },\n \"cost\": {\n \"amount\": \"-1\"\n }\n }'","response":"{\n \"jobId\": \"e95725e2-9159-4d45-b1c5-d3a0fed56d7b\"\n}"}}],"sdkData":{"signature":{"resolved":[{"field":{"path":"filter"}},{"parent":{"name":"options","fields":[{"path":"cost"},{"path":"rounding"},{"path":"search"},{"path":"actualPrice"},{"path":"compareAtPrice"},{"path":"compareAtPriceDiscount"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Bulk adjust product variants by filter","description":"Decrease the actual price, compare at price, and cost of all variants for products created after a specific date.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst filter = {\n createdDate: {\n $gt: \"2024-07-22T13:22:45\"\n }\n};\n\nconst options = {\n actualPrice: {\n amount: \"-1\"\n },\n compareAtPrice: {\n amount: \"-1\"\n },\n cost: {\n amount: \"-1\"\n }\n};\n\nasync function bulkAdjustProductVariantsByFilter() {\n const response = await productsV3.bulkAdjustProductVariantsByFilter(filter, options);\n}\n\n/* Promise resolves to:\n * {\n * \"jobId\": \"e95725e2-9159-4d45-b1c5-d3a0fed56d7b\"\n * }\n */\n\n","order":1,"source":"manual"},{"title":"bulkAdjustProductVariantsByFilter (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function BulkAdjustProductVariantsByFilter() {\n const response = await myWixClient.productsV3.BulkAdjustProductVariantsByFilter();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products/adjust-variants-by-filter","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/stores","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products","destinationPath":"/v3/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products","destinationPath":"/v3/bulk/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"www._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://blocks.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://create.editorx/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"create.editorx","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wixapps.net/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://*.dev.wix-code.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://_/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products-with-inventory","destinationPath":"/v3/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products-with-inventory","destinationPath":"/v3/bulk/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/all-products-category","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/all-products-category","destinationPath":"/v3/all-products-category","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}}],"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_updated","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.BulkAdjustProductVariantsByFilter","methodName":"BulkAdjustProductVariantsByFilter","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"ADJUSTED_ACTUAL_PRICE_OUT_OF_RANGE","description":"Adjusted `actualPrice` is outside the valid range.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ADJUSTED_ACTUAL_PRICE_OUT_OF_RANGE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"ADJUSTED_COMPARE_AT_PRICE_OUT_OF_RANGE","description":"Adjusted `compareAtPrice` is outside the valid range.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ADJUSTED_COMPARE_AT_PRICE_OUT_OF_RANGE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"ADJUSTED_COST_OUT_OF_RANGE","description":"Adjusted `cost` is outside the valid range.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ADJUSTED_COST_OUT_OF_RANGE"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CANNOT_ADJUST_PRICE_RESTRICTED_VARIANT","description":"Price adjustment attempted for a restricted variant. Price can't be adjusted for variants with restrictions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CANNOT_ADJUST_PRICE_RESTRICTED_VARIANT"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"NO_VARIANT_ADJUSTMENTS_PASSED","description":"No adjustment values provided. At least 1 adjustment value is required.","errorType":"VALIDATION","validationErrorData":{"ruleName":"NO_VARIANT_ADJUSTMENTS_PASSED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INVALID_PRICES_ADJUSTMENTS","description":"Both price fields and `compareAtPriceDiscount` provided. The `actualPrice` and `compareAtPrice` can't be combined with `compareAtPriceDiscount`.","errorType":"VALIDATION","validationErrorData":{"ruleName":"INVALID_PRICES_ADJUSTMENTS"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION_CHOICE","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionChoiceErrorData","description":"Variant choice doesn't exist in the product's option choices.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionErrorData","description":"Variant option doesn't exist in the product's options.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkAdjustProductVariantsByFilterRequest","responseMessage":"wix.stores.catalog.v3.BulkAdjustProductVariantsByFilterResponse"},"legacyExamples":[{"name":"BulkAdjustProductVariantsByFilter","type":"METHOD","content":{"title":"Bulk adjust product variants by filter","description":"Decreases the actual price, compare at price, and cost of all product variants that were created after July 22nd, 2024.","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/adjust-variants-by-filter' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"filter\": {\n \"createdDate\": {\n \"$gt\": \"2024-07-22T13:22:45\"\n }\n },\n \"actualPrice\": {\n \"amount\": \"-1\"\n },\n \"compareAtPrice\": {\n \"amount\": \"-1\"\n },\n \"cost\": {\n \"amount\": \"-1\"\n }\n }'","response":"{\n \"jobId\": \"e95725e2-9159-4d45-b1c5-d3a0fed56d7b\"\n}"}}],"sdkData":{"signature":{"resolved":[{"field":{"path":"filter"}},{"parent":{"name":"options","fields":[{"path":"cost"},{"path":"rounding"},{"path":"search"},{"path":"actualPrice"},{"path":"compareAtPrice"},{"path":"compareAtPriceDiscount"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Bulk adjust product variants by filter","description":"Decrease the actual price, compare at price, and cost of all variants for products created after a specific date.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst filter = {\n createdDate: {\n $gt: \"2024-07-22T13:22:45\"\n }\n};\n\nconst options = {\n actualPrice: {\n amount: \"-1\"\n },\n compareAtPrice: {\n amount: \"-1\"\n },\n cost: {\n amount: \"-1\"\n }\n};\n\nasync function bulkAdjustProductVariantsByFilter() {\n const response = await productsV3.bulkAdjustProductVariantsByFilter(filter, options);\n}\n\n/* Promise resolves to:\n * {\n * \"jobId\": \"e95725e2-9159-4d45-b1c5-d3a0fed56d7b\"\n * }\n */\n\n","order":1,"source":"manual"},{"title":"bulkAdjustProductVariantsByFilter (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function BulkAdjustProductVariantsByFilter() {\n const response = await myWixClient.productsV3.BulkAdjustProductVariantsByFilter();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Adjust Product Variants By Filter","slugifiedName":"bulk-adjust-product-variants-by-filter"},"permissionScopes":[{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}],"isAdminMethod":true},{"summary":"Bulk Create Products With Inventory","description":"Creates up to 100 products, and can create the products' inventories in the variants' default locations.\n\n>**Note:**\n> The following limits apply to the total number of creatable entities in a single request.\n>\n> + `options`: 100\n> + `modifiers`: 100\n> + `infoSections`: 100\n> + `variantsInfo.variants`: 1000\n>\n> For example, you can create 10 products with up to 10 options for each product (10 x 10 = 100), or 1 product with 100 options.\n> Alternatively, you can create 100 products with up to 10 variants in each (100 x 10 = 1000), or 1 product with 1000 variants.","operationId":"wix.stores.catalog.v3.CatalogApi.BulkCreateProductsWithInventory","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkCreateProductsWithInventoryResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkCreateProductsWithInventoryRequest","description":"","properties":{"products":{"description":"List of products to create with inventory.","minItems":1,"maxItems":100,"title":"products","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.v3.ProductWithInventory"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the full product entities in the response.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.MultipleEntitiesOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["products","products.name","products.productType","products.variantsInfo","products.variantsInfo.variants.choices.optionChoiceIds.optionId","products.variantsInfo.variants.choices.optionChoiceIds.choiceId","products.variantsInfo.variants.price","products.variantsInfo.variants.price.actualPrice","products.variantsInfo.variants.physicalProperties.pricePerUnit.settings.measurementUnit","products.variantsInfo.variants.digitalProperties.digitalFile","products.variantsInfo.variants.digitalProperties.digitalFile.id","products.physicalProperties.pricePerUnit.measurementUnit","products.subscriptionDetails.subscriptions","products.subscriptionDetails.subscriptions.title","products.subscriptionDetails.subscriptions.frequency","products.subscriptionDetails.subscriptions.discount.type"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Product Created","description":"","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_created","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.BulkCreateProductsWithInventory","methodName":"BulkCreateProductsWithInventory","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"RIBBON_NOT_FOUND","description":"Couldn't find the ribbon.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"RIBBON_NOT_FOUND"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"RIBBON_CREATION_FAILED","description":"Ribbon creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"RIBBON_CREATION_FAILED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INFO_SECTION_CREATION_FAILED","description":"Info section creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INFO_SECTION_CREATION_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CUSTOMIZATION_NOT_EXIST","description":"Couldn't find the customization.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CUSTOMIZATION_NOT_EXIST"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"CUSTOMIZATIONS_CREATION_FAILED","description":"Customization creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CUSTOMIZATIONS_CREATION_FAILED"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED","description":"Failed to add customization choices.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CHOICE_NOT_EXIST","description":"Couldn't find the choice.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CHOICE_NOT_EXIST"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRODUCT_OPTION_NAME_AND_TYPE_REQUIRED","description":"Option is missing `name` or `type`. Options without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRODUCT_OPTION_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRODUCT_OPTION_CHOICE_NAME_AND_TYPE_REQUIRED","description":"Option choice is missing `name` or `type`. Choices without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRODUCT_OPTION_CHOICE_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MODIFIER_NAME_AND_TYPE_REQUIRED","description":"Modifier is missing `name` or `type`. Modifiers without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MODIFIER_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MODIFIER_CHOICE_NAME_AND_TYPE_REQUIRED","description":"Modifier choice is missing `name` or `type`. Choices without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MODIFIER_CHOICE_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TOO_MANY_OPTIONS_IN_REQUEST","description":"Number of options exceeds the server's limit.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"TOO_MANY_OPTIONS_IN_REQUEST"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE","description":"The `compareAtPrice` is lower than the `actualPrice`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE","description":"Inventory quantity is negative. The quantity must be non-negative.","errorType":"VALIDATION","validationErrorData":{"ruleName":"REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"BRAND_MISSING_ID","description":"Brand is missing an `id`.","errorType":"VALIDATION","validationErrorData":{"ruleName":"BRAND_MISSING_ID"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"ID_NOT_ALLOWED_IN_REQUEST","description":"Request includes the `id` field. For this operation, `id` is auto-generated and can't be passed in the request.","errorType":"VALIDATION","validationErrorData":{"ruleName":"ID_NOT_ALLOWED_IN_REQUEST"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRICE_PER_UNIT_NOT_ALIGNED","description":"Price per unit isn't aligned between product and variants.","errorType":"VALIDATION","validationErrorData":{"ruleName":"PRICE_PER_UNIT_NOT_ALIGNED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION_CHOICE","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionChoiceErrorData","description":"Variant choice doesn't exist in the product's option choices.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionErrorData","description":"Variant option doesn't exist in the product's options.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_CREATE","WIX_STORES.INVENTORY_CREATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkCreateProductsWithInventoryRequest","responseMessage":"wix.stores.catalog.v3.BulkCreateProductsWithInventoryResponse"},"legacyExamples":[{"name":"BulkCreateProductsWithInventory","type":"METHOD","content":{"title":"Bulk create products","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/create' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"fields\": [\n \"CURRENCY\"\n ],\n \"products\": [\n {\n \"name\": \"Coffee\",\n \"productType\": \"PHYSICAL\",\n \"variantsInfo\": {\n \"variants\": [\n {\n \"sku\": \"7777788\",\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"10\"\n }\n },\n \"inventoryItem\": {\n \"preorderInfo\": {\n \"enabled\": true,\n \"limit\": 10,\n \"quantity\": 3\n },\n \"quantity\": 19000\n },\n \"physicalProperties\": {}\n }\n ]\n },\n \"physicalProperties\": {}\n },\n {\n \"name\": \"Chocolate bar\",\n \"visible\": false,\n \"productType\": \"PHYSICAL\",\n \"variantsInfo\": {\n \"variants\": [\n {\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"6\"\n },\n \"compareAtPrice\": {\n \"amount\": \"7\"\n }\n }\n }\n ]\n },\n \"physicalProperties\": {}\n }\n ],\n \"returnEntity\": true\n }'","response":"{\n \"productResults\": {\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"4de56f39-7cfd-4e6b-8437-25825d9d5d6a\",\n \"originalIndex\": 0,\n \"success\": true,\n \"error\": null\n },\n \"item\": {\n \"id\": \"4de56f39-7cfd-4e6b-8437-25825d9d5d6a\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-02T07:40:14.776Z\",\n \"updatedDate\": \"2025-01-02T07:40:14.776Z\",\n \"name\": \"Coffee\",\n \"slug\": \"coffee-6\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": null,\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"IN_STOCK\",\n \"preorderStatus\": \"ENABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": null,\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_3d88a9cf-39e7-47c7-9c95-40b71b00098a\",\n \"currency\": \"USD\",\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"ccf43445-fc4f-4a21-9bd8-075c6f2880c1\",\n \"visible\": true,\n \"sku\": \"7777788\",\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"compareAtPrice\": null\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": null,\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n },\n \"physicalProperties\": {\n \"weight\": null,\n \"pricePerUnit\": null\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735803614775000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"6f1e726f-b47a-48bf-87da-e6501309ca87\",\n \"originalIndex\": 1,\n \"success\": true,\n \"error\": null\n },\n \"item\": {\n \"id\": \"6f1e726f-b47a-48bf-87da-e6501309ca87\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-02T07:40:14.776Z\",\n \"updatedDate\": \"2025-01-02T07:40:14.776Z\",\n \"name\": \"Chocolate bar\",\n \"slug\": \"chocolate-bar-11\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": false,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": null,\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": null,\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_67ab062e-4c8b-4507-aff0-cd4520d9af0c\",\n \"currency\": \"USD\",\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"6.00\",\n \"formattedAmount\": \"$6.00\"\n },\n \"maxValue\": {\n \"amount\": \"6.00\",\n \"formattedAmount\": \"$6.00\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"7.00\",\n \"formattedAmount\": \"$7.00\"\n },\n \"maxValue\": {\n \"amount\": \"7.00\",\n \"formattedAmount\": \"$7.00\"\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"d254f7f4-1aa4-423f-a5ad-8e1260224339\",\n \"visible\": true,\n \"sku\": null,\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"6.00\",\n \"formattedAmount\": \"$6.00\"\n },\n \"compareAtPrice\": {\n \"amount\": \"7.00\",\n \"formattedAmount\": \"$7.00\"\n }\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": null,\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735803614775001\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n },\n \"inventoryResults\": {\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"2e1c8e1a-4534-4803-894a-3a4b2229149e\",\n \"originalIndex\": 0,\n \"success\": true,\n \"error\": null\n },\n \"item\": {\n \"id\": \"2e1c8e1a-4534-4803-894a-3a4b2229149e\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-02T07:40:14.880Z\",\n \"updatedDate\": \"2025-01-02T07:40:14.880Z\",\n \"variantId\": \"ccf43445-fc4f-4a21-9bd8-075c6f2880c1\",\n \"locationId\": \"12fd1450-8f43-425a-87e7-3cb48bfc1249\",\n \"productId\": \"4de56f39-7cfd-4e6b-8437-25825d9d5d6a\",\n \"quantity\": 19000,\n \"trackQuantity\": true,\n \"availabilityStatus\": \"IN_STOCK\",\n \"preorderInfo\": {\n \"enabled\": true,\n \"counter\": 0,\n \"limit\": 10,\n \"message\": null,\n \"quantity\": 10\n },\n \"product\": null,\n \"extendedFields\": null\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n },\n \"error\": null\n }\n}"}}],"sdkData":{"signature":{"resolved":[{"field":{"path":"products"}},{"parent":{"name":"options","fields":[{"path":"returnEntity"},{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Bulk create products with inventory","description":"Create multiple products with embedded inventory items including preorder settings.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst products = [\n {\n name: \"Coffee\",\n productType: \"PHYSICAL\",\n variantsInfo: {\n variants: [\n {\n sku: \"7777788\",\n price: {\n actualPrice: {\n amount: \"10\"\n }\n },\n inventoryItem: {\n preorderInfo: {\n enabled: true,\n limit: 10,\n quantity: 3\n },\n quantity: 19000\n },\n physicalProperties: {}\n }\n ]\n },\n physicalProperties: {}\n },\n {\n name: \"Chocolate bar\",\n visible: false,\n productType: \"PHYSICAL\",\n variantsInfo: {\n variants: [\n {\n price: {\n actualPrice: {\n amount: \"6\"\n },\n compareAtPrice: {\n amount: \"7\"\n }\n }\n }\n ]\n },\n physicalProperties: {}\n }\n];\n\nconst options = {\n fields: [\"CURRENCY\"],\n returnEntity: true\n};\n\nasync function bulkCreateProductsWithInventory() {\n const response = await productsV3.bulkCreateProductsWithInventory(products, options);\n}\n\n/* Promise resolves to:\n * {\n * \"productResults\": {\n * \"results\": [\n * {\n * \"itemMetadata\": { \"id\": \"4de56f39-...\", \"originalIndex\": 0, \"success\": true },\n * \"item\": {\n * \"_id\": \"4de56f39-7cfd-4e6b-8437-25825d9d5d6a\",\n * \"revision\": \"1\",\n * \"name\": \"Coffee\",\n * \"slug\": \"coffee-6\",\n * \"visible\": true,\n * \"productType\": \"PHYSICAL\",\n * \"currency\": \"USD\",\n * \"inventory\": { \"availabilityStatus\": \"IN_STOCK\", \"preorderStatus\": \"ENABLED\" },\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"10.00\", \"formattedAmount\": \"$10.00\" },\n * \"maxValue\": { \"amount\": \"10.00\", \"formattedAmount\": \"$10.00\" }\n * }\n * }\n * },\n * {\n * \"itemMetadata\": { \"id\": \"6f1e726f-...\", \"originalIndex\": 1, \"success\": true },\n * \"item\": {\n * \"_id\": \"6f1e726f-b47a-48bf-87da-e6501309ca87\",\n * \"revision\": \"1\",\n * \"name\": \"Chocolate bar\",\n * \"slug\": \"chocolate-bar-11\",\n * \"visible\": false,\n * \"productType\": \"PHYSICAL\",\n * \"currency\": \"USD\",\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"6.00\", \"formattedAmount\": \"$6.00\" },\n * \"maxValue\": { \"amount\": \"6.00\", \"formattedAmount\": \"$6.00\" }\n * }\n * }\n * }\n * ],\n * \"bulkActionMetadata\": { \"totalSuccesses\": 2, \"totalFailures\": 0 }\n * },\n * \"inventoryResults\": {\n * \"results\": [\n * {\n * \"itemMetadata\": { \"id\": \"2e1c8e1a-...\", \"originalIndex\": 0, \"success\": true },\n * \"item\": {\n * \"_id\": \"2e1c8e1a-4534-4803-894a-3a4b2229149e\",\n * \"variantId\": \"ccf43445-fc4f-4a21-9bd8-075c6f2880c1\",\n * \"productId\": \"4de56f39-7cfd-4e6b-8437-25825d9d5d6a\",\n * \"quantity\": 19000,\n * \"trackQuantity\": true,\n * \"availabilityStatus\": \"IN_STOCK\",\n * \"preorderInfo\": { \"enabled\": true, \"limit\": 10 }\n * }\n * }\n * ],\n * \"bulkActionMetadata\": { \"totalSuccesses\": 1, \"totalFailures\": 0 }\n * }\n * }\n */\n\n","order":1,"source":"manual"},{"title":"bulkCreateProductsWithInventory (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function BulkCreateProductsWithInventory() {\n const response = await myWixClient.productsV3.BulkCreateProductsWithInventory();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products-with-inventory/create","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/stores","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products","destinationPath":"/v3/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products","destinationPath":"/v3/bulk/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"www._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://blocks.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://create.editorx/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"create.editorx","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wixapps.net/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://*.dev.wix-code.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://_/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products-with-inventory","destinationPath":"/v3/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products-with-inventory","destinationPath":"/v3/bulk/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/all-products-category","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/all-products-category","destinationPath":"/v3/all-products-category","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}}],"triggeredEvents":[{"title":"Product Created","description":"","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_created","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.BulkCreateProductsWithInventory","methodName":"BulkCreateProductsWithInventory","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"RIBBON_NOT_FOUND","description":"Couldn't find the ribbon.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"RIBBON_NOT_FOUND"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"RIBBON_CREATION_FAILED","description":"Ribbon creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"RIBBON_CREATION_FAILED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INFO_SECTION_CREATION_FAILED","description":"Info section creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INFO_SECTION_CREATION_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CUSTOMIZATION_NOT_EXIST","description":"Couldn't find the customization.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CUSTOMIZATION_NOT_EXIST"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"CUSTOMIZATIONS_CREATION_FAILED","description":"Customization creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CUSTOMIZATIONS_CREATION_FAILED"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED","description":"Failed to add customization choices.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CHOICE_NOT_EXIST","description":"Couldn't find the choice.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CHOICE_NOT_EXIST"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRODUCT_OPTION_NAME_AND_TYPE_REQUIRED","description":"Option is missing `name` or `type`. Options without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRODUCT_OPTION_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRODUCT_OPTION_CHOICE_NAME_AND_TYPE_REQUIRED","description":"Option choice is missing `name` or `type`. Choices without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRODUCT_OPTION_CHOICE_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MODIFIER_NAME_AND_TYPE_REQUIRED","description":"Modifier is missing `name` or `type`. Modifiers without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MODIFIER_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MODIFIER_CHOICE_NAME_AND_TYPE_REQUIRED","description":"Modifier choice is missing `name` or `type`. Choices without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MODIFIER_CHOICE_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TOO_MANY_OPTIONS_IN_REQUEST","description":"Number of options exceeds the server's limit.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"TOO_MANY_OPTIONS_IN_REQUEST"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE","description":"The `compareAtPrice` is lower than the `actualPrice`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE","description":"Inventory quantity is negative. The quantity must be non-negative.","errorType":"VALIDATION","validationErrorData":{"ruleName":"REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"BRAND_MISSING_ID","description":"Brand is missing an `id`.","errorType":"VALIDATION","validationErrorData":{"ruleName":"BRAND_MISSING_ID"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"ID_NOT_ALLOWED_IN_REQUEST","description":"Request includes the `id` field. For this operation, `id` is auto-generated and can't be passed in the request.","errorType":"VALIDATION","validationErrorData":{"ruleName":"ID_NOT_ALLOWED_IN_REQUEST"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRICE_PER_UNIT_NOT_ALIGNED","description":"Price per unit isn't aligned between product and variants.","errorType":"VALIDATION","validationErrorData":{"ruleName":"PRICE_PER_UNIT_NOT_ALIGNED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION_CHOICE","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionChoiceErrorData","description":"Variant choice doesn't exist in the product's option choices.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionErrorData","description":"Variant option doesn't exist in the product's options.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_CREATE","WIX_STORES.INVENTORY_CREATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkCreateProductsWithInventoryRequest","responseMessage":"wix.stores.catalog.v3.BulkCreateProductsWithInventoryResponse"},"legacyExamples":[{"name":"BulkCreateProductsWithInventory","type":"METHOD","content":{"title":"Bulk create products","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/create' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"fields\": [\n \"CURRENCY\"\n ],\n \"products\": [\n {\n \"name\": \"Coffee\",\n \"productType\": \"PHYSICAL\",\n \"variantsInfo\": {\n \"variants\": [\n {\n \"sku\": \"7777788\",\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"10\"\n }\n },\n \"inventoryItem\": {\n \"preorderInfo\": {\n \"enabled\": true,\n \"limit\": 10,\n \"quantity\": 3\n },\n \"quantity\": 19000\n },\n \"physicalProperties\": {}\n }\n ]\n },\n \"physicalProperties\": {}\n },\n {\n \"name\": \"Chocolate bar\",\n \"visible\": false,\n \"productType\": \"PHYSICAL\",\n \"variantsInfo\": {\n \"variants\": [\n {\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"6\"\n },\n \"compareAtPrice\": {\n \"amount\": \"7\"\n }\n }\n }\n ]\n },\n \"physicalProperties\": {}\n }\n ],\n \"returnEntity\": true\n }'","response":"{\n \"productResults\": {\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"4de56f39-7cfd-4e6b-8437-25825d9d5d6a\",\n \"originalIndex\": 0,\n \"success\": true,\n \"error\": null\n },\n \"item\": {\n \"id\": \"4de56f39-7cfd-4e6b-8437-25825d9d5d6a\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-02T07:40:14.776Z\",\n \"updatedDate\": \"2025-01-02T07:40:14.776Z\",\n \"name\": \"Coffee\",\n \"slug\": \"coffee-6\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": null,\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"IN_STOCK\",\n \"preorderStatus\": \"ENABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": null,\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_3d88a9cf-39e7-47c7-9c95-40b71b00098a\",\n \"currency\": \"USD\",\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"ccf43445-fc4f-4a21-9bd8-075c6f2880c1\",\n \"visible\": true,\n \"sku\": \"7777788\",\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"compareAtPrice\": null\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": null,\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n },\n \"physicalProperties\": {\n \"weight\": null,\n \"pricePerUnit\": null\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735803614775000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"6f1e726f-b47a-48bf-87da-e6501309ca87\",\n \"originalIndex\": 1,\n \"success\": true,\n \"error\": null\n },\n \"item\": {\n \"id\": \"6f1e726f-b47a-48bf-87da-e6501309ca87\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-02T07:40:14.776Z\",\n \"updatedDate\": \"2025-01-02T07:40:14.776Z\",\n \"name\": \"Chocolate bar\",\n \"slug\": \"chocolate-bar-11\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": false,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": null,\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": null,\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_67ab062e-4c8b-4507-aff0-cd4520d9af0c\",\n \"currency\": \"USD\",\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"6.00\",\n \"formattedAmount\": \"$6.00\"\n },\n \"maxValue\": {\n \"amount\": \"6.00\",\n \"formattedAmount\": \"$6.00\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"7.00\",\n \"formattedAmount\": \"$7.00\"\n },\n \"maxValue\": {\n \"amount\": \"7.00\",\n \"formattedAmount\": \"$7.00\"\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"d254f7f4-1aa4-423f-a5ad-8e1260224339\",\n \"visible\": true,\n \"sku\": null,\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"6.00\",\n \"formattedAmount\": \"$6.00\"\n },\n \"compareAtPrice\": {\n \"amount\": \"7.00\",\n \"formattedAmount\": \"$7.00\"\n }\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": null,\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735803614775001\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n },\n \"inventoryResults\": {\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"2e1c8e1a-4534-4803-894a-3a4b2229149e\",\n \"originalIndex\": 0,\n \"success\": true,\n \"error\": null\n },\n \"item\": {\n \"id\": \"2e1c8e1a-4534-4803-894a-3a4b2229149e\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-02T07:40:14.880Z\",\n \"updatedDate\": \"2025-01-02T07:40:14.880Z\",\n \"variantId\": \"ccf43445-fc4f-4a21-9bd8-075c6f2880c1\",\n \"locationId\": \"12fd1450-8f43-425a-87e7-3cb48bfc1249\",\n \"productId\": \"4de56f39-7cfd-4e6b-8437-25825d9d5d6a\",\n \"quantity\": 19000,\n \"trackQuantity\": true,\n \"availabilityStatus\": \"IN_STOCK\",\n \"preorderInfo\": {\n \"enabled\": true,\n \"counter\": 0,\n \"limit\": 10,\n \"message\": null,\n \"quantity\": 10\n },\n \"product\": null,\n \"extendedFields\": null\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n },\n \"error\": null\n }\n}"}}],"sdkData":{"signature":{"resolved":[{"field":{"path":"products"}},{"parent":{"name":"options","fields":[{"path":"returnEntity"},{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Bulk create products with inventory","description":"Create multiple products with embedded inventory items including preorder settings.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst products = [\n {\n name: \"Coffee\",\n productType: \"PHYSICAL\",\n variantsInfo: {\n variants: [\n {\n sku: \"7777788\",\n price: {\n actualPrice: {\n amount: \"10\"\n }\n },\n inventoryItem: {\n preorderInfo: {\n enabled: true,\n limit: 10,\n quantity: 3\n },\n quantity: 19000\n },\n physicalProperties: {}\n }\n ]\n },\n physicalProperties: {}\n },\n {\n name: \"Chocolate bar\",\n visible: false,\n productType: \"PHYSICAL\",\n variantsInfo: {\n variants: [\n {\n price: {\n actualPrice: {\n amount: \"6\"\n },\n compareAtPrice: {\n amount: \"7\"\n }\n }\n }\n ]\n },\n physicalProperties: {}\n }\n];\n\nconst options = {\n fields: [\"CURRENCY\"],\n returnEntity: true\n};\n\nasync function bulkCreateProductsWithInventory() {\n const response = await productsV3.bulkCreateProductsWithInventory(products, options);\n}\n\n/* Promise resolves to:\n * {\n * \"productResults\": {\n * \"results\": [\n * {\n * \"itemMetadata\": { \"id\": \"4de56f39-...\", \"originalIndex\": 0, \"success\": true },\n * \"item\": {\n * \"_id\": \"4de56f39-7cfd-4e6b-8437-25825d9d5d6a\",\n * \"revision\": \"1\",\n * \"name\": \"Coffee\",\n * \"slug\": \"coffee-6\",\n * \"visible\": true,\n * \"productType\": \"PHYSICAL\",\n * \"currency\": \"USD\",\n * \"inventory\": { \"availabilityStatus\": \"IN_STOCK\", \"preorderStatus\": \"ENABLED\" },\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"10.00\", \"formattedAmount\": \"$10.00\" },\n * \"maxValue\": { \"amount\": \"10.00\", \"formattedAmount\": \"$10.00\" }\n * }\n * }\n * },\n * {\n * \"itemMetadata\": { \"id\": \"6f1e726f-...\", \"originalIndex\": 1, \"success\": true },\n * \"item\": {\n * \"_id\": \"6f1e726f-b47a-48bf-87da-e6501309ca87\",\n * \"revision\": \"1\",\n * \"name\": \"Chocolate bar\",\n * \"slug\": \"chocolate-bar-11\",\n * \"visible\": false,\n * \"productType\": \"PHYSICAL\",\n * \"currency\": \"USD\",\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"6.00\", \"formattedAmount\": \"$6.00\" },\n * \"maxValue\": { \"amount\": \"6.00\", \"formattedAmount\": \"$6.00\" }\n * }\n * }\n * }\n * ],\n * \"bulkActionMetadata\": { \"totalSuccesses\": 2, \"totalFailures\": 0 }\n * },\n * \"inventoryResults\": {\n * \"results\": [\n * {\n * \"itemMetadata\": { \"id\": \"2e1c8e1a-...\", \"originalIndex\": 0, \"success\": true },\n * \"item\": {\n * \"_id\": \"2e1c8e1a-4534-4803-894a-3a4b2229149e\",\n * \"variantId\": \"ccf43445-fc4f-4a21-9bd8-075c6f2880c1\",\n * \"productId\": \"4de56f39-7cfd-4e6b-8437-25825d9d5d6a\",\n * \"quantity\": 19000,\n * \"trackQuantity\": true,\n * \"availabilityStatus\": \"IN_STOCK\",\n * \"preorderInfo\": { \"enabled\": true, \"limit\": 10 }\n * }\n * }\n * ],\n * \"bulkActionMetadata\": { \"totalSuccesses\": 1, \"totalFailures\": 0 }\n * }\n * }\n */\n\n","order":1,"source":"manual"},{"title":"bulkCreateProductsWithInventory (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function BulkCreateProductsWithInventory() {\n const response = await myWixClient.productsV3.BulkCreateProductsWithInventory();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Create Products With Inventory","slugifiedName":"bulk-create-products-with-inventory"},"permissionScopes":[{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Inventory write in v3 catalog","scopeId":"SCOPE.STORES.INVENTORY_ITEM_WRITE"}],"isAdminMethod":true},{"summary":"Bulk Delete Products By Filter","description":"Delete multiple products given the provided filter.","operationId":"wix.stores.catalog.v3.CatalogApi.BulkDeleteProductsByFilter","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkDeleteProductsByFilterResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkDeleteProductsByFilterRequest","description":"","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","$ref":"#/components/schemas/google.protobuf.Struct","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Free text to match in searchable fields.","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["filter"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Product Deleted","description":"Triggered when a product is deleted.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_deleted","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.BulkDeleteProductsByFilter","methodName":"BulkDeleteProductsByFilter","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_DELETE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkDeleteProductsByFilterRequest","responseMessage":"wix.stores.catalog.v3.BulkDeleteProductsByFilterResponse"},"legacyExamples":[{"name":"BulkDeleteProductsByFilter","type":"METHOD","content":{"title":"Bulk delete products by filter from store","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/delete-by-filter' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"filter\": {\n \"createdDate\": {\n \"$gt\": \"2024-07-19T10:28:00\"\n }\n },\n \"search\": {\n \"expression\": \"bar\"\n }\n }'","response":"{\n \"jobId\": \"d4578ecb-9f55-4953-a29c-5fbfd379a40b\"\n}"}}],"sdkData":{"signature":{"resolved":[{"field":{"path":"filter"}},{"parent":{"name":"options","fields":[{"path":"search"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"bulkDeleteProductsByFilter","description":"","content":"import { productsV3 } from '@wix/stores';\n\nasync function bulkDeleteProductsByFilter(filter, options) {\n const response = await productsV3.bulkDeleteProductsByFilter(filter, options);\n};","order":1,"source":"generated"},{"title":"bulkDeleteProductsByFilter (with elevated permissions)","description":"","content":"import { productsV3 } from '@wix/stores';\nimport { auth } from '@wix/essentials';\n\nasync function myBulkDeleteProductsByFilterMethod(filter, options) {\n const elevatedBulkDeleteProductsByFilter = auth.elevate(productsV3.bulkDeleteProductsByFilter);\n const response = await elevatedBulkDeleteProductsByFilter(filter, options);\n}","order":4,"source":"generated"},{"title":"bulkDeleteProductsByFilter (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function bulkDeleteProductsByFilter(filter, options) {\n const response = await myWixClient.productsV3.bulkDeleteProductsByFilter(filter, options);\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products/delete-by-filter","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/stores","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products","destinationPath":"/v3/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products","destinationPath":"/v3/bulk/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"www._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://blocks.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://create.editorx/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"create.editorx","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wixapps.net/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://*.dev.wix-code.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://_/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products-with-inventory","destinationPath":"/v3/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products-with-inventory","destinationPath":"/v3/bulk/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/all-products-category","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/all-products-category","destinationPath":"/v3/all-products-category","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}}],"triggeredEvents":[{"title":"Product Deleted","description":"Triggered when a product is deleted.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_deleted","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.BulkDeleteProductsByFilter","methodName":"BulkDeleteProductsByFilter","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_DELETE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkDeleteProductsByFilterRequest","responseMessage":"wix.stores.catalog.v3.BulkDeleteProductsByFilterResponse"},"legacyExamples":[{"name":"BulkDeleteProductsByFilter","type":"METHOD","content":{"title":"Bulk delete products by filter from store","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/delete-by-filter' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"filter\": {\n \"createdDate\": {\n \"$gt\": \"2024-07-19T10:28:00\"\n }\n },\n \"search\": {\n \"expression\": \"bar\"\n }\n }'","response":"{\n \"jobId\": \"d4578ecb-9f55-4953-a29c-5fbfd379a40b\"\n}"}}],"sdkData":{"signature":{"resolved":[{"field":{"path":"filter"}},{"parent":{"name":"options","fields":[{"path":"search"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"bulkDeleteProductsByFilter","description":"","content":"import { productsV3 } from '@wix/stores';\n\nasync function bulkDeleteProductsByFilter(filter, options) {\n const response = await productsV3.bulkDeleteProductsByFilter(filter, options);\n};","order":1,"source":"generated"},{"title":"bulkDeleteProductsByFilter (with elevated permissions)","description":"","content":"import { productsV3 } from '@wix/stores';\nimport { auth } from '@wix/essentials';\n\nasync function myBulkDeleteProductsByFilterMethod(filter, options) {\n const elevatedBulkDeleteProductsByFilter = auth.elevate(productsV3.bulkDeleteProductsByFilter);\n const response = await elevatedBulkDeleteProductsByFilter(filter, options);\n}","order":4,"source":"generated"},{"title":"bulkDeleteProductsByFilter (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function bulkDeleteProductsByFilter(filter, options) {\n const response = await myWixClient.productsV3.bulkDeleteProductsByFilter(filter, options);\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Delete Products By Filter","slugifiedName":"bulk-delete-products-by-filter"},"permissionScopes":[{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}],"isAdminMethod":true},{"summary":"Bulk Remove Info Sections From Products","description":"Removes [info sections](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/info-sections-v3/introduction) from multiple products.","operationId":"wix.stores.catalog.v3.CatalogApi.BulkRemoveInfoSectionsFromProducts","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkRemoveInfoSectionsFromProductsResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkRemoveInfoSectionsFromProductsRequest","description":"","properties":{"products":{"description":"List of product IDs and revisions.","minItems":1,"maxItems":100,"title":"products","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.v3.ProductIdWithRevision"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"infoSectionIds":{"description":"List of IDs of info sections to remove.","format":"GUID","minItems":1,"maxItems":100,"title":"infoSectionIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the full updated product entities in the response.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.MultipleEntitiesOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["products","infoSectionIds"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_updated","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.BulkRemoveInfoSectionsFromProducts","methodName":"BulkRemoveInfoSectionsFromProducts","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkRemoveInfoSectionsFromProductsRequest","responseMessage":"wix.stores.catalog.v3.BulkRemoveInfoSectionsFromProductsResponse"},"legacyExamples":[{"name":"BulkRemoveInfoSectionsFromProducts","type":"METHOD","content":{"title":"Bulk remove info sections to products","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/remove-info-sections' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"fields\": [\n ],\n \"infoSectionIds\": [\n \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\",\n \"1dac2b73-3592-4d80-9a6e-4892caf4e058\"\n ],\n \"products\": [\n {\n \"productId\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"revision\": \"11\"\n },\n {\n \"productId\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"revision\": \"8\"\n }\n ],\n \"returnEntity\": true\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"item\": {\n \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"revision\": \"12\",\n \"createdDate\": \"2024-07-22T13:22:47.771Z\",\n \"updatedDate\": \"2024-07-22T16:40:50.698Z\",\n \"name\": \"Premium Coffee\",\n \"slug\": \"coffee\",\n \"visible\": false,\n \"visibleInPos\": false,\n \"media\": {\n \"main\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n }\n },\n \"options\": [\n {\n \"id\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"name\": \"Size\",\n \"optionRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"4498b805-2aed-43fb-b478-989c906c19cd\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"S\",\n \"name\": \"S\",\n \"inStock\": true\n },\n {\n \"choiceId\": \"26394ab0-d81a-422f-a8c9-562f49a6b595\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"L\",\n \"name\": \"L\",\n \"inStock\": false\n }\n ]\n },\n \"key\": \"Size\"\n },\n {\n \"id\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"name\": \"Box color\",\n \"optionRenderType\": \"SWATCH_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"2e98f13b-ae65-4d30-96c5-ac3a6cf99d60\",\n \"linkedMedia\": [],\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"red\",\n \"name\": \"red\",\n \"colorCode\": \"#FF0000\",\n \"inStock\": true\n },\n {\n \"choiceId\": \"4876dcc7-817e-4c10-a6b2-4a4cc2e241e6\",\n \"linkedMedia\": [],\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"blue\",\n \"name\": \"blue\",\n \"colorCode\": \"#0000FF\",\n \"inStock\": false\n }\n ]\n },\n \"key\": \"Box color\"\n }\n ],\n \"modifiers\": [\n {\n \"id\": \"a3d249f0-a8da-425d-9ec1-3c51c795d927\",\n \"name\": \"Remove price tag\",\n \"modifierRenderType\": \"TEXT_CHOICES\",\n \"mandatory\": false,\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"3050481e-e177-4031-bbe9-be9b00af14b5\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"yes\",\n \"name\": \"yes\"\n },\n {\n \"choiceId\": \"ee729b74-d500-4594-aae5-b5a2e75bf5e7\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"no\",\n \"name\": \"no\"\n }\n ]\n },\n \"key\": \"Remove price tag\"\n }\n ],\n \"brand\": {\n \"id\": \"4a16d28d-1736-41f0-87d8-995f6d9a5bdd\",\n \"name\": \"EcoCoffee\"\n },\n \"infoSections\": [\n {\n \"id\": \"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\"\n }\n ],\n \"ribbon\": {\n \"id\": \"14585597-3302-4145-8da3-24a26d8346d6\",\n \"name\": \"New arrival\"\n },\n \"mainCategoryId\": \"643721c3-446e-47f3-87ee-0a58d6842d48\",\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"6\"\n },\n \"maxValue\": {\n \"amount\": \"6\"\n }\n },\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"5\"\n },\n \"maxValue\": {\n \"amount\": \"5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": {\n \"quantity\": 1.0,\n \"measurementUnit\": \"KG\"\n },\n \"shippingWeightRange\": {\n \"minValue\": 0.1,\n \"maxValue\": 0.1\n }\n }\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"item\": {\n \"id\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"revision\": \"9\",\n \"createdDate\": \"2024-07-22T14:04:05.787Z\",\n \"updatedDate\": \"2024-07-22T16:40:50.698Z\",\n \"name\": \"Recyclable Shopping bag\",\n \"slug\": \"shopping-bag\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {},\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"mainCategoryId\": \"643721c3-446e-47f3-87ee-0a58d6842d48\",\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {}\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sdkData":{"signature":{"resolved":[{"field":{"path":"products"}},{"parent":{"name":"options","fields":[{"path":"infoSectionIds"},{"path":"returnEntity"},{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Bulk remove info sections from products","description":"","content":"import { productsV3 } from \"@wix/stores\";\n\nconst products = [\n {\n productId: \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n revision: \"11\"\n },\n {\n productId: \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n revision: \"8\"\n }\n];\n\nconst options = {\n infoSectionIds: [\n \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\",\n \"1dac2b73-3592-4d80-9a6e-4892caf4e058\"\n ],\n returnEntity: true\n};\n\nasync function bulkRemoveInfoSectionsFromProducts() {\n const response = await productsV3.bulkRemoveInfoSectionsFromProducts(\n products,\n options\n );\n}\n\n/* Promise resolves to:\n * {\n * \"results\": [\n * {\n * \"itemMetadata\": {\n * \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n * \"originalIndex\": 0,\n * \"success\": true\n * },\n * \"item\": {\n * \"_id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n * \"revision\": \"12\",\n * \"name\": \"Premium Coffee\",\n * \"infoSections\": [\n * { \"id\": \"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\" }\n * ]\n * }\n * }\n * ],\n * \"bulkActionMetadata\": {\n * \"totalSuccesses\": 2,\n * \"totalFailures\": 0\n * }\n * }\n */\n","order":1,"source":"manual"},{"title":"bulkRemoveInfoSectionsFromProducts (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function BulkRemoveInfoSectionsFromProducts() {\n const response = await myWixClient.productsV3.BulkRemoveInfoSectionsFromProducts();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products/remove-info-sections","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/stores","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products","destinationPath":"/v3/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products","destinationPath":"/v3/bulk/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"www._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://blocks.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://create.editorx/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"create.editorx","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wixapps.net/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://*.dev.wix-code.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://_/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products-with-inventory","destinationPath":"/v3/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products-with-inventory","destinationPath":"/v3/bulk/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/all-products-category","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/all-products-category","destinationPath":"/v3/all-products-category","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}}],"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_updated","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.BulkRemoveInfoSectionsFromProducts","methodName":"BulkRemoveInfoSectionsFromProducts","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkRemoveInfoSectionsFromProductsRequest","responseMessage":"wix.stores.catalog.v3.BulkRemoveInfoSectionsFromProductsResponse"},"legacyExamples":[{"name":"BulkRemoveInfoSectionsFromProducts","type":"METHOD","content":{"title":"Bulk remove info sections to products","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/remove-info-sections' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"fields\": [\n ],\n \"infoSectionIds\": [\n \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\",\n \"1dac2b73-3592-4d80-9a6e-4892caf4e058\"\n ],\n \"products\": [\n {\n \"productId\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"revision\": \"11\"\n },\n {\n \"productId\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"revision\": \"8\"\n }\n ],\n \"returnEntity\": true\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"item\": {\n \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"revision\": \"12\",\n \"createdDate\": \"2024-07-22T13:22:47.771Z\",\n \"updatedDate\": \"2024-07-22T16:40:50.698Z\",\n \"name\": \"Premium Coffee\",\n \"slug\": \"coffee\",\n \"visible\": false,\n \"visibleInPos\": false,\n \"media\": {\n \"main\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n }\n },\n \"options\": [\n {\n \"id\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"name\": \"Size\",\n \"optionRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"4498b805-2aed-43fb-b478-989c906c19cd\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"S\",\n \"name\": \"S\",\n \"inStock\": true\n },\n {\n \"choiceId\": \"26394ab0-d81a-422f-a8c9-562f49a6b595\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"L\",\n \"name\": \"L\",\n \"inStock\": false\n }\n ]\n },\n \"key\": \"Size\"\n },\n {\n \"id\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"name\": \"Box color\",\n \"optionRenderType\": \"SWATCH_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"2e98f13b-ae65-4d30-96c5-ac3a6cf99d60\",\n \"linkedMedia\": [],\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"red\",\n \"name\": \"red\",\n \"colorCode\": \"#FF0000\",\n \"inStock\": true\n },\n {\n \"choiceId\": \"4876dcc7-817e-4c10-a6b2-4a4cc2e241e6\",\n \"linkedMedia\": [],\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"blue\",\n \"name\": \"blue\",\n \"colorCode\": \"#0000FF\",\n \"inStock\": false\n }\n ]\n },\n \"key\": \"Box color\"\n }\n ],\n \"modifiers\": [\n {\n \"id\": \"a3d249f0-a8da-425d-9ec1-3c51c795d927\",\n \"name\": \"Remove price tag\",\n \"modifierRenderType\": \"TEXT_CHOICES\",\n \"mandatory\": false,\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"3050481e-e177-4031-bbe9-be9b00af14b5\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"yes\",\n \"name\": \"yes\"\n },\n {\n \"choiceId\": \"ee729b74-d500-4594-aae5-b5a2e75bf5e7\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"no\",\n \"name\": \"no\"\n }\n ]\n },\n \"key\": \"Remove price tag\"\n }\n ],\n \"brand\": {\n \"id\": \"4a16d28d-1736-41f0-87d8-995f6d9a5bdd\",\n \"name\": \"EcoCoffee\"\n },\n \"infoSections\": [\n {\n \"id\": \"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\"\n }\n ],\n \"ribbon\": {\n \"id\": \"14585597-3302-4145-8da3-24a26d8346d6\",\n \"name\": \"New arrival\"\n },\n \"mainCategoryId\": \"643721c3-446e-47f3-87ee-0a58d6842d48\",\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"6\"\n },\n \"maxValue\": {\n \"amount\": \"6\"\n }\n },\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"5\"\n },\n \"maxValue\": {\n \"amount\": \"5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": {\n \"quantity\": 1.0,\n \"measurementUnit\": \"KG\"\n },\n \"shippingWeightRange\": {\n \"minValue\": 0.1,\n \"maxValue\": 0.1\n }\n }\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"item\": {\n \"id\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"revision\": \"9\",\n \"createdDate\": \"2024-07-22T14:04:05.787Z\",\n \"updatedDate\": \"2024-07-22T16:40:50.698Z\",\n \"name\": \"Recyclable Shopping bag\",\n \"slug\": \"shopping-bag\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {},\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"mainCategoryId\": \"643721c3-446e-47f3-87ee-0a58d6842d48\",\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {}\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sdkData":{"signature":{"resolved":[{"field":{"path":"products"}},{"parent":{"name":"options","fields":[{"path":"infoSectionIds"},{"path":"returnEntity"},{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Bulk remove info sections from products","description":"","content":"import { productsV3 } from \"@wix/stores\";\n\nconst products = [\n {\n productId: \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n revision: \"11\"\n },\n {\n productId: \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n revision: \"8\"\n }\n];\n\nconst options = {\n infoSectionIds: [\n \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\",\n \"1dac2b73-3592-4d80-9a6e-4892caf4e058\"\n ],\n returnEntity: true\n};\n\nasync function bulkRemoveInfoSectionsFromProducts() {\n const response = await productsV3.bulkRemoveInfoSectionsFromProducts(\n products,\n options\n );\n}\n\n/* Promise resolves to:\n * {\n * \"results\": [\n * {\n * \"itemMetadata\": {\n * \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n * \"originalIndex\": 0,\n * \"success\": true\n * },\n * \"item\": {\n * \"_id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n * \"revision\": \"12\",\n * \"name\": \"Premium Coffee\",\n * \"infoSections\": [\n * { \"id\": \"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\" }\n * ]\n * }\n * }\n * ],\n * \"bulkActionMetadata\": {\n * \"totalSuccesses\": 2,\n * \"totalFailures\": 0\n * }\n * }\n */\n","order":1,"source":"manual"},{"title":"bulkRemoveInfoSectionsFromProducts (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function BulkRemoveInfoSectionsFromProducts() {\n const response = await myWixClient.productsV3.BulkRemoveInfoSectionsFromProducts();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Remove Info Sections From Products","slugifiedName":"bulk-remove-info-sections-from-products"},"permissionScopes":[{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}],"isAdminMethod":true},{"summary":"Bulk Remove Info Sections From Products By Filter","description":"Removes [info sections](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/info-sections-v3/introduction) from multiple products, given the provided filter and search expression.","operationId":"wix.stores.catalog.v3.CatalogApi.BulkRemoveInfoSectionsFromProductsByFilter","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkRemoveInfoSectionsFromProductsByFilterResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkRemoveInfoSectionsFromProductsByFilterRequest","description":"","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","$ref":"#/components/schemas/google.protobuf.Struct","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"infoSectionIds":{"description":"IDs of info sections to remove.","format":"GUID","minItems":1,"maxItems":100,"title":"infoSectionIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Free text to match in searchable fields.","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["filter","infoSectionIds"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_updated","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.BulkRemoveInfoSectionsFromProductsByFilter","methodName":"BulkRemoveInfoSectionsFromProductsByFilter","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkRemoveInfoSectionsFromProductsByFilterRequest","responseMessage":"wix.stores.catalog.v3.BulkRemoveInfoSectionsFromProductsByFilterResponse"},"legacyExamples":[{"name":"BulkRemoveInfoSectionsFromProductsByFilter","type":"METHOD","content":{"title":"Bulk remove info sections to products by filter","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/remove-info-sections-by-filter' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"filter\": {\n \"createdDate\": {\n \"$gt\": \"2024-07-22T13:22:45\"\n }\n },\n \"infoSectionIds\": [\n \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\",\n \"1dac2b73-3592-4d80-9a6e-4892caf4e058\"\n ]\n }'","response":"{\n \"jobId\": \"3ab904a4-d0d5-4e9f-8f48-d9f25bd7178d\"\n}"}}],"sdkData":{"signature":{"resolved":[{"field":{"path":"filter"}},{"parent":{"name":"options","fields":[{"path":"infoSectionIds"},{"path":"search"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Bulk remove info sections from products by filter","description":"Remove info sections from all products created after a specific date.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst filter = {\n createdDate: {\n $gt: \"2024-07-22T13:22:45\"\n }\n};\n\nconst options = {\n infoSectionIds: [\n \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\",\n \"1dac2b73-3592-4d80-9a6e-4892caf4e058\"\n ]\n};\n\nasync function bulkRemoveInfoSectionsFromProductsByFilter() {\n const response = await productsV3.bulkRemoveInfoSectionsFromProductsByFilter(filter, options);\n}\n\n/* Promise resolves to:\n * {\n * \"jobId\": \"3ab904a4-d0d5-4e9f-8f48-d9f25bd7178d\"\n * }\n */\n\n","order":1,"source":"manual"},{"title":"bulkRemoveInfoSectionsFromProductsByFilter (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function BulkRemoveInfoSectionsFromProductsByFilter() {\n const response = await myWixClient.productsV3.BulkRemoveInfoSectionsFromProductsByFilter();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products/remove-info-sections-by-filter","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/stores","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products","destinationPath":"/v3/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products","destinationPath":"/v3/bulk/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"www._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://blocks.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://create.editorx/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"create.editorx","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wixapps.net/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://*.dev.wix-code.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://_/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products-with-inventory","destinationPath":"/v3/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products-with-inventory","destinationPath":"/v3/bulk/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/all-products-category","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/all-products-category","destinationPath":"/v3/all-products-category","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}}],"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_updated","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.BulkRemoveInfoSectionsFromProductsByFilter","methodName":"BulkRemoveInfoSectionsFromProductsByFilter","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkRemoveInfoSectionsFromProductsByFilterRequest","responseMessage":"wix.stores.catalog.v3.BulkRemoveInfoSectionsFromProductsByFilterResponse"},"legacyExamples":[{"name":"BulkRemoveInfoSectionsFromProductsByFilter","type":"METHOD","content":{"title":"Bulk remove info sections to products by filter","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/remove-info-sections-by-filter' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"filter\": {\n \"createdDate\": {\n \"$gt\": \"2024-07-22T13:22:45\"\n }\n },\n \"infoSectionIds\": [\n \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\",\n \"1dac2b73-3592-4d80-9a6e-4892caf4e058\"\n ]\n }'","response":"{\n \"jobId\": \"3ab904a4-d0d5-4e9f-8f48-d9f25bd7178d\"\n}"}}],"sdkData":{"signature":{"resolved":[{"field":{"path":"filter"}},{"parent":{"name":"options","fields":[{"path":"infoSectionIds"},{"path":"search"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Bulk remove info sections from products by filter","description":"Remove info sections from all products created after a specific date.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst filter = {\n createdDate: {\n $gt: \"2024-07-22T13:22:45\"\n }\n};\n\nconst options = {\n infoSectionIds: [\n \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\",\n \"1dac2b73-3592-4d80-9a6e-4892caf4e058\"\n ]\n};\n\nasync function bulkRemoveInfoSectionsFromProductsByFilter() {\n const response = await productsV3.bulkRemoveInfoSectionsFromProductsByFilter(filter, options);\n}\n\n/* Promise resolves to:\n * {\n * \"jobId\": \"3ab904a4-d0d5-4e9f-8f48-d9f25bd7178d\"\n * }\n */\n\n","order":1,"source":"manual"},{"title":"bulkRemoveInfoSectionsFromProductsByFilter (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function BulkRemoveInfoSectionsFromProductsByFilter() {\n const response = await myWixClient.productsV3.BulkRemoveInfoSectionsFromProductsByFilter();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Remove Info Sections From Products By Filter","slugifiedName":"bulk-remove-info-sections-from-products-by-filter"},"permissionScopes":[{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}],"isAdminMethod":true},{"summary":"Bulk Remove Products From Categories By Filter","description":"Removes multiple products, given the provided filter and search expression, from up to 5 categories.\n\nLearn more about the [Categories API](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/categories/introduction).","operationId":"wix.stores.catalog.v3.CatalogApi.BulkRemoveProductsFromCategoriesByFilter","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkRemoveProductsFromCategoriesByFilterResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkRemoveProductsFromCategoriesByFilterRequest","description":"","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","$ref":"#/components/schemas/google.protobuf.Struct","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"categoryIds":{"description":"IDs of the categories from which products will be removed.","format":"GUID","minItems":1,"maxItems":5,"title":"categoryIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Free text to match in searchable fields.","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["categoryIds"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["CATEGORIES.CATEGORY_REMOVE_ITEM"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkRemoveProductsFromCategoriesByFilterRequest","responseMessage":"wix.stores.catalog.v3.BulkRemoveProductsFromCategoriesByFilterResponse"},"legacyExamples":[{"name":"BulkRemoveProductsFromCategoriesByFilter","type":"METHOD","content":{"title":"Bulk remove products from categories by filter","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/remove-from-categories-by-filter' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"categoryIds\": [\n \"7a083f69-3d3e-4cfd-a3ef-43fe68e967e5\"\n ],\n \"filter\": {\n \"productType\": \"PHYSICAL\"\n },\n \"search\": {\n \"expression\": \"Summer\"\n }\n }'","response":"{\n \"jobId\": \"98b3f70d-f632-45e6-89a8-b860e0431f0d\"\n}"}}],"sdkData":{"signature":{"resolved":[{"parent":{"name":"options","fields":[{"path":"filter"},{"path":"categoryIds"},{"path":"search"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Bulk remove products from categories by filter","description":"Remove all physical products containing \"Summer\" in their name from a category.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst options = {\n categoryIds: [\n \"7a083f69-3d3e-4cfd-a3ef-43fe68e967e5\"\n ],\n filter: {\n productType: \"PHYSICAL\"\n },\n search: {\n expression: \"Summer\"\n }\n};\n\nasync function bulkRemoveProductsFromCategoriesByFilter() {\n const response = await productsV3.bulkRemoveProductsFromCategoriesByFilter(options);\n}\n\n/* Promise resolves to:\n * {\n * \"jobId\": \"98b3f70d-f632-45e6-89a8-b860e0431f0d\"\n * }\n */\n\n","order":1,"source":"manual"},{"title":"bulkRemoveProductsFromCategoriesByFilter (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function BulkRemoveProductsFromCategoriesByFilter() {\n const response = await myWixClient.productsV3.BulkRemoveProductsFromCategoriesByFilter();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products/remove-from-categories-by-filter","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/stores","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products","destinationPath":"/v3/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products","destinationPath":"/v3/bulk/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"www._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://blocks.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://create.editorx/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"create.editorx","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wixapps.net/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://*.dev.wix-code.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://_/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products-with-inventory","destinationPath":"/v3/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products-with-inventory","destinationPath":"/v3/bulk/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/all-products-category","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/all-products-category","destinationPath":"/v3/all-products-category","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}}],"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["CATEGORIES.CATEGORY_REMOVE_ITEM"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkRemoveProductsFromCategoriesByFilterRequest","responseMessage":"wix.stores.catalog.v3.BulkRemoveProductsFromCategoriesByFilterResponse"},"legacyExamples":[{"name":"BulkRemoveProductsFromCategoriesByFilter","type":"METHOD","content":{"title":"Bulk remove products from categories by filter","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/remove-from-categories-by-filter' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"categoryIds\": [\n \"7a083f69-3d3e-4cfd-a3ef-43fe68e967e5\"\n ],\n \"filter\": {\n \"productType\": \"PHYSICAL\"\n },\n \"search\": {\n \"expression\": \"Summer\"\n }\n }'","response":"{\n \"jobId\": \"98b3f70d-f632-45e6-89a8-b860e0431f0d\"\n}"}}],"sdkData":{"signature":{"resolved":[{"parent":{"name":"options","fields":[{"path":"filter"},{"path":"categoryIds"},{"path":"search"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Bulk remove products from categories by filter","description":"Remove all physical products containing \"Summer\" in their name from a category.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst options = {\n categoryIds: [\n \"7a083f69-3d3e-4cfd-a3ef-43fe68e967e5\"\n ],\n filter: {\n productType: \"PHYSICAL\"\n },\n search: {\n expression: \"Summer\"\n }\n};\n\nasync function bulkRemoveProductsFromCategoriesByFilter() {\n const response = await productsV3.bulkRemoveProductsFromCategoriesByFilter(options);\n}\n\n/* Promise resolves to:\n * {\n * \"jobId\": \"98b3f70d-f632-45e6-89a8-b860e0431f0d\"\n * }\n */\n\n","order":1,"source":"manual"},{"title":"bulkRemoveProductsFromCategoriesByFilter (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function BulkRemoveProductsFromCategoriesByFilter() {\n const response = await myWixClient.productsV3.BulkRemoveProductsFromCategoriesByFilter();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Remove Products From Categories By Filter","slugifiedName":"bulk-remove-products-from-categories-by-filter"},"permissionScopes":[{"name":"Category item write","scopeId":"SCOPE.CATEGORIES.CATEGORY_ITEM_WRITE"}],"isAdminMethod":true},{"summary":"Bulk Update Product Variants By Filter","description":"Updates multiple product variants, given the provided filter and search expression.\n\nOnly the following variant fields can be updated:\n+ `visible`\n+ `price`\n+ `revenueDetails.cost`\n+ `physicalProperties`","operationId":"wix.stores.catalog.v3.CatalogApi.BulkUpdateProductVariantsByFilter","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkUpdateProductVariantsByFilterResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkUpdateProductVariantsByFilterRequest","description":"","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","$ref":"#/components/schemas/google.protobuf.Struct","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"variant":{"description":"Variant to update.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Variant","summary":"variant","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Free text to match in searchable fields.","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["filter","variant"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_updated","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.BulkUpdateProductVariantsByFilter","methodName":"BulkUpdateProductVariantsByFilter","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FIELD_MASK_VALUE_NOT_SUPPORTED","errorSchemaName":"com.wix.stores.catalog.product.api.v3.UnsupportedFieldMasks","description":"Field mask includes unsupported fields. Only `visible`, `price`, `revenueDetails.cost`, and `physicalProperties` can be updated.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"FIELD_MASK_VALUE_NOT_SUPPORTED"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"VARIANT_ID_ALREADY_EXISTS","description":"Multiple variants have identical `id`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"VARIANT_ID_ALREADY_EXISTS"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR","description":"Field mask includes fields not provided in the request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"EMPTY_FIELD_MASK","description":"Field mask is empty. At least 1 path is required.","errorType":"VALIDATION","validationErrorData":{"ruleName":"EMPTY_FIELD_MASK"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CANNOT_REMOVE_VARIANT_ACTUAL_PRICE","description":"Variant base price removal attempted. The base price is required and can't be removed.","errorType":"VALIDATION","validationErrorData":{"ruleName":"CANNOT_REMOVE_VARIANT_ACTUAL_PRICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION_CHOICE","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionChoiceErrorData","description":"Variant choice doesn't exist in the product's option choices.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionErrorData","description":"Variant option doesn't exist in the product's options.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkUpdateProductVariantsByFilterRequest","responseMessage":"wix.stores.catalog.v3.BulkUpdateProductVariantsByFilterResponse"},"legacyExamples":[{"name":"BulkUpdateProductVariantsByFilter","type":"METHOD","content":{"title":"Bulk update product variants by filter","description":"This example contains all fields that allowed in this method. All variants of all products that satisfy a filter will be updated.","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/update-variants-by-filter' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"filter\": {\n \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\"\n },\n \"variant\": {\n \"choices\": [],\n \"visible\": false,\n \"price\": {\n \"compareAtPrice\": {\n \"amount\": \"7\"\n },\n \"actualPrice\": {\n \"amount\": \"6\"\n }\n },\n \"revenueDetails\": {\n \"cost\": {\n \"amount\": \"5\"\n }\n },\n \"physicalProperties\": {\n \"weight\": \"0.1\",\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": \"0.5\",\n \"measurementUnit\": \"KG\"\n }\n }\n }\n }\n }'","response":"{\n \"jobId\": \"c7ff5d9d-1dea-482b-a367-f00216d03871\"\n}"}}],"sdkData":{"signature":{"resolved":[{"field":{"path":"filter"}},{"parent":{"name":"options","fields":[{"path":"variant"},{"path":"search"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Bulk update product variants by filter","description":"Update all variants of products matching a filter with new pricing and physical properties.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst filter = {\n id: \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\"\n};\n\nconst options = {\n variant: {\n choices: [],\n visible: false,\n price: {\n compareAtPrice: {\n amount: \"7\"\n },\n actualPrice: {\n amount: \"6\"\n }\n },\n revenueDetails: {\n cost: {\n amount: \"5\"\n }\n },\n physicalProperties: {\n weight: \"0.1\",\n pricePerUnit: {\n settings: {\n quantity: \"0.5\",\n measurementUnit: \"KG\"\n }\n }\n }\n }\n};\n\nasync function bulkUpdateProductVariantsByFilter() {\n const response = await productsV3.bulkUpdateProductVariantsByFilter(filter, options);\n}\n\n/* Promise resolves to:\n * {\n * \"jobId\": \"c7ff5d9d-1dea-482b-a367-f00216d03871\"\n * }\n */\n\n","order":1,"source":"manual"},{"title":"bulkUpdateProductVariantsByFilter (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function BulkUpdateProductVariantsByFilter() {\n const response = await myWixClient.productsV3.BulkUpdateProductVariantsByFilter();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products/update-variants-by-filter","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/stores","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products","destinationPath":"/v3/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products","destinationPath":"/v3/bulk/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"www._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://blocks.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://create.editorx/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"create.editorx","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wixapps.net/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://*.dev.wix-code.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://_/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products-with-inventory","destinationPath":"/v3/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products-with-inventory","destinationPath":"/v3/bulk/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/all-products-category","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/all-products-category","destinationPath":"/v3/all-products-category","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}}],"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_updated","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.BulkUpdateProductVariantsByFilter","methodName":"BulkUpdateProductVariantsByFilter","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FIELD_MASK_VALUE_NOT_SUPPORTED","errorSchemaName":"com.wix.stores.catalog.product.api.v3.UnsupportedFieldMasks","description":"Field mask includes unsupported fields. Only `visible`, `price`, `revenueDetails.cost`, and `physicalProperties` can be updated.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"FIELD_MASK_VALUE_NOT_SUPPORTED"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"VARIANT_ID_ALREADY_EXISTS","description":"Multiple variants have identical `id`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"VARIANT_ID_ALREADY_EXISTS"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR","description":"Field mask includes fields not provided in the request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"EMPTY_FIELD_MASK","description":"Field mask is empty. At least 1 path is required.","errorType":"VALIDATION","validationErrorData":{"ruleName":"EMPTY_FIELD_MASK"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CANNOT_REMOVE_VARIANT_ACTUAL_PRICE","description":"Variant base price removal attempted. The base price is required and can't be removed.","errorType":"VALIDATION","validationErrorData":{"ruleName":"CANNOT_REMOVE_VARIANT_ACTUAL_PRICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION_CHOICE","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionChoiceErrorData","description":"Variant choice doesn't exist in the product's option choices.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionErrorData","description":"Variant option doesn't exist in the product's options.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkUpdateProductVariantsByFilterRequest","responseMessage":"wix.stores.catalog.v3.BulkUpdateProductVariantsByFilterResponse"},"legacyExamples":[{"name":"BulkUpdateProductVariantsByFilter","type":"METHOD","content":{"title":"Bulk update product variants by filter","description":"This example contains all fields that allowed in this method. All variants of all products that satisfy a filter will be updated.","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/update-variants-by-filter' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"filter\": {\n \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\"\n },\n \"variant\": {\n \"choices\": [],\n \"visible\": false,\n \"price\": {\n \"compareAtPrice\": {\n \"amount\": \"7\"\n },\n \"actualPrice\": {\n \"amount\": \"6\"\n }\n },\n \"revenueDetails\": {\n \"cost\": {\n \"amount\": \"5\"\n }\n },\n \"physicalProperties\": {\n \"weight\": \"0.1\",\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": \"0.5\",\n \"measurementUnit\": \"KG\"\n }\n }\n }\n }\n }'","response":"{\n \"jobId\": \"c7ff5d9d-1dea-482b-a367-f00216d03871\"\n}"}}],"sdkData":{"signature":{"resolved":[{"field":{"path":"filter"}},{"parent":{"name":"options","fields":[{"path":"variant"},{"path":"search"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Bulk update product variants by filter","description":"Update all variants of products matching a filter with new pricing and physical properties.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst filter = {\n id: \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\"\n};\n\nconst options = {\n variant: {\n choices: [],\n visible: false,\n price: {\n compareAtPrice: {\n amount: \"7\"\n },\n actualPrice: {\n amount: \"6\"\n }\n },\n revenueDetails: {\n cost: {\n amount: \"5\"\n }\n },\n physicalProperties: {\n weight: \"0.1\",\n pricePerUnit: {\n settings: {\n quantity: \"0.5\",\n measurementUnit: \"KG\"\n }\n }\n }\n }\n};\n\nasync function bulkUpdateProductVariantsByFilter() {\n const response = await productsV3.bulkUpdateProductVariantsByFilter(filter, options);\n}\n\n/* Promise resolves to:\n * {\n * \"jobId\": \"c7ff5d9d-1dea-482b-a367-f00216d03871\"\n * }\n */\n\n","order":1,"source":"manual"},{"title":"bulkUpdateProductVariantsByFilter (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function BulkUpdateProductVariantsByFilter() {\n const response = await myWixClient.productsV3.BulkUpdateProductVariantsByFilter();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Update Product Variants By Filter","slugifiedName":"bulk-update-product-variants-by-filter"},"permissionScopes":[{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}],"isAdminMethod":true},{"summary":"Bulk Update Products By Filter","description":"Updates multiple products, given the provided filter.\n\nTo update `infoSections`, `brand` or `ribbon` fields, you must also pass their existing `id`.\n\n> **Note:**\n> The following fields can't be updated with this endpoint:\n> + `slug`\n> + `options`\n> + `modifiers`\n> + `variantsInfo`\n>\n> To update these fields, use [Bulk Update Products](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/bulk-update-products).","operationId":"wix.stores.catalog.v3.CatalogApi.BulkUpdateProductsByFilter","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkUpdateProductsByFilterResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkUpdateProductsByFilterRequest","description":"","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","$ref":"#/components/schemas/google.protobuf.Struct","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"product":{"description":"Product to update.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product","summary":"product","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Free text to match in searchable fields.","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["product","product.subscriptionDetails.subscriptions.title","product.subscriptionDetails.subscriptions.frequency","product.subscriptionDetails.subscriptions.discount.type"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_updated","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.BulkUpdateProductsByFilter","methodName":"BulkUpdateProductsByFilter","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FIELD_MASK_VALUE_NOT_SUPPORTED","errorSchemaName":"com.wix.stores.catalog.product.api.v3.UnsupportedFieldMasks","description":"Field mask includes unsupported fields. Read-only fields and `slug` can't be updated in this operation.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"FIELD_MASK_VALUE_NOT_SUPPORTED"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION","description":"Subscription added to a digital product. Digital products can't have subscriptions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"VARIANT_ID_ALREADY_EXISTS","description":"Multiple variants have identical `id`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"VARIANT_ID_ALREADY_EXISTS"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT","description":"All subscriptions are hidden for a subscription-only product. At least 1 subscription must be visible when `allowOneTimePurchases` is false.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT","description":"Subscription discount `amountOff` exceeds the minimum variant price.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS","description":"Multiple subscriptions have identical IDs.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"BRAND_CREATION_FAILED","description":"Brand creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"BRAND_CREATION_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"RIBBON_NOT_FOUND","description":"Couldn't find the ribbon.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"RIBBON_NOT_FOUND"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INFO_SECTION_ERROR_OCCURRED","description":"Info section update failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INFO_SECTION_ERROR_OCCURRED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CUSTOMIZATION_NOT_EXIST","description":"Couldn't find the customization.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CUSTOMIZATION_NOT_EXIST"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED","description":"Failed to add customization choices.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CHOICE_NOT_EXIST","description":"Couldn't find the choice.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CHOICE_NOT_EXIST"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR","description":"Field mask includes fields not provided in the request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRICE_PER_UNIT_NOT_ALIGNED","description":"If product physicalProperties.pricePerUnit is defined then it must be defined for all variant and vice versa.\nphysicalProperties.pricePerUnit.measurementUnit must be aligned between product and all variants: you cannot have KG (weight) in products and ML (volume) in variants.\nmeasurementUnit of product and every variant must be aligned with site locale (metric or imperial).","errorType":"VALIDATION","validationErrorData":{"ruleName":"PRICE_PER_UNIT_NOT_ALIGNED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_OPTIONS_ON_UPDATE_VARIANTS","description":"Update request includes `variants` but is missing `options`. Both must be provided together.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_OPTIONS_ON_UPDATE_VARIANTS"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"SUBSCRIPTION_INVALID_AUTO_RENEWAL","description":"The `autoRenewal` field is set to false. Set the number of billing cycles in `billingCycles` to prevent automatic renewal instead.","errorType":"VALIDATION","validationErrorData":{"ruleName":"SUBSCRIPTION_INVALID_AUTO_RENEWAL"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DESCRIPTION_SIZE_TOO_BIG","description":"Product `description` field exceeds the maximum size of 32000 bytes.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DESCRIPTION_SIZE_TOO_BIG"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION_CHOICE","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionChoiceErrorData","description":"Variant choice doesn't exist in the product's option choices.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionErrorData","description":"Variant option doesn't exist in the product's options.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkUpdateProductsByFilterRequest","responseMessage":"wix.stores.catalog.v3.BulkUpdateProductsByFilterResponse"},"legacyExamples":[{"name":"BulkUpdateProductsByFilter","type":"METHOD","content":{"title":"Bulk update products by filter","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/update-by-filter' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"filter\": {\n \"createdDate\": {\n \"$gt\": \"2024-07-22T13:22:45\"\n }\n },\n \"product\": {\n \"name\": \"Coffee\",\n \"description\": {\n \"nodes\": [\n {\n \"type\": \"PARAGRAPH\",\n \"id\": \"foo\",\n \"nodes\": [\n {\n \"type\": \"TEXT\",\n \"textData\": {\n \"text\": \"Tasty and eco friendly, in a beautiful gift box.\"\n }\n }\n ],\n \"paragraphData\": {\n \"textStyle\": {\n \"textAlignment\": \"AUTO\"\n }\n }\n }\n ],\n \"metadata\": {\n \"version\": 1,\n \"id\": \"fb97b2c1-a3ff-4319-be5f-bbb7fdf0776c\"\n }\n },\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"items\": [\n {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n }\n ]\n },\n \"brand\": {\n \"id\": \"4a16d28d-1736-41f0-87d8-995f6d9a5bdd\"\n },\n \"infoSections\": [\n {\n \"id\": \"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\"\n }\n ],\n \"ribbon\": {\n \"id\": \"826aec2a-771b-45a6-9f72-392da18fd3bf\"\n }\n }\n }\n'","response":"{\n \"jobId\": \"d825385c-785e-4c2a-9c54-4ab2a2b0d860\"\n}"}}],"sdkData":{"signature":{"resolved":[{"parent":{"name":"options","fields":[{"path":"filter"},{"path":"product"},{"path":"search"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Bulk update products by filter","description":"Update all products matching a filter with new values for name, description, visibility, and more.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst options = {\n filter: {\n createdDate: {\n $gt: \"2024-07-22T13:22:45\"\n }\n },\n product: {\n name: \"Coffee\",\n description: {\n nodes: [\n {\n type: \"PARAGRAPH\",\n id: \"foo\",\n nodes: [\n {\n type: \"TEXT\",\n textData: {\n text: \"Tasty and eco friendly, in a beautiful gift box.\"\n }\n }\n ],\n paragraphData: {\n textStyle: {\n textAlignment: \"AUTO\"\n }\n }\n }\n ],\n metadata: {\n version: 1,\n id: \"fb97b2c1-a3ff-4319-be5f-bbb7fdf0776c\"\n }\n },\n visible: true,\n visibleInPos: true,\n media: {\n items: [\n {\n id: \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n }\n ]\n },\n brand: {\n id: \"4a16d28d-1736-41f0-87d8-995f6d9a5bdd\"\n },\n infoSections: [\n {\n id: \"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\"\n }\n ],\n ribbon: {\n id: \"826aec2a-771b-45a6-9f72-392da18fd3bf\"\n }\n }\n};\n\nasync function bulkUpdateProductsByFilter() {\n const response = await productsV3.bulkUpdateProductsByFilter(options);\n}\n\n/* Promise resolves to:\n * {\n * \"jobId\": \"d825385c-785e-4c2a-9c54-4ab2a2b0d860\"\n * }\n */\n\n","order":1,"source":"manual"},{"title":"bulkUpdateProductsByFilter (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function BulkUpdateProductsByFilter() {\n const response = await myWixClient.productsV3.BulkUpdateProductsByFilter();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products/update-by-filter","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/stores","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products","destinationPath":"/v3/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products","destinationPath":"/v3/bulk/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"www._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://blocks.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://create.editorx/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"create.editorx","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wixapps.net/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://*.dev.wix-code.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://_/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products-with-inventory","destinationPath":"/v3/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products-with-inventory","destinationPath":"/v3/bulk/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/all-products-category","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/all-products-category","destinationPath":"/v3/all-products-category","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}}],"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_updated","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.BulkUpdateProductsByFilter","methodName":"BulkUpdateProductsByFilter","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FIELD_MASK_VALUE_NOT_SUPPORTED","errorSchemaName":"com.wix.stores.catalog.product.api.v3.UnsupportedFieldMasks","description":"Field mask includes unsupported fields. Read-only fields and `slug` can't be updated in this operation.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"FIELD_MASK_VALUE_NOT_SUPPORTED"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION","description":"Subscription added to a digital product. Digital products can't have subscriptions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"VARIANT_ID_ALREADY_EXISTS","description":"Multiple variants have identical `id`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"VARIANT_ID_ALREADY_EXISTS"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT","description":"All subscriptions are hidden for a subscription-only product. At least 1 subscription must be visible when `allowOneTimePurchases` is false.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT","description":"Subscription discount `amountOff` exceeds the minimum variant price.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT"},"name":null},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS","description":"Multiple subscriptions have identical IDs.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"BRAND_CREATION_FAILED","description":"Brand creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"BRAND_CREATION_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"RIBBON_NOT_FOUND","description":"Couldn't find the ribbon.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"RIBBON_NOT_FOUND"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INFO_SECTION_ERROR_OCCURRED","description":"Info section update failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INFO_SECTION_ERROR_OCCURRED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CUSTOMIZATION_NOT_EXIST","description":"Couldn't find the customization.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CUSTOMIZATION_NOT_EXIST"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED","description":"Failed to add customization choices.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CHOICE_NOT_EXIST","description":"Couldn't find the choice.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CHOICE_NOT_EXIST"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR","description":"Field mask includes fields not provided in the request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRICE_PER_UNIT_NOT_ALIGNED","description":"If product physicalProperties.pricePerUnit is defined then it must be defined for all variant and vice versa.\nphysicalProperties.pricePerUnit.measurementUnit must be aligned between product and all variants: you cannot have KG (weight) in products and ML (volume) in variants.\nmeasurementUnit of product and every variant must be aligned with site locale (metric or imperial).","errorType":"VALIDATION","validationErrorData":{"ruleName":"PRICE_PER_UNIT_NOT_ALIGNED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_OPTIONS_ON_UPDATE_VARIANTS","description":"Update request includes `variants` but is missing `options`. Both must be provided together.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_OPTIONS_ON_UPDATE_VARIANTS"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"SUBSCRIPTION_INVALID_AUTO_RENEWAL","description":"The `autoRenewal` field is set to false. Set the number of billing cycles in `billingCycles` to prevent automatic renewal instead.","errorType":"VALIDATION","validationErrorData":{"ruleName":"SUBSCRIPTION_INVALID_AUTO_RENEWAL"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DESCRIPTION_SIZE_TOO_BIG","description":"Product `description` field exceeds the maximum size of 32000 bytes.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DESCRIPTION_SIZE_TOO_BIG"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION_CHOICE","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionChoiceErrorData","description":"Variant choice doesn't exist in the product's option choices.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionErrorData","description":"Variant option doesn't exist in the product's options.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkUpdateProductsByFilterRequest","responseMessage":"wix.stores.catalog.v3.BulkUpdateProductsByFilterResponse"},"legacyExamples":[{"name":"BulkUpdateProductsByFilter","type":"METHOD","content":{"title":"Bulk update products by filter","request":"curl POST 'https://www.wixapis.com/stores/v3/bulk/products/update-by-filter' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"filter\": {\n \"createdDate\": {\n \"$gt\": \"2024-07-22T13:22:45\"\n }\n },\n \"product\": {\n \"name\": \"Coffee\",\n \"description\": {\n \"nodes\": [\n {\n \"type\": \"PARAGRAPH\",\n \"id\": \"foo\",\n \"nodes\": [\n {\n \"type\": \"TEXT\",\n \"textData\": {\n \"text\": \"Tasty and eco friendly, in a beautiful gift box.\"\n }\n }\n ],\n \"paragraphData\": {\n \"textStyle\": {\n \"textAlignment\": \"AUTO\"\n }\n }\n }\n ],\n \"metadata\": {\n \"version\": 1,\n \"id\": \"fb97b2c1-a3ff-4319-be5f-bbb7fdf0776c\"\n }\n },\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"items\": [\n {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n }\n ]\n },\n \"brand\": {\n \"id\": \"4a16d28d-1736-41f0-87d8-995f6d9a5bdd\"\n },\n \"infoSections\": [\n {\n \"id\": \"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\"\n }\n ],\n \"ribbon\": {\n \"id\": \"826aec2a-771b-45a6-9f72-392da18fd3bf\"\n }\n }\n }\n'","response":"{\n \"jobId\": \"d825385c-785e-4c2a-9c54-4ab2a2b0d860\"\n}"}}],"sdkData":{"signature":{"resolved":[{"parent":{"name":"options","fields":[{"path":"filter"},{"path":"product"},{"path":"search"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Bulk update products by filter","description":"Update all products matching a filter with new values for name, description, visibility, and more.","content":"import { productsV3 } from \"@wix/stores\";\n\nconst options = {\n filter: {\n createdDate: {\n $gt: \"2024-07-22T13:22:45\"\n }\n },\n product: {\n name: \"Coffee\",\n description: {\n nodes: [\n {\n type: \"PARAGRAPH\",\n id: \"foo\",\n nodes: [\n {\n type: \"TEXT\",\n textData: {\n text: \"Tasty and eco friendly, in a beautiful gift box.\"\n }\n }\n ],\n paragraphData: {\n textStyle: {\n textAlignment: \"AUTO\"\n }\n }\n }\n ],\n metadata: {\n version: 1,\n id: \"fb97b2c1-a3ff-4319-be5f-bbb7fdf0776c\"\n }\n },\n visible: true,\n visibleInPos: true,\n media: {\n items: [\n {\n id: \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n }\n ]\n },\n brand: {\n id: \"4a16d28d-1736-41f0-87d8-995f6d9a5bdd\"\n },\n infoSections: [\n {\n id: \"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\"\n }\n ],\n ribbon: {\n id: \"826aec2a-771b-45a6-9f72-392da18fd3bf\"\n }\n }\n};\n\nasync function bulkUpdateProductsByFilter() {\n const response = await productsV3.bulkUpdateProductsByFilter(options);\n}\n\n/* Promise resolves to:\n * {\n * \"jobId\": \"d825385c-785e-4c2a-9c54-4ab2a2b0d860\"\n * }\n */\n\n","order":1,"source":"manual"},{"title":"bulkUpdateProductsByFilter (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function BulkUpdateProductsByFilter() {\n const response = await myWixClient.productsV3.BulkUpdateProductsByFilter();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Update Products By Filter","slugifiedName":"bulk-update-products-by-filter"},"permissionScopes":[{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}],"isAdminMethod":true},{"summary":"Bulk Update Products With Inventory","description":"Updates up to 100 products, and can update the products' inventories in the variants' default locations.\n\n>**Note:**\n> The following limits apply to the total number of updatable entities in a single request.\n> For example, you can update 10 products with up to 10 options for each product (10 x 10 = 100), or one product with 100 options.\n> Alternatively, you can update 100 products with up to 10 variants in each (100 x 10 = 1000), or one product with 1000 variants.\n> + `options`: 100\n> + `modifiers`: 100\n> + `infoSections`: 100\n> + `variantsInfo.variants`: 1000","operationId":"wix.stores.catalog.v3.CatalogApi.BulkUpdateProductsWithInventory","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkUpdateProductsWithInventoryResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkUpdateProductsWithInventoryRequest","description":"","properties":{"products":{"description":"List of products to update.","minItems":1,"maxItems":100,"title":"products","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.v3.MaskedProductWithInventory"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the full product entities in the response.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.MultipleEntitiesOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["products","products.product","products.product.id","products.product.revision","products.product.variantsInfo.variants.price","products.product.variantsInfo.variants.price.actualPrice","products.product.variantsInfo.variants.physicalProperties.pricePerUnit.settings.measurementUnit","products.product.variantsInfo.variants.digitalProperties.digitalFile","products.product.variantsInfo.variants.digitalProperties.digitalFile.id","products.product.variantsInfo.variants.choices.optionChoiceIds.optionId","products.product.variantsInfo.variants.choices.optionChoiceIds.choiceId","products.product.physicalProperties.pricePerUnit.measurementUnit","products.product.subscriptionDetails.subscriptions.title","products.product.subscriptionDetails.subscriptions.frequency","products.product.subscriptionDetails.subscriptions.discount.type"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_updated","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.BulkUpdateProductsWithInventory","methodName":"BulkUpdateProductsWithInventory","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"RIBBON_NOT_FOUND","description":"Couldn't find the ribbon.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"RIBBON_NOT_FOUND"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INFO_SECTION_ERROR_OCCURRED","description":"Info section update failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INFO_SECTION_ERROR_OCCURRED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CUSTOMIZATION_NOT_EXIST","description":"Couldn't find the customization.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CUSTOMIZATION_NOT_EXIST"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED","description":"Failed to add customization choices.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CHOICE_NOT_EXIST","description":"Couldn't find the choice.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CHOICE_NOT_EXIST"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"PRODUCT_RESTRICTION_ERROR","description":"Product update violates business restrictions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRODUCT_RESTRICTION_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PREORDER_VALIDATION_ERROR","description":"Variant enabled for preorder on a subscription product. Products with subscriptions can't have preorder variants.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PREORDER_VALIDATION_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TOO_MANY_OPTIONS_IN_REQUEST","description":"Number of options exceeds the server's limit.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"TOO_MANY_OPTIONS_IN_REQUEST"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR","description":"Field mask includes fields not provided in the request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE","description":"The `compareAtPrice` is lower than the `actualPrice`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE","description":"Inventory quantity is negative. The quantity must be non-negative.","errorType":"VALIDATION","validationErrorData":{"ruleName":"REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"BRAND_MISSING_ID","description":"Brand is missing an `id`.","errorType":"VALIDATION","validationErrorData":{"ruleName":"BRAND_MISSING_ID"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DUPLICATE_PRODUCT_IDS_REQUEST","description":"Multiple products have identical IDs in the request.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DUPLICATE_PRODUCT_IDS_REQUEST"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRICE_PER_UNIT_NOT_ALIGNED","description":"Price per unit isn't aligned between product and variants.","errorType":"VALIDATION","validationErrorData":{"ruleName":"PRICE_PER_UNIT_NOT_ALIGNED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION_CHOICE","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionChoiceErrorData","description":"Variant choice doesn't exist in the product's option choices.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionErrorData","description":"Variant option doesn't exist in the product's options.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_UPDATE","WIX_STORES.INVENTORY_UPDATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkUpdateProductsWithInventoryRequest","responseMessage":"wix.stores.catalog.v3.BulkUpdateProductsWithInventoryResponse"},"legacyExamples":[],"sdkData":{"signature":{"resolved":[{"field":{"path":"products"}},{"parent":{"name":"options","fields":[{"path":"returnEntity"},{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"bulkUpdateProductsWithInventory","description":"","content":"import { productsV3 } from '@wix/stores';\n\nasync function bulkUpdateProductsWithInventory(products, options) {\n const response = await productsV3.bulkUpdateProductsWithInventory(products, options);\n};","order":1,"source":"generated"},{"title":"bulkUpdateProductsWithInventory (with elevated permissions)","description":"","content":"import { productsV3 } from '@wix/stores';\nimport { auth } from '@wix/essentials';\n\nasync function myBulkUpdateProductsWithInventoryMethod(products, options) {\n const elevatedBulkUpdateProductsWithInventory = auth.elevate(productsV3.bulkUpdateProductsWithInventory);\n const response = await elevatedBulkUpdateProductsWithInventory(products, options);\n}","order":4,"source":"generated"},{"title":"bulkUpdateProductsWithInventory (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function bulkUpdateProductsWithInventory(products, options) {\n const response = await myWixClient.productsV3.bulkUpdateProductsWithInventory(products, options);\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products-with-inventory/update","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/stores","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products","destinationPath":"/v3/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products","destinationPath":"/v3/bulk/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"www._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://blocks.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://create.editorx/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"create.editorx","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wixapps.net/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://*.dev.wix-code.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://_/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products-with-inventory","destinationPath":"/v3/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products-with-inventory","destinationPath":"/v3/bulk/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/all-products-category","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/all-products-category","destinationPath":"/v3/all-products-category","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}}],"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_updated","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.BulkUpdateProductsWithInventory","methodName":"BulkUpdateProductsWithInventory","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"RIBBON_NOT_FOUND","description":"Couldn't find the ribbon.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"RIBBON_NOT_FOUND"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INFO_SECTION_ERROR_OCCURRED","description":"Info section update failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INFO_SECTION_ERROR_OCCURRED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CUSTOMIZATION_NOT_EXIST","description":"Couldn't find the customization.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CUSTOMIZATION_NOT_EXIST"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED","description":"Failed to add customization choices.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CHOICE_NOT_EXIST","description":"Couldn't find the choice.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CHOICE_NOT_EXIST"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"PRODUCT_RESTRICTION_ERROR","description":"Product update violates business restrictions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRODUCT_RESTRICTION_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PREORDER_VALIDATION_ERROR","description":"Variant enabled for preorder on a subscription product. Products with subscriptions can't have preorder variants.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PREORDER_VALIDATION_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TOO_MANY_OPTIONS_IN_REQUEST","description":"Number of options exceeds the server's limit.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"TOO_MANY_OPTIONS_IN_REQUEST"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR","description":"Field mask includes fields not provided in the request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE","description":"The `compareAtPrice` is lower than the `actualPrice`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE","description":"Inventory quantity is negative. The quantity must be non-negative.","errorType":"VALIDATION","validationErrorData":{"ruleName":"REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"BRAND_MISSING_ID","description":"Brand is missing an `id`.","errorType":"VALIDATION","validationErrorData":{"ruleName":"BRAND_MISSING_ID"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DUPLICATE_PRODUCT_IDS_REQUEST","description":"Multiple products have identical IDs in the request.","errorType":"VALIDATION","validationErrorData":{"ruleName":"DUPLICATE_PRODUCT_IDS_REQUEST"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRICE_PER_UNIT_NOT_ALIGNED","description":"Price per unit isn't aligned between product and variants.","errorType":"VALIDATION","validationErrorData":{"ruleName":"PRICE_PER_UNIT_NOT_ALIGNED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION_CHOICE","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionChoiceErrorData","description":"Variant choice doesn't exist in the product's option choices.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionErrorData","description":"Variant option doesn't exist in the product's options.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_UPDATE","WIX_STORES.INVENTORY_UPDATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkUpdateProductsWithInventoryRequest","responseMessage":"wix.stores.catalog.v3.BulkUpdateProductsWithInventoryResponse"},"legacyExamples":[],"sdkData":{"signature":{"resolved":[{"field":{"path":"products"}},{"parent":{"name":"options","fields":[{"path":"returnEntity"},{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"bulkUpdateProductsWithInventory","description":"","content":"import { productsV3 } from '@wix/stores';\n\nasync function bulkUpdateProductsWithInventory(products, options) {\n const response = await productsV3.bulkUpdateProductsWithInventory(products, options);\n};","order":1,"source":"generated"},{"title":"bulkUpdateProductsWithInventory (with elevated permissions)","description":"","content":"import { productsV3 } from '@wix/stores';\nimport { auth } from '@wix/essentials';\n\nasync function myBulkUpdateProductsWithInventoryMethod(products, options) {\n const elevatedBulkUpdateProductsWithInventory = auth.elevate(productsV3.bulkUpdateProductsWithInventory);\n const response = await elevatedBulkUpdateProductsWithInventory(products, options);\n}","order":4,"source":"generated"},{"title":"bulkUpdateProductsWithInventory (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function bulkUpdateProductsWithInventory(products, options) {\n const response = await myWixClient.productsV3.bulkUpdateProductsWithInventory(products, options);\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Update Products With Inventory","slugifiedName":"bulk-update-products-with-inventory"},"permissionScopes":[{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Inventory write in v3 catalog","scopeId":"SCOPE.STORES.INVENTORY_ITEM_WRITE"}],"isAdminMethod":true},{"summary":"Create Product With Inventory","description":"Creates a new product with its inventory in a single call.\n\nPass `variantsInfo.variants.inventoryItem` to create inventory items for each variant in the default location. Each inventory item can track stock using either `quantity` (for exact stock counts) or `inStock` (for simple availability). If `inventoryItem` isn't provided, no inventory items are created.\n\nYou can also add a ribbon, brand, info sections, options, and modifiers in the same request.\n\nLearn more about [inventory management](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/about-inventory-management) including tracking methods, preorder settings, and multi-location inventory.\n\n> **Note:** When you create a product with inline options or modifiers (without referencing existing customization IDs), new standalone [Customization](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/customizations-v3/introduction) entities are automatically created. These can be reused across other products.","operationId":"wix.stores.catalog.v3.CatalogApi.CreateProductWithInventory","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.CreateProductWithInventoryResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateProductWithInventoryRequest","description":"","properties":{"product":{"description":"Product to create with inventory.\n\nAt least one variant must be provided and each variant must have relevant item in `choices` field for every item in `options`.\nIf `options` is empty one default variant must be provided with empty `choices` list.","$ref":"#/components/schemas/wix.stores.catalog.v3.ProductWithInventory","summary":"product","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return inventory entities in the response.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.SingleEntityOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["product","product.name","product.productType","product.variantsInfo","product.variantsInfo.variants.choices.optionChoiceIds.optionId","product.variantsInfo.variants.choices.optionChoiceIds.choiceId","product.variantsInfo.variants.price","product.variantsInfo.variants.price.actualPrice","product.variantsInfo.variants.physicalProperties.pricePerUnit.settings.measurementUnit","product.variantsInfo.variants.digitalProperties.digitalFile","product.variantsInfo.variants.digitalProperties.digitalFile.id","product.physicalProperties.pricePerUnit.measurementUnit","product.subscriptionDetails.subscriptions","product.subscriptionDetails.subscriptions.title","product.subscriptionDetails.subscriptions.frequency","product.subscriptionDetails.subscriptions.discount.type"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Product Created","description":"Triggered when a product is created.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_created","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.CreateProductWithInventory","methodName":"CreateProductWithInventory","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"RIBBON_NOT_FOUND","description":"Couldn't find the ribbon.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"RIBBON_NOT_FOUND"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"RIBBON_CREATION_FAILED","description":"Ribbon creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"RIBBON_CREATION_FAILED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INFO_SECTION_CREATION_FAILED","description":"Info section creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INFO_SECTION_CREATION_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CUSTOMIZATION_NOT_EXIST","description":"Couldn't find the customization.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CUSTOMIZATION_NOT_EXIST"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"CUSTOMIZATIONS_CREATION_FAILED","description":"Customization creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CUSTOMIZATIONS_CREATION_FAILED"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED","description":"Failed to add customization choices.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CHOICE_NOT_EXIST","description":"Couldn't find the choice.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CHOICE_NOT_EXIST"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRODUCT_OPTION_NAME_AND_TYPE_REQUIRED","description":"Option is missing `name` or `type`. Options without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRODUCT_OPTION_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRODUCT_OPTION_CHOICE_NAME_AND_TYPE_REQUIRED","description":"Option choice is missing `name` or `type`. Choices without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRODUCT_OPTION_CHOICE_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MODIFIER_NAME_AND_TYPE_REQUIRED","description":"Modifier is missing `name` or `type`. Modifiers without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MODIFIER_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MODIFIER_CHOICE_NAME_AND_TYPE_REQUIRED","description":"Modifier choice is missing `name` or `type`. Choices without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MODIFIER_CHOICE_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE","description":"The `compareAtPrice` is lower than the `actualPrice`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE","description":"Inventory quantity is negative. The quantity must be non-negative.","errorType":"VALIDATION","validationErrorData":{"ruleName":"REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"BRAND_MISSING_ID","description":"Brand is missing an `id`.","errorType":"VALIDATION","validationErrorData":{"ruleName":"BRAND_MISSING_ID"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRICE_PER_UNIT_NOT_ALIGNED","description":"Price per unit isn't aligned between product and variants.","errorType":"VALIDATION","validationErrorData":{"ruleName":"PRICE_PER_UNIT_NOT_ALIGNED"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_CREATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.CreateProductWithInventoryRequest","responseMessage":"wix.stores.catalog.v3.CreateProductWithInventoryResponse"},"legacyExamples":[{"name":"CreateProductWithInventory","type":"METHOD","order":2,"content":{"title":"Create a product where the variant is assigned a value for weight.","request":"curl POST 'https://www.wixapis.com/stores/v3/products-with-inventory' \\\n\t-H 'Authorization: ' \\\n\t-H 'Content-Type: application/json' \\\n\t-d '{\n\t\t\"product\": {\n\t\t\t\"name\": \"Adjustable Reading Lamp\",\n\t\t\t\"variantsInfo\": {\n\t\t\t\t\"variants\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"price\": {\n\t\t\t\t\t\t\t\"actualPrice\": {\n\t\t\t\t\t\t\t\t\"amount\": \"20\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"inventoryItem\": {\n\t\t\t\t\t\t\t\"inStock\": true\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"physicalProperties\": {\n\t\t\t\t\t\t\t\"weight\": \"60\"\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t},\n\t\t\t\"productType\": \"PHYSICAL\",\n\t\t\t\"physicalProperties\": {}\n\t\t}\n\t}'","response":"{\n \"product\": {\n \"id\": \"c7f39676-734b-4145-a307-af6577f4cfa2\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-04-15T12:00:12.219Z\",\n \"updatedDate\": \"2025-04-15T12:00:12.219Z\",\n \"name\": \"Adjustable Reading Lamp\",\n \"slug\": \"adjustable-reading-lamp\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": null,\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"IN_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": {\n \"minValue\": 60,\n \"maxValue\": 60\n },\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": null,\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_92467bc7-e4c4-4c16-b229-da3f5b00aea2\",\n \"importId\": null,\n \"currency\": null,\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"20\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"20\",\n \"formattedAmount\": null\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"0\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"0\",\n \"formattedAmount\": null\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"6e1bc76c-959d-41f3-bb5d-522c4d0b6f11\",\n \"visible\": true,\n \"sku\": null,\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"20\",\n \"formattedAmount\": null\n },\n \"compareAtPrice\": null\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": null,\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n },\n \"physicalProperties\": {\n \"weight\": 60,\n \"pricePerUnit\": null\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1744718412060000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n },\n \"inventoryResults\": {\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"ea023f89-9d2f-4812-b465-d91117ea1623\",\n \"originalIndex\": 0,\n \"success\": true,\n \"error\": null\n },\n \"item\": {\n \"id\": \"ea023f89-9d2f-4812-b465-d91117ea1623\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-04-15T12:00:13.473Z\",\n \"updatedDate\": \"2025-04-15T12:00:13.473Z\",\n \"variantId\": \"6e1bc76c-959d-41f3-bb5d-522c4d0b6f11\",\n \"locationId\": \"68892ef3-3715-4ce3-8a6e-0561350f8860\",\n \"productId\": \"c7f39676-734b-4145-a307-af6577f4cfa2\",\n \"inStock\": true,\n \"trackQuantity\": false,\n \"availabilityStatus\": \"IN_STOCK\",\n \"preorderInfo\": {\n \"enabled\": false,\n \"counter\": null,\n \"limit\": null,\n \"message\": null,\n \"quantity\": null\n },\n \"product\": null,\n \"extendedFields\": null\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n },\n \"error\": null\n }\n}"}},{"name":"CreateProductWithInventory","type":"METHOD","order":1,"content":{"title":"Create minimal possible product","request":"curl POST 'https://www.wixapis.com/stores/v3/products-with-inventory' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"product\": {\n \"name\": \"Shopping bag\",\n \"productType\": \"PHYSICAL\",\n \"variantsInfo\": {\n \"variants\": [\n {\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"0.5\"\n }\n },\n \"inventoryItem\": {\n \"inStock\": false\n }\n }\n ]\n },\n \"physicalProperties\": {}\n }\n }'","response":"{\n \"product\": {\n \"id\": \"789e6969-6eb4-4799-aacb-e207037564c4\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-02T07:36:01.066Z\",\n \"updatedDate\": \"2025-01-02T07:36:01.066Z\",\n \"name\": \"Shopping bag\",\n \"slug\": \"shopping-bag-1\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": null,\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": null,\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_f3e89a8b-5865-47de-86fa-cd923c2586e5\",\n \"currency\": null,\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"a3c6d6b2-4265-4e9a-8406-cafd4a61fb06\",\n \"visible\": true,\n \"sku\": null,\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"compareAtPrice\": null\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": null,\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735803361054000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n },\n \"inventoryResults\": {\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"2937f8d3-3439-4e46-83ab-7a83e4e37da1\",\n \"originalIndex\": 0,\n \"success\": true,\n \"error\": null\n },\n \"item\": null\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n },\n \"error\": null\n }\n}"}}],"sdkData":{"signature":{"resolved":[{"field":{"path":"product"}},{"parent":{"name":"options","fields":[{"path":"returnEntity"},{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Create a product with weight and inventory","description":"Create a product where the variant is assigned a value for weight","content":"import { productsV3 } from \"@wix/stores\";\n\nconst product = {\n name: \"Adjustable Reading Lamp\",\n variantsInfo: {\n variants: [\n {\n price: {\n actualPrice: {\n amount: \"20\"\n }\n },\n inventoryItem: {\n inStock: true\n },\n physicalProperties: {\n weight: \"60\"\n }\n }\n ]\n },\n productType: \"PHYSICAL\",\n physicalProperties: {}\n};\n\nasync function createProductWithInventory() {\n const response = await productsV3.createProductWithInventory(product);\n}\n","order":2,"source":"manual"},{"title":"Create a basic product with inventory","description":"","content":"import { productsV3 } from \"@wix/stores\";\n\nconst product = {\n name: \"Shopping bag\",\n productType: \"PHYSICAL\",\n variantsInfo: {\n variants: [\n {\n price: {\n actualPrice: {\n amount: \"0.5\"\n }\n },\n inventoryItem: {\n inStock: false\n }\n }\n ]\n },\n physicalProperties: {}\n};\n\nasync function createProductWithInventory() {\n const response = await productsV3.createProductWithInventory(product);\n}\n","order":1,"source":"manual"},{"title":"createProductWithInventory (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function CreateProductWithInventory() {\n const response = await myWixClient.productsV3.CreateProductWithInventory();\n};","order":3,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/products-with-inventory","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/stores","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products","destinationPath":"/v3/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products","destinationPath":"/v3/bulk/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"www._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://blocks.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://create.editorx/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"create.editorx","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wixapps.net/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://*.dev.wix-code.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://_/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products-with-inventory","destinationPath":"/v3/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products-with-inventory","destinationPath":"/v3/bulk/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/all-products-category","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/all-products-category","destinationPath":"/v3/all-products-category","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}}],"triggeredEvents":[{"title":"Product Created","description":"Triggered when a product is created.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_created","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.CreateProductWithInventory","methodName":"CreateProductWithInventory","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"RIBBON_NOT_FOUND","description":"Couldn't find the ribbon.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"RIBBON_NOT_FOUND"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"RIBBON_CREATION_FAILED","description":"Ribbon creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"RIBBON_CREATION_FAILED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INFO_SECTION_CREATION_FAILED","description":"Info section creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INFO_SECTION_CREATION_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CUSTOMIZATION_NOT_EXIST","description":"Couldn't find the customization.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CUSTOMIZATION_NOT_EXIST"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"CUSTOMIZATIONS_CREATION_FAILED","description":"Customization creation failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CUSTOMIZATIONS_CREATION_FAILED"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED","description":"Failed to add customization choices.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CHOICE_NOT_EXIST","description":"Couldn't find the choice.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CHOICE_NOT_EXIST"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRODUCT_OPTION_NAME_AND_TYPE_REQUIRED","description":"Option is missing `name` or `type`. Options without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRODUCT_OPTION_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRODUCT_OPTION_CHOICE_NAME_AND_TYPE_REQUIRED","description":"Option choice is missing `name` or `type`. Choices without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRODUCT_OPTION_CHOICE_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MODIFIER_NAME_AND_TYPE_REQUIRED","description":"Modifier is missing `name` or `type`. Modifiers without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MODIFIER_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MODIFIER_CHOICE_NAME_AND_TYPE_REQUIRED","description":"Modifier choice is missing `name` or `type`. Choices without an `id` must include both.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MODIFIER_CHOICE_NAME_AND_TYPE_REQUIRED"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE","description":"The `compareAtPrice` is lower than the `actualPrice`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE","description":"Inventory quantity is negative. The quantity must be non-negative.","errorType":"VALIDATION","validationErrorData":{"ruleName":"REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"BRAND_MISSING_ID","description":"Brand is missing an `id`.","errorType":"VALIDATION","validationErrorData":{"ruleName":"BRAND_MISSING_ID"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRICE_PER_UNIT_NOT_ALIGNED","description":"Price per unit isn't aligned between product and variants.","errorType":"VALIDATION","validationErrorData":{"ruleName":"PRICE_PER_UNIT_NOT_ALIGNED"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_CREATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.CreateProductWithInventoryRequest","responseMessage":"wix.stores.catalog.v3.CreateProductWithInventoryResponse"},"legacyExamples":[{"name":"CreateProductWithInventory","type":"METHOD","order":2,"content":{"title":"Create a product where the variant is assigned a value for weight.","request":"curl POST 'https://www.wixapis.com/stores/v3/products-with-inventory' \\\n\t-H 'Authorization: ' \\\n\t-H 'Content-Type: application/json' \\\n\t-d '{\n\t\t\"product\": {\n\t\t\t\"name\": \"Adjustable Reading Lamp\",\n\t\t\t\"variantsInfo\": {\n\t\t\t\t\"variants\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"price\": {\n\t\t\t\t\t\t\t\"actualPrice\": {\n\t\t\t\t\t\t\t\t\"amount\": \"20\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"inventoryItem\": {\n\t\t\t\t\t\t\t\"inStock\": true\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"physicalProperties\": {\n\t\t\t\t\t\t\t\"weight\": \"60\"\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t},\n\t\t\t\"productType\": \"PHYSICAL\",\n\t\t\t\"physicalProperties\": {}\n\t\t}\n\t}'","response":"{\n \"product\": {\n \"id\": \"c7f39676-734b-4145-a307-af6577f4cfa2\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-04-15T12:00:12.219Z\",\n \"updatedDate\": \"2025-04-15T12:00:12.219Z\",\n \"name\": \"Adjustable Reading Lamp\",\n \"slug\": \"adjustable-reading-lamp\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": null,\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"IN_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": {\n \"minValue\": 60,\n \"maxValue\": 60\n },\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": null,\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_92467bc7-e4c4-4c16-b229-da3f5b00aea2\",\n \"importId\": null,\n \"currency\": null,\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"20\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"20\",\n \"formattedAmount\": null\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"0\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"0\",\n \"formattedAmount\": null\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"6e1bc76c-959d-41f3-bb5d-522c4d0b6f11\",\n \"visible\": true,\n \"sku\": null,\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"20\",\n \"formattedAmount\": null\n },\n \"compareAtPrice\": null\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": null,\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n },\n \"physicalProperties\": {\n \"weight\": 60,\n \"pricePerUnit\": null\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1744718412060000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n },\n \"inventoryResults\": {\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"ea023f89-9d2f-4812-b465-d91117ea1623\",\n \"originalIndex\": 0,\n \"success\": true,\n \"error\": null\n },\n \"item\": {\n \"id\": \"ea023f89-9d2f-4812-b465-d91117ea1623\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-04-15T12:00:13.473Z\",\n \"updatedDate\": \"2025-04-15T12:00:13.473Z\",\n \"variantId\": \"6e1bc76c-959d-41f3-bb5d-522c4d0b6f11\",\n \"locationId\": \"68892ef3-3715-4ce3-8a6e-0561350f8860\",\n \"productId\": \"c7f39676-734b-4145-a307-af6577f4cfa2\",\n \"inStock\": true,\n \"trackQuantity\": false,\n \"availabilityStatus\": \"IN_STOCK\",\n \"preorderInfo\": {\n \"enabled\": false,\n \"counter\": null,\n \"limit\": null,\n \"message\": null,\n \"quantity\": null\n },\n \"product\": null,\n \"extendedFields\": null\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n },\n \"error\": null\n }\n}"}},{"name":"CreateProductWithInventory","type":"METHOD","order":1,"content":{"title":"Create minimal possible product","request":"curl POST 'https://www.wixapis.com/stores/v3/products-with-inventory' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"product\": {\n \"name\": \"Shopping bag\",\n \"productType\": \"PHYSICAL\",\n \"variantsInfo\": {\n \"variants\": [\n {\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"0.5\"\n }\n },\n \"inventoryItem\": {\n \"inStock\": false\n }\n }\n ]\n },\n \"physicalProperties\": {}\n }\n }'","response":"{\n \"product\": {\n \"id\": \"789e6969-6eb4-4799-aacb-e207037564c4\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-02T07:36:01.066Z\",\n \"updatedDate\": \"2025-01-02T07:36:01.066Z\",\n \"name\": \"Shopping bag\",\n \"slug\": \"shopping-bag-1\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": null,\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": null,\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_f3e89a8b-5865-47de-86fa-cd923c2586e5\",\n \"currency\": null,\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"a3c6d6b2-4265-4e9a-8406-cafd4a61fb06\",\n \"visible\": true,\n \"sku\": null,\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"compareAtPrice\": null\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": null,\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735803361054000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": null\n },\n \"inventoryResults\": {\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"2937f8d3-3439-4e46-83ab-7a83e4e37da1\",\n \"originalIndex\": 0,\n \"success\": true,\n \"error\": null\n },\n \"item\": null\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n },\n \"error\": null\n }\n}"}}],"sdkData":{"signature":{"resolved":[{"field":{"path":"product"}},{"parent":{"name":"options","fields":[{"path":"returnEntity"},{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Create a product with weight and inventory","description":"Create a product where the variant is assigned a value for weight","content":"import { productsV3 } from \"@wix/stores\";\n\nconst product = {\n name: \"Adjustable Reading Lamp\",\n variantsInfo: {\n variants: [\n {\n price: {\n actualPrice: {\n amount: \"20\"\n }\n },\n inventoryItem: {\n inStock: true\n },\n physicalProperties: {\n weight: \"60\"\n }\n }\n ]\n },\n productType: \"PHYSICAL\",\n physicalProperties: {}\n};\n\nasync function createProductWithInventory() {\n const response = await productsV3.createProductWithInventory(product);\n}\n","order":2,"source":"manual"},{"title":"Create a basic product with inventory","description":"","content":"import { productsV3 } from \"@wix/stores\";\n\nconst product = {\n name: \"Shopping bag\",\n productType: \"PHYSICAL\",\n variantsInfo: {\n variants: [\n {\n price: {\n actualPrice: {\n amount: \"0.5\"\n }\n },\n inventoryItem: {\n inStock: false\n }\n }\n ]\n },\n physicalProperties: {}\n};\n\nasync function createProductWithInventory() {\n const response = await productsV3.createProductWithInventory(product);\n}\n","order":1,"source":"manual"},{"title":"createProductWithInventory (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function CreateProductWithInventory() {\n const response = await myWixClient.productsV3.CreateProductWithInventory();\n};","order":3,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Create Product With Inventory","slugifiedName":"create-product-with-inventory"},"permissionScopes":[{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}],"isAdminMethod":true},{"summary":"Get All Products Category","description":"Retrieves the ID of the \"All Products\" category, which is automatically assigned to all products.\n\nLearn more about the [Categories API](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/categories/introduction).","operationId":"wix.stores.catalog.v3.CatalogApi.GetAllProductsCategory","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.GetAllProductsCategoryResponse","description":""}},"deprecated":false,"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.ALL_PRODUCTS_CATEGORY_READ"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.GetAllProductsCategoryRequest","responseMessage":"wix.stores.catalog.v3.GetAllProductsCategoryResponse"},"legacyExamples":[{"name":"GetAllProductsCategory","type":"METHOD","content":{"title":"Get all-products category id and tree reference","request":"curl GET 'https://www.wixapis.com/stores/v3/all-products-category' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\","response":"{\n \"categoryId\": \"894d495b-57d7-41ce-98a5-1320542731dd\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n }\n}"}}],"sdkData":{"signature":{"resolved":[]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Get the all products category ID and tree reference","description":"","content":"import { productsV3 } from \"@wix/stores\";\n\nasync function getAllProductsCategory() {\n const response = await productsV3.getAllProductsCategory();\n}\n\n/* Promise resolves to:\n * {\n * \"categoryId\": \"894d495b-57d7-41ce-98a5-1320542731dd\",\n * \"treeReference\": {\n * \"appNamespace\": \"@wix/stores\"\n * }\n * }\n */\n\n","order":1,"source":"manual"},{"title":"getAllProductsCategory (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function GetAllProductsCategory() {\n const response = await myWixClient.productsV3.GetAllProductsCategory();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"get","path":"/v3/all-products-category","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/stores","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products","destinationPath":"/v3/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products","destinationPath":"/v3/bulk/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"www._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://blocks.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://create.editorx/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"create.editorx","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wixapps.net/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://*.dev.wix-code.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://_/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products-with-inventory","destinationPath":"/v3/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products-with-inventory","destinationPath":"/v3/bulk/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/all-products-category","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/all-products-category","destinationPath":"/v3/all-products-category","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}}],"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.ALL_PRODUCTS_CATEGORY_READ"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.GetAllProductsCategoryRequest","responseMessage":"wix.stores.catalog.v3.GetAllProductsCategoryResponse"},"legacyExamples":[{"name":"GetAllProductsCategory","type":"METHOD","content":{"title":"Get all-products category id and tree reference","request":"curl GET 'https://www.wixapis.com/stores/v3/all-products-category' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\","response":"{\n \"categoryId\": \"894d495b-57d7-41ce-98a5-1320542731dd\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n }\n}"}}],"sdkData":{"signature":{"resolved":[]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Get the all products category ID and tree reference","description":"","content":"import { productsV3 } from \"@wix/stores\";\n\nasync function getAllProductsCategory() {\n const response = await productsV3.getAllProductsCategory();\n}\n\n/* Promise resolves to:\n * {\n * \"categoryId\": \"894d495b-57d7-41ce-98a5-1320542731dd\",\n * \"treeReference\": {\n * \"appNamespace\": \"@wix/stores\"\n * }\n * }\n */\n\n","order":1,"source":"manual"},{"title":"getAllProductsCategory (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function GetAllProductsCategory() {\n const response = await myWixClient.productsV3.GetAllProductsCategory();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Get All Products Category","slugifiedName":"get-all-products-category"},"permissionScopes":[{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"}],"isAdminMethod":false},{"summary":"Get Product By Slug","description":"Retrieves a product by slug.\n\n> **Note:**\n> To retrieve a non-visible product (`visible: false`), your app must have the 'Product v3 read admin' (`SCOPE.STORES.PRODUCT_READ_ADMIN`) permission scope.","operationId":"wix.stores.catalog.v3.CatalogApi.GetProductBySlug","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"slug","description":"Product slug.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"fields","in":"query","description":"Fields to include in the response.","required":false,"schema":{"description":"Fields to include in the response.","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.SingleEntityOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.GetProductBySlugResponse","description":""}},"deprecated":false,"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"NO_PERMISSION_TO_READ_MERCHANT_DATA","description":"The [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities) used to call the method doesn't have the required permissions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"NO_PERMISSION_TO_READ_MERCHANT_DATA"},"name":null},{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"NO_PERMISSION_TO_INCLUDE_NOT_VISIBLE_PRODUCTS","description":"The [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities) used to call the method doesn't have the required permissions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"NO_PERMISSION_TO_INCLUDE_NOT_VISIBLE_PRODUCTS"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_READ","WIX_STORES.PRODUCT_READ_NON_VISIBLE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.GetProductBySlugRequest","responseMessage":"wix.stores.catalog.v3.GetProductBySlugResponse"},"legacyExamples":[{"name":"GetProductBySlug","type":"METHOD","content":{"title":"Get Product by slug","request":"curl -X GET \\\n 'https://www.wixapis.com/stores/v3/products/slug/shopping-bag?fields=VARIANTS_INFO&fields=WEIGHT_MEASUREMENT_UNIT_INFO' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"product\": {\n \"id\": \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-01T10:13:14.540Z\",\n \"updatedDate\": \"2025-01-01T10:13:15.689Z\",\n \"name\": \"Shopping bag\",\n \"slug\": \"shopping-bag\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n },\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_a7daf3a2-2a31-49b3-8a64-8264cd1006c7\",\n \"currency\": null,\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"75ba03bc-e56f-4b6d-be52-691eb2ed5fd7\",\n \"visible\": true,\n \"sku\": null,\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"compareAtPrice\": null\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": null,\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n },\n \"physicalProperties\": {\n \"weight\": null,\n \"pricePerUnit\": null\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735726394407000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": {\n \"minSubscriptionPrice\": null,\n \"minSubscriptionPricePerUnit\": null,\n \"pricePerUnitData\": null,\n \"sku\": null,\n \"weight\": null,\n \"revenueDetails\": null,\n \"actualPrice\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"compareAtPrice\": null\n }\n }\n}"}}],"sdkData":{"signature":{"resolved":[{"field":{"path":"slug"}},{"parent":{"name":"options","fields":[{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Get a product by slug","description":"Retrieve a product by its URL slug with specific field projections","content":"import { productsV3 } from \"@wix/stores\";\n\nconst slug = \"shopping-bag\";\n\nconst options = {\n fields: [\"VARIANTS_INFO\", \"WEIGHT_MEASUREMENT_UNIT_INFO\"]\n};\n\nasync function getProductBySlug() {\n const response = await productsV3.getProductBySlug(slug, options);\n}\n\n/* Promise resolves to:\n * {\n * \"_id\": \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n * \"revision\": \"1\",\n * \"name\": \"Shopping bag\",\n * \"slug\": \"shopping-bag\",\n * \"visible\": true,\n * \"productType\": \"PHYSICAL\",\n * \"physicalProperties\": {\n * \"weightMeasurementUnitInfo\": {\n * \"weightMeasurementUnit\": \"KG\"\n * }\n * },\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"0.5\" },\n * \"maxValue\": { \"amount\": \"0.5\" }\n * },\n * \"variantsInfo\": {\n * \"variants\": [\n * {\n * \"_id\": \"75ba03bc-e56f-4b6d-be52-691eb2ed5fd7\",\n * \"visible\": true,\n * \"price\": {\n * \"actualPrice\": { \"amount\": \"0.5\" }\n * },\n * \"inventoryStatus\": {\n * \"inStock\": false,\n * \"preorderEnabled\": false\n * }\n * }\n * ]\n * }\n * }\n */\n\n","order":1,"source":"manual"},{"title":"getProductBySlug (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function GetProductBySlug() {\n const response = await myWixClient.productsV3.GetProductBySlug();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"get","path":"/v3/products/slug/{slug}","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/stores","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products","destinationPath":"/v3/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products","destinationPath":"/v3/bulk/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"www._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://blocks.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://create.editorx/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"create.editorx","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wixapps.net/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://*.dev.wix-code.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://_/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products-with-inventory","destinationPath":"/v3/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products-with-inventory","destinationPath":"/v3/bulk/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/all-products-category","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/all-products-category","destinationPath":"/v3/all-products-category","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}}],"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"NO_PERMISSION_TO_READ_MERCHANT_DATA","description":"The [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities) used to call the method doesn't have the required permissions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"NO_PERMISSION_TO_READ_MERCHANT_DATA"},"name":null},{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"NO_PERMISSION_TO_INCLUDE_NOT_VISIBLE_PRODUCTS","description":"The [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities) used to call the method doesn't have the required permissions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"NO_PERMISSION_TO_INCLUDE_NOT_VISIBLE_PRODUCTS"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_READ","WIX_STORES.PRODUCT_READ_NON_VISIBLE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.GetProductBySlugRequest","responseMessage":"wix.stores.catalog.v3.GetProductBySlugResponse"},"legacyExamples":[{"name":"GetProductBySlug","type":"METHOD","content":{"title":"Get Product by slug","request":"curl -X GET \\\n 'https://www.wixapis.com/stores/v3/products/slug/shopping-bag?fields=VARIANTS_INFO&fields=WEIGHT_MEASUREMENT_UNIT_INFO' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"product\": {\n \"id\": \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-01T10:13:14.540Z\",\n \"updatedDate\": \"2025-01-01T10:13:15.689Z\",\n \"name\": \"Shopping bag\",\n \"slug\": \"shopping-bag\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": \"1aecdc65-176f-4f07-a846-77a8d5079eb5\",\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n },\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_a7daf3a2-2a31-49b3-8a64-8264cd1006c7\",\n \"currency\": null,\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"maxValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"75ba03bc-e56f-4b6d-be52-691eb2ed5fd7\",\n \"visible\": true,\n \"sku\": null,\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"compareAtPrice\": null\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": null,\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n },\n \"physicalProperties\": {\n \"weight\": null,\n \"pricePerUnit\": null\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735726394407000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": [],\n \"variantSummary\": {\n \"variantCount\": 1\n },\n \"minVariantPriceInfo\": {\n \"minSubscriptionPrice\": null,\n \"minSubscriptionPricePerUnit\": null,\n \"pricePerUnitData\": null,\n \"sku\": null,\n \"weight\": null,\n \"revenueDetails\": null,\n \"actualPrice\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": null\n },\n \"compareAtPrice\": null\n }\n }\n}"}}],"sdkData":{"signature":{"resolved":[{"field":{"path":"slug"}},{"parent":{"name":"options","fields":[{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Get a product by slug","description":"Retrieve a product by its URL slug with specific field projections","content":"import { productsV3 } from \"@wix/stores\";\n\nconst slug = \"shopping-bag\";\n\nconst options = {\n fields: [\"VARIANTS_INFO\", \"WEIGHT_MEASUREMENT_UNIT_INFO\"]\n};\n\nasync function getProductBySlug() {\n const response = await productsV3.getProductBySlug(slug, options);\n}\n\n/* Promise resolves to:\n * {\n * \"_id\": \"9e8924aa-c3f2-4fe6-bc98-ace47295c52d\",\n * \"revision\": \"1\",\n * \"name\": \"Shopping bag\",\n * \"slug\": \"shopping-bag\",\n * \"visible\": true,\n * \"productType\": \"PHYSICAL\",\n * \"physicalProperties\": {\n * \"weightMeasurementUnitInfo\": {\n * \"weightMeasurementUnit\": \"KG\"\n * }\n * },\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"0.5\" },\n * \"maxValue\": { \"amount\": \"0.5\" }\n * },\n * \"variantsInfo\": {\n * \"variants\": [\n * {\n * \"_id\": \"75ba03bc-e56f-4b6d-be52-691eb2ed5fd7\",\n * \"visible\": true,\n * \"price\": {\n * \"actualPrice\": { \"amount\": \"0.5\" }\n * },\n * \"inventoryStatus\": {\n * \"inStock\": false,\n * \"preorderEnabled\": false\n * }\n * }\n * ]\n * }\n * }\n */\n\n","order":1,"source":"manual"},{"title":"getProductBySlug (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function GetProductBySlug() {\n const response = await myWixClient.productsV3.GetProductBySlug();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Get Product By Slug","slugifiedName":"get-product-by-slug"},"permissionScopes":[{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"}],"isAdminMethod":false},{"summary":"Update Product With Inventory","description":"Updates a product and its inventory in a single call.\n\nEach time the product is updated, `revision` increments by 1.\nThe current `revision` must be passed when updating the product.\nThis ensures you're working with the latest product and prevents unintended overwrites.\n\nEach inventory item can track stock using either `quantity` (for exact stock counts) or `inStock` (for simple availability). Learn more about [inventory management](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/about-inventory-management) including tracking methods, preorder settings, and multi-location inventory.\n\n>**Notes:**\n> + To update array fields like `options`, `modifiers`, `variantsInfo.variants`, and any others, you must pass the entire existing array. Passing only the changed item overwrites the entire array, not just merge the single change.\n> + To update `variantsInfo.variants` you must also pass `options` and vice versa. This is because variants and options are mutually dependent and must be aligned.\n> + To update existing `variantsInfo.variants`, make sure to provide `variantsInfo.variants.id`. If no ID is passed, a variant is created with a new ID.\n> + Updating media per variant isn't supported. Instead, assign media items to product option choices using the `linkedMedia` field. You must use preexisting product media.","operationId":"wix.stores.catalog.v3.CatalogApi.UpdateProductWithInventory","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"product.id","description":"Product ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.UpdateProductWithInventoryResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateProductWithInventoryRequest","description":"","properties":{"product":{"description":"Product to update.","$ref":"#/components/schemas/wix.stores.catalog.v3.ProductWithInventory","summary":"product","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the full inventory entities in the response.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.SingleEntityOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["product","product.id","product.revision","product.variantsInfo.variants.price","product.variantsInfo.variants.price.actualPrice","product.variantsInfo.variants.physicalProperties.pricePerUnit.settings.measurementUnit","product.variantsInfo.variants.digitalProperties.digitalFile","product.variantsInfo.variants.digitalProperties.digitalFile.id","product.variantsInfo.variants.choices.optionChoiceIds.optionId","product.variantsInfo.variants.choices.optionChoiceIds.choiceId","product.physicalProperties.pricePerUnit.measurementUnit","product.subscriptionDetails.subscriptions.title","product.subscriptionDetails.subscriptions.frequency","product.subscriptionDetails.subscriptions.discount.type"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_updated","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.UpdateProductWithInventory","methodName":"UpdateProductWithInventory","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"RIBBON_NOT_FOUND","description":"Couldn't find the ribbon.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"RIBBON_NOT_FOUND"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INFO_SECTION_ERROR_OCCURRED","description":"Info section update failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INFO_SECTION_ERROR_OCCURRED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CUSTOMIZATION_NOT_EXIST","description":"Couldn't find the customization.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CUSTOMIZATION_NOT_EXIST"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED","description":"Failed to add customization choices.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CHOICE_NOT_EXIST","description":"Couldn't find the choice.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CHOICE_NOT_EXIST"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"PRODUCT_RESTRICTION_ERROR","description":"Product update violates business restrictions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRODUCT_RESTRICTION_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PREORDER_VALIDATION_ERROR","description":"Variant enabled for preorder on a subscription product. Products with subscriptions can't have preorder variants.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PREORDER_VALIDATION_ERROR"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR","description":"Field mask includes fields not provided in the request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE","description":"The `compareAtPrice` is lower than the `actualPrice`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE","description":"Inventory quantity is negative. The quantity must be non-negative.","errorType":"VALIDATION","validationErrorData":{"ruleName":"REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"BRAND_MISSING_ID","description":"Brand is missing an `id`.","errorType":"VALIDATION","validationErrorData":{"ruleName":"BRAND_MISSING_ID"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRICE_PER_UNIT_NOT_ALIGNED","description":"Price per unit isn't aligned between product and variants.","errorType":"VALIDATION","validationErrorData":{"ruleName":"PRICE_PER_UNIT_NOT_ALIGNED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION_CHOICE","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionChoiceErrorData","description":"Variant choice doesn't exist in the product's option choices.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionErrorData","description":"Variant option doesn't exist in the product's options.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.UpdateProductWithInventoryRequest","responseMessage":"wix.stores.catalog.v3.UpdateProductWithInventoryResponse"},"legacyExamples":[{"name":"UpdateProductWithInventory","type":"METHOD","content":{"title":"Update product with inventory","request":"curl PATCH 'https://www.wixapis.com/stores/v3/products-with-inventory/abc62281-87b7-47e8-98ba-20e25341ad98' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"product\": {\n \"id\": \"4de56f39-7cfd-4e6b-8437-25825d9d5d6a\",\n \"revision\": \"2\",\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"3bc237b4-d480-46e2-b49d-7b92a746780f\",\n \"choices\": [],\n \"inventoryItem\": {\n \"in_stock\": false\n },\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"0.5\"\n }\n }\n }\n ]\n }\n }\n }'","response":"{\n \"product\": {\n \"id\": \"4de56f39-7cfd-4e6b-8437-25825d9d5d6a\",\n \"revision\": \"3\",\n \"createdDate\": \"2025-01-02T07:40:14.776Z\",\n \"updatedDate\": \"2025-01-02T07:40:14.776Z\",\n \"name\": \"Coffee\",\n \"slug\": \"coffee-6\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": null,\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"IN_STOCK\",\n \"preorderStatus\": \"ENABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": null,\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_3d88a9cf-39e7-47c7-9c95-40b71b00098a\",\n \"currency\": \"USD\",\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"3bc237b4-d480-46e2-b49d-7b92a746780f\",\n \"visible\": true,\n \"sku\": \"7777788\",\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"compareAtPrice\": null\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": null,\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n },\n \"physicalProperties\": {\n \"weight\": null,\n \"pricePerUnit\": null\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735803614775000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": []\n },\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n },\n \"inventoryResults\": {\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"2e1c8e1a-4534-4803-894a-3a4b2229149e\",\n \"originalIndex\": 0,\n \"success\": true,\n \"error\": null\n },\n \"item\": {\n \"id\": \"2e1c8e1a-4534-4803-894a-3a4b2229149e\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-02T07:40:14.880Z\",\n \"updatedDate\": \"2025-01-02T07:40:14.880Z\",\n \"variantId\": \"ccf43445-fc4f-4a21-9bd8-075c6f2880c1\",\n \"locationId\": \"12fd1450-8f43-425a-87e7-3cb48bfc1249\",\n \"productId\": \"4de56f39-7cfd-4e6b-8437-25825d9d5d6a\",\n \"quantity\": 19000,\n \"trackQuantity\": true,\n \"availabilityStatus\": \"IN_STOCK\",\n \"preorderInfo\": {\n \"enabled\": true,\n \"counter\": 0,\n \"limit\": 10,\n \"message\": null,\n \"quantity\": 10\n },\n \"product\": null,\n \"extendedFields\": null\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n },\n \"error\": null\n }\n}"}}],"sdkData":{"signature":{"resolved":[{"field":{"path":"product.id"}},{"field":{"path":"product"}},{"parent":{"name":"options","fields":[{"path":"returnEntity"},{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Update a product with inventory","description":"","content":"import { productsV3 } from \"@wix/stores\";\n\nconst productId = \"4de56f39-7cfd-4e6b-8437-25825d9d5d6a\";\n\nconst product = {\n id: \"4de56f39-7cfd-4e6b-8437-25825d9d5d6a\",\n revision: \"2\",\n variantsInfo: {\n variants: [\n {\n id: \"3bc237b4-d480-46e2-b49d-7b92a746780f\",\n choices: [],\n inventoryItem: {\n inStock: false\n },\n price: {\n actualPrice: {\n amount: \"0.5\"\n }\n }\n }\n ]\n }\n};\n\nasync function updateProductWithInventory() {\n const response = await productsV3.updateProductWithInventory(productId, product);\n}\n\n/* Promise resolves to:\n * {\n * \"product\": {\n * \"_id\": \"4de56f39-7cfd-4e6b-8437-25825d9d5d6a\",\n * \"revision\": \"3\",\n * \"name\": \"Coffee\",\n * \"slug\": \"coffee-6\",\n * \"visible\": true,\n * \"productType\": \"PHYSICAL\",\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"10.00\", \"formattedAmount\": \"$10.00\" },\n * \"maxValue\": { \"amount\": \"10.00\", \"formattedAmount\": \"$10.00\" }\n * },\n * \"variantsInfo\": {\n * \"variants\": [\n * {\n * \"_id\": \"3bc237b4-d480-46e2-b49d-7b92a746780f\",\n * \"visible\": true,\n * \"sku\": \"7777788\",\n * \"price\": {\n * \"actualPrice\": { \"amount\": \"10.00\", \"formattedAmount\": \"$10.00\" }\n * },\n * \"inventoryStatus\": {\n * \"inStock\": false,\n * \"preorderEnabled\": false\n * }\n * }\n * ]\n * }\n * },\n * \"inventoryResults\": {\n * \"results\": [\n * {\n * \"itemMetadata\": {\n * \"id\": \"2e1c8e1a-4534-4803-894a-3a4b2229149e\",\n * \"originalIndex\": 0,\n * \"success\": true\n * }\n * }\n * ],\n * \"bulkActionMetadata\": {\n * \"totalSuccesses\": 1,\n * \"totalFailures\": 0\n * }\n * }\n * }\n */\n\n","order":1,"source":"manual"},{"title":"updateProductWithInventory (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function UpdateProductWithInventory() {\n const response = await myWixClient.productsV3.UpdateProductWithInventory();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"patch","path":"/v3/products-with-inventory/{product.id}","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/stores","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products","destinationPath":"/v3/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products","destinationPath":"/v3/bulk/products","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"www._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://blocks.wix.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://create.editorx/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"create.editorx","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://editor.wixapps.net/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://*.dev.wix-code.com/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://_/_api/stores-catalog-orchestrator","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/stores-catalog-orchestrator","destinationPath":"","url":"_","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/products-with-inventory","destinationPath":"/v3/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/bulk/products-with-inventory","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/products-with-inventory","destinationPath":"/v3/bulk/products-with-inventory","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}},{"url":"https://www.wixapis.com/stores/v3/all-products-category","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/all-products-category","destinationPath":"/v3/all-products-category","url":"www.wixapis.com","serviceName":"wix.stores.catalog.v3.CatalogApi"}}],"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.product_updated","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"operationId":"wix.stores.catalog.v3.CatalogApi.UpdateProductWithInventory","methodName":"UpdateProductWithInventory","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"RIBBON_NOT_FOUND","description":"Couldn't find the ribbon.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"RIBBON_NOT_FOUND"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INFO_SECTION_ERROR_OCCURRED","description":"Info section update failed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INFO_SECTION_ERROR_OCCURRED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CUSTOMIZATION_NOT_EXIST","description":"Couldn't find the customization.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CUSTOMIZATION_NOT_EXIST"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED","description":"Failed to add customization choices.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ADD_CUSTOMIZATION_CHOICES_FAILED"},"name":null},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CHOICE_NOT_EXIST","description":"Couldn't find the choice.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CHOICE_NOT_EXIST"},"name":null},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"PRODUCT_RESTRICTION_ERROR","description":"Product update violates business restrictions.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRODUCT_RESTRICTION_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PREORDER_VALIDATION_ERROR","description":"Variant enabled for preorder on a subscription product. Products with subscriptions can't have preorder variants.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PREORDER_VALIDATION_ERROR"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR","description":"Field mask includes fields not provided in the request.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR"},"name":null},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE","description":"The `compareAtPrice` is lower than the `actualPrice`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE","description":"Inventory quantity is negative. The quantity must be non-negative.","errorType":"VALIDATION","validationErrorData":{"ruleName":"REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"BRAND_MISSING_ID","description":"Brand is missing an `id`.","errorType":"VALIDATION","validationErrorData":{"ruleName":"BRAND_MISSING_ID"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"PRICE_PER_UNIT_NOT_ALIGNED","description":"Price per unit isn't aligned between product and variants.","errorType":"VALIDATION","validationErrorData":{"ruleName":"PRICE_PER_UNIT_NOT_ALIGNED"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION_CHOICE","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionChoiceErrorData","description":"Variant choice doesn't exist in the product's option choices.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION_CHOICE"},"name":null},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_VARIANT_OPTION","errorSchemaName":"com.wix.stores.catalog.product.api.v3.MissingVariantOptionErrorData","description":"Variant option doesn't exist in the product's options.","errorType":"VALIDATION","validationErrorData":{"ruleName":"MISSING_VARIANT_OPTION"},"name":null}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.UpdateProductWithInventoryRequest","responseMessage":"wix.stores.catalog.v3.UpdateProductWithInventoryResponse"},"legacyExamples":[{"name":"UpdateProductWithInventory","type":"METHOD","content":{"title":"Update product with inventory","request":"curl PATCH 'https://www.wixapis.com/stores/v3/products-with-inventory/abc62281-87b7-47e8-98ba-20e25341ad98' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"product\": {\n \"id\": \"4de56f39-7cfd-4e6b-8437-25825d9d5d6a\",\n \"revision\": \"2\",\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"3bc237b4-d480-46e2-b49d-7b92a746780f\",\n \"choices\": [],\n \"inventoryItem\": {\n \"in_stock\": false\n },\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"0.5\"\n }\n }\n }\n ]\n }\n }\n }'","response":"{\n \"product\": {\n \"id\": \"4de56f39-7cfd-4e6b-8437-25825d9d5d6a\",\n \"revision\": \"3\",\n \"createdDate\": \"2025-01-02T07:40:14.776Z\",\n \"updatedDate\": \"2025-01-02T07:40:14.776Z\",\n \"name\": \"Coffee\",\n \"slug\": \"coffee-6\",\n \"url\": null,\n \"description\": null,\n \"plainDescription\": null,\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": null,\n \"itemsInfo\": null\n },\n \"seoData\": null,\n \"taxGroupId\": null,\n \"options\": [],\n \"modifiers\": [],\n \"brand\": null,\n \"infoSections\": [],\n \"ribbon\": null,\n \"directCategoriesInfo\": null,\n \"allCategoriesInfo\": null,\n \"mainCategoryId\": null,\n \"directCategoryIdsInfo\": null,\n \"costRange\": null,\n \"inventory\": {\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"availabilityStatus\": \"IN_STOCK\",\n \"preorderStatus\": \"ENABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": null,\n \"fulfillerId\": null,\n \"shippingGroupId\": null,\n \"shippingWeightRange\": null,\n \"pricePerUnitRange\": null,\n \"weightMeasurementUnitInfo\": null,\n \"deliveryProfileId\": null\n },\n \"handle\": \"Product_3d88a9cf-39e7-47c7-9c95-40b71b00098a\",\n \"currency\": \"USD\",\n \"breadcrumbsInfo\": null,\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"3bc237b4-d480-46e2-b49d-7b92a746780f\",\n \"visible\": true,\n \"sku\": \"7777788\",\n \"barcode\": null,\n \"choices\": [],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"10.00\",\n \"formattedAmount\": \"$10.00\"\n },\n \"compareAtPrice\": null\n },\n \"revenueDetails\": null,\n \"media\": null,\n \"subscriptionPricesInfo\": null,\n \"inventoryStatus\": {\n \"inStock\": false,\n \"preorderEnabled\": false\n },\n \"physicalProperties\": {\n \"weight\": null,\n \"pricePerUnit\": null\n }\n }\n ]\n },\n \"subscriptionDetails\": null,\n \"extendedFields\": null,\n \"seoTitle\": null,\n \"seoDescription\": null,\n \"numericId\": \"1735803614775000\",\n \"flattenOptions\": [],\n \"flattenModifiers\": []\n },\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n },\n \"inventoryResults\": {\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"2e1c8e1a-4534-4803-894a-3a4b2229149e\",\n \"originalIndex\": 0,\n \"success\": true,\n \"error\": null\n },\n \"item\": {\n \"id\": \"2e1c8e1a-4534-4803-894a-3a4b2229149e\",\n \"revision\": \"1\",\n \"createdDate\": \"2025-01-02T07:40:14.880Z\",\n \"updatedDate\": \"2025-01-02T07:40:14.880Z\",\n \"variantId\": \"ccf43445-fc4f-4a21-9bd8-075c6f2880c1\",\n \"locationId\": \"12fd1450-8f43-425a-87e7-3cb48bfc1249\",\n \"productId\": \"4de56f39-7cfd-4e6b-8437-25825d9d5d6a\",\n \"quantity\": 19000,\n \"trackQuantity\": true,\n \"availabilityStatus\": \"IN_STOCK\",\n \"preorderInfo\": {\n \"enabled\": true,\n \"counter\": 0,\n \"limit\": 10,\n \"message\": null,\n \"quantity\": 10\n },\n \"product\": null,\n \"extendedFields\": null\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n },\n \"error\": null\n }\n}"}}],"sdkData":{"signature":{"resolved":[{"field":{"path":"product.id"}},{"field":{"path":"product"}},{"parent":{"name":"options","fields":[{"path":"returnEntity"},{"path":"fields"}]}}]},"packageName":"@wix/stores","namespace":"productsV3","methodExamples":[{"title":"Update a product with inventory","description":"","content":"import { productsV3 } from \"@wix/stores\";\n\nconst productId = \"4de56f39-7cfd-4e6b-8437-25825d9d5d6a\";\n\nconst product = {\n id: \"4de56f39-7cfd-4e6b-8437-25825d9d5d6a\",\n revision: \"2\",\n variantsInfo: {\n variants: [\n {\n id: \"3bc237b4-d480-46e2-b49d-7b92a746780f\",\n choices: [],\n inventoryItem: {\n inStock: false\n },\n price: {\n actualPrice: {\n amount: \"0.5\"\n }\n }\n }\n ]\n }\n};\n\nasync function updateProductWithInventory() {\n const response = await productsV3.updateProductWithInventory(productId, product);\n}\n\n/* Promise resolves to:\n * {\n * \"product\": {\n * \"_id\": \"4de56f39-7cfd-4e6b-8437-25825d9d5d6a\",\n * \"revision\": \"3\",\n * \"name\": \"Coffee\",\n * \"slug\": \"coffee-6\",\n * \"visible\": true,\n * \"productType\": \"PHYSICAL\",\n * \"actualPriceRange\": {\n * \"minValue\": { \"amount\": \"10.00\", \"formattedAmount\": \"$10.00\" },\n * \"maxValue\": { \"amount\": \"10.00\", \"formattedAmount\": \"$10.00\" }\n * },\n * \"variantsInfo\": {\n * \"variants\": [\n * {\n * \"_id\": \"3bc237b4-d480-46e2-b49d-7b92a746780f\",\n * \"visible\": true,\n * \"sku\": \"7777788\",\n * \"price\": {\n * \"actualPrice\": { \"amount\": \"10.00\", \"formattedAmount\": \"$10.00\" }\n * },\n * \"inventoryStatus\": {\n * \"inStock\": false,\n * \"preorderEnabled\": false\n * }\n * }\n * ]\n * }\n * },\n * \"inventoryResults\": {\n * \"results\": [\n * {\n * \"itemMetadata\": {\n * \"id\": \"2e1c8e1a-4534-4803-894a-3a4b2229149e\",\n * \"originalIndex\": 0,\n * \"success\": true\n * }\n * }\n * ],\n * \"bulkActionMetadata\": {\n * \"totalSuccesses\": 1,\n * \"totalFailures\": 0\n * }\n * }\n * }\n */\n\n","order":1,"source":"manual"},{"title":"updateProductWithInventory (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { productsV3 } from '@wix/stores';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { productsV3 },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function UpdateProductWithInventory() {\n const response = await myWixClient.productsV3.UpdateProductWithInventory();\n};","order":2,"source":"generated"}]},"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Update Product With Inventory","slugifiedName":"update-product-with-inventory"},"permissionScopes":[{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}],"isAdminMethod":true}],"webhooks":[{"summary":"Product Created","title":"Product Created","description":"","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"com.wix.stores.catalog.product.api.v3.ProductService","domainEvent":"CREATED","eventType":"wix.stores.catalog.v3.product_created","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"legacyExamples":[{"name":"ProductCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"4ae86daa-0f77-463c-a0ad-9f25fb50929e\",\n \"entityFqdn\": \"wix.stores.catalog.v3.product\",\n \"slug\": \"created\",\n \"entityId\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"createdEvent\": {\n \"entityAsJson\": {\n \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-07-22T13:22:47.771Z\",\n \"updatedDate\": \"2024-07-22T13:22:47.771Z\",\n \"name\": \"Coffee\",\n \"slug\": \"coffee\",\n \"url\": {\n \"relativePath\": \"/product-page/coffee\",\n \"url\": \"https://my.wixsite.com/food-store/product-page/coffee\"\n },\n \"description\": {\n \"nodes\": [\n {\n \"type\": \"PARAGRAPH\",\n \"id\": \"foo\",\n \"nodes\": [\n {\n \"type\": \"TEXT\",\n \"id\": \"\",\n \"nodes\": [],\n \"textData\": {\n \"text\": \"Tasty and eco friendly, in a beautiful gift box.\",\n \"decorations\": []\n }\n }\n ],\n \"paragraphData\": {\n \"textStyle\": {\n \"textAlignment\": \"AUTO\"\n }\n }\n }\n ],\n \"metadata\": {\n \"version\": 1,\n \"id\": \"fb97b2c1-a3ff-4319-be5f-bbb7fdf0776c\"\n }\n },\n \"plainDescription\": \"

Tasty and eco friendly, in a beautiful gift box.

\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n \"itemsInfo\": {\n \"items\": [\n {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n {\n \"url\": \"https://example.jpeg\",\n \"uploadId\": \"44682905-395a-4c18-8fab-e050725ba3f6\"\n }\n ]\n }\n },\n \"options\": [\n {\n \"id\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"name\": \"Size\",\n \"optionRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"4498b805-2aed-43fb-b478-989c906c19cd\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"S\",\n \"name\": \"S\",\n \"inStock\": true\n },\n {\n \"choiceId\": \"26394ab0-d81a-422f-a8c9-562f49a6b595\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"L\",\n \"name\": \"L\",\n \"inStock\": false\n }\n ]\n },\n \"key\": \"Size\"\n },\n {\n \"id\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"name\": \"Box color\",\n \"optionRenderType\": \"SWATCH_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"2e98f13b-ae65-4d30-96c5-ac3a6cf99d60\",\n \"linkedMedia\": [],\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"red\",\n \"name\": \"red\",\n \"colorCode\": \"#FF0000\",\n \"inStock\": true\n },\n {\n \"choiceId\": \"4876dcc7-817e-4c10-a6b2-4a4cc2e241e6\",\n \"linkedMedia\": [],\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"blue\",\n \"name\": \"blue\",\n \"colorCode\": \"#0000FF\",\n \"inStock\": false\n }\n ]\n },\n \"key\": \"Box color\"\n }\n ],\n \"modifiers\": [\n {\n \"id\": \"1d628610-6963-43c0-862a-f823142b00a0\",\n \"name\": \"Engraving\",\n \"modifierRenderType\": \"FREE_TEXT\",\n \"mandatory\": false,\n \"freeTextSettings\": {\n \"minCharCount\": 0,\n \"maxCharCount\": 499,\n \"title\": \"Would you like to engrave something on the box?\",\n \"key\": \"Would you like to engrave something on the box?\"\n },\n \"key\": \"Engraving\"\n },\n {\n \"id\": \"a3d249f0-a8da-425d-9ec1-3c51c795d927\",\n \"name\": \"Remove price tag\",\n \"modifierRenderType\": \"TEXT_CHOICES\",\n \"mandatory\": false,\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"3050481e-e177-4031-bbe9-be9b00af14b5\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"yes\",\n \"name\": \"yes\"\n },\n {\n \"choiceId\": \"ee729b74-d500-4594-aae5-b5a2e75bf5e7\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"no\",\n \"name\": \"no\"\n }\n ]\n },\n \"key\": \"Remove price tag\"\n }\n ],\n \"brand\": {\n \"id\": \"4a16d28d-1736-41f0-87d8-995f6d9a5bdd\",\n \"name\": \"EcoCoffee\"\n },\n \"infoSections\": [\n {\n \"id\": \"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\",\n \"uniqueName\": \"Coffee refund\",\n \"title\": \"Refund policy\",\n \"description\": {\n \"nodes\": [\n {\n \"type\": \"PARAGRAPH\",\n \"id\": \"xjkk51429\",\n \"nodes\": [\n {\n \"type\": \"TEXT\",\n \"id\": \"\",\n \"nodes\": [],\n \"textData\": {\n \"text\": \"2 weeks full refund unless you asked for engraving \",\n \"decorations\": []\n }\n }\n ],\n \"paragraphData\": {}\n }\n ],\n \"metadata\": {\n \"version\": 1\n },\n \"documentStyle\": {}\n },\n \"plainDescription\": \"

2 weeks full refund unless you asked for engraving

\"\n }\n ],\n \"ribbon\": {\n \"id\": \"826aec2a-771b-45a6-9f72-392da18fd3bf\",\n \"name\": \"best seller\"\n },\n \"directCategoriesInfo\": {\n \"categories\": []\n },\n \"allCategoriesInfo\": {\n \"categories\": []\n },\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"9\",\n \"formattedAmount\": \"$9.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"costRange\": {\n \"minValue\": {\n \"amount\": \"0.0\",\n \"formattedAmount\": \"$0.00\"\n },\n \"maxValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": {\n \"quantity\": 1.0,\n \"measurementUnit\": \"KG\"\n },\n \"shippingWeightRange\": {\n \"minValue\": 0.2,\n \"maxValue\": 0.4\n },\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n }\n },\n \"currency\": \"USD\",\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"0a186a72-d289-446a-aa51-adf125d30dc6\",\n \"visible\": true,\n \"sku\": \"c-s-r-1111\",\n \"barcode\": \"111111111\",\n \"choices\": [\n {\n \"optionChoiceIds\": {\n \"optionId\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"choiceId\": \"4498b805-2aed-43fb-b478-989c906c19cd\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Size\",\n \"choiceName\": \"S\",\n \"renderType\": \"TEXT_CHOICES\"\n }\n },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"2e98f13b-ae65-4d30-96c5-ac3a6cf99d60\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Box color\",\n \"choiceName\": \"red\",\n \"renderType\": \"SWATCH_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"compareAtPrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"actualPrice\": {\n \"amount\": \"9\",\n \"formattedAmount\": \"$9.00\"\n }\n },\n \"revenueDetails\": {\n \"cost\": {\n \"amount\": \"8\",\n \"formattedAmount\": \"$8.00\"\n },\n \"profit\": {\n \"amount\": \"1\",\n \"formattedAmount\": \"$1.00\"\n },\n \"profitMargin\": 0.1111\n },\n \"media\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n \"physicalProperties\": {\n \"weight\": 0.2,\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": 150.0,\n \"measurementUnit\": \"G\"\n },\n \"value\": \"60.00\",\n \"description\": \"$60.00/1 kg\"\n }\n },\n \"subscriptionPricesInfo\": {\n \"subscriptionPrices\": []\n }\n },\n {\n \"id\": \"5aace0e6-4bab-4d0e-a595-1bcaa01d2377\",\n \"visible\": true,\n \"barcode\": \"111111112\",\n \"choices\": [\n {\n \"optionChoiceIds\": {\n \"optionId\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"choiceId\": \"4498b805-2aed-43fb-b478-989c906c19cd\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Size\",\n \"choiceName\": \"S\",\n \"renderType\": \"TEXT_CHOICES\"\n }\n },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"4876dcc7-817e-4c10-a6b2-4a4cc2e241e6\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Box color\",\n \"choiceName\": \"blue\",\n \"renderType\": \"SWATCH_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"compareAtPrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"actualPrice\": {\n \"amount\": \"9.5\",\n \"formattedAmount\": \"$9.50\"\n }\n },\n \"revenueDetails\": {\n \"cost\": {\n \"amount\": \"8\",\n \"formattedAmount\": \"$8.00\"\n },\n \"profit\": {\n \"amount\": \"1.5\",\n \"formattedAmount\": \"$1.50\"\n },\n \"profitMargin\": 0.1579\n },\n \"media\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n \"physicalProperties\": {\n \"weight\": 0.2,\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": 150.0,\n \"measurementUnit\": \"G\"\n },\n \"value\": \"63.33\",\n \"description\": \"$63.33/1 kg\"\n }\n },\n \"subscriptionPricesInfo\": {\n \"subscriptionPrices\": []\n }\n },\n {\n \"id\": \"1d2acec3-5294-4521-a648-6f2ed5f58c43\",\n \"visible\": false,\n \"barcode\": \"111111113\",\n \"choices\": [\n {\n \"optionChoiceIds\": {\n \"optionId\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"choiceId\": \"26394ab0-d81a-422f-a8c9-562f49a6b595\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Size\",\n \"choiceName\": \"L\",\n \"renderType\": \"TEXT_CHOICES\"\n }\n },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"2e98f13b-ae65-4d30-96c5-ac3a6cf99d60\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Box color\",\n \"choiceName\": \"red\",\n \"renderType\": \"SWATCH_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"compareAtPrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"actualPrice\": {\n \"amount\": \"14\",\n \"formattedAmount\": \"$14.00\"\n }\n },\n \"revenueDetails\": {\n \"cost\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"profit\": {\n \"amount\": \"4\",\n \"formattedAmount\": \"$4.00\"\n },\n \"profitMargin\": 0.2857\n },\n \"media\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n \"physicalProperties\": {\n \"weight\": 0.4,\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": 300.0,\n \"measurementUnit\": \"G\"\n },\n \"value\": \"46.67\",\n \"description\": \"$46.67/1 kg\"\n }\n },\n \"subscriptionPricesInfo\": {\n \"subscriptionPrices\": []\n }\n },\n {\n \"id\": \"5c390d11-8d35-48e3-8037-428812e0426c\",\n \"visible\": true,\n \"barcode\": \"111111114\",\n \"choices\": [\n {\n \"optionChoiceIds\": {\n \"optionId\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"choiceId\": \"26394ab0-d81a-422f-a8c9-562f49a6b595\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Size\",\n \"choiceName\": \"L\",\n \"renderType\": \"TEXT_CHOICES\"\n }\n },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"4876dcc7-817e-4c10-a6b2-4a4cc2e241e6\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Box color\",\n \"choiceName\": \"blue\",\n \"renderType\": \"SWATCH_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"compareAtPrice\": null,\n \"actualPrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"media\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n \"physicalProperties\": {\n \"weight\": 0.4,\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": 300.0,\n \"measurementUnit\": \"G\"\n },\n \"value\": \"50.00\",\n \"description\": \"$50.00/1 kg\"\n }\n },\n \"subscriptionPricesInfo\": {\n \"subscriptionPrices\": []\n }\n }\n ]\n }\n }\n },\n \"eventTime\": \"2024-07-22T13:22:47.923240503Z\",\n \"triggeredByAnonymizeRequest\": false,\n \"entityEventSequence\": \"1\"\n}\n"}],"sdkExamples":[{"title":"onProductCreated","content":"import { doNotCallProductsV3 } from '@wix/stores';\n\ndoNotCallProductsV3.onProductCreated((event) => {\n // handle your event here\n});","order":0},{"title":"onProductCreated (self-hosted)","content":"import { createClient, AppStrategy } from '@wix/sdk';\nimport { doNotCallProductsV3 } from '@wix/stores';\n\nconst wixClient = createClient({\n auth: AppStrategy({\n appId: 'MY-APP-ID',\n publicKey: 'YOUR_APP_PUBLIC_KEY',\n }),\n modules: {\n doNotCallProductsV3,\n },\n});\n\nwixClient.doNotCallProductsV3.onProductCreated((event) => {\n // handle your event here\n});","order":1}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product","contentLink":{"displayName":"Product Created","slugifiedName":"product-created"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"}]},{"summary":"Product Deleted","title":"Product Deleted","description":"Triggered when a product is deleted.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"com.wix.stores.catalog.product.api.v3.ProductService","domainEvent":"DELETED","eventType":"wix.stores.catalog.v3.product_deleted","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"legacyExamples":[{"name":"ProductDeleted","eventType":"DELETED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"e100bc33-ba14-4c92-948e-416bfb884091\",\n \"entityFqdn\": \"wix.stores.catalog.v3.product\",\n \"slug\": \"deleted\",\n \"entityId\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"deletedEvent\": {\n \"movedToTrash\": true,\n \"deletedEntityAsJson\": {\n \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"revision\": \"17\",\n \"createdDate\": \"2024-07-22T13:22:47.771Z\",\n \"updatedDate\": \"2024-07-22T17:05:33.830Z\",\n \"name\": \"Coffee\",\n \"slug\": \"coffee\",\n \"url\": {\n \"relativePath\": \"/product-page/coffee\",\n \"url\": \"https://my.wixsite.com/food-store/product-page/coffee\"\n },\n \"description\": {\n \"nodes\": [\n {\n \"type\": \"PARAGRAPH\",\n \"id\": \"foo\",\n \"nodes\": [\n {\n \"type\": \"TEXT\",\n \"id\": \"\",\n \"nodes\": [],\n \"textData\": {\n \"text\": \"Tasty and eco friendly, in a beautiful gift box.\",\n \"decorations\": []\n }\n }\n ],\n \"paragraphData\": {\n \"textStyle\": {\n \"textAlignment\": \"AUTO\"\n }\n }\n }\n ],\n \"metadata\": {\n \"version\": 1,\n \"id\": \"fb97b2c1-a3ff-4319-be5f-bbb7fdf0776c\"\n }\n },\n \"plainDescription\": \"

Tasty and eco friendly, in a beautiful gift box.

\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"main\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n \"itemsInfo\" : {\n \"items\": [\n {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n }\n ]\n }\n },\n \"options\": [\n {\n \"id\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"name\": \"Size\",\n \"optionRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"4498b805-2aed-43fb-b478-989c906c19cd\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"S\",\n \"name\": \"S\",\n \"inStock\": true\n },\n {\n \"choiceId\": \"26394ab0-d81a-422f-a8c9-562f49a6b595\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"L\",\n \"name\": \"L\",\n \"inStock\": false\n }\n ]\n },\n \"key\": \"Size\"\n },\n {\n \"id\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"name\": \"Box color\",\n \"optionRenderType\": \"SWATCH_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"2e98f13b-ae65-4d30-96c5-ac3a6cf99d60\",\n \"linkedMedia\": [],\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"red\",\n \"name\": \"red\",\n \"colorCode\": \"#FF0000\",\n \"inStock\": true\n },\n {\n \"choiceId\": \"4876dcc7-817e-4c10-a6b2-4a4cc2e241e6\",\n \"linkedMedia\": [],\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"blue\",\n \"name\": \"blue\",\n \"colorCode\": \"#0000FF\",\n \"inStock\": false\n }\n ]\n },\n \"key\": \"Box color\"\n }\n ],\n \"modifiers\": [\n {\n \"id\": \"\",\n \"name\": \"Remove price tag\",\n \"modifierRenderType\": \"FREE_TEXT\",\n \"mandatory\": false,\n \"freeTextSettings\": {\n \"minCharCount\": 0,\n \"maxCharCount\": 499,\n \"title\": \"Would you like to engrave something on the box?\",\n \"key\": \"\"\n },\n \"key\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"Remove price tag\",\n \"modifierRenderType\": \"TEXT_CHOICES\",\n \"mandatory\": false,\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceId\": \"\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"\",\n \"name\": \"yes\"\n },\n {\n \"choiceId\": \"\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"\",\n \"name\": \"no\"\n }\n ]\n },\n \"key\": \"\"\n }\n ],\n \"brand\": {\n \"id\": \"4a16d28d-1736-41f0-87d8-995f6d9a5bdd\",\n \"name\": \"EcoCoffee\"\n },\n \"infoSections\": [\n {\n \"id\": \"59954f23-fbcd-42e5-ba61-7c8cf9d8b409\",\n \"uniqueName\": \"Coffee refund\",\n \"title\": \"Refund policy\",\n \"description\": {\n \"nodes\": [\n {\n \"type\": \"PARAGRAPH\",\n \"id\": \"xjkk51429\",\n \"nodes\": [\n {\n \"type\": \"TEXT\",\n \"id\": \"\",\n \"nodes\": [],\n \"textData\": {\n \"text\": \"2 weeks full refund unless you asked for engraving \",\n \"decorations\": []\n }\n }\n ],\n \"paragraphData\": {}\n }\n ],\n \"metadata\": {\n \"version\": 1\n },\n \"documentStyle\": {}\n },\n \"plainDescription\": \"

2 weeks full refund unless you asked for engraving

\"\n }\n ],\n \"ribbon\": {\n \"id\": \"826aec2a-771b-45a6-9f72-392da18fd3bf\",\n \"name\": \"best seller\"\n },\n \"directCategoriesInfo\": {\n \"categories\": [\n {\n \"id\": \"643721c3-446e-47f3-87ee-0a58d6842d48\"\n }\n ]\n },\n \"allCategoriesInfo\": {\n \"categories\": [\n {\n \"id\": \"643721c3-446e-47f3-87ee-0a58d6842d48\"\n }\n ]\n },\n \"mainCategoryId\": \"643721c3-446e-47f3-87ee-0a58d6842d48\",\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"6\",\n \"formattedAmount\": \"$6.00\"\n },\n \"maxValue\": {\n \"amount\": \"6\",\n \"formattedAmount\": \"$6.00\"\n }\n },\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"5\",\n \"formattedAmount\": \"$5.00\"\n },\n \"maxValue\": {\n \"amount\": \"5\",\n \"formattedAmount\": \"$5.00\"\n }\n },\n \"costRange\": {\n \"minValue\": {\n \"amount\": \"4\",\n \"formattedAmount\": \"$4.00\"\n },\n \"maxValue\": {\n \"amount\": \"4\",\n \"formattedAmount\": \"$4.00\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": {\n \"quantity\": 1.0,\n \"measurementUnit\": \"KG\"\n },\n \"shippingWeightRange\": {\n \"minValue\": 0.1,\n \"maxValue\": 0.1\n },\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n }\n },\n \"currency\": \"USD\",\n \"breadcrumbsInfo\": {\n \"breadcrumbs\": [\n {\n \"categoryId\": \"643721c3-446e-47f3-87ee-0a58d6842d48\",\n \"categoryName\": \"All Products\",\n \"categorySlug\": \"all-products\"\n }\n ]\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"0a186a72-d289-446a-aa51-adf125d30dc6\",\n \"visible\": false,\n \"sku\": \"c-s-r-1111\",\n \"barcode\": \"111111111\",\n \"choices\": [\n {\n \"optionChoiceIds\": {\n \"optionId\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"choiceId\": \"4498b805-2aed-43fb-b478-989c906c19cd\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Size\",\n \"choiceName\": \"S\",\n \"renderType\": \"TEXT_CHOICES\"\n }\n },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"2e98f13b-ae65-4d30-96c5-ac3a6cf99d60\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Box color\",\n \"choiceName\": \"red\",\n \"renderType\": \"SWATCH_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"compareAtPrice\": {\n \"amount\": \"6\",\n \"formattedAmount\": \"$6.00\"\n },\n \"actualPrice\": {\n \"amount\": \"5\",\n \"formattedAmount\": \"$5.00\"\n }\n },\n \"revenueDetails\": {\n \"cost\": {\n \"amount\": \"4\",\n \"formattedAmount\": \"$4.00\"\n },\n \"profit\": {\n \"amount\": \"1\",\n \"formattedAmount\": \"$1.00\"\n },\n \"profitMargin\": 0.1667\n },\n \"media\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n \"physicalProperties\": {\n \"weight\": 0.1,\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": 0.5,\n \"measurementUnit\": \"KG\"\n },\n \"value\": \"10.00\",\n \"description\": \"$10.00/1 kg\"\n }\n },\n \"subscriptionPricesInfo\": {\n \"subscriptionPrices\": []\n }\n },\n {\n \"id\": \"5aace0e6-4bab-4d0e-a595-1bcaa01d2377\",\n \"visible\": false,\n \"barcode\": \"111111112\",\n \"choices\": [\n {\n \"optionChoiceIds\": {\n \"optionId\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"choiceId\": \"4498b805-2aed-43fb-b478-989c906c19cd\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Size\",\n \"choiceName\": \"S\",\n \"renderType\": \"TEXT_CHOICES\"\n }\n },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"4876dcc7-817e-4c10-a6b2-4a4cc2e241e6\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Box color\",\n \"choiceName\": \"blue\",\n \"renderType\": \"SWATCH_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"compareAtPrice\": {\n \"amount\": \"6\",\n \"formattedAmount\": \"$6.00\"\n },\n \"actualPrice\": {\n \"amount\": \"5\",\n \"formattedAmount\": \"$5.00\"\n }\n },\n \"revenueDetails\": {\n \"cost\": {\n \"amount\": \"4\",\n \"formattedAmount\": \"$4.00\"\n },\n \"profit\": {\n \"amount\": \"1\",\n \"formattedAmount\": \"$1.00\"\n },\n \"profitMargin\": 0.1667\n },\n \"media\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n \"physicalProperties\": {\n \"weight\": 0.1,\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": 0.5,\n \"measurementUnit\": \"KG\"\n },\n \"value\": \"10.00\",\n \"description\": \"$10.00/1 kg\"\n }\n },\n \"subscriptionPricesInfo\": {\n \"subscriptionPrices\": []\n }\n },\n {\n \"id\": \"1d2acec3-5294-4521-a648-6f2ed5f58c43\",\n \"visible\": false,\n \"barcode\": \"111111113\",\n \"choices\": [\n {\n \"optionChoiceIds\": {\n \"optionId\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"choiceId\": \"26394ab0-d81a-422f-a8c9-562f49a6b595\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Size\",\n \"choiceName\": \"L\",\n \"renderType\": \"TEXT_CHOICES\"\n }\n },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"2e98f13b-ae65-4d30-96c5-ac3a6cf99d60\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Box color\",\n \"choiceName\": \"red\",\n \"renderType\": \"SWATCH_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"compareAtPrice\": {\n \"amount\": \"6\",\n \"formattedAmount\": \"$6.00\"\n },\n \"actualPrice\": {\n \"amount\": \"5\",\n \"formattedAmount\": \"$5.00\"\n }\n },\n \"revenueDetails\": {\n \"cost\": {\n \"amount\": \"4\",\n \"formattedAmount\": \"$4.00\"\n },\n \"profit\": {\n \"amount\": \"1\",\n \"formattedAmount\": \"$1.00\"\n },\n \"profitMargin\": 0.1667\n },\n \"media\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n \"physicalProperties\": {\n \"weight\": 0.1,\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": 0.5,\n \"measurementUnit\": \"KG\"\n },\n \"value\": \"10.00\",\n \"description\": \"$10.00/1 kg\"\n }\n },\n \"subscriptionPricesInfo\": {\n \"subscriptionPrices\": []\n }\n },\n {\n \"id\": \"5c390d11-8d35-48e3-8037-428812e0426c\",\n \"visible\": false,\n \"barcode\": \"111111114\",\n \"choices\": [\n {\n \"optionChoiceIds\": {\n \"optionId\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"choiceId\": \"26394ab0-d81a-422f-a8c9-562f49a6b595\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Size\",\n \"choiceName\": \"L\",\n \"renderType\": \"TEXT_CHOICES\"\n }\n },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"4876dcc7-817e-4c10-a6b2-4a4cc2e241e6\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Box color\",\n \"choiceName\": \"blue\",\n \"renderType\": \"SWATCH_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"compareAtPrice\": {\n \"amount\": \"6\",\n \"formattedAmount\": \"$6.00\"\n },\n \"actualPrice\": {\n \"amount\": \"5\",\n \"formattedAmount\": \"$5.00\"\n }\n },\n \"revenueDetails\": {\n \"cost\": {\n \"amount\": \"4\",\n \"formattedAmount\": \"$4.00\"\n },\n \"profit\": {\n \"amount\": \"1\",\n \"formattedAmount\": \"$1.00\"\n },\n \"profitMargin\": 0.1667\n },\n \"media\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n \"physicalProperties\": {\n \"weight\": 0.1,\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": 0.5,\n \"measurementUnit\": \"KG\"\n },\n \"value\": \"10.00\",\n \"description\": \"$10.00/1 kg\"\n }\n },\n \"subscriptionPricesInfo\": {\n \"subscriptionPrices\": []\n }\n }\n ]\n }\n }\n },\n \"eventTime\": \"2024-07-22T17:19:37.246315574Z\",\n \"triggeredByAnonymizeRequest\": false,\n \"entityEventSequence\": \"37\"\n}\n"}],"sdkExamples":[{"title":"onProductDeleted","content":"import { doNotCallProductsV3 } from '@wix/stores';\n\ndoNotCallProductsV3.onProductDeleted((event) => {\n // handle your event here\n});","order":0},{"title":"onProductDeleted (self-hosted)","content":"import { createClient, AppStrategy } from '@wix/sdk';\nimport { doNotCallProductsV3 } from '@wix/stores';\n\nconst wixClient = createClient({\n auth: AppStrategy({\n appId: 'MY-APP-ID',\n publicKey: 'YOUR_APP_PUBLIC_KEY',\n }),\n modules: {\n doNotCallProductsV3,\n },\n});\n\nwixClient.doNotCallProductsV3.onProductDeleted((event) => {\n // handle your event here\n});","order":1}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product","contentLink":{"displayName":"Product Deleted","slugifiedName":"product-deleted"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"}]},{"summary":"Product Updated","title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"com.wix.stores.catalog.product.api.v3.ProductService","domainEvent":"UPDATED","eventType":"wix.stores.catalog.v3.product_updated","permissionsInfo":[{"name":"WIX_STORES.PRODUCT_READ","manual":false}],"legacyExamples":[{"name":"ProductUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"e6a571a2-c522-4826-ae71-6bb99074123a\",\n \"entityFqdn\": \"wix.stores.catalog.v3.product\",\n \"slug\": \"updated\",\n \"entityId\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"updatedEvent\": {\n \"currentEntityAsJson\": {\n \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-07-22T13:22:47.771Z\",\n \"updatedDate\": \"2024-07-22T13:51:49.970Z\",\n \"name\": \"Premium Coffee\",\n \"slug\": \"coffee\",\n \"url\": {\n \"relativePath\": \"/product-page/coffee\",\n \"url\": \"https://my.wixsite.com/food-store/product-page/coffee\"\n },\n \"description\": {\n \"nodes\": [\n {\n \"type\": \"PARAGRAPH\",\n \"id\": \"foo\",\n \"nodes\": [\n {\n \"type\": \"TEXT\",\n \"id\": \"\",\n \"nodes\": [],\n \"textData\": {\n \"text\": \"Tasty, high quality and eco friendly, in a beautiful gift box.\",\n \"decorations\": []\n }\n }\n ],\n \"paragraphData\": {\n \"textStyle\": {\n \"textAlignment\": \"AUTO\"\n }\n }\n }\n ],\n \"metadata\": {\n \"version\": 1,\n \"id\": \"fb97b2c1-a3ff-4319-be5f-bbb7fdf0776c\"\n }\n },\n \"plainDescription\": \"

Tasty, high quality and eco friendly, in a beautiful gift box.

2 weeks full refund unless you asked for engraving

Brazil

\"\n }\n ],\n \"ribbon\": {\n \"id\": \"14585597-3302-4145-8da3-24a26d8346d6\",\n \"name\": \"New arrival\"\n },\n \"directCategoriesInfo\": {\n \"categories\": [\n {\n \"id\": \"643721c3-446e-47f3-87ee-0a58d6842d48\"\n }\n ]\n },\n \"allCategoriesInfo\": {\n \"categories\": [\n {\n \"id\": \"643721c3-446e-47f3-87ee-0a58d6842d48\"\n }\n ]\n },\n \"mainCategoryId\": \"643721c3-446e-47f3-87ee-0a58d6842d48\",\n \"compareAtPriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"actualPriceRange\": {\n \"minValue\": {\n \"amount\": \"9\",\n \"formattedAmount\": \"$9.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"costRange\": {\n \"minValue\": {\n \"amount\": \"0.0\",\n \"formattedAmount\": \"$0.00\"\n },\n \"maxValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderAvailability\": \"NO_VARIANTS\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"pricePerUnit\": {\n \"quantity\": 1.0,\n \"measurementUnit\": \"KG\"\n },\n \"shippingWeightRange\": {\n \"minValue\": 0.2,\n \"maxValue\": 0.4\n },\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n }\n },\n \"currency\": \"USD\",\n \"breadcrumbsInfo\": {\n \"breadcrumbs\": [\n {\n \"categoryId\": \"643721c3-446e-47f3-87ee-0a58d6842d48\",\n \"categoryName\": \"All Products\",\n \"categorySlug\": \"all-products\"\n }\n ]\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"0a186a72-d289-446a-aa51-adf125d30dc6\",\n \"visible\": true,\n \"sku\": \"c-s-r-1111\",\n \"barcode\": \"111111111\",\n \"choices\": [\n {\n \"optionChoiceIds\": {\n \"optionId\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"choiceId\": \"4498b805-2aed-43fb-b478-989c906c19cd\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Size\",\n \"choiceName\": \"S\",\n \"renderType\": \"TEXT_CHOICES\"\n }\n },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"2e98f13b-ae65-4d30-96c5-ac3a6cf99d60\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Box color\",\n \"choiceName\": \"red\",\n \"renderType\": \"SWATCH_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"compareAtPrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"actualPrice\": {\n \"amount\": \"9\",\n \"formattedAmount\": \"$9.00\"\n }\n },\n \"revenueDetails\": {\n \"cost\": {\n \"amount\": \"8\",\n \"formattedAmount\": \"$8.00\"\n },\n \"profit\": {\n \"amount\": \"1\",\n \"formattedAmount\": \"$1.00\"\n },\n \"profitMargin\": 0.1111\n },\n \"media\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n \"physicalProperties\": {\n \"weight\": 0.2,\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": 150.0,\n \"measurementUnit\": \"G\"\n },\n \"value\": \"60.00\",\n \"description\": \"$60.00/1 kg\"\n }\n },\n \"subscriptionPricesInfo\": {\n \"subscriptionPrices\": []\n }\n },\n {\n \"id\": \"5aace0e6-4bab-4d0e-a595-1bcaa01d2377\",\n \"visible\": true,\n \"barcode\": \"111111112\",\n \"choices\": [\n {\n \"optionChoiceIds\": {\n \"optionId\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"choiceId\": \"4498b805-2aed-43fb-b478-989c906c19cd\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Size\",\n \"choiceName\": \"S\",\n \"renderType\": \"TEXT_CHOICES\"\n }\n },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"4876dcc7-817e-4c10-a6b2-4a4cc2e241e6\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Box color\",\n \"choiceName\": \"blue\",\n \"renderType\": \"SWATCH_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"compareAtPrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"actualPrice\": {\n \"amount\": \"9.5\",\n \"formattedAmount\": \"$9.50\"\n }\n },\n \"revenueDetails\": {\n \"cost\": {\n \"amount\": \"8\",\n \"formattedAmount\": \"$8.00\"\n },\n \"profit\": {\n \"amount\": \"1.5\",\n \"formattedAmount\": \"$1.50\"\n },\n \"profitMargin\": 0.1579\n },\n \"media\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n \"physicalProperties\": {\n \"weight\": 0.2,\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": 150.0,\n \"measurementUnit\": \"G\"\n },\n \"value\": \"63.33\",\n \"description\": \"$63.33/1 kg\"\n }\n },\n \"subscriptionPricesInfo\": {\n \"subscriptionPrices\": []\n }\n },\n {\n \"id\": \"1d2acec3-5294-4521-a648-6f2ed5f58c43\",\n \"visible\": false,\n \"barcode\": \"111111113\",\n \"choices\": [\n {\n \"optionChoiceIds\": {\n \"optionId\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"choiceId\": \"26394ab0-d81a-422f-a8c9-562f49a6b595\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Size\",\n \"choiceName\": \"L\",\n \"renderType\": \"TEXT_CHOICES\"\n }\n },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"2e98f13b-ae65-4d30-96c5-ac3a6cf99d60\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Box color\",\n \"choiceName\": \"red\",\n \"renderType\": \"SWATCH_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"compareAtPrice\": {\n \"amount\": \"14\",\n \"formattedAmount\": \"$14.00\"\n }\n },\n \"revenueDetails\": {\n \"cost\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"profit\": {\n \"amount\": \"4\",\n \"formattedAmount\": \"$4.00\"\n },\n \"profitMargin\": 0.2857\n },\n \"media\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n \"physicalProperties\": {\n \"weight\": 0.4,\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": 300.0,\n \"measurementUnit\": \"G\"\n },\n \"value\": \"46.67\",\n \"description\": \"$46.67/1 kg\"\n }\n },\n \"subscriptionPricesInfo\": {\n \"subscriptionPrices\": []\n }\n },\n {\n \"id\": \"5c390d11-8d35-48e3-8037-428812e0426c\",\n \"visible\": true,\n \"barcode\": \"111111114\",\n \"choices\": [\n {\n \"optionChoiceIds\": {\n \"optionId\": \"85bb0544-63c7-431b-9659-f81b18a7dd9f\",\n \"choiceId\": \"26394ab0-d81a-422f-a8c9-562f49a6b595\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Size\",\n \"choiceName\": \"L\",\n \"renderType\": \"TEXT_CHOICES\"\n }\n },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"4876dcc7-817e-4c10-a6b2-4a4cc2e241e6\"\n },\n \"optionChoiceNames\": {\n \"optionName\": \"Box color\",\n \"choiceName\": \"blue\",\n \"renderType\": \"SWATCH_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"actualPrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"media\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"image\": {\n \"id\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"url\": \"https://static.wixstatic.com/media/370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\",\n \"height\": 1200,\n \"width\": 1200,\n \"filename\": \"food.jpeg\",\n \"sizeInBytes\": \"116752\"\n },\n \"uploadId\": \"370e1a_c65292a0c0584c26aa32d9d921302af9~mv2.jpeg\"\n },\n \"physicalProperties\": {\n \"weight\": 0.4,\n \"pricePerUnit\": {\n \"settings\": {\n \"quantity\": 300.0,\n \"measurementUnit\": \"G\"\n },\n \"value\": \"50.00\",\n \"description\": \"$50.00/1 kg\"\n }\n },\n \"subscriptionPricesInfo\": {\n \"subscriptionPrices\": []\n }\n }\n ]\n }\n },\n \"modifiedFields\": {\n \"modifiers[1].choicesSettings.choices[1].colorCodes\": null,\n \"modifiers[0].choicesSettings\": null,\n \"name\": \"Coffee\",\n \"modifiers[0].freeTextSettings.minCharCount\": \"0\",\n \"modifiers[1].choicesSettings.choices[1].name.value\": \"no\",\n \"modifiers[1].choicesSettings.choices[0].choiceType\": \"CHOICE_TEXT\",\n \"modifiers[0].id\": \"1d628610-6963-43c0-862a-f823142b00a0\",\n \"modifiers[1].id.value\": \"a3d249f0-a8da-425d-9ec1-3c51c795d927\",\n \"modifiers[1].choicesSettings.choices[0].key\": \"yes\",\n \"modifiers[0].key\": \"Engraving\",\n \"modifiers[1].mandatory\": false,\n \"visible\": true,\n \"modifiers[1].choicesSettings.choices[1].choiceType\": \"CHOICE_TEXT\",\n \"modifiers[0].freeTextSettings.maxCharCount\": \"499\",\n \"description\": {\n \"nodes\": [\n {\n \"nodes\": [\n {\n \"type\": \"TEXT\",\n \"id\": \"\",\n \"textData\": {\n \"text\": \"Tasty and eco friendly, in a beautiful gift box.\"\n }\n }\n ],\n \"type\": \"PARAGRAPH\",\n \"id\": \"foo\",\n \"paragraphData\": {\n \"textStyle\": {\n \"textAlignment\": \"AUTO\"\n }\n }\n }\n ],\n \"metadata\": {\n \"version\": \"1\",\n \"id\": \"fb97b2c1-a3ff-4319-be5f-bbb7fdf0776c\"\n }\n },\n \"visibleInPos\": true,\n \"modifiers[1].choicesSettings.choices[0].image\": null,\n \"ribbon.name\": \"best seller\",\n \"infoSections[1]\": null,\n \"modifiers[1].choicesSettings.choices[0].colorCodes\": null,\n \"modifiers[1].key\": \"Remove price tag\",\n \"modifiers[1].freeTextSettings\": null,\n \"modifiers[1].choicesSettings.choices[0].choiceId.value\": \"3050481e-e177-4031-bbe9-be9b00af14b5\",\n \"modifiers[1].choicesSettings.choices[1].image\": null,\n \"modifiers[1].choicesSettings.choices[1].key\": \"no\",\n \"plainDescription\": \"

Tasty and eco friendly, in a beautiful gift box.

\",\n \"revision\": \"1\",\n \"modifiers[0].freeTextSettings.key\": \"Would you like to engrave something on the box?\",\n \"modifiers[1].choicesSettings.choices[1].colorCode\": null,\n \"modifiers[1].choicesSettings.choices[0].name.value\": \"yes\",\n \"modifiers[0].name\": \"Engraving\",\n \"modifiers[1].name.value\": \"Remove price tag\",\n \"modifiers[1].choicesSettings.choices[0].colorCode\": null,\n \"modifiers[1].choicesSettings.choices[1].choiceId.value\": \"ee729b74-d500-4594-aae5-b5a2e75bf5e7\",\n \"ribbon.id\": \"826aec2a-771b-45a6-9f72-392da18fd3bf\",\n \"modifiers[0].modifierRenderType\": \"FREE_TEXT\",\n \"modifiers[1].choicesSettings.choices[1].addedPrice\": null,\n \"modifiers[0].freeTextSettings.title\": \"Would you like to engrave something on the box?\",\n \"updatedDate\": \"2024-07-22T13:41:41.859Z\",\n \"modifiers[1].choicesSettings.choices[0].addedPrice\": null,\n \"modifiers[1].modifierRenderType\": \"TEXT_CHOICES\"\n }\n },\n \"eventTime\": \"2024-07-22T13:51:50.545511227Z\",\n \"triggeredByAnonymizeRequest\": false,\n \"entityEventSequence\": \"5\"\n}\n"}],"sdkExamples":[{"title":"onProductUpdated","content":"import { doNotCallProductsV3 } from '@wix/stores';\n\ndoNotCallProductsV3.onProductUpdated((event) => {\n // handle your event here\n});","order":0},{"title":"onProductUpdated (self-hosted)","content":"import { createClient, AppStrategy } from '@wix/sdk';\nimport { doNotCallProductsV3 } from '@wix/stores';\n\nconst wixClient = createClient({\n auth: AppStrategy({\n appId: 'MY-APP-ID',\n publicKey: 'YOUR_APP_PUBLIC_KEY',\n }),\n modules: {\n doNotCallProductsV3,\n },\n});\n\nwixClient.doNotCallProductsV3.onProductUpdated((event) => {\n // handle your event here\n});","order":1}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product","contentLink":{"displayName":"Product Updated","slugifiedName":"product-updated"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"}]}],"articles":[],"components":{"schemas":{"com.wix.stores.catalog.product.api.v3.Product":{"type":"object","properties":{"id":{"description":"Product ID.","minLength":1,"maxLength":36,"immutable":true,"readOnly":true,"title":"id","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time the product is updated.\nTo prevent conflicting changes,\nthe current revision must be passed when updating the product.\n\nIgnored when creating a product.","readOnly":true,"title":"revision","type":"string","format":"int64","$ref":"#/components/schemas/google.protobuf.Int64Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the product was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","$ref":"#/components/schemas/google.protobuf.Timestamp","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the product was updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","$ref":"#/components/schemas/google.protobuf.Timestamp","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Product name. Translatable.","minLength":1,"maxLength":80,"title":"name","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"Product slug.\n\nIf not provided, the slug is autogenerated based on the product name.","format":"URL_SLUG","title":"slug","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"URL to the site's product page.\n\n> **Note:** Returned only when you pass `\"URL\"` to the `fields` array in Products API requests.","readOnly":true,"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.PageUrlV2","summary":"url","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Product description using rich content.\n> **Note:** Returned only when you pass `\"DESCRIPTION\"` to the `fields` array in Products API requests.\n\n\nSee Ricos document reference\n","$ref":"#/components/schemas/wix.rich_content.v1.RichContent","summary":"description","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"plainDescription":{"description":"Product description in HTML.\n\n+ When provided on create/update, this string must be valid HTML. It's then converted to rich content.\n+ `plainDescription` is ignored when a value is also passed to the `description` field.\n> **Note:** Returned only when you pass `\"PLAIN_DESCRIPTION\"` to the `fields` array in Products API requests.","maxLength":16000,"title":"plainDescription","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"visible":{"description":"Whether the product is visible to site visitors.\n\nDefault: `true`","title":"visible","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"visibleInPos":{"description":"Whether the product is visible in POS (point of sale).\n\nDefault: `true`\n> **Note:** Always `false` for `productType: DIGITAL`.","title":"visibleInPos","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"media":{"description":"Product media items. For a detailed explanation of product media, see [About Product Media](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/about-product-media).","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Media","summary":"media","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"seoData":{"description":"Product SEO data.","$ref":"#/components/schemas/com.wixpress.advanced.seo.SeoSchema","summary":"seoData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"taxGroupId":{"description":"[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","title":"taxGroupId","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"options":{"description":"Product options, such as \"Size\" or \"Color\". Options define the ways a product can vary.\n\nWhen 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-product-options-and-variants).\n\nOptions 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.","maxItems":6,"title":"options","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ConnectedOption"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"modifiers":{"description":"Product modifiers. Collect additional information from customers without creating variants.\n\nUnlike 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-product-options-and-variants).\n\nModifiers 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.","maxItems":10,"title":"modifiers","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ConnectedModifier"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"brand":{"description":"Product [brand](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/brands-v3/introduction).\n\n+ Pass `brand.name` to add a new brand while creating a product.\n+ Pass an existing brand's `id` to assign that brand to the product.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Brand","summary":"brand","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"infoSections":{"description":"Product [info section](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/info-sections-v3/introduction).\n\n+ Pass `infoSection.uniqueName`, `infoSection.title`, and `infoSection.description` to add a new info section while creating a product.\n+ Pass an existing info section's `id` or `uniqueName` to assign that info section to the product.","maxItems":10,"title":"infoSections","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.InfoSection"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ribbon":{"description":"Product [ribbon](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/ribbons-v3/introduction).\n\n+ Pass `ribbon.name` to add a new ribbon while creating a product.\n+ Pass an existing ribbon's `id` or `name` to assign that ribbon to the product.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Ribbon","summary":"ribbon","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"directCategoriesInfo":{"description":"List of [categories](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/categories/introduction) that directly contain this product.\n\nUpdated automatically when a product is added/removed from a category, when an item is moved within a category, or when a category is deleted.\n> **Note:** Returned only when you pass `\"DIRECT_CATEGORIES_INFO\"` to the `fields` array in Products API requests.","readOnly":true,"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ProductCategoriesInfo","summary":"directCategoriesInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"allCategoriesInfo":{"description":"List of [categories](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/categories/introduction) that directly contain this product, as well as their parent categories.\n> **Note:** Returned only when you pass `\"ALL_CATEGORIES_INFO\"` to the `fields` array in Products API requests.","readOnly":true,"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ProductCategoriesInfo","summary":"allCategoriesInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mainCategoryId":{"description":"The ID of the product's primary direct [category](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/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","title":"mainCategoryId","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","referencedEntity":"wix.categories.v1.category"}},"costRange":{"description":"Product cost range - minimum and maximum costs of all product variants.\n\n> **Note:** Returned only when the following conditions are met:\n> + You pass `\"MERCHANT_DATA\"` to the `fields` array in Products API requests.\n> + Your app has the required `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.","readOnly":true,"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.PriceRange","summary":"costRange","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"inventory":{"description":"Product inventory info.\n\n> **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. Learn more about [inventory management](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/about-inventory-management).","readOnly":true,"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Inventory","summary":"inventory","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"productType":{"description":"Product type: `PHYSICAL` for tangible goods that require shipping, or `DIGITAL` for downloadable content.\n\nWhen passing `productType: PHYSICAL`, you must also pass `physicalProperties`. When passing `productType: DIGITAL`, you can optionally pass `digitalProperties` in each variant.","immutable":true,"title":"productType","type":"string","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ProductType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"handle":{"description":"A unique human-friendly identifier for the product.\n\nUnlike 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":true,"title":"handle","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"currency":{"description":"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.\n\nDefaults to the currency defined in the site settings, unless specified in the request's `x-wix-currency` header.\n> **Note:** Returned only when you pass `\"CURRENCY\"` to the `fields` array in Products API requests.","format":"CURRENCY","readOnly":true,"title":"currency","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"breadcrumbsInfo":{"description":"Breadcrumbs of the `mainCategoryId`. Used to navigate to parent [categories](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/categories/introduction). Useful for building navigation UI and for SEO purposes.\n> **Note:** Returned only when you pass `\"BREADCRUMBS_INFO\"` to the `fields` array in Products API requests.","readOnly":true,"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.BreadcrumbsInfo","summary":"breadcrumbsInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actualPriceRange":{"description":"Minimum and maximum current selling prices across all product variants.","readOnly":true,"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.PriceRange","summary":"actualPriceRange","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"compareAtPriceRange":{"description":"Minimum and maximum compare-at prices (original prices before discounts) across all product variants. Used to show savings to customers.","readOnly":true,"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.PriceRange","summary":"compareAtPriceRange","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"variantsInfo":{"description":"Product variants. Each variant represents a specific purchasable version of a product defined by option choices.\n\nEach variant must reference all product options via its `choices` array, using `optionChoiceNames` in requests.\nYou must explicitly provide each variant when creating products with options.\n\nFor more information, see [About Product Options and Variants](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/about-product-options-and-variants).","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.VariantsInfo","summary":"variantsInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"purchaseEligibility":{"description":"Purchase eligibility settings for the product.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.PurchaseEligibility","summary":"purchaseEligibility","x-wix-docs":{"exposure":"PUBLIC","maturity":"BETA"}},"extendedFields":{"description":"Custom extended fields for the product object.\n\n[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.","$ref":"#/components/schemas/wix.common.data.dataextensions.ExtendedFields","summary":"extendedFields","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"subscriptionDetails":{"description":"Product subscriptions.\n\nSubscription 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.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.SubscriptionDetails","summary":"subscriptionDetails","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"variantSummary":{"description":"The total number of variants for the product.","readOnly":true,"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.VariantSummary","summary":"variantSummary","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Product","description":"A product in a Wix Stores catalog.\n\nProducts can be physical goods that require shipping, or digital content that customers download. Each product has at least one variant, which represents a specific purchasable version with its own pricing, SKU, and inventory. Products with options (like size or color) have multiple variants.\n\nProducts can be associated with brands and ribbons, enhanced with info sections and extended fields, and organized into categories.","oneOf":[{"description":"","summary":"typedProperties","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product.typedProperties"}]},"com.wix.stores.catalog.product.api.v3.Product.typedProperties":{"type":"object","title":"typedProperties","properties":{"physicalProperties":{"description":"Physical properties.\n\nRequired when `productType: PHYSICAL`.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.PhysicalProperties","summary":"physicalProperties","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.PageUrlV2":{"type":"object","properties":{"relativePath":{"description":"The relative path for the page within the site. For example, `/product-page/a-product`.","title":"relativePath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"The page's full URL. For example, `https://mysite.com/product-page/a-product`.","title":"url","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PageUrlV2","description":"","x-wix-docs":{"decompositeOf":"wix.common.PageUrlV2"}},"wix.rich_content.v1.RichContent":{"type":"object","properties":{"nodes":{"description":"Node objects representing a rich content document.","title":"nodes","type":"array","items":{"$ref":"#/components/schemas/wix.rich_content.v1.Node"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metadata":{"description":"Object metadata.","$ref":"#/components/schemas/wix.rich_content.v1.Metadata","summary":"metadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"documentStyle":{"description":"Global styling for header, paragraph, block quote, and code block nodes in the object.","$ref":"#/components/schemas/wix.rich_content.v1.DocumentStyle","summary":"documentStyle","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RichContent","description":""},"wix.rich_content.v1.Node":{"type":"object","properties":{"type":{"description":"Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format.","title":"type","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.Node.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"id":{"description":"Node ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nodes":{"description":"A list of child nodes.","title":"nodes","type":"array","items":{"$ref":"#/components/schemas/wix.rich_content.v1.Node"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"style":{"description":"Padding and background color styling for the node.","$ref":"#/components/schemas/wix.rich_content.v1.NodeStyle","summary":"style","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Node","description":"","oneOf":[{"description":"","summary":"data","$ref":"#/components/schemas/wix.rich_content.v1.Node.data"}]},"wix.rich_content.v1.Node.data":{"type":"object","title":"data","properties":{"buttonData":{"description":"Data for a button node.","$ref":"#/components/schemas/wix.rich_content.v1.ButtonData","summary":"buttonData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"codeBlockData":{"description":"Data for a code block node.","$ref":"#/components/schemas/wix.rich_content.v1.CodeBlockData","summary":"codeBlockData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dividerData":{"description":"Data for a divider node.","$ref":"#/components/schemas/wix.rich_content.v1.DividerData","summary":"dividerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fileData":{"description":"Data for a file node.","$ref":"#/components/schemas/wix.rich_content.v1.FileData","summary":"fileData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"galleryData":{"description":"Data for a gallery node.","$ref":"#/components/schemas/wix.rich_content.v1.GalleryData","summary":"galleryData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"gifData":{"description":"Data for a GIF node.","$ref":"#/components/schemas/wix.rich_content.v1.GIFData","summary":"gifData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"headingData":{"description":"Data for a heading node.","$ref":"#/components/schemas/wix.rich_content.v1.HeadingData","summary":"headingData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"htmlData":{"description":"Data for an embedded HTML node.","$ref":"#/components/schemas/wix.rich_content.v1.HTMLData","summary":"htmlData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"imageData":{"description":"Data for an image node.","$ref":"#/components/schemas/wix.rich_content.v1.ImageData","summary":"imageData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"linkPreviewData":{"description":"Data for a link preview node.","$ref":"#/components/schemas/wix.rich_content.v1.LinkPreviewData","summary":"linkPreviewData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mapData":{"description":"","$ref":"#/components/schemas/wix.rich_content.v1.MapData","summary":"mapData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"paragraphData":{"description":"Data for a paragraph node.","$ref":"#/components/schemas/wix.rich_content.v1.ParagraphData","summary":"paragraphData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pollData":{"description":"Data for a poll node.","$ref":"#/components/schemas/wix.rich_content.v1.PollData","summary":"pollData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"textData":{"description":"Data for a text node. Used to apply decorations to text.","$ref":"#/components/schemas/wix.rich_content.v1.TextData","summary":"textData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appEmbedData":{"description":"Data for an app embed node.","$ref":"#/components/schemas/wix.rich_content.v1.AppEmbedData","summary":"appEmbedData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"videoData":{"description":"Data for a video node.","$ref":"#/components/schemas/wix.rich_content.v1.VideoData","summary":"videoData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"embedData":{"description":"Data for an oEmbed node.","$ref":"#/components/schemas/wix.rich_content.v1.EmbedData","summary":"embedData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"collapsibleListData":{"description":"Data for a collapsible list node.","$ref":"#/components/schemas/wix.rich_content.v1.CollapsibleListData","summary":"collapsibleListData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tableData":{"description":"Data for a table node.","$ref":"#/components/schemas/wix.rich_content.v1.TableData","summary":"tableData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tableCellData":{"description":"Data for a table cell node.","$ref":"#/components/schemas/wix.rich_content.v1.TableCellData","summary":"tableCellData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"externalData":{"description":"Data for a custom external node.","$ref":"#/components/schemas/wix.rich_content.v1.Struct","summary":"externalData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"audioData":{"description":"Data for an audio node.","$ref":"#/components/schemas/wix.rich_content.v1.AudioData","summary":"audioData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"orderedListData":{"description":"Data for an ordered list node.","$ref":"#/components/schemas/wix.rich_content.v1.OrderedListData","summary":"orderedListData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulletedListData":{"description":"Data for a bulleted list node.","$ref":"#/components/schemas/wix.rich_content.v1.BulletedListData","summary":"bulletedListData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"blockquoteData":{"description":"Data for a block quote node.","$ref":"#/components/schemas/wix.rich_content.v1.BlockquoteData","summary":"blockquoteData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"captionData":{"description":"Data for a caption node.","$ref":"#/components/schemas/wix.rich_content.v1.CaptionData","summary":"captionData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"layoutData":{"description":"Data for a layout node. Reserved for future use.","$ref":"#/components/schemas/wix.rich_content.v1.LayoutData","summary":"layoutData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"layoutCellData":{"description":"Data for a cell node.","$ref":"#/components/schemas/wix.rich_content.v1.LayoutCellData","summary":"layoutCellData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.rich_content.v1.Node.Type":{"type":"string","description":"","title":"Type","enum":[{"order":0,"value":"PARAGRAPH","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"TEXT","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"HEADING","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"BULLETED_LIST","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":4,"value":"ORDERED_LIST","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":5,"value":"LIST_ITEM","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":6,"value":"BLOCKQUOTE","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":7,"value":"CODE_BLOCK","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":8,"value":"VIDEO","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":9,"value":"DIVIDER","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":10,"value":"FILE","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":11,"value":"GALLERY","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":12,"value":"GIF","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":13,"value":"HTML","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":14,"value":"IMAGE","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":15,"value":"LINK_PREVIEW","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":16,"value":"MAP","description":"@deprecated","maturity":"GA","exposure":"PUBLIC"},{"order":17,"value":"POLL","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":18,"value":"APP_EMBED","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":19,"value":"BUTTON","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":20,"value":"COLLAPSIBLE_LIST","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":21,"value":"TABLE","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":22,"value":"EMBED","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":23,"value":"COLLAPSIBLE_ITEM","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":24,"value":"COLLAPSIBLE_ITEM_TITLE","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":25,"value":"COLLAPSIBLE_ITEM_BODY","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":26,"value":"TABLE_CELL","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":27,"value":"TABLE_ROW","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":28,"value":"EXTERNAL","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":29,"value":"AUDIO","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":30,"value":"CAPTION","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":31,"value":"LAYOUT","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":32,"value":"LAYOUT_CELL","description":"","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.NodeStyle":{"type":"object","properties":{"paddingTop":{"description":"The top padding value in pixels.","title":"paddingTop","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paddingBottom":{"description":"The bottom padding value in pixels.","title":"paddingBottom","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"backgroundColor":{"description":"The background color as a hexadecimal value.","title":"backgroundColor","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NodeStyle","description":""},"wix.rich_content.v1.ButtonData":{"type":"object","properties":{"containerData":{"description":"Styling for the button's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"The button type.","title":"type","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.ButtonData.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"styles":{"description":"Styling for the button.","$ref":"#/components/schemas/wix.rich_content.v1.ButtonData.Styles","summary":"styles","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"text":{"description":"The text to display on the button.","title":"text","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"link":{"description":"Button link details.","$ref":"#/components/schemas/wix.rich_content.v1.Link","summary":"link","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ButtonData","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"wix.rich_content.v1.ButtonData.Styles.Border":{"type":"object","properties":{"width":{"description":"Deprecated: Use `borderWidth` in `styles` instead.","title":"width","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"radius":{"description":"Deprecated: Use `borderRadius` in `styles` instead.","title":"radius","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}}},"title":"Border","description":""},"wix.rich_content.v1.ButtonData.Styles.Colors":{"type":"object","properties":{"text":{"description":"Deprecated: Use `textColor` in `styles` instead.","title":"text","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"border":{"description":"Deprecated: Use `borderColor` in `styles` instead.","title":"border","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"background":{"description":"Deprecated: Use `backgroundColor` in `styles` instead.","title":"background","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}}},"title":"Colors","description":""},"wix.rich_content.v1.PluginContainerData":{"type":"object","properties":{"width":{"description":"The width of the node when it's displayed.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData.Width","summary":"width","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"alignment":{"description":"The node's alignment within its container.","title":"alignment","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData.Alignment","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"spoiler":{"description":"Spoiler cover settings for the node.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData.Spoiler","summary":"spoiler","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"The height of the node when it's displayed.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData.Height","summary":"height","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"textWrap":{"description":"Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`.","title":"textWrap","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PluginContainerData","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"wix.rich_content.v1.PluginContainerData.Width.Type":{"type":"string","description":"","title":"Type","enum":[{"order":0,"value":"CONTENT","description":"Width matches the content width","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"SMALL","description":"Small Width","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"ORIGINAL","description":"Width will match the original asset width","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"FULL_WIDTH","description":"coast-to-coast display","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.PluginContainerData.Width":{"type":"object","properties":{},"title":"Width","description":"","oneOf":[{"description":"","summary":"data","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData.Width.data"}]},"wix.rich_content.v1.PluginContainerData.Width.data":{"type":"object","title":"data","properties":{"size":{"description":"One of the following predefined width options:\n`CONTENT`: The width of the container matches the content width.\n`SMALL`: A small width.\n`ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.\n`FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.","title":"size","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData.Width.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"custom":{"description":"A custom width value in pixels.","title":"custom","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.rich_content.v1.PluginContainerData.Alignment":{"type":"string","description":"","title":"Alignment","enum":[{"order":0,"value":"CENTER","description":"Center Alignment","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"LEFT","description":"Left Alignment","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"RIGHT","description":"Right Alignment","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.PluginContainerData.Spoiler":{"type":"object","properties":{"enabled":{"description":"Sets whether the spoiler cover is enabled for this node. Defaults to `false`.","title":"enabled","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"The description displayed on top of the spoiler cover.","title":"description","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"buttonText":{"description":"The text for the button used to remove the spoiler cover.","title":"buttonText","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Spoiler","description":""},"wix.rich_content.v1.PluginContainerData.Height":{"type":"object","properties":{"custom":{"description":"A custom height value in pixels.","title":"custom","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Height","description":""},"wix.rich_content.v1.ButtonData.Type":{"type":"string","description":"","title":"Type","enum":[{"order":0,"value":"LINK","description":"Regular link button","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"ACTION","description":"Triggers custom action that is defined in plugin configuration by the consumer","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.ButtonData.Styles":{"type":"object","properties":{"border":{"description":"Deprecated: Use `borderWidth` and `borderRadius` instead.","$ref":"#/components/schemas/wix.rich_content.v1.ButtonData.Styles.Border","summary":"border","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"colors":{"description":"Deprecated: Use `textColor`, `borderColor` and `backgroundColor` instead.","$ref":"#/components/schemas/wix.rich_content.v1.ButtonData.Styles.Colors","summary":"colors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"borderWidth":{"description":"Border width in pixels.","title":"borderWidth","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderWidthHover":{"description":"Deprecated: Use `borderWidth` for normal/hover states instead.","title":"borderWidthHover","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"borderRadius":{"description":"Border radius in pixels.","title":"borderRadius","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderColor":{"description":"Border color as a hexadecimal value.","format":"COLOR_HEX","title":"borderColor","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderColorHover":{"description":"Border color as a hexadecimal value (hover state).","format":"COLOR_HEX","title":"borderColorHover","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"textColor":{"description":"Text color as a hexadecimal value.","format":"COLOR_HEX","title":"textColor","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"textColorHover":{"description":"Text color as a hexadecimal value (hover state).","format":"COLOR_HEX","title":"textColorHover","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"backgroundColor":{"description":"Background color as a hexadecimal value.","format":"COLOR_HEX","title":"backgroundColor","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"backgroundColorHover":{"description":"Background color as a hexadecimal value (hover state).","format":"COLOR_HEX","title":"backgroundColorHover","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"buttonSize":{"description":"Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`.","title":"buttonSize","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Styles","description":""},"wix.rich_content.v1.Link":{"type":"object","properties":{"target":{"description":"he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:\n`SELF` - Default. Opens the linked document in the same frame as the link.\n`BLANK` - Opens the linked document in a new browser tab or window.\n`PARENT` - Opens the linked document in the link's parent frame.\n`TOP` - Opens the linked document in the full body of the link's browser tab or window.","title":"target","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.Link.Target","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rel":{"description":"The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document.","$ref":"#/components/schemas/wix.rich_content.v1.Link.Rel","summary":"rel","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"customData":{"description":"A serialized object used for a custom or external link panel.","title":"customData","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Link","description":"","oneOf":[{"description":"","summary":"data","$ref":"#/components/schemas/wix.rich_content.v1.Link.data"}]},"wix.rich_content.v1.Link.data":{"type":"object","title":"data","properties":{"url":{"description":"The absolute URL for the linked document.","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"anchor":{"description":"The target node's ID. Used for linking to another node in this object.","title":"anchor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.rich_content.v1.Link.Target":{"type":"string","description":"","title":"Target","enum":[{"order":0,"value":"SELF","description":"Opens the linked document in the same frame as it was clicked (this is default)","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"BLANK","description":"Opens the linked document in a new window or tab","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"PARENT","description":"Opens the linked document in the parent frame","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"TOP","description":"Opens the linked document in the full body of the window","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.Link.Rel":{"type":"object","properties":{"nofollow":{"description":"Indicates to search engine crawlers not to follow the link. Defaults to `false`.","title":"nofollow","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sponsored":{"description":"Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`.","title":"sponsored","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ugc":{"description":"Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page’s author. For example, a link in a fourm post. Defaults to `false`.","title":"ugc","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"noreferrer":{"description":"Indicates that this link protect referral information from being passed to the target website.","title":"noreferrer","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Rel","description":""},"wix.rich_content.v1.CodeBlockData":{"type":"object","properties":{"textStyle":{"description":"Styling for the code block's text.","$ref":"#/components/schemas/wix.rich_content.v1.TextStyle","summary":"textStyle","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CodeBlockData","description":""},"wix.rich_content.v1.TextStyle":{"type":"object","properties":{"textAlignment":{"description":"Text alignment. Defaults to `AUTO`.","title":"textAlignment","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.TextStyle.TextAlignment","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lineHeight":{"description":"A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px.","title":"lineHeight","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TextStyle","description":""},"wix.rich_content.v1.TextStyle.TextAlignment":{"type":"string","description":"","title":"TextAlignment","enum":[{"order":0,"value":"AUTO","description":"browser default, eqivalent to `initial`","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"LEFT","description":"Left align","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"RIGHT","description":"Right align","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"CENTER","description":"Center align","maturity":"GA","exposure":"PUBLIC"},{"order":4,"value":"JUSTIFY","description":"Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.DividerData":{"type":"object","properties":{"containerData":{"description":"Styling for the divider's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lineStyle":{"description":"Divider line style.","title":"lineStyle","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.DividerData.LineStyle","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"Divider width.","title":"width","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.DividerData.Width","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"alignment":{"description":"Divider alignment.","title":"alignment","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.DividerData.Alignment","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DividerData","description":""},"wix.rich_content.v1.DividerData.LineStyle":{"type":"string","description":"","title":"LineStyle","enum":[{"order":0,"value":"SINGLE","description":"Single Line","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"DOUBLE","description":"Double Line","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"DASHED","description":"Dashed Line","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"DOTTED","description":"Dotted Line","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.DividerData.Width":{"type":"string","description":"","title":"Width","enum":[{"order":0,"value":"LARGE","description":"Large line","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"MEDIUM","description":"Medium line","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"SMALL","description":"Small line","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.DividerData.Alignment":{"type":"string","description":"","title":"Alignment","enum":[{"order":0,"value":"CENTER","description":"Center alignment","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"LEFT","description":"Left alignment","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"RIGHT","description":"Right alignment","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.FileData":{"type":"object","properties":{"containerData":{"description":"Styling for the file's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"src":{"description":"The source for the file's data.","$ref":"#/components/schemas/wix.rich_content.v1.FileSource","summary":"src","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"File name.","title":"name","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"File type.","title":"type","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"size":{"description":"Use `sizeInKb` instead.","title":"size","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"pdfSettings":{"description":"Settings for PDF files.","$ref":"#/components/schemas/wix.rich_content.v1.FileData.PDFSettings","summary":"pdfSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mimeType":{"description":"File MIME type.","title":"mimeType","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"path":{"description":"File path.","title":"path","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sizeInKb":{"description":"File size in KB.","title":"sizeInKb","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FileData","description":""},"wix.rich_content.v1.FileData.PDFSettings.ViewMode":{"type":"string","description":"","title":"ViewMode","enum":[{"order":0,"value":"NONE","description":"No PDF view","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"FULL","description":"Full PDF view","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"MINI","description":"Mini PDF view","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.FileSource":{"type":"object","properties":{"private":{"description":"Indicates whether the file's source is private. Defaults to `false`.","title":"private","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FileSource","description":"","oneOf":[{"description":"","summary":"data","$ref":"#/components/schemas/wix.rich_content.v1.FileSource.data"}]},"wix.rich_content.v1.FileSource.data":{"type":"object","title":"data","properties":{"url":{"description":"The absolute URL for the file's source.","title":"url","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"custom":{"description":"Custom ID. Use `id` instead.","title":"custom","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"id":{"description":"An ID that's resolved to a URL by a resolver function.","title":"id","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.rich_content.v1.FileData.PDFSettings":{"type":"object","properties":{"viewMode":{"description":"PDF view mode. One of the following:\n`NONE` : The PDF isn't displayed.\n`FULL` : A full page view of the PDF is displayed.\n`MINI` : A mini view of the PDF is displayed.","title":"viewMode","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.FileData.PDFSettings.ViewMode","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"disableDownload":{"description":"Sets whether the PDF download button is disabled. Defaults to `false`.","title":"disableDownload","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"disablePrint":{"description":"Sets whether the PDF print button is disabled. Defaults to `false`.","title":"disablePrint","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PDFSettings","description":""},"wix.rich_content.v1.GalleryData":{"type":"object","properties":{"containerData":{"description":"Styling for the gallery's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"items":{"description":"The items in the gallery.","title":"items","type":"array","items":{"$ref":"#/components/schemas/wix.rich_content.v1.GalleryData.Item"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"options":{"description":"Options for defining the gallery's appearance.","$ref":"#/components/schemas/wix.rich_content.v1.GalleryOptions","summary":"options","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"disableExpand":{"description":"Sets whether the gallery's expand button is disabled. Defaults to `false`.","title":"disableExpand","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"disableDownload":{"description":"Sets whether the gallery's download button is disabled. Defaults to `false`.","title":"disableDownload","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GalleryData","description":""},"wix.rich_content.v1.Media":{"type":"object","properties":{"src":{"description":"The source for the media's data.","$ref":"#/components/schemas/wix.rich_content.v1.FileSource","summary":"src","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"Media width in pixels.","title":"width","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"Media height in pixels.","title":"height","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"duration":{"description":"Media duration in seconds. Only relevant for audio and video files.","title":"duration","type":"number","format":"double","$ref":"#/components/schemas/google.protobuf.DoubleValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Media","description":""},"google.protobuf.DoubleValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DoubleValue","description":""},"wix.rich_content.v1.GalleryData.Item.Image":{"type":"object","properties":{"media":{"description":"Image file details.","$ref":"#/components/schemas/wix.rich_content.v1.Media","summary":"media","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"link":{"description":"Link details for images that are links.","$ref":"#/components/schemas/wix.rich_content.v1.Link","summary":"link","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Image","description":""},"wix.rich_content.v1.GalleryData.Item.Video":{"type":"object","properties":{"media":{"description":"Video file details.","$ref":"#/components/schemas/wix.rich_content.v1.Media","summary":"media","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"thumbnail":{"description":"Video thumbnail file details.","$ref":"#/components/schemas/wix.rich_content.v1.Media","summary":"thumbnail","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Video","description":""},"wix.rich_content.v1.GalleryData.Item":{"type":"object","properties":{"title":{"description":"Item title.","title":"title","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"altText":{"description":"Item's alternative text.","title":"altText","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Item","description":"","oneOf":[{"description":"","summary":"data","$ref":"#/components/schemas/wix.rich_content.v1.GalleryData.Item.data"}]},"wix.rich_content.v1.GalleryData.Item.data":{"type":"object","title":"data","properties":{"image":{"description":"An image item.","$ref":"#/components/schemas/wix.rich_content.v1.GalleryData.Item.Image","summary":"image","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"video":{"description":"A video item.","$ref":"#/components/schemas/wix.rich_content.v1.GalleryData.Item.Video","summary":"video","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.rich_content.v1.GalleryOptions":{"type":"object","properties":{"layout":{"description":"Gallery layout.","$ref":"#/components/schemas/wix.rich_content.v1.GalleryOptions.Layout","summary":"layout","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"item":{"description":"Styling for gallery items.","$ref":"#/components/schemas/wix.rich_content.v1.GalleryOptions.ItemStyle","summary":"item","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"thumbnails":{"description":"Styling for gallery thumbnail images.","$ref":"#/components/schemas/wix.rich_content.v1.GalleryOptions.Thumbnails","summary":"thumbnails","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GalleryOptions","description":""},"wix.rich_content.v1.GalleryOptions.Layout.Type":{"type":"string","description":"","title":"Type","enum":[{"order":0,"value":"COLLAGE","description":"Collage type","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"MASONRY","description":"Masonry type","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"GRID","description":"Grid type","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"THUMBNAIL","description":"Thumbnail type","maturity":"GA","exposure":"PUBLIC"},{"order":4,"value":"SLIDER","description":"Slider type","maturity":"GA","exposure":"PUBLIC"},{"order":5,"value":"SLIDESHOW","description":"Slideshow type","maturity":"GA","exposure":"PUBLIC"},{"order":6,"value":"PANORAMA","description":"Panorama type","maturity":"GA","exposure":"PUBLIC"},{"order":7,"value":"COLUMN","description":"Column type","maturity":"GA","exposure":"PUBLIC"},{"order":8,"value":"MAGIC","description":"Magic type","maturity":"GA","exposure":"PUBLIC"},{"order":9,"value":"FULLSIZE","description":"Fullsize images type","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.GalleryOptions.Layout.Orientation":{"type":"string","description":"","title":"Orientation","enum":[{"order":0,"value":"ROWS","description":"Rows Orientation","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"COLUMNS","description":"Columns Orientation","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.GalleryOptions.ItemStyle.Crop":{"type":"string","description":"","title":"Crop","enum":[{"order":0,"value":"FILL","description":"Crop to fill","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"FIT","description":"Crop to fit","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.GalleryOptions.Thumbnails.Alignment":{"type":"string","description":"","title":"Alignment","enum":[{"order":0,"value":"TOP","description":"Top alignment","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"RIGHT","description":"Right alignment","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"BOTTOM","description":"Bottom alignment","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"LEFT","description":"Left alignment","maturity":"GA","exposure":"PUBLIC"},{"order":4,"value":"NONE","description":"No thumbnail","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.GalleryOptions.Layout":{"type":"object","properties":{"type":{"description":"Gallery layout type.","title":"type","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.GalleryOptions.Layout.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"horizontalScroll":{"description":"Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`.","title":"horizontalScroll","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"orientation":{"description":"Gallery orientation.","title":"orientation","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.GalleryOptions.Layout.Orientation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberOfColumns":{"description":"The number of columns to display on full size screens.","title":"numberOfColumns","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mobileNumberOfColumns":{"description":"The number of columns to display on mobile screens.","title":"mobileNumberOfColumns","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Layout","description":""},"wix.rich_content.v1.GalleryOptions.ItemStyle":{"type":"object","properties":{"targetSize":{"description":"Desirable dimension for each item in pixels (behvaior changes according to gallery type)","title":"targetSize","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ratio":{"description":"Item ratio","title":"ratio","type":"number","format":"double","$ref":"#/components/schemas/google.protobuf.DoubleValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"crop":{"description":"Sets how item images are cropped.","title":"crop","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.GalleryOptions.ItemStyle.Crop","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"spacing":{"description":"The spacing between items in pixels.","title":"spacing","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemStyle","description":""},"wix.rich_content.v1.GalleryOptions.Thumbnails":{"type":"object","properties":{"placement":{"description":"Thumbnail alignment.","title":"placement","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.GalleryOptions.Thumbnails.Alignment","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"spacing":{"description":"Spacing between thumbnails in pixels.","title":"spacing","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Thumbnails","description":""},"wix.rich_content.v1.GIFData":{"type":"object","properties":{"containerData":{"description":"Styling for the GIF's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"original":{"description":"The source of the full size GIF.","$ref":"#/components/schemas/wix.rich_content.v1.GIF","summary":"original","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"downsized":{"description":"The source of the downsized GIF.","$ref":"#/components/schemas/wix.rich_content.v1.GIF","summary":"downsized","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"Height in pixels.","title":"height","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"Width in pixels.","title":"width","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"gifType":{"description":"Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`.","title":"gifType","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.GIFData.GIFType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GIFData","description":""},"wix.rich_content.v1.GIF":{"type":"object","properties":{"gif":{"description":"GIF format URL.","format":"WEB_URL","title":"gif","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mp4":{"description":"MP4 format URL.","format":"WEB_URL","title":"mp4","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"still":{"description":"Thumbnail URL.","format":"WEB_URL","title":"still","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GIF","description":""},"wix.rich_content.v1.GIFData.GIFType":{"type":"string","description":"","title":"GIFType","enum":[{"order":0,"value":"NORMAL","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"STICKER","description":"","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.HeadingData":{"type":"object","properties":{"level":{"description":"Heading level from 1-6.","title":"level","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"textStyle":{"description":"Styling for the heading text.","$ref":"#/components/schemas/wix.rich_content.v1.TextStyle","summary":"textStyle","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"indentation":{"description":"Indentation level from 1-4.","title":"indentation","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"HeadingData","description":""},"wix.rich_content.v1.HTMLData":{"type":"object","properties":{"containerData":{"description":"Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"source":{"description":"The type of HTML code.","title":"source","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.HTMLData.Source","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"autoHeight":{"description":"If container height is aligned with its content height. Defaults to `true`.","title":"autoHeight","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"HTMLData","description":"","oneOf":[{"description":"","summary":"data","$ref":"#/components/schemas/wix.rich_content.v1.HTMLData.data"}]},"wix.rich_content.v1.HTMLData.data":{"type":"object","title":"data","properties":{"url":{"description":"The URL for the HTML code for the node.","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"html":{"description":"The HTML code for the node.","title":"html","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"isAdsense":{"description":"Whether this is an AdSense element. Use `source` instead.","title":"isAdsense","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}}}},"wix.rich_content.v1.HTMLData.Source":{"type":"string","description":"","title":"Source","enum":[{"order":0,"value":"HTML","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"ADSENSE","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"AI","description":"","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.ImageData":{"type":"object","properties":{"containerData":{"description":"Styling for the image's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"image":{"description":"Image file details.","$ref":"#/components/schemas/wix.rich_content.v1.Media","summary":"image","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"link":{"description":"Link details for images that are links.","$ref":"#/components/schemas/wix.rich_content.v1.Link","summary":"link","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"disableExpand":{"description":"Sets whether the image expands to full screen when clicked. Defaults to `false`.","title":"disableExpand","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"altText":{"description":"Image's alternative text.","title":"altText","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"caption":{"description":"Deprecated: use Caption node instead.","title":"caption","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"disableDownload":{"description":"Sets whether the image's download button is disabled. Defaults to `false`.","title":"disableDownload","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"decorative":{"description":"Sets whether the image is decorative and does not need an explanation. Defaults to `false`.","title":"decorative","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"styles":{"description":"Styling for the image.","$ref":"#/components/schemas/wix.rich_content.v1.ImageData.Styles","summary":"styles","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ImageData","description":""},"wix.rich_content.v1.ImageData.Styles.Border":{"type":"object","properties":{"width":{"description":"Border width in pixels.","title":"width","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"color":{"description":"Border color as a hexadecimal value.","format":"COLOR_HEX","title":"color","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"radius":{"description":"Border radius in pixels.","title":"radius","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Border","description":""},"wix.rich_content.v1.ImageData.Styles":{"type":"object","properties":{"border":{"description":"Border attributes.","$ref":"#/components/schemas/wix.rich_content.v1.ImageData.Styles.Border","summary":"border","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Styles","description":""},"wix.rich_content.v1.LinkPreviewData":{"type":"object","properties":{"containerData":{"description":"Styling for the link preview's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"link":{"description":"Link details.","$ref":"#/components/schemas/wix.rich_content.v1.Link","summary":"link","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Preview title.","title":"title","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"thumbnailUrl":{"description":"Preview thumbnail URL.","title":"thumbnailUrl","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Preview description.","title":"description","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"html":{"description":"The preview content as HTML.","title":"html","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"styles":{"description":"Styling for the link preview.","$ref":"#/components/schemas/wix.rich_content.v1.LinkPreviewData.Styles","summary":"styles","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LinkPreviewData","description":""},"wix.rich_content.v1.LinkPreviewData.Styles.Position":{"type":"string","description":"","title":"Position","enum":[{"order":0,"value":"START","description":"Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts)","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"END","description":"Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts)","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"TOP","description":"Thumbnail positioned at the top","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"HIDDEN","description":"Thumbnail hidden and not displayed","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.LinkPreviewData.Styles":{"type":"object","properties":{"backgroundColor":{"description":"Background color as a hexadecimal value.","format":"COLOR_HEX","title":"backgroundColor","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"titleColor":{"description":"Title color as a hexadecimal value.","format":"COLOR_HEX","title":"titleColor","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"subtitleColor":{"description":"Subtitle color as a hexadecimal value.","format":"COLOR_HEX","title":"subtitleColor","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"linkColor":{"description":"Link color as a hexadecimal value.","format":"COLOR_HEX","title":"linkColor","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderWidth":{"description":"Border width in pixels.","title":"borderWidth","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderRadius":{"description":"Border radius in pixels.","title":"borderRadius","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderColor":{"description":"Border color as a hexadecimal value.","format":"COLOR_HEX","title":"borderColor","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"thumbnailPosition":{"description":"Position of thumbnail. Defaults to `START`.","title":"thumbnailPosition","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.LinkPreviewData.Styles.Position","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Styles","description":""},"wix.rich_content.v1.MapData":{"type":"object","properties":{"containerData":{"description":"Styling for the map's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mapSettings":{"description":"Map settings.","$ref":"#/components/schemas/wix.rich_content.v1.MapSettings","summary":"mapSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MapData","description":""},"wix.rich_content.v1.MapSettings":{"type":"object","properties":{"address":{"description":"The address to display on the map.","title":"address","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"draggable":{"description":"Sets whether the map is draggable.","title":"draggable","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"marker":{"description":"Sets whether the location marker is visible.","title":"marker","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"streetViewControl":{"description":"Sets whether street view control is enabled.","title":"streetViewControl","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"zoomControl":{"description":"Sets whether zoom control is enabled.","title":"zoomControl","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lat":{"description":"Location latitude.","title":"lat","type":"number","format":"double","$ref":"#/components/schemas/google.protobuf.DoubleValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lng":{"description":"Location longitude.","title":"lng","type":"number","format":"double","$ref":"#/components/schemas/google.protobuf.DoubleValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"locationName":{"description":"Location name.","title":"locationName","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"viewModeControl":{"description":"Sets whether view mode control is enabled.","title":"viewModeControl","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"initialZoom":{"description":"Initial zoom value.","title":"initialZoom","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mapType":{"description":"Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types.","title":"mapType","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.MapType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MapSettings","description":""},"wix.rich_content.v1.MapType":{"type":"string","description":"","title":"MapType","enum":[{"order":0,"value":"ROADMAP","description":"Roadmap map type","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"SATELITE","description":"Satellite map type","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"HYBRID","description":"Hybrid map type","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"TERRAIN","description":"Terrain map type","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.ParagraphData":{"type":"object","properties":{"textStyle":{"description":"Styling for the paragraph text.","$ref":"#/components/schemas/wix.rich_content.v1.TextStyle","summary":"textStyle","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"indentation":{"description":"Indentation level from 1-4.","title":"indentation","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"level":{"description":"Paragraph level","title":"level","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ParagraphData","description":""},"wix.rich_content.v1.PollData":{"type":"object","properties":{"containerData":{"description":"Styling for the poll's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"poll":{"description":"Poll data.","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Poll","summary":"poll","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"layout":{"description":"Layout settings for the poll and voting options.","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Layout","summary":"layout","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"design":{"description":"Styling for the poll and voting options.","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Design","summary":"design","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PollData","description":""},"wix.rich_content.v1.PollData.Poll.Settings.Permissions.ViewRole":{"type":"string","description":"","title":"ViewRole","enum":[{"order":0,"value":"CREATOR","description":"Only Poll creator can view the results","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"VOTERS","description":"Anyone who voted can see the results","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"EVERYONE","description":"Anyone can see the results, even if one didn't vote","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.PollData.Poll.Settings.Permissions.VoteRole":{"type":"string","description":"","title":"VoteRole","enum":[{"order":0,"value":"SITE_MEMBERS","description":"Logged in member","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"ALL","description":"Anyone","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.PollData.Poll.Settings.Permissions":{"type":"object","properties":{"view":{"description":"Sets who can view the poll results.","title":"view","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Poll.Settings.Permissions.ViewRole","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"vote":{"description":"Sets who can vote.","title":"vote","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Poll.Settings.Permissions.VoteRole","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"allowMultipleVotes":{"description":"Sets whether one voter can vote multiple times. Defaults to `false`.","title":"allowMultipleVotes","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Permissions","description":""},"wix.rich_content.v1.PollData.Poll.Option":{"type":"object","properties":{"id":{"description":"Option ID.","title":"id","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Option title.","title":"title","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"image":{"description":"The image displayed with the option.","$ref":"#/components/schemas/wix.rich_content.v1.Media","summary":"image","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Option","description":""},"wix.rich_content.v1.PollData.Poll.Settings":{"type":"object","properties":{"permissions":{"description":"Permissions settings for voting.","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Poll.Settings.Permissions","summary":"permissions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"showVoters":{"description":"Sets whether voters are displayed in the vote results. Defaults to `true`.","title":"showVoters","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"showVotesCount":{"description":"Sets whether the vote count is displayed. Defaults to `true`.","title":"showVotesCount","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Settings","description":""},"wix.rich_content.v1.PollData.Layout.PollLayout.Type":{"type":"string","description":"","title":"Type","enum":[{"order":0,"value":"LIST","description":"List","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"GRID","description":"Grid","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.PollData.Layout.PollLayout.Direction":{"type":"string","description":"","title":"Direction","enum":[{"order":0,"value":"LTR","description":"Left-to-right","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"RTL","description":"Right-to-left","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.PollData.Layout.PollLayout":{"type":"object","properties":{"type":{"description":"The layout for displaying the voting options.","title":"type","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Layout.PollLayout.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"direction":{"description":"The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right.","title":"direction","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Layout.PollLayout.Direction","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"enableImage":{"description":"Sets whether to display the main poll image. Defaults to `false`.","title":"enableImage","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PollLayout","description":""},"wix.rich_content.v1.PollData.Layout.OptionLayout":{"type":"object","properties":{"enableImage":{"description":"Sets whether to display option images. Defaults to `false`.","title":"enableImage","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"OptionLayout","description":""},"wix.rich_content.v1.PollData.Design.PollDesign.Background.Type":{"type":"string","description":"","title":"Type","enum":[{"order":0,"value":"COLOR","description":"Color background type","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"IMAGE","description":"Image background type","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"GRADIENT","description":"Gradiant background type","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.PollData.Design.PollDesign.Background.Gradient":{"type":"object","properties":{"angle":{"description":"The gradient angle in degrees.","title":"angle","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"startColor":{"description":"The start color as a hexademical value.","format":"COLOR_HEX","title":"startColor","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lastColor":{"description":"The end color as a hexademical value.","format":"COLOR_HEX","title":"lastColor","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Gradient","description":""},"wix.rich_content.v1.PollData.Design.PollDesign.Background":{"type":"object","properties":{"type":{"description":"Background type. For each option, include the relevant details.","title":"type","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Design.PollDesign.Background.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Background","description":"","oneOf":[{"description":"","summary":"background","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Design.PollDesign.Background.background"}]},"wix.rich_content.v1.PollData.Design.PollDesign.Background.background":{"type":"object","title":"background","properties":{"color":{"description":"The background color as a hexademical value.","format":"COLOR_HEX","title":"color","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"image":{"description":"An image to use for the background.","$ref":"#/components/schemas/wix.rich_content.v1.Media","summary":"image","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"gradient":{"description":"Details for a gradient background.","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Design.PollDesign.Background.Gradient","summary":"gradient","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.rich_content.v1.PollData.Design.PollDesign":{"type":"object","properties":{"background":{"description":"Background styling.","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Design.PollDesign.Background","summary":"background","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderRadius":{"description":"Border radius in pixels.","title":"borderRadius","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PollDesign","description":""},"wix.rich_content.v1.PollData.Design.OptionDesign":{"type":"object","properties":{"borderRadius":{"description":"Border radius in pixels.","title":"borderRadius","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"OptionDesign","description":""},"wix.rich_content.v1.PollData.Poll":{"type":"object","properties":{"id":{"description":"Poll ID.","title":"id","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Poll title.","title":"title","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"creatorId":{"description":"Poll creator ID.","title":"creatorId","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"image":{"description":"Main poll image.","$ref":"#/components/schemas/wix.rich_content.v1.Media","summary":"image","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"options":{"description":"Voting options.","title":"options","type":"array","items":{"$ref":"#/components/schemas/wix.rich_content.v1.PollData.Poll.Option"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"settings":{"description":"The poll's permissions and display settings.","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Poll.Settings","summary":"settings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Poll","description":""},"wix.rich_content.v1.PollData.Layout":{"type":"object","properties":{"poll":{"description":"Poll layout settings.","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Layout.PollLayout","summary":"poll","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"options":{"description":"Voting otpions layout settings.","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Layout.OptionLayout","summary":"options","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Layout","description":""},"wix.rich_content.v1.PollData.Design":{"type":"object","properties":{"poll":{"description":"Styling for the poll.","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Design.PollDesign","summary":"poll","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"options":{"description":"Styling for voting options.","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Design.OptionDesign","summary":"options","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Design","description":""},"wix.rich_content.v1.TextData":{"type":"object","properties":{"text":{"description":"The text to apply decorations to.","title":"text","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"decorations":{"description":"The decorations to apply.","title":"decorations","type":"array","items":{"$ref":"#/components/schemas/wix.rich_content.v1.Decoration"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TextData","description":""},"wix.rich_content.v1.Decoration":{"type":"object","properties":{"type":{"description":"The type of decoration to apply.","title":"type","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.Decoration.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Decoration","description":"Adds appearence changes to text","oneOf":[{"description":"","summary":"data","$ref":"#/components/schemas/wix.rich_content.v1.Decoration.data"}]},"wix.rich_content.v1.Decoration.data":{"type":"object","title":"data","properties":{"anchorData":{"description":"Data for an anchor link decoration.","$ref":"#/components/schemas/wix.rich_content.v1.AnchorData","summary":"anchorData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"colorData":{"description":"Data for a color decoration.","$ref":"#/components/schemas/wix.rich_content.v1.ColorData","summary":"colorData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"linkData":{"description":"Data for an external link decoration.","$ref":"#/components/schemas/wix.rich_content.v1.LinkData","summary":"linkData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mentionData":{"description":"Data for a mention decoration.","$ref":"#/components/schemas/wix.rich_content.v1.MentionData","summary":"mentionData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fontSizeData":{"description":"Data for a font size decoration.","$ref":"#/components/schemas/wix.rich_content.v1.FontSizeData","summary":"fontSizeData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fontWeightValue":{"description":"Font weight for a bold decoration.","title":"fontWeightValue","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"italicData":{"description":"Data for an italic decoration. Defaults to `true`.","title":"italicData","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"underlineData":{"description":"Data for an underline decoration. Defaults to `true`.","title":"underlineData","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"spoilerData":{"description":"Data for a spoiler decoration.","$ref":"#/components/schemas/wix.rich_content.v1.SpoilerData","summary":"spoilerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"strikethroughData":{"description":"Data for a strikethrough decoration. Defaults to `true`.","title":"strikethroughData","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"superscriptData":{"description":"Data for a superscript decoration. Defaults to `true`.","title":"superscriptData","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"subscriptData":{"description":"Data for a subscript decoration. Defaults to `true`.","title":"subscriptData","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fontFamilyData":{"description":"Data for a font family decoration.","$ref":"#/components/schemas/wix.rich_content.v1.FontFamilyData","summary":"fontFamilyData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.rich_content.v1.Decoration.Type":{"type":"string","description":"","title":"Type","enum":[{"order":0,"value":"BOLD","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"ITALIC","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"UNDERLINE","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"SPOILER","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":4,"value":"ANCHOR","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":5,"value":"MENTION","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":6,"value":"LINK","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":7,"value":"COLOR","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":8,"value":"FONT_SIZE","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":9,"value":"EXTERNAL","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":10,"value":"STRIKETHROUGH","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":11,"value":"SUPERSCRIPT","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":12,"value":"SUBSCRIPT","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":13,"value":"FONT_FAMILY","description":"","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.AnchorData":{"type":"object","properties":{"anchor":{"description":"The target node's ID.","title":"anchor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AnchorData","description":""},"wix.rich_content.v1.ColorData":{"type":"object","properties":{"background":{"description":"The text's background color as a hexadecimal value.","title":"background","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"foreground":{"description":"The text's foreground color as a hexadecimal value.","title":"foreground","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ColorData","description":""},"wix.rich_content.v1.LinkData":{"type":"object","properties":{"link":{"description":"Link details.","$ref":"#/components/schemas/wix.rich_content.v1.Link","summary":"link","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LinkData","description":""},"wix.rich_content.v1.MentionData":{"type":"object","properties":{"name":{"description":"The mentioned user's name.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"The version of the user's name that appears after the `@` character in the mention.","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"id":{"description":"Mentioned user's ID.","title":"id","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MentionData","description":""},"wix.rich_content.v1.FontSizeData":{"type":"object","properties":{"unit":{"description":"The units used for the font size.","title":"unit","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.FontSizeData.fontType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"value":{"description":"Font size value.","title":"value","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FontSizeData","description":""},"wix.rich_content.v1.FontSizeData.fontType":{"type":"string","description":"","title":"fontType","enum":[{"order":0,"value":"PX","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"EM","description":"","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.SpoilerData":{"type":"object","properties":{"id":{"description":"Spoiler ID.","title":"id","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SpoilerData","description":""},"wix.rich_content.v1.FontFamilyData":{"type":"object","properties":{"value":{"description":"","maxLength":1000,"title":"value","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FontFamilyData","description":""},"wix.rich_content.v1.AppEmbedData":{"type":"object","properties":{"type":{"description":"The type of Wix App content being embedded.","title":"type","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.AppEmbedData.AppType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"itemId":{"description":"The ID of the embedded content.","title":"itemId","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"The name of the embedded content.","title":"name","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"imageSrc":{"description":"Deprecated: Use `image` instead.","title":"imageSrc","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"url":{"description":"The URL for the embedded content.","title":"url","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"image":{"description":"An image for the embedded content.","$ref":"#/components/schemas/wix.rich_content.v1.Media","summary":"image","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hideImage":{"description":"Whether to hide the image.","title":"hideImage","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hideTitle":{"description":"Whether to hide the title.","title":"hideTitle","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hidePrice":{"description":"Whether to hide the price.","title":"hidePrice","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hideDescription":{"description":"Whether to hide the description (Event and Booking).","title":"hideDescription","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hideDateTime":{"description":"Whether to hide the date and time (Event).","title":"hideDateTime","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hideLocation":{"description":"Whether to hide the location (Event).","title":"hideLocation","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hideDuration":{"description":"Whether to hide the duration (Booking).","title":"hideDuration","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hideButton":{"description":"Whether to hide the button.","title":"hideButton","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hideRibbon":{"description":"Whether to hide the ribbon.","title":"hideRibbon","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"buttonStyles":{"description":"Button styling options.","$ref":"#/components/schemas/wix.rich_content.v1.AppEmbedData.ButtonStyles","summary":"buttonStyles","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"imageStyles":{"description":"Image styling options.","$ref":"#/components/schemas/wix.rich_content.v1.AppEmbedData.ImageStyles","summary":"imageStyles","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ribbonStyles":{"description":"Ribbon styling options.","$ref":"#/components/schemas/wix.rich_content.v1.AppEmbedData.RibbonStyles","summary":"ribbonStyles","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cardStyles":{"description":"Card styling options.","$ref":"#/components/schemas/wix.rich_content.v1.AppEmbedData.CardStyles","summary":"cardStyles","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"containerData":{"description":"Styling for the app embed's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pricingData":{"description":"Pricing data for embedded Wix App content.","$ref":"#/components/schemas/wix.rich_content.v1.AppEmbedData.PricingData","summary":"pricingData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AppEmbedData","description":"","oneOf":[{"description":"","summary":"appData","$ref":"#/components/schemas/wix.rich_content.v1.AppEmbedData.appData"}]},"wix.rich_content.v1.AppEmbedData.appData":{"type":"object","title":"appData","properties":{"bookingData":{"description":"Data for embedded Wix Bookings content.","$ref":"#/components/schemas/wix.rich_content.v1.AppEmbedData.BookingData","summary":"bookingData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventData":{"description":"Data for embedded Wix Events content.","$ref":"#/components/schemas/wix.rich_content.v1.AppEmbedData.EventData","summary":"eventData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.rich_content.v1.AppEmbedData.ImageStyles.Position":{"type":"string","description":"","title":"Position","enum":[{"order":0,"value":"START","description":"Image positioned at the start (left in LTR layouts, right in RTL layouts)","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"END","description":"Image positioned at the end (right in LTR layouts, left in RTL layouts)","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"TOP","description":"Image positioned at the top","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.AppEmbedData.ImageStyles.AspectRatio":{"type":"string","description":"","title":"AspectRatio","enum":[{"order":0,"value":"SQUARE","description":"1:1 aspect ratio","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"RECTANGLE","description":"16:9 aspect ratio","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.AppEmbedData.ImageStyles.Resizing":{"type":"string","description":"","title":"Resizing","enum":[{"order":0,"value":"FILL","description":"Fill the container, may crop the image","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"FIT","description":"Fit the image within the container","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.AppEmbedData.RibbonStyles.Placement":{"type":"string","description":"","title":"Placement","enum":[{"order":0,"value":"IMAGE","description":"Ribbon placed on the image","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"PRODUCT_INFO","description":"Ribbon placed on the product information","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.AppEmbedData.CardStyles.Type":{"type":"string","description":"","title":"Type","enum":[{"order":0,"value":"CONTAINED","description":"Card with visible border and background","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"FRAMELESS","description":"Card without visible border","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.AppEmbedData.CardStyles.Alignment":{"type":"string","description":"","title":"Alignment","enum":[{"order":0,"value":"START","description":"Content aligned to start (left in LTR layouts, right in RTL layouts)","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"CENTER","description":"Content centered","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"END","description":"Content aligned to end (right in LTR layouts, left in RTL layouts)","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.AppEmbedData.CardStyles.Layout":{"type":"string","description":"","title":"Layout","enum":[{"order":0,"value":"STACKED","description":"Elements stacked vertically","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"SIDE_BY_SIDE","description":"Elements arranged horizontally","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.AppEmbedData.AppType":{"type":"string","description":"","title":"AppType","enum":[{"order":0,"value":"PRODUCT","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"EVENT","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"BOOKING","description":"","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.AppEmbedData.BookingData":{"type":"object","properties":{"durations":{"description":"Booking duration in minutes.","title":"durations","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BookingData","description":""},"wix.rich_content.v1.AppEmbedData.EventData":{"type":"object","properties":{"scheduling":{"description":"Event schedule.","title":"scheduling","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"location":{"description":"Event location.","title":"location","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EventData","description":""},"wix.rich_content.v1.AppEmbedData.ButtonStyles":{"type":"object","properties":{"buttonText":{"description":"Text to display on the button.","title":"buttonText","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderWidth":{"description":"Border width in pixels.","title":"borderWidth","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderRadius":{"description":"Border radius in pixels.","title":"borderRadius","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderColor":{"description":"Border color as a hexadecimal value.","format":"COLOR_HEX","title":"borderColor","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"textColor":{"description":"Text color as a hexadecimal value.","format":"COLOR_HEX","title":"textColor","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"backgroundColor":{"description":"Background color as a hexadecimal value.","format":"COLOR_HEX","title":"backgroundColor","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderColorHover":{"description":"Border color as a hexadecimal value (hover state).","format":"COLOR_HEX","title":"borderColorHover","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"textColorHover":{"description":"Text color as a hexadecimal value (hover state).","format":"COLOR_HEX","title":"textColorHover","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"backgroundColorHover":{"description":"Background color as a hexadecimal value (hover state).","format":"COLOR_HEX","title":"backgroundColorHover","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"buttonSize":{"description":"Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`.","title":"buttonSize","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ButtonStyles","description":""},"wix.rich_content.v1.AppEmbedData.ImageStyles":{"type":"object","properties":{"hideImage":{"description":"Whether to hide the image.","title":"hideImage","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"imagePosition":{"description":"Position of image. Defaults to `START`.","title":"imagePosition","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.AppEmbedData.ImageStyles.Position","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"aspectRatio":{"description":"Aspect ratio for the image. Defaults to `SQUARE`.","title":"aspectRatio","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.AppEmbedData.ImageStyles.AspectRatio","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"resizing":{"description":"How the image should be resized. Defaults to `FILL`.","title":"resizing","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.AppEmbedData.ImageStyles.Resizing","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderColor":{"description":"Image border color as a hexadecimal value.","format":"COLOR_HEX","title":"borderColor","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderWidth":{"description":"Image border width in pixels.","title":"borderWidth","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderRadius":{"description":"Image border radius in pixels.","title":"borderRadius","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ImageStyles","description":""},"wix.rich_content.v1.AppEmbedData.RibbonStyles":{"type":"object","properties":{"ribbonText":{"description":"Text to display on the ribbon.","title":"ribbonText","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"backgroundColor":{"description":"Ribbon background color as a hexadecimal value.","format":"COLOR_HEX","title":"backgroundColor","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"textColor":{"description":"Ribbon text color as a hexadecimal value.","format":"COLOR_HEX","title":"textColor","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderColor":{"description":"Ribbon border color as a hexadecimal value.","format":"COLOR_HEX","title":"borderColor","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderWidth":{"description":"Ribbon border width in pixels.","title":"borderWidth","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderRadius":{"description":"Ribbon border radius in pixels.","title":"borderRadius","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ribbonPlacement":{"description":"Placement of the ribbon. Defaults to `IMAGE`.","title":"ribbonPlacement","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.AppEmbedData.RibbonStyles.Placement","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RibbonStyles","description":""},"wix.rich_content.v1.AppEmbedData.CardStyles":{"type":"object","properties":{"backgroundColor":{"description":"Card background color as a hexadecimal value.","format":"COLOR_HEX","title":"backgroundColor","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderColor":{"description":"Card border color as a hexadecimal value.","format":"COLOR_HEX","title":"borderColor","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderWidth":{"description":"Card border width in pixels.","title":"borderWidth","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderRadius":{"description":"Card border radius in pixels.","title":"borderRadius","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Card type. Defaults to `CONTAINED`.","title":"type","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.AppEmbedData.CardStyles.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"alignment":{"description":"Content alignment. Defaults to `START`.","title":"alignment","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.AppEmbedData.CardStyles.Alignment","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"titlePriceLayout":{"description":"Layout for title and price. Defaults to `STACKED`.","title":"titlePriceLayout","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.AppEmbedData.CardStyles.Layout","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"titleColor":{"description":"Title text color as a hexadecimal value.","format":"COLOR_HEX","title":"titleColor","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"textColor":{"description":"Text color as a hexadecimal value.","format":"COLOR_HEX","title":"textColor","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CardStyles","description":""},"wix.rich_content.v1.AppEmbedData.PricingData":{"type":"object","properties":{"valueFrom":{"description":"Minimum numeric price value as string (e.g., \"10.99\").","title":"valueFrom","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"maxScale":2}}},"valueTo":{"description":"Maximum numeric price value as string (e.g., \"19.99\").","title":"valueTo","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"maxScale":2}}},"discountedValue":{"description":"Numeric price value as string after discount application (e.g., \"15.99\").","title":"discountedValue","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"maxScale":2}}},"currency":{"description":"Currency of the value in ISO 4217 format (e.g., \"USD\", \"EUR\").","format":"CURRENCY","title":"currency","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pricingPlanId":{"description":"Pricing plan ID.","format":"GUID","title":"pricingPlanId","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PricingData","description":""},"wix.rich_content.v1.VideoData":{"type":"object","properties":{"containerData":{"description":"Styling for the video's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"video":{"description":"Video details.","$ref":"#/components/schemas/wix.rich_content.v1.Media","summary":"video","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"thumbnail":{"description":"Video thumbnail details.","$ref":"#/components/schemas/wix.rich_content.v1.Media","summary":"thumbnail","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"disableDownload":{"description":"Sets whether the video's download button is disabled. Defaults to `false`.","title":"disableDownload","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Video title.","title":"title","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"options":{"description":"Video options.","$ref":"#/components/schemas/wix.rich_content.v1.PlaybackOptions","summary":"options","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"VideoData","description":""},"wix.rich_content.v1.PlaybackOptions":{"type":"object","properties":{"autoPlay":{"description":"Sets whether the media will automatically start playing.","title":"autoPlay","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"playInLoop":{"description":"Sets whether media's will be looped.","title":"playInLoop","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"showControls":{"description":"Sets whether media's controls will be shown.","title":"showControls","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PlaybackOptions","description":""},"wix.rich_content.v1.EmbedData":{"type":"object","properties":{"containerData":{"description":"Styling for the oEmbed node's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"oembed":{"description":"An [oEmbed](https://www.oembed.com) object.","$ref":"#/components/schemas/wix.rich_content.v1.Oembed","summary":"oembed","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"src":{"description":"Origin asset source.","title":"src","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EmbedData","description":""},"wix.rich_content.v1.Oembed":{"type":"object","properties":{"type":{"description":"The resource type.","title":"type","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"The width of the resource specified in the `url` property in pixels.","title":"width","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"The height of the resource specified in the `url` property in pixels.","title":"height","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Resource title.","title":"title","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"The source URL for the resource.","title":"url","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"html":{"description":"HTML for embedding a video player. The HTML should have no padding or margins.","title":"html","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"authorName":{"description":"The name of the author or owner of the resource.","title":"authorName","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"authorUrl":{"description":"The URL for the author or owner of the resource.","title":"authorUrl","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"providerName":{"description":"The name of the resource provider.","title":"providerName","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"providerUrl":{"description":"The URL for the resource provider.","title":"providerUrl","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"thumbnailUrl":{"description":"The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined.","title":"thumbnailUrl","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"thumbnailWidth":{"description":"The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined.","title":"thumbnailWidth","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"thumbnailHeight":{"description":"The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined.","title":"thumbnailHeight","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"videoUrl":{"description":"The URL for an embedded viedo.","title":"videoUrl","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"version":{"description":"The oEmbed version number. This value must be `1.0`.","title":"version","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Oembed","description":""},"wix.rich_content.v1.CollapsibleListData":{"type":"object","properties":{"containerData":{"description":"Styling for the collapsible list's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"expandOnlyOne":{"description":"If `true`, only one item can be expanded at a time. Defaults to `false`.","title":"expandOnlyOne","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"initialExpandedItems":{"description":"Sets which items are expanded when the page loads.","title":"initialExpandedItems","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.CollapsibleListData.InitialExpandedItems","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"direction":{"description":"The direction of the text in the list. Either left-to-right or right-to-left.","title":"direction","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.CollapsibleListData.Direction","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"isQapageData":{"description":"If `true`, The collapsible item will appear in search results as an FAQ.","title":"isQapageData","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CollapsibleListData","description":""},"wix.rich_content.v1.CollapsibleListData.InitialExpandedItems":{"type":"string","description":"","title":"InitialExpandedItems","enum":[{"order":0,"value":"FIRST","description":"First item will be expended initally","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"ALL","description":"All items will expended initally","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"NONE","description":"All items collapsed initally","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.CollapsibleListData.Direction":{"type":"string","description":"","title":"Direction","enum":[{"order":0,"value":"LTR","description":"Left-to-right","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"RTL","description":"Right-to-left","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.TableData":{"type":"object","properties":{"containerData":{"description":"Styling for the table's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dimensions":{"description":"The table's dimensions.","$ref":"#/components/schemas/wix.rich_content.v1.TableData.Dimensions","summary":"dimensions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"header":{"description":"Deprecated: Use `rowHeader` and `columnHeader` instead.","title":"header","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"rowHeader":{"description":"Sets whether the table's first row is a header. Defaults to `false`.","title":"rowHeader","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"columnHeader":{"description":"Sets whether the table's first column is a header. Defaults to `false`.","title":"columnHeader","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cellSpacing":{"description":"The spacing between cells in pixels. Defaults to `0`.","title":"cellSpacing","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cellPadding":{"description":"Padding in pixels for cells. Follows CSS order: top, right, bottom, left.","maxItems":4,"title":"cellPadding","type":"array","items":{"type":"integer"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TableData","description":""},"wix.rich_content.v1.TableData.Dimensions":{"type":"object","properties":{"colsWidthRatio":{"description":"An array representing relative width of each column in relation to the other columns.","title":"colsWidthRatio","type":"array","items":{"type":"integer"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rowsHeight":{"description":"An array representing the height of each row in pixels.","title":"rowsHeight","type":"array","items":{"type":"integer"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"colsMinWidth":{"description":"An array representing the minimum width of each column in pixels.","title":"colsMinWidth","type":"array","items":{"type":"integer"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Dimensions","description":""},"wix.rich_content.v1.TableCellData":{"type":"object","properties":{"cellStyle":{"description":"Styling for the cell's background color and text alignment.","$ref":"#/components/schemas/wix.rich_content.v1.TableCellData.CellStyle","summary":"cellStyle","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderColors":{"description":"The cell's border colors.","$ref":"#/components/schemas/wix.rich_content.v1.TableCellData.BorderColors","summary":"borderColors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"colspan":{"description":"Defines how many columns the cell spans. Default: 1.","title":"colspan","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rowspan":{"description":"Defines how many rows the cell spans. Default: 1.","title":"rowspan","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderWidths":{"description":"The cell's border widths.","$ref":"#/components/schemas/wix.rich_content.v1.TableCellData.BorderWidths","summary":"borderWidths","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TableCellData","description":""},"wix.rich_content.v1.TableCellData.VerticalAlignment":{"type":"string","description":"","title":"VerticalAlignment","enum":[{"order":0,"value":"TOP","description":"Top alignment","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"MIDDLE","description":"Middle alignment","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"BOTTOM","description":"Bottom alignment","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.TableCellData.CellStyle":{"type":"object","properties":{"verticalAlignment":{"description":"Vertical alignment for the cell's text.","title":"verticalAlignment","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.TableCellData.VerticalAlignment","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"backgroundColor":{"description":"Cell background color as a hexadecimal value.","format":"COLOR_HEX","title":"backgroundColor","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CellStyle","description":""},"wix.rich_content.v1.TableCellData.BorderColors":{"type":"object","properties":{"left":{"description":"Left border color as a hexadecimal value.","format":"COLOR_HEX","title":"left","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"right":{"description":"Right border color as a hexadecimal value.","format":"COLOR_HEX","title":"right","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"top":{"description":"Top border color as a hexadecimal value.","format":"COLOR_HEX","title":"top","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bottom":{"description":"Bottom border color as a hexadecimal value.","format":"COLOR_HEX","title":"bottom","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BorderColors","description":""},"wix.rich_content.v1.TableCellData.BorderWidths":{"type":"object","properties":{"left":{"description":"Left border width in pixels.","title":"left","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"right":{"description":"Right border width in pixels.","title":"right","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"top":{"description":"Top border width in pixels.","title":"top","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bottom":{"description":"Bottom border width in pixels.","title":"bottom","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BorderWidths","description":""},"wix.rich_content.v1.Struct":{"type":"object","properties":{"fields":{"description":"An unordered map of dynamically typed values.","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/wix.rich_content.v1.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":"`Struct` represents a structured data value, consisting of fields\nwhich map to dynamically typed values. In some languages, `Struct`\nmight be supported by a native representation. For example, in\nscripting languages like JS a struct is represented as an\nobject. The details of that representation are described together\nwith the proto support for the language.\n\nThe JSON representation for `Struct` is JSON object."},"wix.rich_content.v1.Value":{"type":"object","properties":{},"title":"Value","description":"`Value` represents a dynamically typed value which can be either\nnull, a number, a string, a boolean, a recursive struct value, or a\nlist of values. A producer of value is expected to set one of these\nvariants. Absence of any variant indicates an error.\n\nThe JSON representation for `Value` is JSON value.","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/wix.rich_content.v1.Value.kind"}]},"wix.rich_content.v1.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"A null value.","title":"nullValue","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"A double value.","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"A string value.","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"A boolean value.","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"A structured value.","$ref":"#/components/schemas/wix.rich_content.v1.Struct","summary":"structValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"An array of `value` objects.","$ref":"#/components/schemas/wix.rich_content.v1.ListValue","summary":"listValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.rich_content.v1.NullValue":{"type":"string","description":"`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\nThe JSON representation for `NullValue` is JSON `null`.","title":"NullValue","enum":[{"order":0,"value":"NULL_VALUE","description":"Null value.","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.ListValue":{"type":"object","properties":{"values":{"description":"Repeated field of dynamically typed values.","title":"values","type":"array","items":{"$ref":"#/components/schemas/wix.rich_content.v1.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":"`ListValue` is a wrapper around a repeated field of values.\n\nThe JSON representation for `ListValue` is JSON array."},"wix.rich_content.v1.AudioData":{"type":"object","properties":{"containerData":{"description":"Styling for the audio node's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"audio":{"description":"Audio file details.","$ref":"#/components/schemas/wix.rich_content.v1.Media","summary":"audio","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"disableDownload":{"description":"Sets whether the audio node's download button is disabled. Defaults to `false`.","title":"disableDownload","type":"boolean","$ref":"#/components/schemas/google.protobuf.BoolValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"coverImage":{"description":"Cover image.","$ref":"#/components/schemas/wix.rich_content.v1.Media","summary":"coverImage","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Track name.","title":"name","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"authorName":{"description":"Author name.","title":"authorName","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"html":{"description":"An HTML version of the audio node.","title":"html","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AudioData","description":""},"wix.rich_content.v1.OrderedListData":{"type":"object","properties":{"indentation":{"description":"Indentation level from 0-4.","title":"indentation","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Offset level from 0-4.","title":"offset","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"start":{"description":"List start number.","title":"start","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"OrderedListData","description":""},"wix.rich_content.v1.BulletedListData":{"type":"object","properties":{"indentation":{"description":"Indentation level from 0-4.","title":"indentation","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Offset level from 0-4.","title":"offset","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulletedListData","description":""},"wix.rich_content.v1.BlockquoteData":{"type":"object","properties":{"indentation":{"description":"Indentation level from 1-4.","title":"indentation","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BlockquoteData","description":""},"wix.rich_content.v1.CaptionData":{"type":"object","properties":{"textStyle":{"description":"","$ref":"#/components/schemas/wix.rich_content.v1.TextStyle","summary":"textStyle","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CaptionData","description":""},"wix.rich_content.v1.LayoutData":{"type":"object","properties":{"backgroundColor":{"description":"Background color as a hexadecimal value.","format":"COLOR_HEX","title":"backgroundColor","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"backgroundImage":{"description":"Background image.","$ref":"#/components/schemas/wix.rich_content.v1.LayoutData.BackgroundImage","summary":"backgroundImage","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderColor":{"description":"Border color as a hexadecimal value.","format":"COLOR_HEX","title":"borderColor","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderWidth":{"description":"Border width in pixels.","title":"borderWidth","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderRadius":{"description":"Border","title":"borderRadius","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"backdropColor":{"description":"Backdrop color as a hexadecimal value.","format":"COLOR_HEX","title":"backdropColor","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"backdropImage":{"description":"Backdrop image.radius in pixels.","$ref":"#/components/schemas/wix.rich_content.v1.LayoutData.BackgroundImage","summary":"backdropImage","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"backdropPaddingTop":{"description":"Backdrop top padding.","title":"backdropPaddingTop","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"backdropPaddingBottom":{"description":"Backdrop bottom padding","title":"backdropPaddingBottom","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"gap":{"description":"Horizontal and vertical gap between columns","title":"gap","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cellPadding":{"description":"Padding in pixels for cells. Follows CSS order: top, right, bottom, left","maxItems":4,"title":"cellPadding","type":"array","items":{"type":"integer"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cellVerticalAlignment":{"description":"Vertical alignment for the cell's items.","title":"cellVerticalAlignment","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.LayoutData.VerticalAlignment.Alignment","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"responsivenessBehaviour":{"description":"Responsiveness behaviour of columns when responsiveness applies. Either stacks or wrappers.","title":"responsivenessBehaviour","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.LayoutData.ResponsivenessBehaviour","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"responsivenessBreakpoint":{"description":"Size in pixels when responsiveness_behaviour applies","title":"responsivenessBreakpoint","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"containerData":{"description":"Styling for the layout's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"designTarget":{"description":"Defines where selected design propertied applies to","title":"designTarget","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.LayoutData.DesignTarget","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LayoutData","description":""},"wix.rich_content.v1.LayoutData.ImageScaling.Scaling":{"type":"string","description":"","title":"Scaling","enum":[{"order":0,"value":"AUTO","description":"Auto image scaling","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"CONTAIN","description":"Contain image scaling","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"COVER","description":"Cover image scaling","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.LayoutData.ImagePosition":{"type":"string","description":"","title":"ImagePosition","enum":[{"order":0,"value":"CENTER","description":"Image positioned at the center","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"CENTER_LEFT","description":"Image positioned on the left","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"CENTER_RIGHT","description":"Image positioned on the right","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"TOP","description":"Image positioned at the center top","maturity":"GA","exposure":"PUBLIC"},{"order":4,"value":"TOP_LEFT","description":"Image positioned at the top left","maturity":"GA","exposure":"PUBLIC"},{"order":5,"value":"TOP_RIGHT","description":"Image positioned at the top right","maturity":"GA","exposure":"PUBLIC"},{"order":6,"value":"BOTTOM","description":"Image positioned at the center bottom","maturity":"GA","exposure":"PUBLIC"},{"order":7,"value":"BOTTOM_LEFT","description":"Image positioned at the bottom left","maturity":"GA","exposure":"PUBLIC"},{"order":8,"value":"BOTTOM_RIGHT","description":"Image positioned at the bottom right","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.LayoutData.BackgroundImage":{"type":"object","properties":{"media":{"description":"Background image.","$ref":"#/components/schemas/wix.rich_content.v1.Media","summary":"media","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"opacity":{"description":"Background image opacity.","title":"opacity","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scaling":{"description":"Background image scaling.","title":"scaling","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.LayoutData.ImageScaling.Scaling","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"position":{"description":"Position of background. Defaults to `CENTER`.","title":"position","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.LayoutData.ImagePosition","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BackgroundImage","description":""},"wix.rich_content.v1.LayoutData.VerticalAlignment.Alignment":{"type":"string","description":"","title":"Alignment","enum":[{"order":0,"value":"TOP","description":"Top alignment","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"MIDDLE","description":"Middle alignment","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"BOTTOM","description":"Bottom alignment","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.LayoutData.ResponsivenessBehaviour":{"type":"string","description":"","title":"ResponsivenessBehaviour","enum":[{"order":0,"value":"STACK","description":"Stacking of columns","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"WRAP","description":"Wrapping of columns","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.LayoutData.DesignTarget":{"type":"string","description":"","title":"DesignTarget","enum":[{"order":0,"value":"LAYOUT","description":"Design applied to layout","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"CELL","description":"Design applied to cells","maturity":"GA","exposure":"PUBLIC"}]},"wix.rich_content.v1.LayoutCellData":{"type":"object","properties":{"colSpan":{"description":"Size of the cell in 12 columns grid.","title":"colSpan","type":"integer","format":"int32","$ref":"#/components/schemas/google.protobuf.Int32Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LayoutCellData","description":""},"wix.rich_content.v1.Metadata":{"type":"object","properties":{"version":{"description":"Schema version.","minimum":0,"title":"version","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdTimestamp":{"description":"When the object was created.","readOnly":true,"title":"createdTimestamp","type":"string","format":"date-time","$ref":"#/components/schemas/google.protobuf.Timestamp","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"updatedTimestamp":{"description":"When the object was most recently updated.","title":"updatedTimestamp","type":"string","format":"date-time","$ref":"#/components/schemas/google.protobuf.Timestamp","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"id":{"description":"Object ID.","title":"id","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Metadata","description":""},"wix.rich_content.v1.DocumentStyle":{"type":"object","properties":{"headerOne":{"description":"Styling for H1 nodes.","$ref":"#/components/schemas/wix.rich_content.v1.TextNodeStyle","summary":"headerOne","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"headerTwo":{"description":"Styling for H2 nodes.","$ref":"#/components/schemas/wix.rich_content.v1.TextNodeStyle","summary":"headerTwo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"headerThree":{"description":"Styling for H3 nodes.","$ref":"#/components/schemas/wix.rich_content.v1.TextNodeStyle","summary":"headerThree","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"headerFour":{"description":"Styling for H4 nodes.","$ref":"#/components/schemas/wix.rich_content.v1.TextNodeStyle","summary":"headerFour","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"headerFive":{"description":"Styling for H5 nodes.","$ref":"#/components/schemas/wix.rich_content.v1.TextNodeStyle","summary":"headerFive","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"headerSix":{"description":"Styling for H6 nodes.","$ref":"#/components/schemas/wix.rich_content.v1.TextNodeStyle","summary":"headerSix","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paragraph":{"description":"Styling for paragraph nodes.","$ref":"#/components/schemas/wix.rich_content.v1.TextNodeStyle","summary":"paragraph","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"blockquote":{"description":"Styling for block quote nodes.","$ref":"#/components/schemas/wix.rich_content.v1.TextNodeStyle","summary":"blockquote","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"codeBlock":{"description":"Styling for code block nodes.","$ref":"#/components/schemas/wix.rich_content.v1.TextNodeStyle","summary":"codeBlock","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DocumentStyle","description":""},"wix.rich_content.v1.TextNodeStyle":{"type":"object","properties":{"decorations":{"description":"The decorations to apply to the node.","title":"decorations","type":"array","items":{"$ref":"#/components/schemas/wix.rich_content.v1.Decoration"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nodeStyle":{"description":"Padding and background color for the node.","$ref":"#/components/schemas/wix.rich_content.v1.NodeStyle","summary":"nodeStyle","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lineHeight":{"description":"Line height for text in the node.","title":"lineHeight","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TextNodeStyle","description":""},"com.wix.stores.catalog.product.api.v3.Media":{"type":"object","properties":{"main":{"description":"Main media (image, video, etc.) associated with this product.\nAutomatically set to the first item in the media list.","readOnly":true,"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ProductMedia","summary":"main","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"itemsInfo":{"description":"All media items.\n> **Note:** Returned only when you pass `\"MEDIA_ITEMS_INFO\"` to the `fields` array in Products API requests.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.MediaItemsInfo","summary":"itemsInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Media","description":""},"com.wix.stores.catalog.product.api.v3.ProductMedia":{"type":"object","properties":{"altText":{"description":"Image alt text.","minLength":1,"maxLength":1000,"title":"altText","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"displayName":{"description":"Media display name.\n\nOverrides the default media name. Can be passed only when the media is set by a URL in this item's `url` field.","maxLength":80,"title":"displayName","type":"string","$ref":"#/components/schemas/google.protobuf.StringValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mediaType":{"description":"Media type.","readOnly":true,"title":"mediaType","type":"string","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ProductMedia.MediaType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"thumbnail":{"description":"Media thumbnail.\n> **Note:** Returned only when you pass `\"THUMBNAIL\"` to the `fields` array in Products API requests.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Thumbnail","summary":"thumbnail","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"uploadId":{"description":"ID used to upload media to Wix Media Manager.","readOnly":true,"format":"GUID","title":"uploadId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ProductMedia","description":"","oneOf":[{"description":"","summary":"setBy","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ProductMedia.setBy"},{"description":"","summary":"media","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ProductMedia.media"}]},"com.wix.stores.catalog.product.api.v3.Pro