inner content

{"id":"133d354d-8c65-4c27-9d48-d711bed4b0b3","createdDate":"2024-09-02T10:04:33.766Z","updatedDate":"2024-09-02T10:04:33.766Z","resourceId":"9f553509-a896-4528-a129-a5174837b224","api":{"schema":{"object":{"displayName":"Product Object","description":"Short description of ProductService","slug":"product-object","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product","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\": \"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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"salePriceRange\": {\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 \"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 \"basePrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"salePrice\": {\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"},"methods":[{"summary":"Create Product","description":"Creates a new product.\n\nThis endpoint also allows to add a ribbon, brand, info sections, options, and modifiers.","operationId":"wix.stores.catalog.v3.CatalogApi.CreateProduct","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.CreateProductResponse","description":""}},"deprecated":false,"servers":[{"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"}}],"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 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/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.media.itemsInfo.items.setBy","product.variantsInfo","product.variantsInfo.variants","product.variantsInfo.variants.price","product.variantsInfo.variants.price.basePrice","product.variantsInfo.variants.physicalProperties.pricePerUnit.settings.measurementUnit","product.variantsInfo.variants.digitalProperties.digitalFile","product.variantsInfo.variants.digitalProperties.digitalFile.id","product.physicalProperties.pricePerUnit.measurementUnit","product.options.choicesSettings.choices","product.modifiers.choicesSettings.choices","product.subscriptionDetails.subscriptions","product.subscriptionDetails.subscriptions.title","product.subscriptionDetails.subscriptions.frequency","product.subscriptionDetails.subscriptions.cycles","product.subscriptionDetails.subscriptions.discount.discount","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":"BETA","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","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"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_VARIANT_OPTION_CHOICE"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_PRODUCT_OPTIONS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_DEFAULT_VARIANT"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"VARIANTS_ARE_NOT_ALIGNED_WITH_PRODUCT","errorSchemaName":"com.wix.stores.catalog.product.api.v3.VariantsNotAlignedWithProduct"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"DUPLICATE_SLUG_ERROR"},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"DIGITAL_FILE_NOT_FOUND_ERROR"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"BARCODE_ALREADY_EXIST_ERROR"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_BARCODE_ERROR"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SKU_ALREADY_EXIST_ERROR"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_SKU_ERROR"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"VARIANT_ID_ALREADY_EXISTS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PRODUCTS_LIMIT_EXCEEDED"},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"PRODUCT_MEDIA_NOT_EXIST"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"MODIFIER_FREE_TEXT_SETTINGS_MIN_CHAR_IS_ZERO"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ONLY_SPACES_STRING_ERROR"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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 \"VARIANTS_INFO\",\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 \"basePrice\": {\n \"amount\": \"10\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"10\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"15\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"15\"\n },\n \"salePrice\": {\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\": \"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 \"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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"salePriceRange\": {\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 \"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 \"basePrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\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\": \"ac491fa2-f5fc-479f-9123-65bc32d1ad28\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-07-22T14:23:18.780Z\",\n \"updatedDate\": \"2024-07-22T14:23:18.780Z\",\n \"name\": \"Chocolate bar\",\n \"slug\": \"chocolate-bar\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {},\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"salePriceRange\": {\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 \"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 \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"37d07149-eb0c-4040-89e9-73df9ccbe03c\",\n \"visible\": true,\n \"choices\": [],\n \"price\": {\n \"basePrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"salePrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"physicalProperties\": {\n \"weight\": 0.3\n },\n \"subscriptionPricesInfo\": {\n \"subscriptionPrices\": [\n {\n \"subscriptionId\": \"79851453-0d41-4330-913f-3085904bfa8d\",\n \"price\": {\n \"amount\": \"12.00\",\n \"formattedAmount\": \"$12.00\"\n }\n },\n {\n \"subscriptionId\": \"85c4a167-4c6a-4d6d-9abd-ea654266cfdd\",\n \"price\": {\n \"amount\": \"13.50\",\n \"formattedAmount\": \"$13.50\"\n }\n },\n {\n \"subscriptionId\": \"349a646c-3325-4c65-912e-460e4c4751d6\",\n \"price\": {\n \"amount\": \"15.00\",\n \"formattedAmount\": \"$15.00\"\n }\n }\n ]\n }\n }\n ]\n },\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}"}},{"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 \"basePrice\": {\n \"amount\": \"0.5\"\n }\n },\n \"physicalProperties\": {}\n }\n ]\n }\n }\n}'","response":"{\n \"product\": {\n \"id\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-07-22T14:04:05.787Z\",\n \"updatedDate\": \"2024-07-22T14:04:05.787Z\",\n \"name\": \"Shopping bag\",\n \"slug\": \"shopping-bag\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {},\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {}\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/products","rpcOnly":false,"triggeredEvents":[{"title":"Product Created","description":"Triggered when a product is created.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"BETA","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","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"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_VARIANT_OPTION_CHOICE"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_PRODUCT_OPTIONS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_DEFAULT_VARIANT"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"VARIANTS_ARE_NOT_ALIGNED_WITH_PRODUCT","errorSchemaName":"com.wix.stores.catalog.product.api.v3.VariantsNotAlignedWithProduct"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"DUPLICATE_SLUG_ERROR"},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"DIGITAL_FILE_NOT_FOUND_ERROR"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"BARCODE_ALREADY_EXIST_ERROR"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_BARCODE_ERROR"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SKU_ALREADY_EXIST_ERROR"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_SKU_ERROR"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"VARIANT_ID_ALREADY_EXISTS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PRODUCTS_LIMIT_EXCEEDED"},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"PRODUCT_MEDIA_NOT_EXIST"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"MODIFIER_FREE_TEXT_SETTINGS_MIN_CHAR_IS_ZERO"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ONLY_SPACES_STRING_ERROR"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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 \"VARIANTS_INFO\",\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 \"basePrice\": {\n \"amount\": \"10\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"10\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"15\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"15\"\n },\n \"salePrice\": {\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\": \"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 \"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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"salePriceRange\": {\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 \"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 \"basePrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\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\": \"ac491fa2-f5fc-479f-9123-65bc32d1ad28\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-07-22T14:23:18.780Z\",\n \"updatedDate\": \"2024-07-22T14:23:18.780Z\",\n \"name\": \"Chocolate bar\",\n \"slug\": \"chocolate-bar\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {},\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"salePriceRange\": {\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 \"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 \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"37d07149-eb0c-4040-89e9-73df9ccbe03c\",\n \"visible\": true,\n \"choices\": [],\n \"price\": {\n \"basePrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"salePrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"physicalProperties\": {\n \"weight\": 0.3\n },\n \"subscriptionPricesInfo\": {\n \"subscriptionPrices\": [\n {\n \"subscriptionId\": \"79851453-0d41-4330-913f-3085904bfa8d\",\n \"price\": {\n \"amount\": \"12.00\",\n \"formattedAmount\": \"$12.00\"\n }\n },\n {\n \"subscriptionId\": \"85c4a167-4c6a-4d6d-9abd-ea654266cfdd\",\n \"price\": {\n \"amount\": \"13.50\",\n \"formattedAmount\": \"$13.50\"\n }\n },\n {\n \"subscriptionId\": \"349a646c-3325-4c65-912e-460e4c4751d6\",\n \"price\": {\n \"amount\": \"15.00\",\n \"formattedAmount\": \"$15.00\"\n }\n }\n ]\n }\n }\n ]\n },\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}"}},{"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 \"basePrice\": {\n \"amount\": \"0.5\"\n }\n },\n \"physicalProperties\": {}\n }\n ]\n }\n }\n}'","response":"{\n \"product\": {\n \"id\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-07-22T14:04:05.787Z\",\n \"updatedDate\": \"2024-07-22T14:04:05.787Z\",\n \"name\": \"Shopping bag\",\n \"slug\": \"shopping-bag\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {},\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {}\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Create Product","slugifiedName":"create-product"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Create Product With Inventory","description":"Creates a new product, and can create the product's inventory in the variants' default locations.\n\nThis endpoint also allows to add a ribbon, brand, info sections, options, and modifiers.","operationId":"wix.stores.catalog.v3.CatalogApi.CreateProductWithInventory","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.CreateProductWithInventoryResponse","description":""}},"deprecated":false,"servers":[{"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"}},{"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"}}],"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 the full created 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.SingleEntityOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["product","product.name","product.productType","product.media.itemsInfo.items.setBy","product.variantsInfo","product.variantsInfo.variants.price","product.variantsInfo.variants.price.basePrice","product.variantsInfo.variants.physicalProperties.pricePerUnit.settings.measurementUnit","product.variantsInfo.variants.digitalProperties.digitalFile","product.variantsInfo.variants.digitalProperties.digitalFile.id","product.physicalProperties.pricePerUnit.measurementUnit","product.options.choicesSettings.choices","product.modifiers.choicesSettings.choices","product.subscriptionDetails.subscriptions","product.subscriptionDetails.subscriptions.title","product.subscriptionDetails.subscriptions.frequency","product.subscriptionDetails.subscriptions.cycles","product.subscriptionDetails.subscriptions.discount.discount","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":"BETA","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","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.CreateProductWithInventoryRequest","responseMessage":"wix.stores.catalog.v3.CreateProductWithInventoryResponse"},"legacyExamples":[{"name":"CreateProductWithInventory","type":"METHOD","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 \"basePrice\": {\n \"amount\": \"0.5\"\n }\n },\n \"inventoryItem\": {\n \"inStock\": true\n }\n \"physicalProperties\": {}\n }\n ]\n }\n }\n}'","response":"{\n \"product\": {\n \"id\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-07-22T14:04:05.787Z\",\n \"updatedDate\": \"2024-07-22T14:04:05.787Z\",\n \"name\": \"Shopping bag\",\n \"slug\": \"shopping-bag\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"items\": []\n },\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {}\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/products-with-inventory","rpcOnly":false,"triggeredEvents":[{"title":"Product Created","description":"Triggered when a product is created.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"BETA","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","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.CreateProductWithInventoryRequest","responseMessage":"wix.stores.catalog.v3.CreateProductWithInventoryResponse"},"legacyExamples":[{"name":"CreateProductWithInventory","type":"METHOD","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 \"basePrice\": {\n \"amount\": \"0.5\"\n }\n },\n \"inventoryItem\": {\n \"inStock\": true\n }\n \"physicalProperties\": {}\n }\n ]\n }\n }\n}'","response":"{\n \"product\": {\n \"id\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-07-22T14:04:05.787Z\",\n \"updatedDate\": \"2024-07-22T14:04:05.787Z\",\n \"name\": \"Shopping bag\",\n \"slug\": \"shopping-bag\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"items\": []\n },\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {}\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Create Product With Inventory","slugifiedName":"create-product-with-inventory"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"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> + If `variantsInfo.variants` are passed, they will replace all existing variants.\n> + To update existing `variantsInfo.variants`, make sure to provide `variantsInfo.variants.id`. If no ID is passed, the variant will be created with a new ID.","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,"servers":[{"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"}}],"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.media.itemsInfo.items.setBy","product.variantsInfo.variants.price","product.variantsInfo.variants.price.basePrice","product.variantsInfo.variants.physicalProperties.pricePerUnit.settings.measurementUnit","product.variantsInfo.variants.digitalProperties.digitalFile","product.variantsInfo.variants.digitalProperties.digitalFile.id","product.physicalProperties.pricePerUnit.measurementUnit","product.options.choicesSettings.choices","product.modifiers.choicesSettings.choices","product.subscriptionDetails.subscriptions.title","product.subscriptionDetails.subscriptions.frequency","product.subscriptionDetails.subscriptions.cycles","product.subscriptionDetails.subscriptions.discount.discount","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":"BETA","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","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"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_VARIANT_OPTION_CHOICE"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_PRODUCT_OPTIONS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_DEFAULT_VARIANT"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FIELD_MASK_VALUE_NOT_SUPPORTED","errorSchemaName":"com.wix.stores.catalog.product.api.v3.UnsupportedFieldMasks"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"VARIANTS_ARE_NOT_ALIGNED_WITH_PRODUCT","errorSchemaName":"com.wix.stores.catalog.product.api.v3.VariantsNotAlignedWithProduct"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"DUPLICATE_SLUG_ERROR"},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"DIGITAL_FILE_NOT_FOUND_ERROR"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"BARCODE_ALREADY_EXIST_ERROR"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_BARCODE_ERROR"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SKU_ALREADY_EXIST_ERROR"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_SKU_ERROR"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"VARIANT_ID_ALREADY_EXISTS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PREORDER_VALIDATION_ERROR"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.UpdateProductRequest","responseMessage":"wix.stores.catalog.v3.UpdateProductResponse"},"legacyExamples":[{"name":"UpdateProduct","type":"METHOD","order":1,"content":{"title":"Update product name","request":"curl PATCH 'https://www.wixapis.com/stores/v3/products/abc62281-87b7-47e8-98ba-20e25341ad98' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"product\": {\n \"id\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"revision\": \"1\",\n \"name\": \"Recyclable Shopping bag\"\n }\n }'","response":"{\n \"product\": {\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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {}\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/d17bb5c4-e10f-4b83-ae97-f27f2edc18f1' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"fields\": [\n \"VARIANTS_INFO\",\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\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"revision\": \"1\",\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 \"modifiers\": [\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 \"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\": \"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 \"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 },\n {\n \"choiceId\": \"4876dcc7-817e-4c10-a6b2-4a4cc2e241e6\",\n \"linkedMedia\": [],\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"blue\",\n \"name\": \"blue\",\n \"colorCode\": \"#0000FF\"\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 },\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 }\n ],\n \"ribbon\": {\n \"id\": \"14585597-3302-4145-8da3-24a26d8346d6\",\n \"name\": \"New arrival\"\n },\n \"mainCategoryId\": \"643721c3-446e-47f3-87ee-0a58d6842d48\",\n \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"salePriceRange\": {\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 \"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 \"basePrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"salePrice\": {\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}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"patch","path":"/v3/products/{product.id}","rpcOnly":false,"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"BETA","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","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"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_VARIANT_OPTION_CHOICE"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_PRODUCT_OPTIONS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_DEFAULT_VARIANT"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FIELD_MASK_VALUE_NOT_SUPPORTED","errorSchemaName":"com.wix.stores.catalog.product.api.v3.UnsupportedFieldMasks"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"VARIANTS_ARE_NOT_ALIGNED_WITH_PRODUCT","errorSchemaName":"com.wix.stores.catalog.product.api.v3.VariantsNotAlignedWithProduct"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"DUPLICATE_SLUG_ERROR"},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"DIGITAL_FILE_NOT_FOUND_ERROR"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"BARCODE_ALREADY_EXIST_ERROR"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_BARCODE_ERROR"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SKU_ALREADY_EXIST_ERROR"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_SKU_ERROR"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"VARIANT_ID_ALREADY_EXISTS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PREORDER_VALIDATION_ERROR"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.UpdateProductRequest","responseMessage":"wix.stores.catalog.v3.UpdateProductResponse"},"legacyExamples":[{"name":"UpdateProduct","type":"METHOD","order":1,"content":{"title":"Update product name","request":"curl PATCH 'https://www.wixapis.com/stores/v3/products/abc62281-87b7-47e8-98ba-20e25341ad98' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"product\": {\n \"id\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"revision\": \"1\",\n \"name\": \"Recyclable Shopping bag\"\n }\n }'","response":"{\n \"product\": {\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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {}\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/d17bb5c4-e10f-4b83-ae97-f27f2edc18f1' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"fields\": [\n \"VARIANTS_INFO\",\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\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"revision\": \"1\",\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 \"modifiers\": [\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 \"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\": \"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 \"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 },\n {\n \"choiceId\": \"4876dcc7-817e-4c10-a6b2-4a4cc2e241e6\",\n \"linkedMedia\": [],\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"blue\",\n \"name\": \"blue\",\n \"colorCode\": \"#0000FF\"\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 },\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 }\n ],\n \"ribbon\": {\n \"id\": \"14585597-3302-4145-8da3-24a26d8346d6\",\n \"name\": \"New arrival\"\n },\n \"mainCategoryId\": \"643721c3-446e-47f3-87ee-0a58d6842d48\",\n \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"salePriceRange\": {\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 \"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 \"basePrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"salePrice\": {\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}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Update Product","slugifiedName":"update-product"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Update Product With Inventory","description":"Updates a new product, and can update the product's inventory.\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> + Passing `variantsInfo.variants` will replace all existing variants.\n> + To update existing `variantsInfo.variants`, pass `variantsInfo.variants.id`. If no ID is passed, the variant will be created with a new ID.","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,"servers":[{"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"}},{"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"}}],"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 product entity 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.media.itemsInfo.items.setBy","product.variantsInfo.variants.price","product.variantsInfo.variants.price.basePrice","product.variantsInfo.variants.physicalProperties.pricePerUnit.settings.measurementUnit","product.variantsInfo.variants.digitalProperties.digitalFile","product.variantsInfo.variants.digitalProperties.digitalFile.id","product.physicalProperties.pricePerUnit.measurementUnit","product.options.choicesSettings.choices","product.modifiers.choicesSettings.choices","product.subscriptionDetails.subscriptions.title","product.subscriptionDetails.subscriptions.frequency","product.subscriptionDetails.subscriptions.cycles","product.subscriptionDetails.subscriptions.discount.discount","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":"BETA","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","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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 name","request":"curl PATCH 'https://www.wixapis.com/stores/v3/products/abc62281-87b7-47e8-98ba-20e25341ad98' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"product\": {\n \"id\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"revision\": \"1\",\n \"variants_info\": {\n \"variants\": [\n {\n \"choices\": [],\n \"inventory_item\": {\n \"in_stock\": false\n },\n \"price\": {\n \"base_price\": {\n \"amount\": \"0.5\"\n }\n }\n }\n ]\n }\n }\n }'","response":"{\n \"product\": {\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\": \"Shopping bag\",\n \"slug\": \"shopping-bag\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"items\": []\n },\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"mainCategoryId\": \"643721c3-446e-47f3-87ee-0a58d6842d48\",\n \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {},\n \"inventoryResults\": {\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"e9e62f9d-9f67-4de2-adf4-68e436696f05\",\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 }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"patch","path":"/v3/products-with-inventory/{product.id}","rpcOnly":false,"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"BETA","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","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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 name","request":"curl PATCH 'https://www.wixapis.com/stores/v3/products/abc62281-87b7-47e8-98ba-20e25341ad98' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"product\": {\n \"id\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"revision\": \"1\",\n \"variants_info\": {\n \"variants\": [\n {\n \"choices\": [],\n \"inventory_item\": {\n \"in_stock\": false\n },\n \"price\": {\n \"base_price\": {\n \"amount\": \"0.5\"\n }\n }\n }\n ]\n }\n }\n }'","response":"{\n \"product\": {\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\": \"Shopping bag\",\n \"slug\": \"shopping-bag\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"items\": []\n },\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"mainCategoryId\": \"643721c3-446e-47f3-87ee-0a58d6842d48\",\n \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {},\n \"inventoryResults\": {\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"e9e62f9d-9f67-4de2-adf4-68e436696f05\",\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 }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Update Product With Inventory","slugifiedName":"update-product-with-inventory"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"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> For example, you can create 10 products with up to 10 options for each product (10 x 10 = 100), or one product with 100 options.\n> Alternatively, you can create 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.BulkCreateProducts","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkCreateProductsResponse","description":""}},"deprecated":false,"servers":[{"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"}}],"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.media.itemsInfo.items.setBy","products.variantsInfo","products.variantsInfo.variants","products.variantsInfo.variants.price","products.variantsInfo.variants.price.basePrice","products.variantsInfo.variants.physicalProperties.pricePerUnit.settings.measurementUnit","products.variantsInfo.variants.digitalProperties.digitalFile","products.variantsInfo.variants.digitalProperties.digitalFile.id","products.physicalProperties.pricePerUnit.measurementUnit","products.options.choicesSettings.choices","products.modifiers.choicesSettings.choices","products.subscriptionDetails.subscriptions","products.subscriptionDetails.subscriptions.title","products.subscriptionDetails.subscriptions.frequency","products.subscriptionDetails.subscriptions.cycles","products.subscriptionDetails.subscriptions.discount.discount","products.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":"BETA","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","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"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_VARIANT_OPTION_CHOICE"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_PRODUCT_OPTIONS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_DEFAULT_VARIANT"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"VARIANTS_ARE_NOT_ALIGNED_WITH_PRODUCT","errorSchemaName":"com.wix.stores.catalog.product.api.v3.VariantsNotAlignedWithProduct"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"DUPLICATE_SLUG_ERROR"},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"DIGITAL_FILE_NOT_FOUND_ERROR"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"BARCODE_ALREADY_EXIST_ERROR"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_BARCODE_ERROR"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SKU_ALREADY_EXIST_ERROR"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_SKU_ERROR"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"VARIANT_ID_ALREADY_EXISTS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PRODUCTS_LIMIT_EXCEEDED"},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"PRODUCT_MEDIA_NOT_EXIST"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"MODIFIER_FREE_TEXT_SETTINGS_MIN_CHAR_IS_ZERO"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ONLY_SPACES_STRING_ERROR"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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 \"basePrice\": {\n \"amount\": \"10\"\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 \"basePrice\": {\n \"amount\": \"7\"\n },\n \"salePrice\": {\n \"amount\": \"6\"\n }\n }\n }\n ]\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {}\n }\n ],\n \"returnEntity\": true\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"217b1efd-a06a-4a71-8217-4d495fd10869\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"item\": {\n \"id\": \"217b1efd-a06a-4a71-8217-4d495fd10869\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-07-22T17:36:42.185Z\",\n \"updatedDate\": \"2024-07-22T17:36:42.185Z\",\n \"name\": \"Coffee\",\n \"slug\": \"coffee\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {},\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {},\n \"currency\": \"USD\"\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"16cf5031-21d0-49da-aa33-d5629629b890\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"item\": {\n \"id\": \"16cf5031-21d0-49da-aa33-d5629629b890\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-07-22T17:36:42.185Z\",\n \"updatedDate\": \"2024-07-22T17:36:42.185Z\",\n \"name\": \"Chocolate bar\",\n \"slug\": \"chocolate-bar-1\",\n \"visible\": false,\n \"visibleInPos\": true,\n \"media\": {},\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"7\",\n \"formattedAmount\": \"$7.00\"\n },\n \"maxValue\": {\n \"amount\": \"7\",\n \"formattedAmount\": \"$7.00\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"6\",\n \"formattedAmount\": \"$6.00\"\n },\n \"maxValue\": {\n \"amount\": \"6\",\n \"formattedAmount\": \"$6.00\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {},\n \"currency\": \"USD\"\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products/create","rpcOnly":false,"triggeredEvents":[{"title":"Product Created","description":"Triggered when a product is created.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"BETA","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","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"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_VARIANT_OPTION_CHOICE"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_PRODUCT_OPTIONS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_DEFAULT_VARIANT"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"VARIANTS_ARE_NOT_ALIGNED_WITH_PRODUCT","errorSchemaName":"com.wix.stores.catalog.product.api.v3.VariantsNotAlignedWithProduct"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"DUPLICATE_SLUG_ERROR"},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"DIGITAL_FILE_NOT_FOUND_ERROR"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"BARCODE_ALREADY_EXIST_ERROR"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_BARCODE_ERROR"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SKU_ALREADY_EXIST_ERROR"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_SKU_ERROR"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"VARIANT_ID_ALREADY_EXISTS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PRODUCTS_LIMIT_EXCEEDED"},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"PRODUCT_MEDIA_NOT_EXIST"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"MODIFIER_FREE_TEXT_SETTINGS_MIN_CHAR_IS_ZERO"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ONLY_SPACES_STRING_ERROR"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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 \"basePrice\": {\n \"amount\": \"10\"\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 \"basePrice\": {\n \"amount\": \"7\"\n },\n \"salePrice\": {\n \"amount\": \"6\"\n }\n }\n }\n ]\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {}\n }\n ],\n \"returnEntity\": true\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"217b1efd-a06a-4a71-8217-4d495fd10869\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"item\": {\n \"id\": \"217b1efd-a06a-4a71-8217-4d495fd10869\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-07-22T17:36:42.185Z\",\n \"updatedDate\": \"2024-07-22T17:36:42.185Z\",\n \"name\": \"Coffee\",\n \"slug\": \"coffee\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {},\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {},\n \"currency\": \"USD\"\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"16cf5031-21d0-49da-aa33-d5629629b890\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"item\": {\n \"id\": \"16cf5031-21d0-49da-aa33-d5629629b890\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-07-22T17:36:42.185Z\",\n \"updatedDate\": \"2024-07-22T17:36:42.185Z\",\n \"name\": \"Chocolate bar\",\n \"slug\": \"chocolate-bar-1\",\n \"visible\": false,\n \"visibleInPos\": true,\n \"media\": {},\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"7\",\n \"formattedAmount\": \"$7.00\"\n },\n \"maxValue\": {\n \"amount\": \"7\",\n \"formattedAmount\": \"$7.00\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"6\",\n \"formattedAmount\": \"$6.00\"\n },\n \"maxValue\": {\n \"amount\": \"6\",\n \"formattedAmount\": \"$6.00\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {},\n \"currency\": \"USD\"\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Create Products","slugifiedName":"bulk-create-products"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"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> For example, you can create 10 products with up to 10 options for each product (10 x 10 = 100), or one product with 100 options.\n> Alternatively, you can create 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.BulkCreateProductsWithInventory","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkCreateProductsWithInventoryResponse","description":""}},"deprecated":false,"servers":[{"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"}},{"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"}}],"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.media.itemsInfo.items.setBy","products.variantsInfo","products.variantsInfo.variants.price","products.variantsInfo.variants.price.basePrice","products.variantsInfo.variants.physicalProperties.pricePerUnit.settings.measurementUnit","products.variantsInfo.variants.digitalProperties.digitalFile","products.variantsInfo.variants.digitalProperties.digitalFile.id","products.physicalProperties.pricePerUnit.measurementUnit","products.options.choicesSettings.choices","products.modifiers.choicesSettings.choices","products.subscriptionDetails.subscriptions","products.subscriptionDetails.subscriptions.title","products.subscriptionDetails.subscriptions.frequency","products.subscriptionDetails.subscriptions.cycles","products.subscriptionDetails.subscriptions.discount.discount","products.subscriptionDetails.subscriptions.discount.type"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Product Created","description":"","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"BETA","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","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_CREATE","WIX_STORES.INVENTORY_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Inventory write in v3 catalog","scopeId":"SCOPE.STORES.INVENTORY_ITEM_WRITE"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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 \"variantsInfo\": {\n \"variants\": [\n {\n \"price\": {\n \"basePrice\": {\n \"amount\": \"10\"\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 \"basePrice\": {\n \"amount\": \"7\"\n },\n \"salePrice\": {\n \"amount\": \"6\"\n }\n }\n }\n ]\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {}\n }\n ],\n \"returnEntity\": true\n }'","response":"{\n \"productResults\": {\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"217b1efd-a06a-4a71-8217-4d495fd10869\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"item\": {\n \"id\": \"217b1efd-a06a-4a71-8217-4d495fd10869\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-07-22T17:36:42.185Z\",\n \"updatedDate\": \"2024-07-22T17:36:42.185Z\",\n \"name\": \"Coffee\",\n \"slug\": \"coffee\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"items\": []\n },\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"IN_STOCK\",\n \"preorderStatus\": \"ENABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {},\n \"currency\": \"USD\"\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"16cf5031-21d0-49da-aa33-d5629629b890\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"item\": {\n \"id\": \"16cf5031-21d0-49da-aa33-d5629629b890\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-07-22T17:36:42.185Z\",\n \"updatedDate\": \"2024-07-22T17:36:42.185Z\",\n \"name\": \"Chocolate bar\",\n \"slug\": \"chocolate-bar-1\",\n \"visible\": false,\n \"visibleInPos\": true,\n \"media\": {\n \"items\": []\n },\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"7\",\n \"formattedAmount\": \"$7.00\"\n },\n \"maxValue\": {\n \"amount\": \"7\",\n \"formattedAmount\": \"$7.00\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"6\",\n \"formattedAmount\": \"$6.00\"\n },\n \"maxValue\": {\n \"amount\": \"6\",\n \"formattedAmount\": \"$6.00\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {},\n \"currency\": \"USD\"\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\": \"466d5f80-4f62-4f59-a1bf-119029aacdf2\",\n \"originalIndex\": 0,\n \"success\": true,\n \"error\": null\n },\n \"item\": {\n \"id\": \"466d5f80-4f62-4f59-a1bf-119029aacdf2\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-08-05T13:52:13.988Z\",\n \"updatedDate\": \"2024-08-05T13:52:13.988Z\",\n \"variantId\": \"3b02b4f6-9296-458c-8c63-93df29f07aee\",\n \"locationId\": \"fb43b0ff-1ec0-43c7-bc61-9ebfdd697166\",\n \"productId\": \"8f25b97e-fdb0-4dd5-a1c5-a522ac6268df\",\n \"quantity\": 3,\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 \"itemMetadata\": {\n \"id\": \"a1295e11-f88b-49ae-84fe-fcd6176e254e\",\n \"originalIndex\": 1,\n \"success\": true,\n \"error\": null\n },\n \"item\": {\n \"id\": \"a1295e11-f88b-49ae-84fe-fcd6176e254e\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-08-05T13:52:13.988Z\",\n \"updatedDate\": \"2024-08-05T13:52:13.988Z\",\n \"variantId\": \"d6c8a554-240c-4287-931e-395a7d865944\",\n \"locationId\": \"fb43b0ff-1ec0-43c7-bc61-9ebfdd697166\",\n \"productId\": \"36a1ca15-7898-42b0-acda-d5be7449290d\",\n \"inStock\": false,\n \"trackQuantity\": false,\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderInfo\": {\n \"enabled\": false,\n \"counter\": null,\n \"limit\": null,\n \"message\": null,\n \"quantity\": null\n },\n \"product\": null,\n \"extended_fields\": null\n }\n }\n ],\n \"bulk_action_metadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n },\n \"error\": null\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products-with-inventory/create","rpcOnly":false,"triggeredEvents":[{"title":"Product Created","description":"","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"BETA","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","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_CREATE","WIX_STORES.INVENTORY_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Inventory write in v3 catalog","scopeId":"SCOPE.STORES.INVENTORY_ITEM_WRITE"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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 \"variantsInfo\": {\n \"variants\": [\n {\n \"price\": {\n \"basePrice\": {\n \"amount\": \"10\"\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 \"basePrice\": {\n \"amount\": \"7\"\n },\n \"salePrice\": {\n \"amount\": \"6\"\n }\n }\n }\n ]\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {}\n }\n ],\n \"returnEntity\": true\n }'","response":"{\n \"productResults\": {\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"217b1efd-a06a-4a71-8217-4d495fd10869\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"item\": {\n \"id\": \"217b1efd-a06a-4a71-8217-4d495fd10869\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-07-22T17:36:42.185Z\",\n \"updatedDate\": \"2024-07-22T17:36:42.185Z\",\n \"name\": \"Coffee\",\n \"slug\": \"coffee\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {\n \"items\": []\n },\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"IN_STOCK\",\n \"preorderStatus\": \"ENABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {},\n \"currency\": \"USD\"\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"16cf5031-21d0-49da-aa33-d5629629b890\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"item\": {\n \"id\": \"16cf5031-21d0-49da-aa33-d5629629b890\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-07-22T17:36:42.185Z\",\n \"updatedDate\": \"2024-07-22T17:36:42.185Z\",\n \"name\": \"Chocolate bar\",\n \"slug\": \"chocolate-bar-1\",\n \"visible\": false,\n \"visibleInPos\": true,\n \"media\": {\n \"items\": []\n },\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"7\",\n \"formattedAmount\": \"$7.00\"\n },\n \"maxValue\": {\n \"amount\": \"7\",\n \"formattedAmount\": \"$7.00\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"6\",\n \"formattedAmount\": \"$6.00\"\n },\n \"maxValue\": {\n \"amount\": \"6\",\n \"formattedAmount\": \"$6.00\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {},\n \"currency\": \"USD\"\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\": \"466d5f80-4f62-4f59-a1bf-119029aacdf2\",\n \"originalIndex\": 0,\n \"success\": true,\n \"error\": null\n },\n \"item\": {\n \"id\": \"466d5f80-4f62-4f59-a1bf-119029aacdf2\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-08-05T13:52:13.988Z\",\n \"updatedDate\": \"2024-08-05T13:52:13.988Z\",\n \"variantId\": \"3b02b4f6-9296-458c-8c63-93df29f07aee\",\n \"locationId\": \"fb43b0ff-1ec0-43c7-bc61-9ebfdd697166\",\n \"productId\": \"8f25b97e-fdb0-4dd5-a1c5-a522ac6268df\",\n \"quantity\": 3,\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 \"itemMetadata\": {\n \"id\": \"a1295e11-f88b-49ae-84fe-fcd6176e254e\",\n \"originalIndex\": 1,\n \"success\": true,\n \"error\": null\n },\n \"item\": {\n \"id\": \"a1295e11-f88b-49ae-84fe-fcd6176e254e\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-08-05T13:52:13.988Z\",\n \"updatedDate\": \"2024-08-05T13:52:13.988Z\",\n \"variantId\": \"d6c8a554-240c-4287-931e-395a7d865944\",\n \"locationId\": \"fb43b0ff-1ec0-43c7-bc61-9ebfdd697166\",\n \"productId\": \"36a1ca15-7898-42b0-acda-d5be7449290d\",\n \"inStock\": false,\n \"trackQuantity\": false,\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderInfo\": {\n \"enabled\": false,\n \"counter\": null,\n \"limit\": null,\n \"message\": null,\n \"quantity\": null\n },\n \"product\": null,\n \"extended_fields\": null\n }\n }\n ],\n \"bulk_action_metadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n },\n \"error\": null\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Create Products With Inventory","slugifiedName":"bulk-create-products-with-inventory"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Inventory write in v3 catalog","scopeId":"SCOPE.STORES.INVENTORY_ITEM_WRITE"}]},{"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,"servers":[{"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"}}],"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.media.itemsInfo.items.setBy","products.product.variantsInfo.variants.price","products.product.variantsInfo.variants.price.basePrice","products.product.variantsInfo.variants.physicalProperties.pricePerUnit.settings.measurementUnit","products.product.variantsInfo.variants.digitalProperties.digitalFile","products.product.variantsInfo.variants.digitalProperties.digitalFile.id","products.product.physicalProperties.pricePerUnit.measurementUnit","products.product.options.choicesSettings.choices","products.product.modifiers.choicesSettings.choices","products.product.subscriptionDetails.subscriptions.title","products.product.subscriptionDetails.subscriptions.frequency","products.product.subscriptionDetails.subscriptions.cycles","products.product.subscriptionDetails.subscriptions.discount.discount","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":"BETA","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","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"TOO_MANY_VARIANTS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"MISSING_VARIANT_OPTION_CHOICE"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_VARIANT_OPTION_CHOICE"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_PRODUCT_OPTIONS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_DEFAULT_VARIANT"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FIELD_MASK_VALUE_NOT_SUPPORTED","errorSchemaName":"com.wix.stores.catalog.product.api.v3.UnsupportedFieldMasks"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"VARIANTS_ARE_NOT_ALIGNED_WITH_PRODUCT","errorSchemaName":"com.wix.stores.catalog.product.api.v3.VariantsNotAlignedWithProduct"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"DUPLICATE_SLUG_ERROR"},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"DIGITAL_FILE_NOT_FOUND_ERROR"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"BARCODE_ALREADY_EXIST_ERROR"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_BARCODE_ERROR"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SKU_ALREADY_EXIST_ERROR"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_SKU_ERROR"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"VARIANT_ID_ALREADY_EXISTS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PREORDER_VALIDATION_ERROR"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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 \"fields\": [],\n \"products\": [\n {\n \"product\": {\n \"id\": \"217b1efd-a06a-4a71-8217-4d495fd10869\",\n \"revision\": \"1\",\n \"name\": \"Premium Coffee\"\n }\n },\n {\n \"product\": {\n \"id\": \"16cf5031-21d0-49da-aa33-d5629629b890\",\n \"revision\": \"1\",\n \"visible\": true\n }\n }\n ],\n \"returnEntity\": true\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"217b1efd-a06a-4a71-8217-4d495fd10869\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"item\": {\n \"id\": \"217b1efd-a06a-4a71-8217-4d495fd10869\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-07-22T17:36:42.185Z\",\n \"updatedDate\": \"2024-07-22T17:41:35.690Z\",\n \"name\": \"Premium Coffee\",\n \"slug\": \"coffee\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {},\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"mainCategoryId\": \"643721c3-446e-47f3-87ee-0a58d6842d48\",\n \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\"\n },\n \"maxValue\": {\n \"amount\": \"10\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\"\n },\n \"maxValue\": {\n \"amount\": \"10\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {},\n \"flattenOptions\": [],\n \"flattenModifiers\": []\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"16cf5031-21d0-49da-aa33-d5629629b890\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"item\": {\n \"id\": \"16cf5031-21d0-49da-aa33-d5629629b890\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-07-22T17:36:42.185Z\",\n \"updatedDate\": \"2024-07-22T17:41:35.690Z\",\n \"name\": \"Chocolate bar\",\n \"slug\": \"chocolate-bar-1\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {},\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"mainCategoryId\": \"643721c3-446e-47f3-87ee-0a58d6842d48\",\n \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"7\"\n },\n \"maxValue\": {\n \"amount\": \"7\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"6\"\n },\n \"maxValue\": {\n \"amount\": \"6\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\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}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products/update","rpcOnly":false,"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"BETA","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","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"TOO_MANY_VARIANTS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"MISSING_VARIANT_OPTION_CHOICE"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_VARIANT_OPTION_CHOICE"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_PRODUCT_OPTIONS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_DEFAULT_VARIANT"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FIELD_MASK_VALUE_NOT_SUPPORTED","errorSchemaName":"com.wix.stores.catalog.product.api.v3.UnsupportedFieldMasks"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"VARIANTS_ARE_NOT_ALIGNED_WITH_PRODUCT","errorSchemaName":"com.wix.stores.catalog.product.api.v3.VariantsNotAlignedWithProduct"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"DUPLICATE_SLUG_ERROR"},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"DIGITAL_FILE_NOT_FOUND_ERROR"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"BARCODE_ALREADY_EXIST_ERROR"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_BARCODE_ERROR"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SKU_ALREADY_EXIST_ERROR"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DUPLICATE_SKU_ERROR"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"VARIANT_ID_ALREADY_EXISTS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PREORDER_VALIDATION_ERROR"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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 \"fields\": [],\n \"products\": [\n {\n \"product\": {\n \"id\": \"217b1efd-a06a-4a71-8217-4d495fd10869\",\n \"revision\": \"1\",\n \"name\": \"Premium Coffee\"\n }\n },\n {\n \"product\": {\n \"id\": \"16cf5031-21d0-49da-aa33-d5629629b890\",\n \"revision\": \"1\",\n \"visible\": true\n }\n }\n ],\n \"returnEntity\": true\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"217b1efd-a06a-4a71-8217-4d495fd10869\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"item\": {\n \"id\": \"217b1efd-a06a-4a71-8217-4d495fd10869\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-07-22T17:36:42.185Z\",\n \"updatedDate\": \"2024-07-22T17:41:35.690Z\",\n \"name\": \"Premium Coffee\",\n \"slug\": \"coffee\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {},\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"mainCategoryId\": \"643721c3-446e-47f3-87ee-0a58d6842d48\",\n \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\"\n },\n \"maxValue\": {\n \"amount\": \"10\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\"\n },\n \"maxValue\": {\n \"amount\": \"10\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {},\n \"flattenOptions\": [],\n \"flattenModifiers\": []\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"16cf5031-21d0-49da-aa33-d5629629b890\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"item\": {\n \"id\": \"16cf5031-21d0-49da-aa33-d5629629b890\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-07-22T17:36:42.185Z\",\n \"updatedDate\": \"2024-07-22T17:41:35.690Z\",\n \"name\": \"Chocolate bar\",\n \"slug\": \"chocolate-bar-1\",\n \"visible\": true,\n \"visibleInPos\": true,\n \"media\": {},\n \"options\": [],\n \"modifiers\": [],\n \"infoSections\": [],\n \"mainCategoryId\": \"643721c3-446e-47f3-87ee-0a58d6842d48\",\n \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"7\"\n },\n \"maxValue\": {\n \"amount\": \"7\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"6\"\n },\n \"maxValue\": {\n \"amount\": \"6\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\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}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Update Products","slugifiedName":"bulk-update-products"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"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,"servers":[{"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"}},{"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"}}],"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.media.itemsInfo.items.setBy","products.product.variantsInfo.variants.price","products.product.variantsInfo.variants.price.basePrice","products.product.variantsInfo.variants.physicalProperties.pricePerUnit.settings.measurementUnit","products.product.variantsInfo.variants.digitalProperties.digitalFile","products.product.variantsInfo.variants.digitalProperties.digitalFile.id","products.product.physicalProperties.pricePerUnit.measurementUnit","products.product.options.choicesSettings.choices","products.product.modifiers.choicesSettings.choices","products.product.subscriptionDetails.subscriptions.title","products.product.subscriptionDetails.subscriptions.frequency","products.product.subscriptionDetails.subscriptions.cycles","products.product.subscriptionDetails.subscriptions.discount.discount","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":"BETA","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","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_UPDATE","WIX_STORES.INVENTORY_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Inventory write in v3 catalog","scopeId":"SCOPE.STORES.INVENTORY_ITEM_WRITE"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkUpdateProductsWithInventoryRequest","responseMessage":"wix.stores.catalog.v3.BulkUpdateProductsWithInventoryResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products-with-inventory/update","rpcOnly":false,"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"BETA","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","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_UPDATE","WIX_STORES.INVENTORY_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Inventory write in v3 catalog","scopeId":"SCOPE.STORES.INVENTORY_ITEM_WRITE"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.BulkUpdateProductsWithInventoryRequest","responseMessage":"wix.stores.catalog.v3.BulkUpdateProductsWithInventoryResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Update Products With Inventory","slugifiedName":"bulk-update-products-with-inventory"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Inventory write in v3 catalog","scopeId":"SCOPE.STORES.INVENTORY_ITEM_WRITE"}]},{"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 cannot 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/rest/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,"servers":[{"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"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkUpdateProductsByFilterRequest","description":"","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","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.media.itemsInfo.items.setBy","product.subscriptionDetails.subscriptions.title","product.subscriptionDetails.subscriptions.frequency","product.subscriptionDetails.subscriptions.cycles","product.subscriptionDetails.subscriptions.discount.discount","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":"BETA","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","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"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"VARIANT_ID_ALREADY_EXISTS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products/update-by-filter","rpcOnly":false,"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"BETA","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","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"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"VARIANT_ID_ALREADY_EXISTS"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"SUBSCRIPTION_ID_ALREADY_EXISTS"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Update Products By Filter","slugifiedName":"bulk-update-products-by-filter"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Update Extended Fields","description":"Updates a product's extended fields.\n\n[Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must first be configured in the Wix Developers Center.","operationId":"wix.stores.catalog.v3.CatalogApi.UpdateExtendedFields","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.UpdateExtendedFieldsResponse","description":""}},"deprecated":false,"servers":[{"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"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateExtendedFieldsRequest","description":"","properties":{"namespace":{"description":"App namespace.","minLength":4,"maxLength":150,"title":"namespace","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"namespaceData":{"description":"Data to update.","title":"namespaceData","type":"object","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":["productId","namespace","namespaceData"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.UpdateExtendedFieldsRequest","responseMessage":"wix.stores.catalog.v3.UpdateExtendedFieldsResponse"},"legacyExamples":[{"name":"UpdateExtendedFields","type":"METHOD","content":{"title":"Update product extended fields","request":"curl POST 'https://www.wixapis.com/stores/v3/products/abc62281-87b7-47e8-98ba-20e25341ad98/update-extended-fields' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"productId\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"namespace\": \"@my-app/data-extension-name\",\n \"namespaceData\": {\n \"sustainable\": true\n }\n }'","response":"{\n \"product\": {\n \"id\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"revision\": \"11\",\n \"createdDate\": \"2024-07-22T14:04:05.787Z\",\n \"updatedDate\": \"2024-07-22T16:45:18.485Z\",\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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {},\n \"extendedFields\": {\n \"namespaces\": {\n \"@my-app/data-extension-name\": {\n \"sustainable\": true\n }\n }\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/products/{productId}/update-extended-fields","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.v3.UpdateExtendedFieldsRequest","responseMessage":"wix.stores.catalog.v3.UpdateExtendedFieldsResponse"},"legacyExamples":[{"name":"UpdateExtendedFields","type":"METHOD","content":{"title":"Update product extended fields","request":"curl POST 'https://www.wixapis.com/stores/v3/products/abc62281-87b7-47e8-98ba-20e25341ad98/update-extended-fields' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"productId\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"namespace\": \"@my-app/data-extension-name\",\n \"namespaceData\": {\n \"sustainable\": true\n }\n }'","response":"{\n \"product\": {\n \"id\": \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"revision\": \"11\",\n \"createdDate\": \"2024-07-22T14:04:05.787Z\",\n \"updatedDate\": \"2024-07-22T16:45:18.485Z\",\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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {},\n \"extendedFields\": {\n \"namespaces\": {\n \"@my-app/data-extension-name\": {\n \"sustainable\": true\n }\n }\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Update Extended Fields","slugifiedName":"update-extended-fields"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Get Product","description":"Retrieves a product.\n\n> **Note:**\n> To retrieve a non-visible product (`visible: false`), your app must have the required `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,"servers":[{"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"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_READ","WIX_STORES.PRODUCT_READ_NON_VISIBLE"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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/d17bb5c4-e10f-4b83-ae97-f27f2edc18f1' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"product\": {\n \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"revision\": \"4\",\n \"createdDate\": \"2024-07-22T13:22:47.771Z\",\n \"updatedDate\": \"2024-07-22T13:51:49.970Z\",\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 \"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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\"\n },\n \"maxValue\": {\n \"amount\": \"15\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"9\"\n },\n \"maxValue\": {\n \"amount\": \"15\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\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 }\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/d17bb5c4-e10f-4b83-ae97-f27f2edc18f1?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\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-07-22T13:22:47.771Z\",\n \"updatedDate\": \"2024-07-22T13:41:41.859Z\",\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 \"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\": \"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 \"inStock\": true\n },\n {\n \"choiceId\": \"ee729b74-d500-4594-aae5-b5a2e75bf5e7\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"no\",\n \"name\": \"no\",\n \"inStock\": false\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 \"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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"salePriceRange\": {\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 \"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 \"basePrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"salePrice\": {\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 }"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"get","path":"/v3/products/{productId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_READ","WIX_STORES.PRODUCT_READ_NON_VISIBLE"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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/d17bb5c4-e10f-4b83-ae97-f27f2edc18f1' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"product\": {\n \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"revision\": \"4\",\n \"createdDate\": \"2024-07-22T13:22:47.771Z\",\n \"updatedDate\": \"2024-07-22T13:51:49.970Z\",\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 \"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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\"\n },\n \"maxValue\": {\n \"amount\": \"15\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"9\"\n },\n \"maxValue\": {\n \"amount\": \"15\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\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 }\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/d17bb5c4-e10f-4b83-ae97-f27f2edc18f1?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\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-07-22T13:22:47.771Z\",\n \"updatedDate\": \"2024-07-22T13:41:41.859Z\",\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 \"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\": \"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 \"inStock\": true\n },\n {\n \"choiceId\": \"ee729b74-d500-4594-aae5-b5a2e75bf5e7\",\n \"linkedMedia\": [],\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"no\",\n \"name\": \"no\",\n \"inStock\": false\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 \"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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"salePriceRange\": {\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 \"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 \"basePrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"salePrice\": {\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 }"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Get Product","slugifiedName":"get-product"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"}]},{"summary":"Delete Product","description":"Deletes a product and all its variants.","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,"servers":[{"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"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Product Deleted","description":"Triggered when a product is deleted.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"BETA","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","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_DELETE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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":"{}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"delete","path":"/v3/products/{productId}","rpcOnly":false,"triggeredEvents":[{"title":"Product Deleted","description":"Triggered when a product is deleted.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"BETA","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","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_DELETE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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":"{}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Delete Product","slugifiedName":"delete-product"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"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,"servers":[{"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"}}],"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":"BETA","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","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_DELETE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products/delete","rpcOnly":false,"triggeredEvents":[{"title":"Product Deleted","description":"Triggered when a product is deleted.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"BETA","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","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_DELETE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Delete Products","slugifiedName":"bulk-delete-products"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"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,"servers":[{"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"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkDeleteProductsByFilterRequest","description":"","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","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":"BETA","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","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_DELETE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products/delete-by-filter","rpcOnly":false,"triggeredEvents":[{"title":"Product Deleted","description":"Triggered when a product is deleted.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"BETA","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","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_DELETE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Delete Products By Filter","slugifiedName":"bulk-delete-products-by-filter"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"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 required `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,"servers":[{"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"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_READ","WIX_STORES.PRODUCT_READ_NON_VISIBLE"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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\": \"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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"fec2519d-22d8-46e8-874a-979fd22ec241\",\n \"visible\": true,\n \"choices\": [],\n \"price\": {\n \"basePrice\": {\n \"amount\": \"0.5\"\n },\n \"salePrice\": {\n \"amount\": \"0.5\"\n }\n },\n \"physicalProperties\": {}\n }\n ]\n }\n }\n }"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"get","path":"/v3/products/slug/{slug}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_READ","WIX_STORES.PRODUCT_READ_NON_VISIBLE"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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\": \"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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"weightMeasurementUnitInfo\": {\n \"weightMeasurementUnit\": \"KG\"\n }\n },\n \"variantsInfo\": {\n \"variants\": [\n {\n \"id\": \"fec2519d-22d8-46e8-874a-979fd22ec241\",\n \"visible\": true,\n \"choices\": [],\n \"price\": {\n \"basePrice\": {\n \"amount\": \"0.5\"\n },\n \"salePrice\": {\n \"amount\": \"0.5\"\n }\n },\n \"physicalProperties\": {}\n }\n ]\n }\n }\n }"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Get Product By Slug","slugifiedName":"get-product-by-slug"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"}]},{"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\n\nTo learn about working with _Search_ endpoints, see\n[API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),\nand [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).\n\n> **Note:** To retrieve a non-visible product (`visible: false`), your app must have the required `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.","operationId":"wix.stores.catalog.v3.CatalogApi.SearchProducts","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.SearchProductsResponse","description":""}},"deprecated":false,"servers":[{"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"}}],"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":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_READ","WIX_STORES.PRODUCT_READ_NON_VISIBLE"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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\": \"Tasty\"\n }\n }\n }'","response":"{\n \"products\": [\n {\n \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"revision\": \"4\",\n \"createdDate\": \"2024-07-22T13:22:47.771Z\",\n \"updatedDate\": \"2024-07-22T13:51:49.970Z\",\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 \"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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"9\",\n \"formattedAmount\": \"$9.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\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 }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {},\n \"hasNext\": false\n }\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\": \"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 \"salePriceRange.minValue.amount\": {\n \"$gt\": 3\n }\n },\n {\n \"salePriceRange.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 }\n }\n }'","response":"{\n \"products\": [\n {\n \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"revision\": \"4\",\n \"createdDate\": \"2024-07-22T13:22:47.771Z\",\n \"updatedDate\": \"2024-07-22T13:51:49.970Z\",\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 \"id\": \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\"\n }\n ],\n \"ribbon\": {\n \"id\": \"14585597-3302-4145-8da3-24a26d8346d6\",\n \"name\": \"New arrival\"\n },\n \"allCategoriesInfo\": {\n \"categories\": [\n {\n \"id\": \"643721c3-446e-47f3-87ee-0a58d6842d48\"\n }\n ]\n },\n \"mainCategoryId\": \"643721c3-446e-47f3-87ee-0a58d6842d48\",\n \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"9\",\n \"formattedAmount\": \"$9.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\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 }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {},\n \"hasNext\": false\n }\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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"salePriceRange\": {\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 \"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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": \"$0.50\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": \"$0.50\"\n }\n },\n \"salePriceRange\": {\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 \"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 \"VARIANTS_INFO\",\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.salePrice.amount\": {\n \"$gt\": 1\n }\n },\n {\n \"price.salePrice.amount\": {\n \"$lt\": 20\n }\n },\n {\n \"price.basePrice.amount\": {\n \"$lt\": 100\n }\n },\n {\n \"sku\": {\n \"$eq\": \"c-s-r-1111\"\n }\n },\n {\n \"barcode\": {\n \"$eq\": \"111111111\"\n }\n },\n {\n \"physicalProperties.weight\": {\n \"$lte\": 0.2\n }\n },\n {\n \"choices.optionChoiceIds.optionId\": {\n \"$hasSome\": [\n \"85bb0544-63c7-431b-9659-f81b18a7dd9f\"\n ]\n }\n },\n {\n \"choices.optionChoiceIds.choiceId\": {\n \"$hasSome\": [\n \"4498b805-2aed-43fb-b478-989c906c19cd\"\n ]\n }\n }\n ]\n }\n }\n }\n}'","response":"{\n \"products\": [\n {\n \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"revision\": \"4\",\n \"createdDate\": \"2024-07-22T13:22:47.771Z\",\n \"updatedDate\": \"2024-07-22T13:51:49.970Z\",\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 \"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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"9\",\n \"formattedAmount\": \"$9.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\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 },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"2e98f13b-ae65-4d30-96c5-ac3a6cf99d60\"\n }\n }\n ],\n \"price\": {\n \"basePrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"salePrice\": {\n \"amount\": \"9\",\n \"formattedAmount\": \"$9.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.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 },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"4876dcc7-817e-4c10-a6b2-4a4cc2e241e6\"\n }\n }\n ],\n \"price\": {\n \"basePrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"salePrice\": {\n \"amount\": \"9.5\",\n \"formattedAmount\": \"$9.50\"\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.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 },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"2e98f13b-ae65-4d30-96c5-ac3a6cf99d60\"\n }\n }\n ],\n \"price\": {\n \"basePrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"salePrice\": {\n \"amount\": \"14\",\n \"formattedAmount\": \"$14.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\": \"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 },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"4876dcc7-817e-4c10-a6b2-4a4cc2e241e6\"\n }\n }\n ],\n \"price\": {\n \"basePrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"salePrice\": {\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 ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {},\n \"hasNext\": false\n }\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.salePrice.amount\",\n \"scalar\": {\n \"type\": \"MIN\"\n }\n },\n {\n \"type\": \"SCALAR\",\n \"name\": \"max_price\",\n \"field_path\": \"variantsInfo.variants.price.salePrice.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.salePrice.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.salePrice.amount\",\n \"scalar\": {\n \"type\": \"MAX\",\n \"value\": 15.0\n }\n }\n ]\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/products/search","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_READ","WIX_STORES.PRODUCT_READ_NON_VISIBLE"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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\": \"Tasty\"\n }\n }\n }'","response":"{\n \"products\": [\n {\n \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"revision\": \"4\",\n \"createdDate\": \"2024-07-22T13:22:47.771Z\",\n \"updatedDate\": \"2024-07-22T13:51:49.970Z\",\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 \"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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"9\",\n \"formattedAmount\": \"$9.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\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 }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {},\n \"hasNext\": false\n }\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\": \"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 \"salePriceRange.minValue.amount\": {\n \"$gt\": 3\n }\n },\n {\n \"salePriceRange.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 }\n }\n }'","response":"{\n \"products\": [\n {\n \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"revision\": \"4\",\n \"createdDate\": \"2024-07-22T13:22:47.771Z\",\n \"updatedDate\": \"2024-07-22T13:51:49.970Z\",\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 \"id\": \"b9b39003-0edd-41c0-9403-a0fe19cc5bb4\"\n }\n ],\n \"ribbon\": {\n \"id\": \"14585597-3302-4145-8da3-24a26d8346d6\",\n \"name\": \"New arrival\"\n },\n \"allCategoriesInfo\": {\n \"categories\": [\n {\n \"id\": \"643721c3-446e-47f3-87ee-0a58d6842d48\"\n }\n ]\n },\n \"mainCategoryId\": \"643721c3-446e-47f3-87ee-0a58d6842d48\",\n \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"9\",\n \"formattedAmount\": \"$9.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\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 }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {},\n \"hasNext\": false\n }\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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"salePriceRange\": {\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 \"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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": \"$0.50\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": \"$0.50\"\n }\n },\n \"salePriceRange\": {\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 \"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 \"VARIANTS_INFO\",\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.salePrice.amount\": {\n \"$gt\": 1\n }\n },\n {\n \"price.salePrice.amount\": {\n \"$lt\": 20\n }\n },\n {\n \"price.basePrice.amount\": {\n \"$lt\": 100\n }\n },\n {\n \"sku\": {\n \"$eq\": \"c-s-r-1111\"\n }\n },\n {\n \"barcode\": {\n \"$eq\": \"111111111\"\n }\n },\n {\n \"physicalProperties.weight\": {\n \"$lte\": 0.2\n }\n },\n {\n \"choices.optionChoiceIds.optionId\": {\n \"$hasSome\": [\n \"85bb0544-63c7-431b-9659-f81b18a7dd9f\"\n ]\n }\n },\n {\n \"choices.optionChoiceIds.choiceId\": {\n \"$hasSome\": [\n \"4498b805-2aed-43fb-b478-989c906c19cd\"\n ]\n }\n }\n ]\n }\n }\n }\n}'","response":"{\n \"products\": [\n {\n \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"revision\": \"4\",\n \"createdDate\": \"2024-07-22T13:22:47.771Z\",\n \"updatedDate\": \"2024-07-22T13:51:49.970Z\",\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 \"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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"9\",\n \"formattedAmount\": \"$9.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\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 },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"2e98f13b-ae65-4d30-96c5-ac3a6cf99d60\"\n }\n }\n ],\n \"price\": {\n \"basePrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"salePrice\": {\n \"amount\": \"9\",\n \"formattedAmount\": \"$9.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.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 },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"4876dcc7-817e-4c10-a6b2-4a4cc2e241e6\"\n }\n }\n ],\n \"price\": {\n \"basePrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"salePrice\": {\n \"amount\": \"9.5\",\n \"formattedAmount\": \"$9.50\"\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.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 },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"2e98f13b-ae65-4d30-96c5-ac3a6cf99d60\"\n }\n }\n ],\n \"price\": {\n \"basePrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"salePrice\": {\n \"amount\": \"14\",\n \"formattedAmount\": \"$14.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\": \"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 },\n {\n \"optionChoiceIds\": {\n \"optionId\": \"1938d364-126d-4304-b706-9e9e9f6d376f\",\n \"choiceId\": \"4876dcc7-817e-4c10-a6b2-4a4cc2e241e6\"\n }\n }\n ],\n \"price\": {\n \"basePrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"salePrice\": {\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 ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {},\n \"hasNext\": false\n }\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.salePrice.amount\",\n \"scalar\": {\n \"type\": \"MIN\"\n }\n },\n {\n \"type\": \"SCALAR\",\n \"name\": \"max_price\",\n \"field_path\": \"variantsInfo.variants.price.salePrice.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.salePrice.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.salePrice.amount\",\n \"scalar\": {\n \"type\": \"MAX\",\n \"value\": 15.0\n }\n }\n ]\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Search Products","slugifiedName":"search-products"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"}]},{"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\n\nTo learn about working with _Query_ endpoints, see\n[API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),\nand [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).\n\n> **Note:** To retrieve a non-visible product (`visible: false`), your app must have the required `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.","operationId":"wix.stores.catalog.v3.CatalogApi.QueryProducts","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.QueryProductsResponse","description":""}},"deprecated":false,"servers":[{"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"}}],"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":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_READ","WIX_STORES.PRODUCT_READ_NON_VISIBLE"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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 \"fieldName\": \"createdDate\",\n \"order\": \"DESC\"\n }\n ],\n \"filter\": {\n \"id\": {\n \"$in\": [\n \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"ac491fa2-f5fc-479f-9123-65bc32d1ad28\"\n ]\n }\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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"15\"\n },\n \"maxValue\": {\n \"amount\": \"15\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"15\"\n },\n \"maxValue\": {\n \"amount\": \"15\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"shippingWeightRange\": {\n \"minValue\": 0.3,\n \"maxValue\": 0.3\n }\n },\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 \"flattenOptions\": [],\n \"flattenModifiers\": []\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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {},\n \"flattenOptions\": [],\n \"flattenModifiers\": []\n },\n {\n \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"revision\": \"4\",\n \"createdDate\": \"2024-07-22T13:22:47.771Z\",\n \"updatedDate\": \"2024-07-22T13:51:49.970Z\",\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 \"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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\"\n },\n \"maxValue\": {\n \"amount\": \"15\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"9\"\n },\n \"maxValue\": {\n \"amount\": \"15\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\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 },\n \"flattenOptions\": [],\n \"flattenModifiers\": []\n }\n ],\n \"pagingMetadata\": {\n \"count\": 3,\n \"cursors\": {},\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/products/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_READ","WIX_STORES.PRODUCT_READ_NON_VISIBLE"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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 \"fieldName\": \"createdDate\",\n \"order\": \"DESC\"\n }\n ],\n \"filter\": {\n \"id\": {\n \"$in\": [\n \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"abc62281-87b7-47e8-98ba-20e25341ad98\",\n \"ac491fa2-f5fc-479f-9123-65bc32d1ad28\"\n ]\n }\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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"15\"\n },\n \"maxValue\": {\n \"amount\": \"15\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"15\"\n },\n \"maxValue\": {\n \"amount\": \"15\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {\n \"shippingWeightRange\": {\n \"minValue\": 0.3,\n \"maxValue\": 0.3\n }\n },\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 \"flattenOptions\": [],\n \"flattenModifiers\": []\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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\n \"preorderStatus\": \"DISABLED\"\n },\n \"productType\": \"PHYSICAL\",\n \"physicalProperties\": {},\n \"flattenOptions\": [],\n \"flattenModifiers\": []\n },\n {\n \"id\": \"d17bb5c4-e10f-4b83-ae97-f27f2edc18f1\",\n \"revision\": \"4\",\n \"createdDate\": \"2024-07-22T13:22:47.771Z\",\n \"updatedDate\": \"2024-07-22T13:51:49.970Z\",\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 \"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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\"\n },\n \"maxValue\": {\n \"amount\": \"15\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"9\"\n },\n \"maxValue\": {\n \"amount\": \"15\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\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 },\n \"flattenOptions\": [],\n \"flattenModifiers\": []\n }\n ],\n \"pagingMetadata\": {\n \"count\": 3,\n \"cursors\": {},\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Query Products","slugifiedName":"query-products"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"}]},{"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,"servers":[{"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"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CountProductsRequest","description":"","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","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 required `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":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_READ","WIX_STORES.PRODUCT_READ_NON_VISIBLE"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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 \"salePriceRange.minValue.amount\": {\n \"$gt\": 3\n }\n },\n {\n \"salePriceRange.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}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/products/count","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_READ","WIX_STORES.PRODUCT_READ_NON_VISIBLE"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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 \"salePriceRange.minValue.amount\": {\n \"$gt\": 3\n }\n },\n {\n \"salePriceRange.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}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Count Products","slugifiedName":"count-products"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"}]},{"summary":"Bulk Update Product Variants By Filter","description":"Updates a variant of multiple products, given the provided filter and search expression.\n\n\nOnly the following variant fields can be updated:\n+ `visible`\n+ `price`\n+ `revenueDetails.cost`\n+ `physicalOptions`","operationId":"wix.stores.catalog.v3.CatalogApi.BulkUpdateProductVariantsByFilter","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkUpdateProductVariantsByFilterResponse","description":""}},"deprecated":false,"servers":[{"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"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkUpdateProductVariantsByFilterRequest","description":"","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","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":"BETA","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","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"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"VARIANT_ID_ALREADY_EXISTS"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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 \"basePrice\": {\n \"amount\": \"7\"\n },\n \"salePrice\": {\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}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products/update-variants-by-filter","rpcOnly":false,"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"BETA","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","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"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"VARIANT_ID_ALREADY_EXISTS"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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 \"basePrice\": {\n \"amount\": \"7\"\n },\n \"salePrice\": {\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}"}}],"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":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Bulk Adjust Product Variants By Filter","description":"Adjusts the price and cost of multiple variants, given the provided filter and search expression.\n\n\nOnly the following variant fields can be increased/decreased by amount or percentage:\n+ `basePrice`\n+ `salePrice`\n+ `cost`\n+ `salePriceFromBasePrice`","operationId":"wix.stores.catalog.v3.CatalogApi.BulkAdjustProductVariantsByFilter","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkAdjustProductVariantsByFilterResponse","description":""}},"deprecated":false,"servers":[{"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"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkAdjustProductVariantsByFilterRequest","description":"","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"basePrice":{"description":"Base price adjustment.","$ref":"#/components/schemas/wix.stores.catalog.v3.AdjustValue","summary":"basePrice","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"salePrice":{"description":"Sale price adjustment.","$ref":"#/components/schemas/wix.stores.catalog.v3.AdjustValue","summary":"salePrice","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"}},"salePriceFromBasePrice":{"description":"Set variant sale price from base price by applying provided discount to it.\nFor example variant base price 100$, variant sale price 95$, requested `salePriceFromBasePrice.percentage` is 10, then old sale price ignored and new sale price set to 90 (100$ - 10%).","$ref":"#/components/schemas/wix.stores.catalog.v3.UnsignedAdjustValue","summary":"salePriceFromBasePrice","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"}}},"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":"BETA","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","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"NO_VARIANT_ADJUSTMENTS_PASSED"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INVALID_PRICES_ADJUSTMENTS"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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":"This example shows how to decrease base price, sale price, and cost by 1$ of all variants of all products that satisfy a filter.","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 \"basePrice\": {\n \"amount\": \"-1\"\n },\n \"salePrice\": {\n \"amount\": \"-1\"\n },\n \"cost\": {\n \"amount\": \"-1\"\n }\n }'","response":"{\n \"jobId\": \"e95725e2-9159-4d45-b1c5-d3a0fed56d7b\"\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products/adjust-variants-by-filter","rpcOnly":false,"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"BETA","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","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"NO_VARIANT_ADJUSTMENTS_PASSED"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INVALID_PRICES_ADJUSTMENTS"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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":"This example shows how to decrease base price, sale price, and cost by 1$ of all variants of all products that satisfy a filter.","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 \"basePrice\": {\n \"amount\": \"-1\"\n },\n \"salePrice\": {\n \"amount\": \"-1\"\n },\n \"cost\": {\n \"amount\": \"-1\"\n }\n }'","response":"{\n \"jobId\": \"e95725e2-9159-4d45-b1c5-d3a0fed56d7b\"\n}"}}],"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":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Bulk Add Info Sections To Products By Filter","description":"Adds info sections 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,"servers":[{"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"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkAddInfoSectionsToProductsByFilterRequest","description":"","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","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":"BETA","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","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"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products/add-info-sections-by-filter","rpcOnly":false,"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"BETA","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","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"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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}"}}],"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":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Bulk Add Info Sections To Products","description":"Adds info sections to multiple products.","operationId":"wix.stores.catalog.v3.CatalogApi.BulkAddInfoSectionsToProducts","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkAddInfoSectionsToProductsResponse","description":""}},"deprecated":false,"servers":[{"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"}}],"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":"BETA","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","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"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"6\"\n },\n \"maxValue\": {\n \"amount\": \"6\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"5\"\n },\n \"maxValue\": {\n \"amount\": \"5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\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}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products/add-info-sections","rpcOnly":false,"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"BETA","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","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"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"6\"\n },\n \"maxValue\": {\n \"amount\": \"6\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"5\"\n },\n \"maxValue\": {\n \"amount\": \"5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\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}"}}],"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":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Bulk Remove Info Sections From Products By Filter","description":"Removes info sections 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,"servers":[{"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"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkRemoveInfoSectionsFromProductsByFilterRequest","description":"","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"infoSectionIds":{"description":"IDs of info sections to remove.","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":"BETA","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","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products/remove-info-sections-by-filter","rpcOnly":false,"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"BETA","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","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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}"}}],"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":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Bulk Remove Info Sections From Products","description":"Removes info sections from multiple products.","operationId":"wix.stores.catalog.v3.CatalogApi.BulkRemoveInfoSectionsFromProducts","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkRemoveInfoSectionsFromProductsResponse","description":""}},"deprecated":false,"servers":[{"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"}}],"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":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":"BETA","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","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"6\"\n },\n \"maxValue\": {\n \"amount\": \"6\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"5\"\n },\n \"maxValue\": {\n \"amount\": \"5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\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}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products/remove-info-sections","rpcOnly":false,"triggeredEvents":[{"title":"Product Updated","description":"Triggered when a product is updated.","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"BETA","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","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.PRODUCT_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"6\"\n },\n \"maxValue\": {\n \"amount\": \"6\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"5\"\n },\n \"maxValue\": {\n \"amount\": \"5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"salePriceRange\": {\n \"minValue\": {\n \"amount\": \"0.5\"\n },\n \"maxValue\": {\n \"amount\": \"0.5\"\n }\n },\n \"inventory\": {\n \"availabilityStatus\": \"OUT_OF_STOCK\",\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}"}}],"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":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Bulk Add Products To Categories By Filter","description":"Adds multiple products, given the provided filter and search expression, to up to 5 categories.\n\nLearn more about the [Categories API](https://dev.wix.com/docs/rest/business-management/categories/introduction).","operationId":"wix.stores.catalog.v3.CatalogApi.BulkAddProductsToCategoriesByFilter","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkAddProductsToCategoriesByFilterResponse","description":""}},"deprecated":false,"servers":[{"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"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkAddProductsToCategoriesByFilterRequest","description":"","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","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":"BETA","permissions":["CATEGORIES.CATEGORY_ADD_ITEM"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Category item write","scopeId":"SCOPE.CATEGORIES.CATEGORY_ITEM_WRITE"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products/add-to-categories-by-filter","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_ADD_ITEM"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Category item write","scopeId":"SCOPE.CATEGORIES.CATEGORY_ITEM_WRITE"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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}"}}],"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"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}]},{"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/rest/business-management/categories/introduction).","operationId":"wix.stores.catalog.v3.CatalogApi.BulkRemoveProductsFromCategoriesByFilter","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkRemoveProductsFromCategoriesByFilterResponse","description":""}},"deprecated":false,"servers":[{"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"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkRemoveProductsFromCategoriesByFilterRequest","description":"","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","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":"BETA","permissions":["CATEGORIES.CATEGORY_REMOVE_ITEM"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Category item write","scopeId":"SCOPE.CATEGORIES.CATEGORY_ITEM_WRITE"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/products/remove-from-categories-by-filter","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.stores.catalog.v3.CatalogApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_REMOVE_ITEM"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Category item write","scopeId":"SCOPE.CATEGORIES.CATEGORY_ITEM_WRITE"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"}],"protoArtifactId":"com.wixpress.stores.catalog:stores-catalog-orchestrator","serviceArtifactId":"com.wixpress.stores.catalog.stores-catalog-orchestrator","labels":[{"identifier":"BETA"},{"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}"}}],"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"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}]}],"webhooks":[{"summary":"Product Created","title":"Product Created","description":"","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"CREATED","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"wix.stores.catalog.v3.product_created","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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"maxValue\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n }\n },\n \"salePriceRange\": {\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 \"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 \"basePrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"10\",\n \"formattedAmount\": \"$10.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"15\",\n \"formattedAmount\": \"$15.00\"\n },\n \"salePrice\": {\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"}],"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":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"}]},{"summary":"Product Updated","title":"Product Updated","description":"","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"UPDATED","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"wix.stores.catalog.v3.product_updated","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

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"}],"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":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"}]},{"summary":"Product Deleted","title":"Product Deleted","description":"","permissions":["WIX_STORES.PRODUCT_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.stores.catalog.v3.product","serviceName":"wix.stores.catalog.v3.CatalogApi","domainEvent":"DELETED","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"wix.stores.catalog.v3.product_deleted","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 \"basePriceRange\": {\n \"minValue\": {\n \"amount\": \"6\",\n \"formattedAmount\": \"$6.00\"\n },\n \"maxValue\": {\n \"amount\": \"6\",\n \"formattedAmount\": \"$6.00\"\n }\n },\n \"salePriceRange\": {\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 \"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 \"basePrice\": {\n \"amount\": \"6\",\n \"formattedAmount\": \"$6.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"6\",\n \"formattedAmount\": \"$6.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"6\",\n \"formattedAmount\": \"$6.00\"\n },\n \"salePrice\": {\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 \"basePrice\": {\n \"amount\": \"6\",\n \"formattedAmount\": \"$6.00\"\n },\n \"salePrice\": {\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"}],"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":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Read products in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_READ"},{"name":"Product v3 read admin","scopeId":"SCOPE.STORES.PRODUCT_READ_ADMIN"}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About Products\n\nThe Products API allows you to create and manage a store's products. \n\nWith the products API you can:\n- [Create](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/create-product) and [Bulk Create Products](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-create-products)\n- [Update](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/update-product) and [Bulk Update Products](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-update-products)\n- [Delete](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/delete-product) and [Bulk Delete Products](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-delete-products)\n- [Get](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/get-product), [Search](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/search-products), [Query](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/query-products), and [Count Products](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/count-products)\n- [Bulk Update Variants](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-update-product-variants-by-filter)\n- [Bulk Add](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-add-products-to-categories-by-filter) and [Bulk Remove Products From Categories](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-remove-products-from-categories-by-filter)\n- And more\n\n## Before you begin\nIt’s important to note the following points before starting to code:\n- The site owner must install the Wix Stores app.\n\n## Sample flows\n* [Add and arrange products in category](slug::sample-use-cases-and-flows#Add-and-arrange-products-in-category*fallback::./sample-flows.md#Add-and-arrange-products-in-category)\n* [Prepare store for Christmas Sale](slug::sample-use-cases-and-flows#Prepare-store-for-christmas-sale*fallback::./sample-flows.md#Prepare-store-for-christmas-sale)\n"},{"displayName":"Sample Use Cases and Flows","slugifyName":"sample-use-cases-and-flows","content":"# Sample Use Cases and Flows\n\nThis article shares a possible use case your app could support, as well as sample flows that could support this use case.\nThis can be a helpful jumping-off point as you plan your app's implementation.\n\n## Add and arrange products in category\n\nHelp merchants to manage their products by using categories. For this we will be using the [Categories API](fallback::https://dev.wix.com/docs/rest/business-management/categories/introduction).\n\n1. Call [Create Category](fallback::https://dev.wix.com/docs/rest/business-management/categories/create-category) and pass `\"@wix/stores\"` to the `treeReference.appNamespace` field.\n2. Save `category.id` from the response. \n3. Call [Bulk Add Items To Category](fallback::https://dev.wix.com/docs/rest/business-management/categories/bulk-add-items-to-category) and pass the `items` you want to add to the category. After products added to category you can rearrange them for example to promote some products to be displayed in the beginning. Note that you can arrange only 100 products, more products can be added but you cannot control arrangement of them. Call [Set Arranged Items](fallback::https://dev.wix.com/docs/rest/business-management/categories/set-arranged-items) endpoint. Pass exactly same params as in step 2 but now `items` must be in same order in which you want to see them.\n4. Now you can load all products that belongs to given category and keep their arrangement by calling [Search Products](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/search-products) endpoint of ProductService with next body \n\n```json\n{\n \"search\": {\n \"sort\": [\n {\n \"selectItemsBy\": [\n {\n \"directCategoriesInfo.categories.id\": \"\"\n }\n ],\n \"fieldName\": \"directCategoriesInfo.categories.index\",\n \"order\": \"ASC\"\n }\n ],\n \"filter\": {\n \"directCategoriesInfo.categories\": {\n \"$matchItems\": [\n {\n \"id\": \"\"\n }\n ]\n }\n }\n }\n}\n```\nReplace `` with real category id from step 1. Pay attention to `sort.selectItemsBy` parameter where you must pass filter by categoryId, this allows you to sort products by arrangement that you set in CategoriesService on step 3.\n\n## Prepare store for Christmas Sale\nBefore big sale merchant might want to prepare store by creating a new category for products on sale, adding ribbons to products to catch visitors' attention and of course setting new sale price. Let's see how to do it step by step.\n1. [Add and arrange products in category](fallback::#add-and-arrange-products-in-category). This will allow visitor to filter by this category on storefront category page (if merchant enabled this filter in editor). Also it allows merchant to control which products visitor will see first.\n2. Create new ribbon by calling [Create Ribbon](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/ribbons-v3/create-ribbon) endpoint of external RibbonService. Save `ribbon.id` that you received in response.\n3. To add ribbon \"Sale!\" to all products in category call [Bulk Update Products By Filter](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-update-products-by-filter) endpoint. In `filter` send filter by category id. In `product` send only `ribbon`. So your request will look like:\n```json\n{\n \"filter\": {\n \"directCategoriesInfo.categories.id\": \"\"\n },\n \"product\": {\n \"ribbon\": {\n \"id\": \"\"\n }\n }\n}\n```\n4. Finally we need to update sale prices. For simplicity let's consider single product with one variant which has basePrice 100$ and salePrice 90$.\n\na) If you want to adjust all sale prices by some specific amount or percentage which depends on original sale price value call [Bulk Adjust Product Variants By Filter](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-adjust-product-variants-by-filter). For example if you want to decrease current sale prices by 10% pass next body:\n```json\n{\n \"salePrice\": {\n \"percentage\": -10\n }\n}\n```\nAfter this call example product will have basePrice 100$ and salePrice 81$.\n\nb) If you want to calculate new sale prices from base price by applying some discount to it call [Bulk Adjust Product Variants By Filter](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-adjust-product-variants-by-filter) with `salePriceFromSasePrice`. For example if you want to set sale as 20% discount from base price pass next body:\n```json\n{\n \"salePriceFromBasePrice\": {\n \"percentage\": 20\n }\n}\n```\nAfter this call example product will have basePrice 100$ and salePrice 80$.\n\nc) If you want to set exact sale price same for all variants of all products call [Bulk Update Product Variants By Filter](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-update-product-variants-by-filter) endpoint with variant with desired sale price:\n```json\n{\n \"variant\": {\n \"price\": {\n \"salePrice\": {\n \"amount\": \"75\"\n }\n }\n }\n}\n```\nAfter this call example product will have basePrice 100$ and salePrice 75$.\n"}],"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","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":"integer","format":"int64","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","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Product name. Translatable.","minLength":1,"maxLength":80,"title":"name","type":"string","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","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"}},"plainDescription":{"description":"Product description in HTML.\n\n+ When provided on create/update, this string must be a valid HTML. It will then be converted to rich content.\n+ `plainDescription` is ignored when 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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"visible":{"description":"Whether the product is visible to site visitors on the site.\n\nDefault: `true`","title":"visible","type":"boolean","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"media":{"description":"Product media items.","$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.","format":"GUID","title":"taxGroupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"options":{"description":"Product options. Allows the customer to customize the product. For example, selecting color, size, and more.\n\nAlways generates variants: every variant must have exactly one choice related to each option.\nSince options and variants tightly coupled and rely on each other they usually should be provided together in all operations.","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.\n\nAllows the customer to customize product, e.g. select Color, Size and so on similarly to `options` but with one main difference - `modifiers` never generate any variants.","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.\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.\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.\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 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 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":"Main category ID.","format":"GUID","title":"mainCategoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"basePriceRange":{"description":"Product base price range - minimum and maximum prices of all product variants.","readOnly":true,"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.PriceRange","summary":"basePriceRange","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"salePriceRange":{"description":"Product sale price range - minimum and maximum sale prices of all product variants.","readOnly":true,"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.PriceRange","summary":"salePriceRange","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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.","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.\n\nWhen passing `productType: PHYSICAL`, you must also pass `physicalProperties`.","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.\nUnlike the product ID, the handle can be set by the user to ensure consistency across multiple platforms.\nIn case handle wasn't given, the handle will be automatically generated.","minLength":1,"maxLength":100,"immutable":true,"title":"handle","type":"string","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 `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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"breadcrumbsInfo":{"description":"Breadcrumbs of the `mainCategoryId`. Used to navigate to parent categories.\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"}},"variantsInfo":{"description":"Product variants.\n\n> **Note:** Returned only when you pass `\"VARIANTS_INFO\"` to the `fields` array in Products API requests.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.VariantsInfo","summary":"variantsInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"extendedFields":{"description":"Custom extended fields for the product object.\n\n[Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the Wix Dev Center 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.","$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":"","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":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PageUrlV2","description":""},"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":"Data for a map node.","$ref":"#/components/schemas/wix.rich_content.v1.MapData","summary":"mapData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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"}}}},"wix.rich_content.v1.Node.Type":{"type":"string","description":"","title":"Type","enum":["PARAGRAPH","TEXT","HEADING","BULLETED_LIST","ORDERED_LIST","LIST_ITEM","BLOCKQUOTE","CODE_BLOCK","VIDEO","DIVIDER","FILE","GALLERY","GIF","HTML","IMAGE","LINK_PREVIEW","MAP","POLL","APP_EMBED","BUTTON","COLLAPSIBLE_LIST","TABLE","EMBED","COLLAPSIBLE_ITEM","COLLAPSIBLE_ITEM_TITLE","COLLAPSIBLE_ITEM_BODY","TABLE_CELL","TABLE_ROW","EXTERNAL","AUDIO"]},"wix.rich_content.v1.NodeStyle":{"type":"object","properties":{"paddingTop":{"description":"The top padding value in pixels.","title":"paddingTop","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paddingBottom":{"description":"The bottom padding value in pixels.","title":"paddingBottom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"backgroundColor":{"description":"The background color as a hexadecimal value.","title":"backgroundColor","type":"string","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","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":"Border width in pixels.","title":"width","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"radius":{"description":"Border radius in pixels.","title":"radius","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Border","description":""},"wix.rich_content.v1.ButtonData.Styles.Colors":{"type":"object","properties":{"text":{"description":"The text color as a hexadecimal value.","title":"text","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"border":{"description":"The border color as a hexadecimal value.","title":"border","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"background":{"description":"The background color as a hexadecimal value.","title":"background","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","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":["CONTENT","SMALL","ORIGINAL","FULL_WIDTH"]},"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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.rich_content.v1.PluginContainerData.Alignment":{"type":"string","description":"","title":"Alignment","enum":["CENTER","LEFT","RIGHT"]},"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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"The description displayed on top of the spoiler cover.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"buttonText":{"description":"The text for the button used to remove the spoiler cover.","title":"buttonText","type":"string","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Height","description":""},"wix.rich_content.v1.ButtonData.Type":{"type":"string","description":"","title":"Type","enum":["LINK","ACTION"]},"wix.rich_content.v1.ButtonData.Styles":{"type":"object","properties":{"border":{"description":"Border attributes.","$ref":"#/components/schemas/wix.rich_content.v1.ButtonData.Styles.Border","summary":"border","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"colors":{"description":"Color attributes.","$ref":"#/components/schemas/wix.rich_content.v1.ButtonData.Styles.Colors","summary":"colors","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","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":["SELF","BLANK","PARENT","TOP"]},"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","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","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","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","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TextStyle","description":""},"wix.rich_content.v1.TextStyle.TextAlignment":{"type":"string","description":"","title":"TextAlignment","enum":["AUTO","LEFT","RIGHT","CENTER","JUSTIFY"]},"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":["SINGLE","DOUBLE","DASHED","DOTTED"]},"wix.rich_content.v1.DividerData.Width":{"type":"string","description":"","title":"Width","enum":["LARGE","MEDIUM","SMALL"]},"wix.rich_content.v1.DividerData.Alignment":{"type":"string","description":"","title":"Alignment","enum":["CENTER","LEFT","RIGHT"]},"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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"File type.","title":"type","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"size":{"description":"Use `sizeInKb` instead.","title":"size","type":"integer","format":"int32","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"path":{"description":"File path.","title":"path","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sizeInKb":{"description":"File size in KB.","title":"sizeInKb","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FileData","description":""},"wix.rich_content.v1.FileData.PDFSettings.ViewMode":{"type":"string","description":"","title":"ViewMode","enum":["NONE","FULL","MINI"]},"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","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"custom":{"description":"Custom ID. Use `id` instead.","title":"custom","type":"string","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","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"disablePrint":{"description":"Sets whether the PDF print button is disabled. Defaults to `false`.","title":"disablePrint","type":"boolean","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","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","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"Media height in pixels.","title":"height","type":"integer","format":"int32","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","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"altText":{"description":"Item's alternative text.","title":"altText","type":"string","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":["COLLAGE","MASONRY","GRID","THUMBNAIL","SLIDER","SLIDESHOW","PANORAMA","COLUMN","MAGIC","FULLSIZE"]},"wix.rich_content.v1.GalleryOptions.Layout.Orientation":{"type":"string","description":"","title":"Orientation","enum":["ROWS","COLUMNS"]},"wix.rich_content.v1.GalleryOptions.ItemStyle.Crop":{"type":"string","description":"","title":"Crop","enum":["FILL","FIT"]},"wix.rich_content.v1.GalleryOptions.Thumbnails.Alignment":{"type":"string","description":"","title":"Alignment","enum":["TOP","RIGHT","BOTTOM","LEFT","NONE"]},"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","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mobileNumberOfColumns":{"description":"The number of columns to display on mobile screens.","title":"mobileNumberOfColumns","type":"integer","format":"int32","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ratio":{"description":"Item ratio","title":"ratio","type":"number","format":"double","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","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","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"}}},"title":"GIFData","description":""},"wix.rich_content.v1.GIF":{"type":"object","properties":{"gif":{"description":"GIF format URL.","format":"WEB_URL","title":"gif","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mp4":{"description":"MP4 format URL.","format":"WEB_URL","title":"mp4","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"still":{"description":"Thumbnail URL.","format":"WEB_URL","title":"still","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GIF","description":""},"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","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.","$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"}}},"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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}}}},"wix.rich_content.v1.HTMLData.Source":{"type":"string","description":"","title":"Source","enum":["HTML","ADSENSE"]},"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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"altText":{"description":"Image's alternative text.","title":"altText","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"caption":{"description":"Image caption.","title":"caption","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"disableDownload":{"description":"Sets whether the image's download button is disabled. Defaults to `false`.","title":"disableDownload","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ImageData","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"thumbnailUrl":{"description":"Preview thumbnail URL.","title":"thumbnailUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Preview description.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"html":{"description":"The preview content as HTML.","title":"html","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LinkPreviewData","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"draggable":{"description":"Sets whether the map is draggable.","title":"draggable","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"marker":{"description":"Sets whether the location marker is visible.","title":"marker","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"streetViewControl":{"description":"Sets whether street view control is enabled.","title":"streetViewControl","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"zoomControl":{"description":"Sets whether zoom control is enabled.","title":"zoomControl","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lat":{"description":"Location latitude.","title":"lat","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lng":{"description":"Location longitude.","title":"lng","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"locationName":{"description":"Location name.","title":"locationName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"viewModeControl":{"description":"Sets whether view mode control is enabled.","title":"viewModeControl","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"initialZoom":{"description":"Initial zoom value.","title":"initialZoom","type":"integer","format":"int32","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":["ROADMAP","SATELITE","HYBRID","TERRAIN"]},"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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"level":{"description":"Paragraph level","title":"level","type":"integer","format":"int32","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":["CREATOR","VOTERS","EVERYONE"]},"wix.rich_content.v1.PollData.Poll.Settings.Permissions.VoteRole":{"type":"string","description":"","title":"VoteRole","enum":["SITE_MEMBERS","ALL"]},"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","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Option title.","title":"title","type":"string","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"showVotesCount":{"description":"Sets whether the vote count is displayed. Defaults to `true`.","title":"showVotesCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Settings","description":""},"wix.rich_content.v1.PollData.Layout.PollLayout.Type":{"type":"string","description":"","title":"Type","enum":["LIST","GRID"]},"wix.rich_content.v1.PollData.Layout.PollLayout.Direction":{"type":"string","description":"","title":"Direction","enum":["LTR","RTL"]},"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","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","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":["COLOR","IMAGE","GRADIENT"]},"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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"startColor":{"description":"The start color as a hexademical value.","format":"COLOR_HEX","title":"startColor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lastColor":{"description":"The end color as a hexademical value.","format":"COLOR_HEX","title":"lastColor","type":"string","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","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","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","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Poll title.","title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"creatorId":{"description":"Poll creator ID.","title":"creatorId","type":"string","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"italicData":{"description":"Data for an italic decoration. Defaults to `true`.","title":"italicData","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"underlineData":{"description":"Data for an underline decoration. Defaults to `true`.","title":"underlineData","type":"boolean","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"}}}},"wix.rich_content.v1.Decoration.Type":{"type":"string","description":"","title":"Type","enum":["BOLD","ITALIC","UNDERLINE","SPOILER","ANCHOR","MENTION","LINK","COLOR","FONT_SIZE","EXTERNAL"]},"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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"foreground":{"description":"The text's foreground color as a hexadecimal value.","title":"foreground","type":"string","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","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FontSizeData","description":""},"wix.rich_content.v1.FontSizeData.fontType":{"type":"string","description":"","title":"fontType","enum":["PX","EM"]},"wix.rich_content.v1.SpoilerData":{"type":"object","properties":{"id":{"description":"Spoiler ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SpoilerData","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"The name of the embedded content.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"imageSrc":{"description":"Deprecated: Use `image` instead.","title":"imageSrc","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"url":{"description":"The URL for the embedded content.","title":"url","type":"string","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"}}},"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.AppType":{"type":"string","description":"","title":"AppType","enum":["PRODUCT","EVENT","BOOKING"]},"wix.rich_content.v1.AppEmbedData.BookingData":{"type":"object","properties":{"durations":{"description":"Booking duration in minutes.","title":"durations","type":"string","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"location":{"description":"Event location.","title":"location","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EventData","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Video title.","title":"title","type":"string","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"playInLoop":{"description":"Sets whether media's will be looped.","title":"playInLoop","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"showControls":{"description":"Sets whether media's controls will be shown.","title":"showControls","type":"boolean","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","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","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","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Resource title.","title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"The source URL for the resource.","title":"url","type":"string","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"authorName":{"description":"The name of the author or owner of the resource.","title":"authorName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"authorUrl":{"description":"The URL for the author or owner of the resource.","title":"authorUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"providerName":{"description":"The name of the resource provider.","title":"providerName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"providerUrl":{"description":"The URL for the resource provider.","title":"providerUrl","type":"string","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","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","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"videoUrl":{"description":"The URL for an embedded viedo.","title":"videoUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"version":{"description":"The oEmbed version number. This value must be `1.0`.","title":"version","type":"string","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","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CollapsibleListData","description":""},"wix.rich_content.v1.CollapsibleListData.InitialExpandedItems":{"type":"string","description":"","title":"InitialExpandedItems","enum":["FIRST","ALL","NONE"]},"wix.rich_content.v1.CollapsibleListData.Direction":{"type":"string","description":"","title":"Direction","enum":["LTR","RTL"]},"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","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","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","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"}}},"title":"TableCellData","description":""},"wix.rich_content.v1.TableCellData.VerticalAlignment":{"type":"string","description":"","title":"VerticalAlignment","enum":["TOP","MIDDLE","BOTTOM"]},"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","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"right":{"description":"Right border color as a hexadecimal value.","format":"COLOR_HEX","title":"right","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"top":{"description":"Top border color as a hexadecimal value.","format":"COLOR_HEX","title":"top","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bottom":{"description":"Bottom border color as a hexadecimal value.","format":"COLOR_HEX","title":"bottom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BorderColors","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":["NULL_VALUE"]},"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","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"authorName":{"description":"Author name.","title":"authorName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"html":{"description":"An HTML version of the audio node.","title":"html","type":"string","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","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","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.Metadata":{"type":"object","properties":{"version":{"description":"Schema version.","minimum":1,"title":"version","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdTimestamp":{"description":"When the object was created.","readOnly":true,"title":"createdTimestamp","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"updatedTimestamp":{"description":"When the object was most recently updated.","title":"updatedTimestamp","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"id":{"description":"Object ID.","title":"id","type":"string","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","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.","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"displayName":{"description":"Media display name.\nAllows to override the default media name. Can be passed only when `setBy: url`.","maxLength":80,"title":"displayName","type":"string","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.ProductMedia.setBy":{"type":"object","title":"setBy","properties":{"id":{"description":"ID of existing media from Wix Media Manager.","minLength":1,"maxLength":200,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"Media URL.","format":"WEB_URL","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.stores.catalog.product.api.v3.ProductMedia.media":{"type":"object","title":"media","properties":{"image":{"description":"Product image.","readOnly":true,"$ref":"#/components/schemas/com.wix.media.site_media.upstream.wix.common.Image","summary":"image","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"video":{"description":"Product video.","readOnly":true,"$ref":"#/components/schemas/com.wix.media.site_media.upstream.wix.common.VideoV2","summary":"video","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.media.site_media.upstream.wix.common.Image":{"type":"object","properties":{"id":{"description":"WixMedia image ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"Image URL.","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"Original image height.","readOnly":true,"title":"height","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"Original image width.","readOnly":true,"title":"width","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"altText":{"description":"Image alt text.","title":"altText","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filename":{"description":"Image filename.","readOnly":true,"title":"filename","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Image","description":""},"com.wix.media.site_media.upstream.wix.common.VideoV2":{"type":"object","properties":{"id":{"description":"WixMedia ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"resolutions":{"description":"Available resolutions for the video, starting with the optimal resolution.","readOnly":true,"maxItems":100,"title":"resolutions","type":"array","items":{"$ref":"#/components/schemas/com.wix.media.site_media.upstream.wix.common.VideoResolution"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filename":{"description":"Video filename.","readOnly":true,"title":"filename","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"VideoV2","description":""},"com.wix.media.site_media.upstream.wix.common.VideoResolution":{"type":"object","properties":{"url":{"description":"Video URL.","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"Video height.","title":"height","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"Video width.","title":"width","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"format":{"description":"Video format\nPossible values: ['144p.mp4' '144p.webm' '240p.mp4' '240p.webm' '360p.mp4' '360p.webm' '480p.mp4' '480p.webm'\n'720p.mp4' '720p.webm' '1080p.mp4' '1080p.webm', 'hls' ]","title":"format","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"VideoResolution","description":""},"com.wix.stores.catalog.product.api.v3.MediaItemsInfo":{"type":"object","properties":{"items":{"description":"All media items (images, videos etc) associated with this product.","maxItems":15,"title":"items","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ProductMedia"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MediaItemsInfo","description":""},"com.wixpress.advanced.seo.SeoSchema":{"type":"object","properties":{"tags":{"description":"SEO tag information.","title":"tags","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.advanced.seo.SeoSchema.Tag"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"settings":{"description":"SEO general settings.","$ref":"#/components/schemas/com.wixpress.advanced.seo.SeoSchema.Settings","summary":"settings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SeoSchema","description":"The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.\nThe search engines use this information for ranking purposes, or to display snippets in the search results.\nThis data will override other sources of tags (for example patterns) and will be included in the section of the HTML document, while not being displayed on the page itself."},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"com.wixpress.advanced.seo.SeoSchema.Keyword":{"type":"object","properties":{"term":{"description":"Keyword value.","title":"term","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"isMain":{"description":"Whether the keyword is the main focus keyword.","title":"isMain","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"origin":{"description":"Who added the keyword to the settings","maxLength":1000,"title":"origin","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Keyword","description":""},"com.wixpress.advanced.seo.SeoSchema.Tag":{"type":"object","properties":{"type":{"description":"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.","title":"type","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"props":{"description":"A `{'key':'value'}` pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.\nFor example: `{'name': 'description', 'content': 'the description itself'}`.","title":"props","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"meta":{"description":"SEO tag meta data. For example, `{height: 300, width: 240}`.","title":"meta","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"children":{"description":"SEO tag inner content. For example, ` inner content `.","title":"children","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"custom":{"description":"Whether the tag is a custom tag.","title":"custom","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"disabled":{"description":"Whether the tag is disabled.","title":"disabled","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Tag","description":""},"com.wixpress.advanced.seo.SeoSchema.Settings":{"type":"object","properties":{"preventAutoRedirect":{"description":"Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.\n\n\nDefault: `false` (Auto Redirect is enabled.)","title":"preventAutoRedirect","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"keywords":{"description":"User-selected keyword terms for a specific page.","maxItems":5,"title":"keywords","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.advanced.seo.SeoSchema.Keyword"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Settings","description":""},"com.wix.stores.catalog.product.api.v3.ConnectedOption":{"type":"object","properties":{"id":{"description":"ID of a customization with `customizationType: PRODUCT_OPTION`.","minLength":1,"maxLength":36,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Option name.","minLength":1,"maxLength":50,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"optionRenderType":{"description":"Option render type.","title":"optionRenderType","type":"string","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ConnectedOption.ProductOptionRenderType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ConnectedOption","description":"","oneOf":[{"description":"","summary":"optionSettings","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ConnectedOption.optionSettings"}]},"com.wix.stores.catalog.product.api.v3.ConnectedOption.optionSettings":{"type":"object","title":"optionSettings","properties":{"choicesSettings":{"description":"Choices settings.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ChoicesSettings","summary":"choicesSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.stores.catalog.product.api.v3.ConnectedOption.ProductOptionRenderType":{"type":"string","description":"","title":"ProductOptionRenderType","enum":["UNKNOWN_OPTION_RENDER_TYPE","TEXT_CHOICES","SWATCH_CHOICES"]},"com.wix.stores.catalog.product.api.v3.ChoicesSettings":{"type":"object","properties":{"choices":{"description":"List of available choices for the option.","minItems":1,"maxItems":100,"immutable":true,"title":"choices","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ConnectedOptionChoice"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ChoicesSettings","description":""},"com.wix.stores.catalog.product.api.v3.ConnectedOptionChoice":{"type":"object","properties":{"choiceId":{"description":"The id of the choice.","format":"GUID","title":"choiceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"linkedMedia":{"description":"Product media overrides. When not empty only these images will be shown when such choices selected by customer. Otherwise all images of product.\nWhen several choices from different options selected only media filter present in `media_overrides` of ALL choices will be shown.\nFor example if Color:red has images 1,2,3 and Material:Silk has images 2,3,5 then only images 2,3 will be shown when both of them selected.","maxItems":100,"title":"linkedMedia","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ProductMedia"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"choiceType":{"description":"The type of this choice.","title":"choiceType","type":"string","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ChoiceType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Choice name.","minLength":1,"maxLength":50,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"inStock":{"description":"A flag that indicates if at least one variant with this choice is in stock in the default store's location.\nFor example, a product with 'Color' and 'Size' options with variants: [Blue, Small] which is out of stock and [Red Large] which is in stock. For choice 'Blue' ths flag will be 'false' and for 'Red' the flag will be true","readOnly":true,"title":"inStock","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"visible":{"description":"Whether at least one variant with this choice is visible.\n\nDefault: `false`","readOnly":true,"title":"visible","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ConnectedOptionChoice","description":"","oneOf":[{"description":"","summary":"value","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ConnectedOptionChoice.value"}]},"com.wix.stores.catalog.product.api.v3.ConnectedOptionChoice.value":{"type":"object","title":"value","properties":{"colorCode":{"description":"Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).","minLength":3,"maxLength":20,"title":"colorCode","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.stores.catalog.product.api.v3.ChoiceType":{"type":"string","description":"","title":"ChoiceType","enum":["UNKNOWN_CHOICE_TYPE","CHOICE_TEXT","ONE_COLOR","MULTIPLE_COLORS","IMAGE"]},"com.wix.stores.catalog.product.api.v3.MultipleColors":{"type":"object","properties":{"colorCodes":{"description":"List of color codes.","minLength":3,"maxLength":20,"minItems":2,"maxItems":2,"title":"colorCodes","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MultipleColors","description":""},"com.wix.stores.catalog.product.api.v3.ConnectedModifier":{"type":"object","properties":{"id":{"description":"ID of a customization with `customizationType: MODIFIER`.","minLength":1,"maxLength":36,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Modifier title.","minLength":1,"maxLength":50,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"modifierRenderType":{"description":"Modifier render type.","title":"modifierRenderType","type":"string","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ConnectedModifier.ModifierRenderType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mandatory":{"description":"Whether customer input is required for this modifier.","title":"mandatory","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ConnectedModifier","description":"","oneOf":[{"description":"","summary":"modifierSettings","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ConnectedModifier.modifierSettings"}]},"com.wix.stores.catalog.product.api.v3.ConnectedModifier.modifierSettings":{"type":"object","title":"modifierSettings","properties":{"freeTextSettings":{"description":"Free text modifier settings.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.FreeTextSettings","summary":"freeTextSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"choicesSettings":{"description":"Choice settings.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ModifierChoicesSettings","summary":"choicesSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.stores.catalog.product.api.v3.ConnectedModifier.ModifierRenderType":{"type":"string","description":"","title":"ModifierRenderType","enum":["UNKNOWN_MODIFIER_RENDER_TYPE","FREE_TEXT","TEXT_CHOICES","SWATCH_CHOICES"]},"com.wix.stores.catalog.product.api.v3.FreeTextSettings":{"type":"object","properties":{"minCharCount":{"description":"Minimum number of characters.","title":"minCharCount","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"maxCharCount":{"description":"Maximum number of characters.","maximum":500,"title":"maxCharCount","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"defaultAddedPrice":{"description":"Default amount to be added to the product's price.","title":"defaultAddedPrice","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0","lte":"999999999","maxScale":3}}},"title":{"description":"Title of the text to be input by the customer.","minLength":1,"maxLength":150,"title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FreeTextSettings","description":""},"com.wix.stores.catalog.product.api.v3.ModifierChoicesSettings":{"type":"object","properties":{"choices":{"description":"List of modifier choices.","minItems":1,"maxItems":100,"immutable":true,"title":"choices","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ConnectedModifierChoice"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ModifierChoicesSettings","description":""},"com.wix.stores.catalog.product.api.v3.ConnectedModifierChoice":{"type":"object","properties":{"choiceId":{"description":"Choice ID.","format":"GUID","title":"choiceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"linkedMedia":{"description":"Product media.","maxItems":100,"title":"linkedMedia","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ProductMedia"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"choiceType":{"description":"Choice type.","title":"choiceType","type":"string","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ChoiceType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"key":{"description":"Modifier key. Used for eCommerce integration.","readOnly":true,"minLength":1,"maxLength":50,"title":"key","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Choice name.","minLength":1,"maxLength":50,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"addedPrice":{"description":"Added price.","title":"addedPrice","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0","lte":"999999999","maxScale":3}}}},"title":"ConnectedModifierChoice","description":"","oneOf":[{"description":"","summary":"value","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ConnectedModifierChoice.value"}]},"com.wix.stores.catalog.product.api.v3.ConnectedModifierChoice.value":{"type":"object","title":"value","properties":{"colorCode":{"description":"Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).","minLength":3,"maxLength":20,"title":"colorCode","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.stores.catalog.product.api.v3.Brand":{"type":"object","properties":{"id":{"description":"Brand ID.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Brand name.","maxLength":50,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Brand","description":""},"com.wix.stores.catalog.product.api.v3.InfoSection":{"type":"object","properties":{"id":{"description":"Info section ID.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"uniqueName":{"description":"Info section unique name.\n> **Note:** Returned only when you pass `\"INFO_SECTION\"` to the `fields` array in Products API requests.","maxLength":100,"title":"uniqueName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Info section title.\n> **Note:** Returned only when you pass `\"INFO_SECTION\"` to the `fields` array in Products API requests.","minLength":1,"maxLength":50,"readOnly":true,"title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Info section description using rich content. Learn more about [Working with Rich Content](https://dev.wix.com/docs/go-headless/tutorials-templates/other-tutorials/working-with-rich-content).\n> **Note:** Returned only when you pass `\"INFO_SECTION_DESCRIPTION\"` to the `fields` array in Products API requests.","readOnly":true,"$ref":"#/components/schemas/wix.rich_content.v1.RichContent","summary":"description","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"plainDescription":{"description":"Info section description in HTML.\n\nWhen provided on create/update, this string must be a valid HTML. It will then be converted to rich content.\n`plainDescription` is ignored when value is also passed to the `description` field.\n> **Note:** Returned only when you pass `\"INFO_SECTION_PLAIN_DESCRIPTION\"` to the `fields` array in Products API requests.","maxLength":16000,"title":"plainDescription","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InfoSection","description":""},"com.wix.stores.catalog.product.api.v3.Ribbon":{"type":"object","properties":{"id":{"description":"Ribbon ID.","minLength":1,"maxLength":36,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Ribbon name.","maxLength":30,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Ribbon","description":""},"com.wix.stores.catalog.product.api.v3.ProductCategoriesInfo":{"type":"object","properties":{"categories":{"description":"A list of categories related to product.","readOnly":true,"maxItems":2000,"title":"categories","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ProductCategory"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ProductCategoriesInfo","description":""},"com.wix.stores.catalog.product.api.v3.ProductCategory":{"type":"object","properties":{"id":{"description":"Category ID.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"index":{"description":"Index location of the product within the category.","minimum":0,"maximum":200,"title":"index","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ProductCategory","description":""},"com.wix.stores.catalog.product.api.v3.PriceRange":{"type":"object","properties":{"minValue":{"description":"Minimum value.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.FixedMonetaryAmount","summary":"minValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"maxValue":{"description":"Maximum value.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.FixedMonetaryAmount","summary":"maxValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PriceRange","description":""},"com.wix.stores.catalog.product.api.v3.FixedMonetaryAmount":{"type":"object","properties":{"amount":{"description":"Monetary amount. For example, `\"3.99\"`, or `\"-4.99\"` for a negative amount.","title":"amount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0","lte":"999999999","maxScale":3}}},"formattedAmount":{"description":"Formatted monetary amount. For example, `\"$3.99\"`.\n> **Note:** Returned only when you pass `\"CURRENCY\"` to the `fields` array in Products API requests.","readOnly":true,"maxLength":20,"title":"formattedAmount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FixedMonetaryAmount","description":""},"com.wix.stores.catalog.product.api.v3.Inventory":{"type":"object","properties":{"availabilityStatus":{"description":"Current availability status.\n\n+ `IN_STOCK`: All variants are in stock and available for purchase\n+ `OUT_OF_STOCK`: All variants are out of stock\n+ `PARTIALLY_OUT_OF_STOCK`: Some variants are out of stock and some are in stock and available for purchase","readOnly":true,"title":"availabilityStatus","type":"string","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Inventory.AvailabilityStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"preorderStatus":{"description":"Current preorder status/\n\n+ `ENABLED`: All variants are enabled for preorder\n+ `DISABLED`: All variants are disabled for preorder\n+ `PARTIALLY_ENABLED`: Some variants are disabled and some are enabled for preorder","readOnly":true,"title":"preorderStatus","type":"string","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Inventory.PreorderStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Inventory","description":""},"com.wix.stores.catalog.product.api.v3.Inventory.AvailabilityStatus":{"type":"string","description":"","title":"AvailabilityStatus","enum":["UNKNOWN_AVAILABILITY_STATUS","IN_STOCK","OUT_OF_STOCK","PARTIALLY_OUT_OF_STOCK"]},"com.wix.stores.catalog.product.api.v3.Inventory.PreorderStatus":{"type":"string","description":"","title":"PreorderStatus","enum":["UNKNOWN_PREORDER_STATUS","ENABLED","DISABLED","PARTIALLY_ENABLED"]},"com.wix.stores.catalog.product.api.v3.ProductType":{"type":"string","description":"","title":"ProductType","enum":["UNKNOWN_PRODUCT_TYPE","PHYSICAL","DIGITAL"]},"com.wix.stores.catalog.product.api.v3.PhysicalProperties":{"type":"object","properties":{"pricePerUnit":{"description":"Price per unit settings.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.PricePerUnitSettings","summary":"pricePerUnit","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fulfillerId":{"description":"Fulfiller ID.","format":"GUID","title":"fulfillerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"shippingWeightRange":{"description":"Product shipping weight range - minimum and maximum weights of all the variants.","readOnly":true,"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.WeightRange","summary":"shippingWeightRange","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pricePerUnitRange":{"description":"Product price per unit range. The minimum and maximum price per unit of all the variants.","readOnly":true,"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.PricePerUnitRange","summary":"pricePerUnitRange","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"weightMeasurementUnitInfo":{"description":"Weight measurement unit.\n> **Note:** Returned only when you pass `\"WEIGHT_MEASUREMENT_UNIT_INFO\"` to the `fields` array in Products API requests.","readOnly":true,"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.WeightMeasurementUnitInfo","summary":"weightMeasurementUnitInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PhysicalProperties","description":""},"com.wix.stores.catalog.product.api.v3.PricePerUnitSettings":{"type":"object","properties":{"quantity":{"description":"Quantity.\nFor example, to define price per per 100 grams, set this field to `100`.","minimum":0.01,"maximum":999999999.99,"title":"quantity","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"measurementUnit":{"description":"Measurement unit.\nFor example, to define price per 100 grams, set this field to \"G\".","title":"measurementUnit","type":"string","$ref":"#/components/schemas/com.wix.ecommerce.commons.api.MeasurementUnitEnum.MeasurementUnit","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PricePerUnitSettings","description":""},"com.wix.ecommerce.commons.api.MeasurementUnitEnum.MeasurementUnit":{"type":"string","description":"","title":"MeasurementUnit","enum":["UNSPECIFIED","ML","CL","L","CBM","MG","G","KG","MM","CM","M","SQM","OZ","LB","FLOZ","PT","QT","GAL","IN","FT","YD","SQFT"]},"com.wix.stores.catalog.product.api.v3.WeightRange":{"type":"object","properties":{"minValue":{"description":"Minimum weight across all variants associated with this product.","minimum":0,"maximum":999999999.99,"title":"minValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"maxValue":{"description":"Maximum weight across all variants associated with this product.","minimum":0,"maximum":999999999.99,"title":"maxValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"WeightRange","description":""},"com.wix.stores.catalog.product.api.v3.PricePerUnitRange":{"type":"object","properties":{"minValue":{"description":"Minimum price per unit across all variants.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.PricePerUnitRange.PricePerUnit","summary":"minValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"maxValue":{"description":"Maximum price per unit across all variants.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.PricePerUnitRange.PricePerUnit","summary":"maxValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PricePerUnitRange","description":""},"com.wix.stores.catalog.product.api.v3.PricePerUnitRange.PricePerUnit":{"type":"object","properties":{"value":{"description":"Calculated value of price per unit. Takes into account pricePerUnit settings of product and variants and sale price of variants.\nFor example if discounted price is 2$, product's price per unit setting is 1 Kg, variant price per unit setting is 0.5 Kg then this value is 4$ (means variant weight is 0.5 Kg and it costs 2$ but we want to show price per 1 Kg so we show 4$).","readOnly":true,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0","lte":"999999999","maxScale":3}}},"description":{"description":"Price per unit info in the format of variant specific data / product setting, for example €4.00 / 1 Kg.\n> **Note:** This field is returned by the API only when you pass `fields: \"CURRENCY\"` in a request.","readOnly":true,"maxLength":100,"title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PricePerUnit","description":""},"com.wix.stores.catalog.product.api.v3.WeightMeasurementUnitInfo":{"type":"object","properties":{"weightMeasurementUnit":{"description":"Weight measurement unit.","readOnly":true,"title":"weightMeasurementUnit","type":"string","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.WeightUnit","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"WeightMeasurementUnitInfo","description":""},"com.wix.ecommerce.platform_common.api.WeightUnit":{"type":"string","description":"","title":"WeightUnit","enum":["UNSPECIFIED_WEIGHT_UNIT","KG","LB"]},"com.wix.stores.catalog.product.api.v3.BreadcrumbsInfo":{"type":"object","properties":{"breadcrumbs":{"description":"Breadcrumbs.","readOnly":true,"maxItems":5,"title":"breadcrumbs","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.BreadCrumb"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BreadcrumbsInfo","description":""},"com.wix.stores.catalog.product.api.v3.BreadCrumb":{"type":"object","properties":{"categoryId":{"description":"Category ID.","format":"GUID","title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"categoryName":{"description":"Category name.","minLength":1,"maxLength":80,"title":"categoryName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"categorySlug":{"description":"Category slug.","minLength":1,"maxLength":100,"title":"categorySlug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BreadCrumb","description":""},"com.wix.stores.catalog.product.api.v3.VariantsInfo":{"type":"object","properties":{"variants":{"description":"List of related variants.","minItems":1,"maxItems":1000,"title":"variants","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Variant"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"VariantsInfo","description":""},"com.wix.stores.catalog.product.api.v3.Variant":{"type":"object","properties":{"id":{"description":"Variant ID.","format":"GUID","immutable":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"visible":{"description":"Whether the variant is visible to site visitors.\n\nDefault: `true`","title":"visible","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sku":{"description":"Variant SKU (stock keeping unit).","minLength":1,"maxLength":40,"title":"sku","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"barcode":{"description":"Variant barcode.","minLength":1,"maxLength":40,"title":"barcode","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"choices":{"description":"List of choices.\nIn case this list is empty, this is the default variant of an unmanaged product.","minItems":0,"maxItems":6,"immutable":true,"title":"choices","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.OptionChoice"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"price":{"description":"Variant price.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.PriceInfo","summary":"price","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revenueDetails":{"description":"Variant revenue details.\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.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.RevenueDetails","summary":"revenueDetails","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"media":{"description":"Variant media.","readOnly":true,"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ProductMedia","summary":"media","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"subscriptionPricesInfo":{"description":"Subscription prices calculated by applying subscription discount to the variant `price.salePrice`.\n> **Note:** Returned only when you pass `\"SUBSCRIPTION_PRICES_INFO\"` to the `fields` array in Products API requests.","readOnly":true,"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.SubscriptionPricesInfo","summary":"subscriptionPricesInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"inventoryStatus":{"description":"Variant inventory status.","readOnly":true,"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.InventoryStatus","summary":"inventoryStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Variant","description":"","oneOf":[{"description":"","summary":"typedProperties","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Variant.typedProperties"}]},"com.wix.stores.catalog.product.api.v3.Variant.typedProperties":{"type":"object","title":"typedProperties","properties":{"physicalProperties":{"description":"Physical properties. Must be passed when `productType: PHYSICAL`","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.VariantPhysicalProperties","summary":"physicalProperties","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"digitalProperties":{"description":"Digital properties. Must be passed when `productType: DIGITAL`","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.VariantDigitalProperties","summary":"digitalProperties","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.stores.catalog.product.api.v3.OptionChoice":{"type":"object","properties":{"optionChoiceIds":{"description":"Option and choice IDs.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.OptionChoiceIds","summary":"optionChoiceIds","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"optionChoiceNames":{"description":"Option and choice names.\n> **Note:** Returned only when you pass `\"VARIANT_OPTION_CHOICE_NAMES\"` to the `fields` array in Products API requests.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.OptionChoiceNames","summary":"optionChoiceNames","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"OptionChoice","description":""},"com.wix.stores.catalog.product.api.v3.OptionChoiceIds":{"type":"object","properties":{"optionId":{"description":"Option ID.","minLength":1,"maxLength":36,"immutable":true,"title":"optionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"choiceId":{"description":"","format":"GUID","immutable":true,"title":"choiceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"OptionChoiceIds","description":""},"com.wix.stores.catalog.product.api.v3.OptionChoiceNames":{"type":"object","properties":{"optionName":{"description":"Option name.","minLength":1,"maxLength":50,"title":"optionName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"choiceName":{"description":"Choice name.","minLength":1,"maxLength":50,"title":"choiceName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"renderType":{"description":"Render type.","title":"renderType","type":"string","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ConnectedOption.ProductOptionRenderType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"OptionChoiceNames","description":""},"com.wix.stores.catalog.product.api.v3.PriceInfo":{"type":"object","properties":{"basePrice":{"description":"Variant price. Must be greater or equal to 0.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.FixedMonetaryAmount","summary":"basePrice","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"salePrice":{"description":"Variant sale price. If not provided, sale price will be equal to `basePrice`. When provided, value must be greater or equal to 0, and less than or equal to `basePrice`.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.FixedMonetaryAmount","summary":"salePrice","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PriceInfo","description":""},"com.wix.stores.catalog.product.api.v3.RevenueDetails":{"type":"object","properties":{"cost":{"description":"Item cost.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.FixedMonetaryAmount","summary":"cost","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"profit":{"description":"Profit. Calculated by reducing `cost` from `discountedPrice`.","readOnly":true,"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.FixedMonetaryAmount","summary":"profit","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"profitMargin":{"description":"Profit Margin. Calculated by dividing `profit` by `discountedPrice`.\nThe result is rounded to 4 decimal places.","readOnly":true,"minimum":0,"maximum":1,"title":"profitMargin","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RevenueDetails","description":""},"com.wix.stores.catalog.product.api.v3.VariantPhysicalProperties":{"type":"object","properties":{"weight":{"description":"Variant shipping weight.","minimum":0,"maximum":999999999.99,"title":"weight","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pricePerUnit":{"description":"Price per unit info, in order to show price per unit on the product page.\nFor example if one sells cheese and defines 100g here then we know that buying this variant buyer receives 100g of cheese.\nBut on product page price will be displayed for units defined on product level. See `pricePerUnit.value` to understand how it's calculated.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.PricePerUnit","summary":"pricePerUnit","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"VariantPhysicalProperties","description":""},"com.wix.stores.catalog.product.api.v3.PricePerUnit":{"type":"object","properties":{"settings":{"description":"Price per unit data for this variant.\n`measurementUnit` value must correspond to the measurement unit set on the product.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.PricePerUnitSettings","summary":"settings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"value":{"description":"Calculated value of price per unit. Takes into account `pricePerUnit` settings of parent product, of this variant, and discounted price of variant.\nFor example if discounted price is 2$, product's price per unit setting is 1 Kg, variant price per unit setting is 0.5 Kg then this value is 4$ (means variant weight is 0.5 Kg and it costs 2$ but we want to show price per 1 Kg so we show 4$).","readOnly":true,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0","lte":"999999999","maxScale":3}}},"description":{"description":"Price per unit description.\n> **Note:** Returned only when you pass `\"CURRENCY\"` to the `fields` array in Products API requests.","readOnly":true,"maxLength":100,"title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PricePerUnit","description":""},"com.wix.stores.catalog.product.api.v3.VariantDigitalProperties":{"type":"object","properties":{"digitalFile":{"description":"Digital file which will be downloaded by customer after successful purchase.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.SecuredMedia","summary":"digitalFile","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"VariantDigitalProperties","description":""},"com.wix.stores.catalog.product.api.v3.SecuredMedia":{"type":"object","properties":{"id":{"description":"Media ID in media manager.","minLength":1,"maxLength":100,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fileName":{"description":"Original file name.","minLength":1,"maxLength":1000,"readOnly":true,"title":"fileName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fileSize":{"description":"Original file size.","minLength":1,"maxLength":1000,"readOnly":true,"format":"DECIMAL_VALUE","title":"fileSize","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"maxScale":0}}},"fileType":{"description":"File type.","readOnly":true,"title":"fileType","type":"string","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.SecuredMedia.FileType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SecuredMedia","description":""},"com.wix.stores.catalog.product.api.v3.SecuredMedia.FileType":{"type":"string","description":"","title":"FileType","enum":["UNSPECIFIED","SECURE_PICTURE","SECURE_VIDEO","SECURE_DOCUMENT","SECURE_MUSIC","SECURE_ARCHIVE"]},"com.wix.stores.catalog.product.api.v3.SubscriptionPricesInfo":{"type":"object","properties":{"subscriptionPrices":{"description":"Subscription prices.","maxItems":6,"title":"subscriptionPrices","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.SubscriptionPrice"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SubscriptionPricesInfo","description":""},"com.wix.stores.catalog.product.api.v3.SubscriptionPrice":{"type":"object","properties":{"subscriptionId":{"description":"Subscription ID.","format":"GUID","readOnly":true,"title":"subscriptionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"price":{"description":"Subscription price calculated by applying subscription discount to the variant `price.salePrice`","readOnly":true,"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.FixedMonetaryAmount","summary":"price","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pricePerUnit":{"description":"Price per unit info.","readOnly":true,"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.SubscriptionPricePerUnit","summary":"pricePerUnit","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SubscriptionPrice","description":""},"com.wix.stores.catalog.product.api.v3.SubscriptionPricePerUnit":{"type":"object","properties":{"value":{"description":"Calculated value of price per unit. Takes into account `pricePerUnit` settings of parent product, `pricePerUnit` settings of this variant, and the variant subscription price.","readOnly":true,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0","lte":"999999999","maxScale":3}}},"description":{"description":"Price per unit description.\n> **Note:** Returned only when you pass `\"CURRENCY\"` to the `fields` array in Products API requests.","readOnly":true,"maxLength":20,"title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SubscriptionPricePerUnit","description":""},"com.wix.stores.catalog.product.api.v3.InventoryStatus":{"type":"object","properties":{"inStock":{"description":"Whether the variant is in stock.","title":"inStock","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"preorderEnabled":{"description":"Whether preorder is enabled for this variant.","title":"preorderEnabled","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InventoryStatus","description":""},"wix.common.data.dataextensions.ExtendedFields":{"type":"object","properties":{"namespaces":{"description":"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).","title":"namespaces","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Struct"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ExtendedFields","description":""},"com.wix.stores.catalog.product.api.v3.SubscriptionDetails":{"type":"object","properties":{"subscriptions":{"description":"Subscriptions.","minItems":1,"maxItems":6,"title":"subscriptions","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Subscription"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"allowOneTimePurchases":{"description":"Whether to allow one-time purchases in addition to subscription-based purchases.\n\nDefault: `false`","title":"allowOneTimePurchases","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SubscriptionDetails","description":""},"com.wix.stores.catalog.product.api.v3.Subscription":{"type":"object","properties":{"id":{"description":"Subscription ID.","format":"GUID","immutable":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Subscription title.","minLength":1,"maxLength":20,"title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Subscription description.","maxLength":60,"title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"visible":{"description":"Whether the subscription is visible to site visitors.\n\nDefault: `true`","title":"visible","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"frequency":{"description":"Frequency of recurring payment.\nFor example, if `frequency: MONTH` and `billingCycles: 6`; payment will be made monthly for 6 months.","title":"frequency","type":"string","$ref":"#/components/schemas/wix.payment.api.pay.v2.SubscriptionFrequency","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"interval":{"description":"Interval of recurring payment. Default: `1`. For example, if `frequency: MONTH`, `billingCycles: 3` and `interval: 2`; payment will be made every 2 months for a total of 6 months.","minimum":1,"maximum":50,"title":"interval","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"discount":{"description":"Discount info (optional).\nFor example, a $20 discount would be `amount: 20`, `type: AMOUNT`.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.SubscriptionDiscount","summary":"discount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Subscription","description":"","oneOf":[{"description":"","summary":"cycles","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Subscription.cycles"}]},"com.wix.stores.catalog.product.api.v3.Subscription.cycles":{"type":"object","title":"cycles","properties":{"autoRenewal":{"description":"Whether subscription is renewed automatically at the end of each period. Cannot be `false`, instead set `billingCycles`.","title":"autoRenewal","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"billingCycles":{"description":"Number of billing cycles before subscription ends.","minimum":2,"maximum":999,"title":"billingCycles","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.payment.api.pay.v2.SubscriptionFrequency":{"type":"string","description":"Frequency unit of recurring payment","title":"SubscriptionFrequency","enum":["UNDEFINED","DAY","WEEK","MONTH","YEAR"]},"com.wix.stores.catalog.product.api.v3.SubscriptionDiscount":{"type":"object","properties":{"type":{"description":"Discount type.","title":"type","type":"string","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.SubscriptionDiscount.DiscountType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SubscriptionDiscount","description":"","oneOf":[{"description":"","summary":"discount","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.SubscriptionDiscount.discount"}]},"com.wix.stores.catalog.product.api.v3.SubscriptionDiscount.discount":{"type":"object","title":"discount","properties":{"amountOff":{"description":"Amount to discount from the variant discounted_price.","title":"amountOff","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gt":"0","lte":"999999999","maxScale":3}}},"percentOff":{"description":"Percentage to discount from variant discounted_price.","minimum":0.1,"maximum":99.9,"title":"percentOff","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.stores.catalog.product.api.v3.SubscriptionDiscount.DiscountType":{"type":"string","description":"","title":"DiscountType","enum":["UNKNOWN_DISCOUNT","AMOUNT","PERCENT"]},"com.wix.stores.catalog.product.api.v3.VariantSummary":{"type":"object","properties":{"variantCount":{"description":"The total number of variants for the product.","readOnly":true,"title":"variantCount","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"VariantSummary","description":""},"com.wix.stores.catalog.product.api.v3.MinVariantPriceInfo":{"type":"object","properties":{"basePrice":{"description":"Variant price. Must be greater or equal to 0.","readOnly":true,"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.FixedMonetaryAmount","summary":"basePrice","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"salePrice":{"description":"Variant sale price. If not provided, sale price will be equal to `basePrice`. When provided, value must be greater or equal to 0, and less than or equal to `basePrice`.","readOnly":true,"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.FixedMonetaryAmount","summary":"salePrice","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"minSubscriptionPrice":{"description":"Subscription price calculated by applying subscription discount to the variant `price.salePrice`","readOnly":true,"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.FixedMonetaryAmount","summary":"minSubscriptionPrice","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"minSubscriptionPricePerUnit":{"description":"Subscription price per unit calculated value of price per unit.\nTakes into account `pricePerUnit` settings of parent product, `pricePerUnit` settings of this variant, and the variant subscription price.","readOnly":true,"title":"minSubscriptionPricePerUnit","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0","lte":"999999999","maxScale":3}}},"pricePerUnit":{"description":"Variant price per unit. Takes into account `pricePerUnit` settings of parent product, of this variant, and discounted price of variant.","readOnly":true,"title":"pricePerUnit","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0","lte":"999999999","maxScale":3}}}},"title":"MinVariantPriceInfo","description":""},"wix.search.v1.UpdateDocumentsEvent":{"type":"object","properties":{"appDefId":{"description":"application which owns documents","minLength":2,"title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"documentType":{"description":"type of the documents","minLength":2,"title":"documentType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"language of the documents","minLength":2,"title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"msId":{"description":"site documents belong to","minLength":2,"title":"msId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateDocumentsEvent","description":"","oneOf":[{"description":"","summary":"operation","$ref":"#/components/schemas/wix.search.v1.UpdateDocumentsEvent.operation"}]},"wix.search.v1.UpdateDocumentsEvent.operation":{"type":"object","title":"operation","properties":{"update":{"description":"insert/update documents","$ref":"#/components/schemas/wix.search.v1.DocumentUpdateOperation","summary":"update","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deleteByIds":{"description":"delete by document ids","$ref":"#/components/schemas/wix.search.v1.DeleteByIdsOperation","summary":"deleteByIds","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deleteByFilter":{"description":"delete documents matching filter","$ref":"#/components/schemas/wix.search.v1.DeleteByFilterOperation","summary":"deleteByFilter","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updateByFilter":{"description":"update documents matching filter","$ref":"#/components/schemas/wix.search.v1.UpdateByFilterOperation","summary":"updateByFilter","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updateExisting":{"description":"update only existing documents","$ref":"#/components/schemas/wix.search.v1.UpdateExistingOperation","summary":"updateExisting","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.search.v1.DocumentUpdateOperation":{"type":"object","properties":{"documents":{"description":"documents to index or update","title":"documents","type":"array","items":{"$ref":"#/components/schemas/wix.search.v1.IndexDocument"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DocumentUpdateOperation","description":""},"wix.search.v1.IndexDocument":{"type":"object","properties":{"payload":{"description":"data bag with non-searchable fields (url, image)","$ref":"#/components/schemas/wix.search.v1.DocumentPayload","summary":"payload","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"exposure":{"description":"what type of users should documents be visible to","title":"exposure","type":"string","$ref":"#/components/schemas/wix.search.v1.DocumentExposureType.Enum","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"document":{"description":"document with mandatory fields (id, title, description) and with fields specific to the type of the document","title":"document","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"permittedMemberGroups":{"description":"what member groups is the document exposed to. Used only with GROUP_PROTECTED exposure","title":"permittedMemberGroups","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"seoHidden":{"description":"if true SEO is disabled for this document","title":"seoHidden","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"isPopup":{"description":"if true the page is a lightbox popup","title":"isPopup","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IndexDocument","description":""},"wix.search.v1.DocumentPayload":{"type":"object","properties":{"url":{"description":"url of the page representing the document","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"documentImage":{"description":"image which represents the document","$ref":"#/components/schemas/wix.search.v1.DocumentImage","summary":"documentImage","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DocumentPayload","description":""},"wix.search.v1.DocumentImage":{"type":"object","properties":{"name":{"description":"the name of the image","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"the width of the image","title":"width","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"the height of the image","title":"height","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DocumentImage","description":""},"wix.search.v1.DocumentExposureType.Enum":{"type":"string","description":"","title":"Enum","enum":["UNKNOWN","PROTECTED","PRIVATE","PUBLIC","UNCHANGED","GROUP_PROTECTED"]},"wix.search.v1.DeleteByIdsOperation":{"type":"object","properties":{"documentIds":{"description":"ids of the documents to delete","title":"documentIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteByIdsOperation","description":""},"wix.search.v1.DeleteByFilterOperation":{"type":"object","properties":{"filter":{"description":"documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteByFilterOperation","description":""},"wix.search.v1.UpdateByFilterOperation":{"type":"object","properties":{"filter":{"description":"documents matching this filter will be updated","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"document":{"description":"partial document to apply","$ref":"#/components/schemas/wix.search.v1.IndexDocument","summary":"document","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateByFilterOperation","description":""},"wix.search.v1.UpdateExistingOperation":{"type":"object","properties":{"documents":{"description":"documents to update","title":"documents","type":"array","items":{"$ref":"#/components/schemas/wix.search.v1.IndexDocument"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateExistingOperation","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"restoreInfo":{"description":"Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity","$ref":"#/components/schemas/wix.common.domainevents.RestoreInfo","summary":"restoreInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.RestoreInfo":{"type":"object","properties":{"deletedDate":{"description":"","title":"deletedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestoreInfo","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"google.protobuf.Empty":{"type":"object","properties":{},"title":"Empty","description":""},"wix.search.v1.SearchIndexingNotification":{"type":"object","properties":{"indexState":{"description":"new state of indexing for the site specified in ms_id","title":"indexState","type":"string","$ref":"#/components/schemas/wix.search.v1.SearchIndexingNotification.State","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"documentType":{"description":"type of the document the notification is targeted for. Applies to all types if not provided","title":"documentType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"languaInternalDocumentUpdateByFilterOperationge the notification is targeted for. Applies to all languages if not provided","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"msId":{"description":"site for which notification is targeted","minLength":2,"title":"msId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SearchIndexingNotification","description":""},"wix.search.v1.SearchIndexingNotification.State":{"type":"string","description":"","title":"State","enum":["Unknown","Off","On"]},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":["UNKNOWN","ANONYMOUS_VISITOR","MEMBER","WIX_USER","APP"]},"wix.stores.catalog.v3.CreateProductRequest":{"type":"object","properties":{"product":{"description":"Product to create.\n\nAt least 1 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/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"}}},"title":"CreateProductRequest","description":""},"com.wix.stores.catalog.product.api.v3.SingleEntityOps.RequestedFields":{"type":"string","description":"","title":"RequestedFields","enum":["UNKNOWN_REQUESTED_FIELD","URL","CURRENCY","INFO_SECTION","MERCHANT_DATA","PLAIN_DESCRIPTION","INFO_SECTION_PLAIN_DESCRIPTION","SUBSCRIPTION_PRICES_INFO","VARIANTS_INFO","BREADCRUMBS_INFO","WEIGHT_MEASUREMENT_UNIT_INFO","VARIANT_OPTION_CHOICE_NAMES","MEDIA_ITEMS_INFO","DESCRIPTION","DIRECT_CATEGORIES_INFO","ALL_CATEGORIES_INFO","MIN_VARIANT_PRICE_INFO","INFO_SECTION_DESCRIPTION"]},"wix.stores.catalog.v3.CreateProductResponse":{"type":"object","properties":{"product":{"description":"Created product.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product","summary":"product","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateProductResponse","description":""},"com.wix.stores.catalog.product.api.v3.VariantsNotAlignedWithProduct":{"type":"object","properties":{"variants":{"description":"Variants not aligned with product","maxItems":1000,"title":"variants","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.VariantNotAlignedWithProduct"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"VariantsNotAlignedWithProduct","description":""},"com.wix.stores.catalog.product.api.v3.VariantNotAlignedWithProduct":{"type":"object","properties":{"variantId":{"description":"variant id","format":"GUID","title":"variantId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"errorDescription":{"description":"what's wrong with this specific variant","maxLength":200,"title":"errorDescription","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"VariantNotAlignedWithProduct","description":""},"wix.stores.catalog.v3.CreateProductWithInventoryRequest":{"type":"object","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 the full created 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.SingleEntityOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateProductWithInventoryRequest","description":""},"wix.stores.catalog.v3.ProductWithInventory":{"type":"object","properties":{"id":{"description":"Product ID.","minLength":1,"maxLength":36,"immutable":true,"readOnly":true,"title":"id","type":"string","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 with inventory.","readOnly":true,"title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Product name.","minLength":1,"maxLength":80,"title":"name","type":"string","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"plainDescription":{"description":"Product description in HTML.\n\n+ When provided on create/update, this string must be a valid HTML. It will then be converted to rich content.\n+ `plainDescription` is ignored when 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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"visible":{"description":"Whether the product is visible to site visitors on the site.\n\nDefault: `true`","title":"visible","type":"boolean","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","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"media":{"description":"Product media items.","$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.","format":"GUID","title":"taxGroupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"options":{"description":"Product options. Allows buyer to customize product, e.g. select Color, Size and so on.\nAlways generates variants: every variant must have exactly one choice related to each option.\nSince options and variants tightly coupled and rely on each other they usually should be provided together in all operations.\nFor existing options and choices provide ids only, all other data (e.g. names, title, types and so on) will be resolved for you by ids.\nIf you don't have ids it's ok to omit them but provide all other data instead. For existing options ids will be resolved, not existing options will be created.\n*None*: you cannot change name of existing option via this endpoint but you can do it by calling CustomizationService","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. Allows buyer to customize product, e.g. select Color, Size and so on similarly to `options` but with one main difference - `modifiers` never generate any variants.\nFor existing modifiers and choices provide ids only, all other data (e.g. names, title, types and so on) will be resolved for you by ids.\nIf you don't have ids it's ok to omit them but provide all other data instead. For existing modifiers ids will be resolved, not existing modifiers will be created.\n*None*: you cannot change name of existing modifier via this endpoint by passing id and changed name, if you pass id name will be ignored. If you want to update existing modifier name do it by calling CustomizationService","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.\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.\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.\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"}},"mainCategoryId":{"description":"Main category ID.","format":"GUID","title":"mainCategoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"productType":{"description":"Product type.\n\nWhen passing `productType: PHYSICAL`, you must also pass `physicalProperties`.","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.\nUnlike the product ID, the handle can be set by the user to ensure consistency across multiple platforms.\nIn case handle wasn't given, the handle will be automatically generated.","minLength":1,"maxLength":100,"immutable":true,"title":"handle","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"variantsInfo":{"description":"Product variants.\n\n> **Note:** Returned only when you pass `\"VARIANTS_INFO\"` to the `fields` array in Products API requests.","$ref":"#/components/schemas/wix.stores.catalog.v3.VariantsInfo","summary":"variantsInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"subscriptionDetails":{"description":"Subscription details.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.SubscriptionDetails","summary":"subscriptionDetails","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"extendedFields":{"description":"Custom extended fields for the product object.\n\n[Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the Wix Dev Center 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"}}},"title":"ProductWithInventory","description":"","oneOf":[{"description":"","summary":"typedProperties","$ref":"#/components/schemas/wix.stores.catalog.v3.ProductWithInventory.typedProperties"}]},"wix.stores.catalog.v3.ProductWithInventory.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"}}}},"wix.stores.catalog.v3.VariantsInfo":{"type":"object","properties":{"variants":{"description":"List of related variants.\nPartial update of variants is not supported so on update you must pass all data for all of them.\nIf you want to update existing variant you must provide `id`, otherwise new variant with different id will be created which might break some integrations that rely on variant ids.","minItems":1,"maxItems":1000,"title":"variants","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.v3.VariantWithInventory"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"VariantsInfo","description":""},"wix.stores.catalog.v3.VariantWithInventory":{"type":"object","properties":{"id":{"description":"Variant ID.","format":"GUID","immutable":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"visible":{"description":"Whether the variant is visible to site visitors.\n\nDefault: `true`","title":"visible","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sku":{"description":"Variant SKU (stock keeping unit).","minLength":1,"maxLength":40,"title":"sku","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"barcode":{"description":"Variant barcode.","minLength":1,"maxLength":40,"title":"barcode","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"price":{"description":"Variant price.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.PriceInfo","summary":"price","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revenueDetails":{"description":"Variant revenue details.\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.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.RevenueDetails","summary":"revenueDetails","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"inventoryItem":{"description":"Inventory item of the variant on the default location.","$ref":"#/components/schemas/wix.stores.catalog.v3.InventoryItemComposite","summary":"inventoryItem","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"choices":{"description":"List of choices.","minItems":0,"maxItems":6,"immutable":true,"title":"choices","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.v3.OptionChoiceReferences"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"VariantWithInventory","description":"","oneOf":[{"description":"","summary":"typedProperties","$ref":"#/components/schemas/wix.stores.catalog.v3.VariantWithInventory.typedProperties"}]},"wix.stores.catalog.v3.VariantWithInventory.typedProperties":{"type":"object","title":"typedProperties","properties":{"physicalProperties":{"description":"Physical properties. Must be passed when `productType: PHYSICAL`","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.VariantPhysicalProperties","summary":"physicalProperties","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"digitalProperties":{"description":"Digital properties. Must be passed when `productType: DIGITAL`","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.VariantDigitalProperties","summary":"digitalProperties","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.stores.catalog.v3.InventoryItemComposite":{"type":"object","properties":{"id":{"description":"Inventory item ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Inventory item revision.","readOnly":true,"title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"preorderInfo":{"description":"Item preorder info.","$ref":"#/components/schemas/com.wix.stores.catalog.inventory.api.v3.PreorderInfo","summary":"preorderInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InventoryItemComposite","description":"","oneOf":[{"description":"","summary":"trackingMethod","$ref":"#/components/schemas/wix.stores.catalog.v3.InventoryItemComposite.trackingMethod"}]},"wix.stores.catalog.v3.InventoryItemComposite.trackingMethod":{"type":"object","title":"trackingMethod","properties":{"inStock":{"description":"Tracking method - in stock.\n\nWhen set to `true`, the item is available for sale without a quantity limit.","title":"inStock","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"quantity":{"description":"Tracking method - quantity left in inventory.\n\nQuantity can be negative when decrementing inventory for an order that has already been paid.","minimum":-100000,"maximum":1000000,"title":"quantity","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.stores.catalog.inventory.api.v3.PreorderInfo":{"type":"object","properties":{"enabled":{"description":"Whether preorder is enabled for the product.\n\nDefault: `false`","title":"enabled","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"message":{"description":"A message the customer will see when the item is out of stock and preorder is enabled.","minLength":1,"maxLength":250,"title":"message","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"limit":{"description":"Number of products that can be preordered after stock reaches zero.\nSupported only for inventory items with `trackQuantity = true`.\n\nDefault: `100000`","minimum":0,"maximum":100000,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"counter":{"description":"Number of times the product was preordered.\n\nSupported only for inventory items with `trackQuantity = true`.","readOnly":true,"minimum":0,"maximum":1000000,"title":"counter","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"quantity":{"description":"Quantity of products that can be preordered.\n\nSupported only for inventory items with `trackQuantity = true`.","readOnly":true,"title":"quantity","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PreorderInfo","description":""},"wix.stores.catalog.v3.OptionChoiceReferences":{"type":"object","properties":{"optionChoiceIds":{"description":"Option and choice IDs.","$ref":"#/components/schemas/wix.stores.catalog.v3.OptionChoiceIds","summary":"optionChoiceIds","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"optionChoiceNames":{"description":"Option and choice names.","$ref":"#/components/schemas/wix.stores.catalog.v3.OptionChoiceNames","summary":"optionChoiceNames","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"OptionChoiceReferences","description":""},"wix.stores.catalog.v3.OptionChoiceIds":{"type":"object","properties":{"optionId":{"description":"Option ID.","minLength":1,"maxLength":36,"immutable":true,"title":"optionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"choiceId":{"description":"Choice ID.","format":"GUID","immutable":true,"title":"choiceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"OptionChoiceIds","description":""},"wix.stores.catalog.v3.OptionChoiceNames":{"type":"object","properties":{"optionName":{"description":"Option name.","minLength":1,"maxLength":50,"title":"optionName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"choiceName":{"description":"Choice name.","minLength":1,"maxLength":50,"title":"choiceName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"renderType":{"description":"Render type.","title":"renderType","type":"string","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ConnectedOption.ProductOptionRenderType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"OptionChoiceNames","description":""},"wix.stores.catalog.v3.CreateProductWithInventoryResponse":{"type":"object","properties":{"product":{"description":"Created product.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product","summary":"product","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"inventoryResults":{"description":"Inventories created by bulk action.","$ref":"#/components/schemas/wix.stores.catalog.v3.BulkInventoryItemResults","summary":"inventoryResults","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateProductWithInventoryResponse","description":""},"wix.stores.catalog.v3.BulkInventoryItemResults":{"type":"object","properties":{"results":{"description":"Inventories modified by bulk action.","minItems":0,"maxItems":1000,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.inventory.api.v3.BulkInventoryItemResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"error":{"description":"Error details in case of failed action.","$ref":"#/components/schemas/wix.api.ApplicationError","summary":"error","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkInventoryItemResults","description":""},"com.wix.stores.catalog.inventory.api.v3.BulkInventoryItemResult":{"type":"object","properties":{"itemMetadata":{"description":"Bulk action metadata for inventory item.","$ref":"#/components/schemas/wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"item":{"description":"Full inventory item entity.\n\nReturned only if `returnEntity: true` is passed in the request.","$ref":"#/components/schemas/com.wix.stores.catalog.inventory.api.v3.InventoryItem","summary":"item","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkInventoryItemResult","description":""},"wix.common.ItemMetadata":{"type":"object","properties":{"id":{"description":"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originalIndex":{"description":"Index of the item within the request array. Allows for correlation between request and response items.","title":"originalIndex","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"success":{"description":"Whether the requested action was successful for this item. When `false`, the `error` field is populated.","title":"success","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"error":{"description":"Details about the error in case of failure.","$ref":"#/components/schemas/wix.api.ApplicationError","summary":"error","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemMetadata","description":""},"wix.api.ApplicationError":{"type":"object","properties":{"code":{"description":"Error code.","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Description of the error.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Data related to the error.","title":"data","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ApplicationError","description":""},"com.wix.stores.catalog.inventory.api.v3.InventoryItem":{"type":"object","properties":{"id":{"description":"Inventory item ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time the inventory item is updated.\nTo prevent conflicting changes,\nthe current revision must be passed when updating the inventory item.\n\nIgnored when creating an inventory item.","readOnly":true,"title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the inventory item was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the inventory item was created.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"variantId":{"description":"Variant ID.","format":"GUID","immutable":true,"title":"variantId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"locationId":{"description":"Stores location ID.","format":"GUID","immutable":true,"title":"locationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"productId":{"description":"Product ID.","minLength":1,"maxLength":36,"immutable":true,"title":"productId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"trackQuantity":{"description":"Whether the quantity is being tracked.","readOnly":true,"title":"trackQuantity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"availabilityStatus":{"description":"Inventory item availability status.\n\nSupported values:\n+ OUT_OF_STOCK: Product is out of stock.\n+ IN_STOCK: Product is in stock. See `quantity` field for exact amount in stock.\n+ PREORDER: Product is only available for preorder. See `preorderInfo` field for more info.","readOnly":true,"title":"availabilityStatus","type":"string","$ref":"#/components/schemas/com.wix.stores.catalog.inventory.api.v3.AvailabilityStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"preorderInfo":{"description":"Item preorder info.","$ref":"#/components/schemas/com.wix.stores.catalog.inventory.api.v3.PreorderInfo","summary":"preorderInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"product":{"description":"Product.","readOnly":true,"$ref":"#/components/schemas/com.wix.stores.catalog.inventory.api.v3.Product","summary":"product","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"extendedFields":{"description":"Custom field data for the inventory item object.\n\n[Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the Wix Dev Center 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"}}},"title":"InventoryItem","description":"Inventory Item.","oneOf":[{"description":"","summary":"trackingMethod","$ref":"#/components/schemas/com.wix.stores.catalog.inventory.api.v3.InventoryItem.trackingMethod"}]},"com.wix.stores.catalog.inventory.api.v3.InventoryItem.trackingMethod":{"type":"object","title":"trackingMethod","properties":{"inStock":{"description":"Tracking method - in stock.\n\nWhen set to `true`, the item is available for sale without a quantity limit.","title":"inStock","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"quantity":{"description":"Tracking method - quantity left in inventory.\n\nQuantity can be negative when decrementing inventory for an order that has already been paid.","minimum":-100000,"maximum":1000000,"title":"quantity","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.stores.catalog.inventory.api.v3.AvailabilityStatus":{"type":"string","description":"","title":"AvailabilityStatus","enum":["UNKNOWN_AVAILABILITY_STATUS","OUT_OF_STOCK","IN_STOCK","PREORDER"]},"com.wix.stores.catalog.inventory.api.v3.Product":{"type":"object","properties":{"name":{"description":"Product name.","maxLength":80,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"directCategoryIds":{"description":"List of category IDs that this product is included in directly.","format":"GUID","maxItems":2000,"title":"directCategoryIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"variantName":{"description":"Variant name.","minLength":1,"maxLength":250,"title":"variantName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"variantSku":{"description":"Variant SKU (stock keeping unit).","minLength":1,"maxLength":40,"title":"variantSku","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Product","description":""},"wix.stores.catalog.v3.upstream.wix.common.BulkActionMetadata":{"type":"object","properties":{"totalSuccesses":{"description":"Number of items that were successfully processed.","title":"totalSuccesses","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalFailures":{"description":"Number of items that couldn't be processed.","title":"totalFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"undetailedFailures":{"description":"Number of failures without details because detailed failure threshold was exceeded.","title":"undetailedFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkActionMetadata","description":""},"wix.stores.catalog.v3.UpdateProductRequest":{"type":"object","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"}}},"title":"UpdateProductRequest","description":""},"google.protobuf.FieldMask":{"type":"object","properties":{"paths":{"description":"","title":"paths","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FieldMask","description":""},"wix.stores.catalog.v3.UpdateProductResponse":{"type":"object","properties":{"product":{"description":"Updated product.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product","summary":"product","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateProductResponse","description":""},"com.wix.stores.catalog.product.api.v3.UnsupportedFieldMasks":{"type":"object","properties":{"fieldMasks":{"description":"Field masks provided in request but not supported","maxLength":1000,"maxItems":100,"title":"fieldMasks","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UnsupportedFieldMasks","description":""},"wix.stores.catalog.v3.UpdateProductWithInventoryRequest":{"type":"object","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 product entity 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"}}},"title":"UpdateProductWithInventoryRequest","description":""},"wix.stores.catalog.v3.UpdateProductWithInventoryResponse":{"type":"object","properties":{"product":{"description":"Updated product.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product","summary":"product","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"inventoryResults":{"description":"Inventories updated by bulk action.","$ref":"#/components/schemas/wix.stores.catalog.v3.BulkInventoryItemResults","summary":"inventoryResults","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateProductWithInventoryResponse","description":""},"wix.stores.catalog.v3.BulkCreateProductsRequest":{"type":"object","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"}}},"title":"BulkCreateProductsRequest","description":""},"com.wix.stores.catalog.product.api.v3.MultipleEntitiesOps.RequestedFields":{"type":"string","description":"","title":"RequestedFields","enum":["UNKNOWN_REQUESTED_FIELD","URL","CURRENCY","INFO_SECTION","MERCHANT_DATA","PLAIN_DESCRIPTION","INFO_SECTION_PLAIN_DESCRIPTION","SUBSCRIPTION_PRICES_INFO","VARIANTS_INFO","BREADCRUMBS_INFO","WEIGHT_MEASUREMENT_UNIT_INFO","VARIANT_OPTION_CHOICE_NAMES","MEDIA_ITEMS_INFO","DESCRIPTION","DIRECT_CATEGORIES_INFO","ALL_CATEGORIES_INFO","MIN_VARIANT_PRICE_INFO","INFO_SECTION_DESCRIPTION"]},"wix.stores.catalog.v3.BulkCreateProductsResponse":{"type":"object","properties":{"results":{"description":"Products created by bulk action.","minItems":1,"maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkProductResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateProductsResponse","description":""},"wix.stores.catalog.v3.BulkProductResult":{"type":"object","properties":{"itemMetadata":{"description":"Information about successful action or error for failure.","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"item":{"description":"Full product entity.\n\nReturned only if `returnEntity: true` is passed in the request.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product","summary":"item","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkProductResult","description":""},"wix.stores.catalog.v3.upstream.wix.common.ItemMetadata":{"type":"object","properties":{"id":{"description":"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).","minLength":1,"maxLength":36,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originalIndex":{"description":"Index of the item within the request array. Allows for correlation between request and response items.","title":"originalIndex","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"success":{"description":"Whether the requested action was successful for this item. When `false`, the `error` field is populated.","title":"success","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"error":{"description":"Details about the error in case of failure.","$ref":"#/components/schemas/wix.api.ApplicationError","summary":"error","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemMetadata","description":""},"wix.stores.catalog.v3.BulkCreateProductsWithInventoryRequest":{"type":"object","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"}}},"title":"BulkCreateProductsWithInventoryRequest","description":""},"wix.stores.catalog.v3.BulkCreateProductsWithInventoryResponse":{"type":"object","properties":{"productResults":{"description":"Products created by bulk action.","$ref":"#/components/schemas/wix.stores.catalog.v3.BulkProductResults","summary":"productResults","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"inventoryResults":{"description":"Inventories created by bulk action.","$ref":"#/components/schemas/wix.stores.catalog.v3.BulkInventoryItemResults","summary":"inventoryResults","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateProductsWithInventoryResponse","description":""},"wix.stores.catalog.v3.BulkProductResults":{"type":"object","properties":{"results":{"description":"Products modified by bulk action.","minItems":1,"maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkProductResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkProductResults","description":""},"wix.stores.catalog.v3.BulkUpdateProductsRequest":{"type":"object","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"}}},"title":"BulkUpdateProductsRequest","description":""},"wix.stores.catalog.v3.MaskedProduct":{"type":"object","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"}}},"title":"MaskedProduct","description":""},"wix.stores.catalog.v3.BulkUpdateProductsResponse":{"type":"object","properties":{"results":{"description":"Products updated by bulk action.","minItems":1,"maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkProductResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateProductsResponse","description":""},"wix.stores.catalog.v3.BulkUpdateProductsWithInventoryRequest":{"type":"object","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"}}},"title":"BulkUpdateProductsWithInventoryRequest","description":""},"wix.stores.catalog.v3.MaskedProductWithInventory":{"type":"object","properties":{"product":{"description":"Product to update.","$ref":"#/components/schemas/wix.stores.catalog.v3.ProductWithInventory","summary":"product","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MaskedProductWithInventory","description":""},"wix.stores.catalog.v3.BulkUpdateProductsWithInventoryResponse":{"type":"object","properties":{"productResults":{"description":"Products updated by bulk action.","$ref":"#/components/schemas/wix.stores.catalog.v3.BulkProductResults","summary":"productResults","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"inventoryResults":{"description":"Inventories updated by bulk action.","$ref":"#/components/schemas/wix.stores.catalog.v3.BulkInventoryItemResults","summary":"inventoryResults","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateProductsWithInventoryResponse","description":""},"wix.stores.catalog.v3.BulkUpdateProductsByFilterRequest":{"type":"object","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","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"}}},"title":"BulkUpdateProductsByFilterRequest","description":""},"wix.stores.catalog.v3.upstream.wix.common.SearchDetails":{"type":"object","properties":{"mode":{"description":"Defines how separate search terms in `expression` are combined","title":"mode","type":"string","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.SearchDetails.Mode","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"expression":{"description":"Search term or expression","maxLength":100,"title":"expression","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path","maxLength":200,"maxItems":20,"title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fuzzy":{"description":"Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm)","title":"fuzzy","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SearchDetails","description":""},"wix.stores.catalog.v3.upstream.wix.common.SearchDetails.Mode":{"type":"string","description":"","title":"Mode","enum":["OR","AND"]},"wix.stores.catalog.v3.BulkUpdateProductsByFilterResponse":{"type":"object","properties":{"jobId":{"description":"Job ID.\n\nPass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..","format":"GUID","title":"jobId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateProductsByFilterResponse","description":""},"wix.stores.catalog.v3.UpdateExtendedFieldsRequest":{"type":"object","properties":{"productId":{"description":"Product ID.","minLength":1,"maxLength":36,"title":"productId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"namespace":{"description":"App namespace.","minLength":4,"maxLength":150,"title":"namespace","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"namespaceData":{"description":"Data to update.","title":"namespaceData","type":"object","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"}}},"title":"UpdateExtendedFieldsRequest","description":""},"wix.stores.catalog.v3.UpdateExtendedFieldsResponse":{"type":"object","properties":{"product":{"description":"Updated product.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product","summary":"product","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateExtendedFieldsResponse","description":""},"wix.stores.catalog.v3.DeleteProductRequest":{"type":"object","properties":{"productId":{"description":"Product ID.","minLength":1,"maxLength":36,"title":"productId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteProductRequest","description":""},"wix.stores.catalog.v3.DeleteProductResponse":{"type":"object","properties":{},"title":"DeleteProductResponse","description":""},"wix.stores.catalog.v3.BulkDeleteProductsRequest":{"type":"object","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"}}},"title":"BulkDeleteProductsRequest","description":""},"wix.stores.catalog.v3.BulkDeleteProductsResponse":{"type":"object","properties":{"results":{"description":"Products deleted by bulk action.","minItems":1,"maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkDeleteProductsResponse.BulkProductResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDeleteProductsResponse","description":""},"wix.stores.catalog.v3.BulkDeleteProductsResponse.BulkProductResult":{"type":"object","properties":{"itemMetadata":{"description":"Bulk action metadata for products.","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkProductResult","description":""},"wix.stores.catalog.v3.BulkDeleteProductsByFilterRequest":{"type":"object","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","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"}}},"title":"BulkDeleteProductsByFilterRequest","description":""},"wix.stores.catalog.v3.BulkDeleteProductsByFilterResponse":{"type":"object","properties":{"jobId":{"description":"Job ID.\n\nPass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..","format":"GUID","title":"jobId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDeleteProductsByFilterResponse","description":""},"wix.stores.catalog.v3.GetProductRequest":{"type":"object","properties":{"productId":{"description":"Product ID.","minLength":1,"maxLength":36,"title":"productId","type":"string","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"}}},"title":"GetProductRequest","description":""},"wix.stores.catalog.v3.GetProductResponse":{"type":"object","properties":{"product":{"description":"Product.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product","summary":"product","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetProductResponse","description":""},"wix.stores.catalog.v3.GetProductBySlugRequest":{"type":"object","properties":{"slug":{"description":"Product slug.","minLength":1,"maxLength":100,"title":"slug","type":"string","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"}}},"title":"GetProductBySlugRequest","description":""},"wix.stores.catalog.v3.GetProductBySlugResponse":{"type":"object","properties":{"product":{"description":"Product.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product","summary":"product","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetProductBySlugResponse","description":""},"wix.stores.catalog.v3.SearchProductsRequest":{"type":"object","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"}}},"title":"SearchProductsRequest","description":""},"wix.stores.catalog.v3.upstream.wix.common.CursorSearch":{"type":"object","properties":{"filter":{"description":"A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf)","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object in the form [{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]","maxItems":10,"title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"aggregations":{"description":"Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.","maxItems":10,"title":"aggregations","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.Aggregation"},"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"}},"timeZone":{"description":"UTC offset or IANA time zone. Valid values are\nISO 8601 UTC offsets, such as +02:00 or -06:00,\nand IANA time zone IDs, such as Europe/Rome\n\nAffects all filters and aggregations returned values.\nYou may override this behavior in a specific filter by providing\ntimestamps including time zone. e.g. `\"2023-12-20T10:52:34.795Z\"`","maxLength":50,"title":"timeZone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorSearch","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.CursorSearch.pagingMethod"}]},"wix.stores.catalog.v3.upstream.wix.common.CursorSearch.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"cursorPaging":{"description":"Cursor pointing to page of results.\nWhen requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.stores.catalog.v3.upstream.wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","maxLength":512,"title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.","title":"order","type":"string","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"wix.stores.catalog.v3.upstream.wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"wix.stores.catalog.v3.upstream.wix.common.Aggregation":{"type":"object","properties":{"name":{"description":"User-defined name of aggregation, should be unique, will appear in aggregation results","maxLength":100,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Type of aggregation, client must provide matching aggregation field below","title":"type","type":"string","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldPath":{"description":"Field to aggregate by, use dot notation to specify json path","maxLength":200,"title":"fieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Aggregation","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.Aggregation.kind"}]},"wix.stores.catalog.v3.upstream.wix.common.Aggregation.kind":{"type":"object","title":"kind","properties":{"value":{"description":"Value aggregation","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.Aggregation.ValueAggregation","summary":"value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"range":{"description":"Range aggregation","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.Aggregation.RangeAggregation","summary":"range","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"Scalar aggregation","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.Aggregation.ScalarAggregation","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateHistogram":{"description":"Date histogram aggregation","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.Aggregation.DateHistogramAggregation","summary":"dateHistogram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nested":{"description":"Nested aggregation","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.Aggregation.NestedAggregation","summary":"nested","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.stores.catalog.v3.upstream.wix.common.Aggregation.RangeAggregation.RangeBucket":{"type":"object","properties":{"from":{"description":"Inclusive lower bound of the range. Required if to is not given","title":"from","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"to":{"description":"Exclusive upper bound of the range. Required if from is not given","title":"to","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeBucket","description":""},"wix.stores.catalog.v3.upstream.wix.common.Aggregation.ValueAggregation.SortType":{"type":"string","description":"","title":"SortType","enum":["COUNT","VALUE"]},"wix.stores.catalog.v3.upstream.wix.common.Aggregation.ValueAggregation.SortDirection":{"type":"string","description":"","title":"SortDirection","enum":["DESC","ASC"]},"wix.stores.catalog.v3.upstream.wix.common.Aggregation.ValueAggregation.MissingValues":{"type":"string","description":"","title":"MissingValues","enum":["EXCLUDE","INCLUDE"]},"wix.stores.catalog.v3.upstream.wix.common.Aggregation.ValueAggregation.IncludeMissingValuesOptions":{"type":"object","properties":{"addToBucket":{"description":"Can specify custom bucket name. Defaults are [string -> \"N/A\"], [int -> \"0\"], [bool -> \"false\"] ...","maxLength":20,"title":"addToBucket","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IncludeMissingValuesOptions","description":""},"wix.stores.catalog.v3.upstream.wix.common.ScalarType":{"type":"string","description":"","title":"ScalarType","enum":["UNKNOWN_SCALAR_TYPE","COUNT_DISTINCT","MIN","MAX","SUM","AVG"]},"wix.stores.catalog.v3.upstream.wix.common.Aggregation.ValueAggregation":{"type":"object","properties":{"sortType":{"description":"Should sort by number of matches or value of the field","title":"sortType","type":"string","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.Aggregation.ValueAggregation.SortType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sortDirection":{"description":"Should sort in ascending or descending order","title":"sortDirection","type":"string","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.Aggregation.ValueAggregation.SortDirection","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"limit":{"description":"How many aggregations would you like to return? Can be between 1 and 250. 10 is the default.","title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"missingValues":{"description":"Should missing values be included or excluded from the aggregation results. Default is EXCLUDE","title":"missingValues","type":"string","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.Aggregation.ValueAggregation.MissingValues","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValueAggregation","description":"","oneOf":[{"description":"","summary":"options","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.Aggregation.ValueAggregation.options"}]},"wix.stores.catalog.v3.upstream.wix.common.Aggregation.ValueAggregation.options":{"type":"object","title":"options","properties":{"includeOptions":{"description":"Options for including missing values","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.Aggregation.ValueAggregation.IncludeMissingValuesOptions","summary":"includeOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.stores.catalog.v3.upstream.wix.common.Aggregation.NestedAggregation.NestedAggregationType":{"type":"string","description":"","title":"NestedAggregationType","enum":["UNKNOWN_AGGREGATION_TYPE","VALUE","RANGE","SCALAR","DATE_HISTOGRAM"]},"wix.stores.catalog.v3.upstream.wix.common.Aggregation.RangeAggregation":{"type":"object","properties":{"buckets":{"description":"List of range buckets, where during aggregation each entity will be placed in the first bucket where its value falls into based on provided range bounds","maxItems":50,"title":"buckets","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.Aggregation.RangeAggregation.RangeBucket"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeAggregation","description":""},"wix.stores.catalog.v3.upstream.wix.common.Aggregation.ScalarAggregation":{"type":"object","properties":{"type":{"description":"Define the operator for the scalar aggregation","title":"type","type":"string","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.ScalarType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ScalarAggregation","description":""},"wix.stores.catalog.v3.upstream.wix.common.Aggregation.DateHistogramAggregation":{"type":"object","properties":{"interval":{"description":"Interval for date histogram aggregation","title":"interval","type":"string","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.Aggregation.DateHistogramAggregation.Interval","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DateHistogramAggregation","description":""},"wix.stores.catalog.v3.upstream.wix.common.Aggregation.DateHistogramAggregation.Interval":{"type":"string","description":"","title":"Interval","enum":["UNKNOWN_INTERVAL","YEAR","MONTH","WEEK","DAY","HOUR","MINUTE","SECOND"]},"wix.stores.catalog.v3.upstream.wix.common.Aggregation.NestedAggregation.NestedAggregationItem":{"type":"object","properties":{"name":{"description":"User-defined name of aggregation, should be unique, will appear in aggregation results","maxLength":100,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Type of aggregation, client must provide matching aggregation field below","title":"type","type":"string","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.Aggregation.NestedAggregation.NestedAggregationType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldPath":{"description":"Field to aggregate by, use dont notation to specify json path","maxLength":200,"title":"fieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedAggregationItem","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.Aggregation.NestedAggregation.NestedAggregationItem.kind"}]},"wix.stores.catalog.v3.upstream.wix.common.Aggregation.NestedAggregation.NestedAggregationItem.kind":{"type":"object","title":"kind","properties":{"value":{"description":"Value aggregation","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.Aggregation.ValueAggregation","summary":"value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"range":{"description":"Range aggregation","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.Aggregation.RangeAggregation","summary":"range","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"Scalar aggregation","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.Aggregation.ScalarAggregation","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateHistogram":{"description":"Date histogram aggregation","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.Aggregation.DateHistogramAggregation","summary":"dateHistogram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.stores.catalog.v3.upstream.wix.common.AggregationType":{"type":"string","description":"","title":"AggregationType","enum":["UNKNOWN_AGGREGATION_TYPE","VALUE","RANGE","SCALAR","DATE_HISTOGRAM","NESTED"]},"wix.stores.catalog.v3.upstream.wix.common.Aggregation.NestedAggregation":{"type":"object","properties":{"nestedAggregations":{"description":"Flattened list of aggregations, where each next aggregation is nested within previous one","minItems":2,"maxItems":3,"title":"nestedAggregations","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.Aggregation.NestedAggregation.NestedAggregationItem"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedAggregation","description":"Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one"},"wix.stores.catalog.v3.upstream.wix.common.CursorPaging":{"type":"object","properties":{"limit":{"description":"Maximum number of items to return in the results.","minimum":0,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursor":{"description":"Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request.","maxLength":16000,"title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPaging","description":""},"wix.stores.catalog.v3.SearchProductsResponse":{"type":"object","properties":{"products":{"description":"List of products.","title":"products","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging metadata.","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.CursorPagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"aggregationData":{"description":"Aggregation data.","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationData","summary":"aggregationData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SearchProductsResponse","description":""},"wix.stores.catalog.v3.upstream.wix.common.CursorPagingMetadata":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Cursor strings that point to the next page, previous page, or both.","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hasNext":{"description":"Whether there are more pages to retrieve following the current page.\n\n+ `true`: Another page of results can be retrieved.\n+ `false`: This is the last page.","title":"hasNext","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPagingMetadata","description":""},"wix.stores.catalog.v3.upstream.wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor string pointing to the next page in the list of results.","maxLength":16000,"title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to the previous page in the list of results.","maxLength":16000,"title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"wix.stores.catalog.v3.upstream.wix.common.AggregationData":{"type":"object","properties":{"results":{"description":"key = aggregation name (as derived from search request)","maxItems":10000,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AggregationData","description":""},"wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.ValueResults.ValueAggregationResult":{"type":"object","properties":{"value":{"description":"Value of the field","maxLength":100,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Count of entities with this value","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValueAggregationResult","description":""},"wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.RangeResults.RangeAggregationResult":{"type":"object","properties":{"from":{"description":"Inclusive lower bound of the range","title":"from","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"to":{"description":"Exclusive upper bound of the range","title":"to","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Count of entities in this range","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeAggregationResult","description":""},"wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.NestedAggregationResults":{"type":"object","properties":{"name":{"description":"User-defined name of aggregation, matches the one provided in request","maxLength":100,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Type of aggregation that matches result","title":"type","type":"string","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldPath":{"description":"Field to aggregate by, matches the one provided in request","maxLength":200,"title":"fieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedAggregationResults","description":"","oneOf":[{"description":"","summary":"result","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.NestedAggregationResults.result"}]},"wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.NestedAggregationResults.result":{"type":"object","title":"result","properties":{"values":{"description":"Value aggregation results","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.ValueResults","summary":"values","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ranges":{"description":"Range aggregation results","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.RangeResults","summary":"ranges","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"Scalar aggregation results","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.ScalarResult","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.ValueResults":{"type":"object","properties":{"results":{"description":"List of value aggregations","maxItems":250,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.ValueResults.ValueAggregationResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValueResults","description":""},"wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.RangeResults":{"type":"object","properties":{"results":{"description":"List of ranges returned in same order as requested","maxItems":50,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.RangeResults.RangeAggregationResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeResults","description":""},"wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.ScalarResult":{"type":"object","properties":{"type":{"description":"Type of scalar aggregation","title":"type","type":"string","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.ScalarType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"value":{"description":"Value of the scalar aggregation","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ScalarResult","description":""},"wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.GroupByValueResults.NestedValueAggregationResult":{"type":"object","properties":{"value":{"description":"Value of the field","maxLength":1000,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nestedResults":{"description":"Nested aggregations","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.NestedAggregationResults","summary":"nestedResults","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedValueAggregationResult","description":""},"wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults.ValueResult":{"type":"object","properties":{"value":{"description":"Value of the field","maxLength":1000,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Count of entities with this value","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValueResult","description":""},"wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults.RangeResult":{"type":"object","properties":{"from":{"description":"Inclusive lower bound of the range","title":"from","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"to":{"description":"Exclusive upper bound of the range","title":"to","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Count of entities in this range","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeResult","description":""},"wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults.ScalarResult":{"type":"object","properties":{"value":{"description":"Value of the scalar aggregation","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ScalarResult","description":""},"wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults.NestedResultValue":{"type":"object","properties":{},"title":"NestedResultValue","description":"","oneOf":[{"description":"","summary":"result","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults.NestedResultValue.result"}]},"wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults.NestedResultValue.result":{"type":"object","title":"result","properties":{"value":{"description":"Value aggregation result","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults.ValueResult","summary":"value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"range":{"description":"Range aggregation result","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults.RangeResult","summary":"range","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"Scalar aggregation result","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults.ScalarResult","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateHistogram":{"description":"Date histogram aggregation result","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults.ValueResult","summary":"dateHistogram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults.Results":{"type":"object","properties":{"results":{"description":"List of nested aggregations","title":"results","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults.NestedResultValue"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Results","description":""},"wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.DateHistogramResults.DateHistogramResult":{"type":"object","properties":{"value":{"description":"Date in ISO 8601 format","maxLength":100,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Count of documents in the bucket","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DateHistogramResult","description":""},"wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.GroupByValueResults":{"type":"object","properties":{"results":{"description":"List of value aggregations","maxItems":1000,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.GroupByValueResults.NestedValueAggregationResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GroupByValueResults","description":""},"wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.DateHistogramResults":{"type":"object","properties":{"results":{"description":"List of date histogram aggregations","maxItems":200,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.DateHistogramResults.DateHistogramResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DateHistogramResults","description":""},"wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults":{"type":"object","properties":{"results":{"description":"List of nested aggregations","maxItems":1000,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults.Results"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedResults","description":"Results of `NESTED` aggregation type in a flattened form\naggregations in resulting array are keyed by requested aggregation `name`."},"wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults":{"type":"object","properties":{"name":{"description":"User-defined name of aggregation as derived from search request","maxLength":100,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Type of aggregation that must match provided kind as derived from search request","title":"type","type":"string","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldPath":{"description":"Field to aggregate by as derived from search request","maxLength":200,"title":"fieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AggregationResults","description":"","oneOf":[{"description":"","summary":"result","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.result"}]},"wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.result":{"type":"object","title":"result","properties":{"values":{"description":"Value aggregation results","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.ValueResults","summary":"values","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ranges":{"description":"Range aggregation results","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.RangeResults","summary":"ranges","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"Scalar aggregation results","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.ScalarResult","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"groupedByValue":{"description":"Group by value aggregation results","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.GroupByValueResults","summary":"groupedByValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateHistogram":{"description":"Date histogram aggregation results","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.DateHistogramResults","summary":"dateHistogram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nested":{"description":"Nested aggregation results","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults","summary":"nested","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.stores.catalog.v3.QueryProductsRequest":{"type":"object","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"}}},"title":"QueryProductsRequest","description":""},"wix.stores.catalog.v3.upstream.wix.common.CursorQuery":{"type":"object","properties":{"filter":{"description":"Filter object in the following format:\n`\"filter\" : {\n\"fieldName1\": \"value1\",\n\"fieldName2\":{\"$operator\":\"value2\"}\n}`\nExample of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object in the following format:\n`[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`","maxItems":5,"title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorQuery","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.CursorQuery.pagingMethod"}]},"wix.stores.catalog.v3.upstream.wix.common.CursorQuery.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"cursorPaging":{"description":"Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.stores.catalog.v3.QueryProductsResponse":{"type":"object","properties":{"products":{"description":"List of products.","title":"products","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging metadata.","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.CursorPagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryProductsResponse","description":""},"wix.stores.catalog.v3.CountProductsRequest":{"type":"object","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","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 required `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.\n\nDefault: `false`","title":"returnNonVisibleProducts","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CountProductsRequest","description":""},"wix.stores.catalog.v3.CountProductsResponse":{"type":"object","properties":{"count":{"description":"Total number of products.","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CountProductsResponse","description":""},"wix.stores.catalog.v3.BulkUpdateProductVariantsByFilterRequest":{"type":"object","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","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"}}},"title":"BulkUpdateProductVariantsByFilterRequest","description":""},"wix.stores.catalog.v3.BulkUpdateProductVariantsByFilterResponse":{"type":"object","properties":{"jobId":{"description":"Job ID.\n\nPass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..","format":"GUID","title":"jobId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateProductVariantsByFilterResponse","description":""},"wix.stores.catalog.v3.BulkAdjustProductVariantsByFilterRequest":{"type":"object","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"basePrice":{"description":"Base price adjustment.","$ref":"#/components/schemas/wix.stores.catalog.v3.AdjustValue","summary":"basePrice","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"salePrice":{"description":"Sale price adjustment.","$ref":"#/components/schemas/wix.stores.catalog.v3.AdjustValue","summary":"salePrice","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"}},"salePriceFromBasePrice":{"description":"Set variant sale price from base price by applying provided discount to it.\nFor example variant base price 100$, variant sale price 95$, requested `salePriceFromBasePrice.percentage` is 10, then old sale price ignored and new sale price set to 90 (100$ - 10%).","$ref":"#/components/schemas/wix.stores.catalog.v3.UnsignedAdjustValue","summary":"salePriceFromBasePrice","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"}}},"title":"BulkAdjustProductVariantsByFilterRequest","description":""},"wix.stores.catalog.v3.AdjustValue":{"type":"object","properties":{},"title":"AdjustValue","description":"","oneOf":[{"description":"","summary":"adjustValue","$ref":"#/components/schemas/wix.stores.catalog.v3.AdjustValue.adjustValue"}]},"wix.stores.catalog.v3.AdjustValue.adjustValue":{"type":"object","title":"adjustValue","properties":{"amount":{"description":"A decimal value to increase or reduce from the original value, can be negative.","title":"amount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"-999999999","lte":"999999999","maxScale":2}}},"percentage":{"description":"The percentage value to increase or reduce from the current value, can be negative.","minimum":-100,"maximum":1000,"title":"percentage","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.stores.catalog.v3.UnsignedAdjustValue":{"type":"object","properties":{},"title":"UnsignedAdjustValue","description":"","oneOf":[{"description":"","summary":"adjustValue","$ref":"#/components/schemas/wix.stores.catalog.v3.UnsignedAdjustValue.adjustValue"}]},"wix.stores.catalog.v3.UnsignedAdjustValue.adjustValue":{"type":"object","title":"adjustValue","properties":{"amount":{"description":"A decimal value to reduce from the original value.","title":"amount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0","lte":"999999999","maxScale":2}}},"percentage":{"description":"The percentage value to reduce from the original value.","minimum":0,"maximum":100,"title":"percentage","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.stores.catalog.v3.BulkAdjustProductVariantsByFilterRequest.RoundingStrategy":{"type":"string","description":"","title":"RoundingStrategy","enum":["UNKNOWN_ROUNDING_STRATEGY","NO_ROUNDING","CURRENCY_PRECISION","NEAREST_WHOLE_NUMBER"]},"wix.stores.catalog.v3.BulkAdjustProductVariantsByFilterResponse":{"type":"object","properties":{"jobId":{"description":"Job ID.\n\nPass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..","format":"GUID","title":"jobId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkAdjustProductVariantsByFilterResponse","description":""},"wix.stores.catalog.v3.BulkAddInfoSectionsToProductsByFilterRequest":{"type":"object","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","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"}}},"title":"BulkAddInfoSectionsToProductsByFilterRequest","description":""},"wix.stores.catalog.v3.BulkAddInfoSectionsToProductsByFilterResponse":{"type":"object","properties":{"jobId":{"description":"Job ID.\n\nPass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..","format":"GUID","title":"jobId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkAddInfoSectionsToProductsByFilterResponse","description":""},"wix.stores.catalog.v3.BulkAddInfoSectionsToProductsRequest":{"type":"object","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"}}},"title":"BulkAddInfoSectionsToProductsRequest","description":""},"wix.stores.catalog.v3.ProductIdWithRevision":{"type":"object","properties":{"productId":{"description":"Product ID.","minLength":1,"maxLength":36,"title":"productId","type":"string","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.","title":"revision","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ProductIdWithRevision","description":""},"wix.stores.catalog.v3.BulkAddInfoSectionsToProductsResponse":{"type":"object","properties":{"results":{"description":"Products updated by bulk action.","minItems":1,"maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkProductResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkAddInfoSectionsToProductsResponse","description":""},"wix.stores.catalog.v3.BulkRemoveInfoSectionsFromProductsByFilterRequest":{"type":"object","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"infoSectionIds":{"description":"IDs of info sections to remove.","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"}}},"title":"BulkRemoveInfoSectionsFromProductsByFilterRequest","description":""},"wix.stores.catalog.v3.BulkRemoveInfoSectionsFromProductsByFilterResponse":{"type":"object","properties":{"jobId":{"description":"Job ID.\n\nPass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..","format":"GUID","title":"jobId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkRemoveInfoSectionsFromProductsByFilterResponse","description":""},"wix.stores.catalog.v3.BulkRemoveInfoSectionsFromProductsRequest":{"type":"object","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":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"}}},"title":"BulkRemoveInfoSectionsFromProductsRequest","description":""},"wix.stores.catalog.v3.BulkRemoveInfoSectionsFromProductsResponse":{"type":"object","properties":{"results":{"description":"Products updated by bulk action.","minItems":1,"maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.v3.BulkProductResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/wix.stores.catalog.v3.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkRemoveInfoSectionsFromProductsResponse","description":""},"wix.stores.catalog.v3.BulkAddProductsToCategoriesByFilterRequest":{"type":"object","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","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"}}},"title":"BulkAddProductsToCategoriesByFilterRequest","description":""},"wix.stores.catalog.v3.BulkAddProductsToCategoriesByFilterResponse":{"type":"object","properties":{"jobId":{"description":"Job ID.\n\nPass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..","format":"GUID","title":"jobId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkAddProductsToCategoriesByFilterResponse","description":""},"wix.stores.catalog.v3.BulkRemoveProductsFromCategoriesByFilterRequest":{"type":"object","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","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"}}},"title":"BulkRemoveProductsFromCategoriesByFilterRequest","description":""},"wix.stores.catalog.v3.BulkRemoveProductsFromCategoriesByFilterResponse":{"type":"object","properties":{"jobId":{"description":"Job ID.\n\nPass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..","format":"GUID","title":"jobId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkRemoveProductsFromCategoriesByFilterResponse","description":""},"com.wixpress.html.cache.invalidate.InvalidateCache":{"type":"object","properties":{"reason":{"description":"tell us why you're invalidating the cache. You don't need to add your app name","maxLength":256,"title":"reason","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"localDc":{"description":"Is local DS","title":"localDc","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InvalidateCache","description":"","oneOf":[{"description":"","summary":"getBy","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.getBy"}]},"com.wixpress.html.cache.invalidate.InvalidateCache.getBy":{"type":"object","title":"getBy","properties":{"metaSiteId":{"description":"Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteId":{"description":"Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!","format":"GUID","title":"siteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"app":{"description":"Invalidate by App","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.App","summary":"app","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"page":{"description":"Invalidate by page id","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.Page","summary":"page","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"uri":{"description":"Invalidate by URI path","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.URI","summary":"uri","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"file":{"description":"Invalidate by file (for media files such as PDFs)","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.File","summary":"file","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.html.cache.invalidate.InvalidateCache.App":{"type":"object","properties":{"appDefId":{"description":"The AppDefId","minLength":1,"title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"The instance Id","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"App","description":""},"com.wixpress.html.cache.invalidate.InvalidateCache.Page":{"type":"object","properties":{"metaSiteId":{"description":"the msid the page is on","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pageId":{"description":"Invalidate by Page ID","minLength":1,"title":"pageId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Page","description":""},"com.wixpress.html.cache.invalidate.InvalidateCache.URI":{"type":"object","properties":{"metaSiteId":{"description":"the msid the URI is on","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"uriPath":{"description":"URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes","minLength":1,"title":"uriPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"URI","description":""},"com.wixpress.html.cache.invalidate.InvalidateCache.File":{"type":"object","properties":{"metaSiteId":{"description":"the msid the file is related to","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fileName":{"description":"Invalidate by filename (for media files such as PDFs)","minLength":1,"maxLength":256,"title":"fileName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"File","description":""},"com.wix.categories.api.v1.CategoryMoved":{"type":"object","properties":{"categoryId":{"description":"Category ID.","format":"GUID","title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"parentCategory":{"description":"Parent category details.","$ref":"#/components/schemas/com.wix.categories.api.v1.ParentCategory","summary":"parentCategory","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CategoryMoved","description":""},"com.wix.categories.api.v1.ParentCategory":{"type":"object","properties":{"id":{"description":"Parent category ID.\n\nDefault: root category ID","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"index":{"description":"Index position of the category within the parent category.","readOnly":true,"title":"index","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ParentCategory","description":""},"com.wix.categories.api.v1.TreeReference":{"type":"object","properties":{"appNamespace":{"description":"Namespace of the app that manages the tree.\n\nFor example, `\"@wix/stores\"`, `\"@bookings/bookingslist\"`, `\"@achievements/quizzes\"`.","minLength":4,"maxLength":150,"title":"appNamespace","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeKey":{"description":"Tree key. You must pass this when a single app manages more than one tree.","minLength":1,"maxLength":44,"title":"treeKey","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TreeReference","description":""},"com.wix.categories.api.v1.ItemAddedToCategory":{"type":"object","properties":{"categoryId":{"description":"Category ID.","format":"GUID","title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"addedItem":{"description":"Details about the added item.","$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference","summary":"addedItem","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemAddedToCategory","description":""},"com.wix.categories.api.v1.ItemReference":{"type":"object","properties":{"catalogItemId":{"description":"ID of the item within the catalog it belongs to.\n\nFor example, `product.id` for Wix Stores or `event.id` for Wix Events.","minLength":1,"maxLength":36,"title":"catalogItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of the app providing the catalog.\n\nYou can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).\n\nFor items from Wix catalogs, the following values always apply:\n+ Wix Stores: `\"215238eb-22a5-4c36-9e7b-e7c08025e04e\"`\n+ Wix Bookings: `\"13d21c63-b5ec-5912-8397-c3a5ddb27a97\"`\n+ Wix Restaurants: `\"9a5d83fd-8570-482e-81ab-cfa88942ee60\"`","minLength":1,"maxLength":36,"title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemReference","description":""},"com.wix.categories.api.v1.ItemsAddedToCategory":{"type":"object","properties":{"categoryId":{"description":"Category ID.","format":"GUID","title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"addedItems":{"description":"List of added items.","maxItems":100,"title":"addedItems","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemsAddedToCategory","description":""},"com.wix.categories.api.v1.ItemRemovedFromCategory":{"type":"object","properties":{"categoryId":{"description":"Category ID.","format":"GUID","title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"removedItem":{"description":"Details about the removed item.","$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference","summary":"removedItem","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemRemovedFromCategory","description":""},"com.wix.categories.api.v1.ItemsRemovedFromCategory":{"type":"object","properties":{"categoryId":{"description":"Category ID.","format":"GUID","title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"removedItems":{"description":"List of removed items.","maxItems":100,"title":"removedItems","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemsRemovedFromCategory","description":""},"com.wix.categories.api.v1.ItemsArrangedInCategory":{"type":"object","properties":{"categoryId":{"description":"Category ID.","format":"GUID","title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemsArrangedInCategory","description":""},"com.wix.stores.catalog.product.api.v3.DoNotCallCreateProductRequest":{"type":"object","properties":{"product":{"description":"Product to be created","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product","summary":"product","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"A list of requested fields to be included 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"}}},"title":"DoNotCallCreateProductRequest","description":""},"com.wix.stores.catalog.product.api.v3.DoNotCallCreateProductResponse":{"type":"object","properties":{"product":{"description":"The created Product","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product","summary":"product","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DoNotCallCreateProductResponse","description":""},"com.wix.stores.catalog.product.api.v3.GetProductRequest":{"type":"object","properties":{"productId":{"description":"Id of the Product to retrieve","minLength":1,"maxLength":36,"title":"productId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"A list of requested fields to be included 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"}}},"title":"GetProductRequest","description":""},"com.wix.stores.catalog.product.api.v3.GetProductResponse":{"type":"object","properties":{"product":{"description":"The retrieved Product","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product","summary":"product","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetProductResponse","description":""},"com.wix.stores.catalog.product.api.v3.GetProductBySlugRequest":{"type":"object","properties":{"slug":{"description":"Product slug. A permanent, friendly URL name unique per store.","minLength":1,"maxLength":100,"title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"A list of requested fields to be included 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"}}},"title":"GetProductBySlugRequest","description":""},"com.wix.stores.catalog.product.api.v3.GetProductBySlugResponse":{"type":"object","properties":{"product":{"description":"The retrieved Product","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product","summary":"product","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetProductBySlugResponse","description":""},"com.wix.stores.catalog.product.api.v3.GetVariantsRequest":{"type":"object","properties":{"productVariantIds":{"description":"Ids of the product and variants to retrieve","maxItems":100,"title":"productVariantIds","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ProductVariantIds"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetVariantsRequest","description":""},"com.wix.stores.catalog.product.api.v3.ProductVariantIds":{"type":"object","properties":{"productId":{"description":"Product id of the requested variants.","minLength":1,"maxLength":36,"title":"productId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"variantIds":{"description":"A list of variant ids.","maxItems":1000,"minLength":1,"maxLength":36,"title":"variantIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ProductVariantIds","description":""},"com.wix.stores.catalog.product.api.v3.GetVariantsResponse":{"type":"object","properties":{"productVariants":{"description":"The retrieved Products and Variants","title":"productVariants","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ProductVariants"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetVariantsResponse","description":""},"com.wix.stores.catalog.product.api.v3.ProductVariants":{"type":"object","properties":{"productId":{"description":"Product id of the requested variants.","minLength":1,"maxLength":36,"title":"productId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"variants":{"description":"A list of variants.","maxItems":1000,"title":"variants","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Variant"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ProductVariants","description":""},"com.wix.stores.catalog.product.api.v3.DoNotCallUpdateProductRequest":{"type":"object","properties":{"product":{"description":"Product to be updated, may be partial","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product","summary":"product","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"A list of requested fields to be included 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"}}},"title":"DoNotCallUpdateProductRequest","description":""},"com.wix.stores.catalog.product.api.v3.DoNotCallUpdateProductResponse":{"type":"object","properties":{"product":{"description":"The updated Product","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product","summary":"product","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DoNotCallUpdateProductResponse","description":""},"com.wix.stores.catalog.product.api.v3.DeleteProductRequest":{"type":"object","properties":{"productId":{"description":"Id of the Product to delete","minLength":1,"maxLength":36,"title":"productId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteProductRequest","description":""},"com.wix.stores.catalog.product.api.v3.DeleteProductResponse":{"type":"object","properties":{},"title":"DeleteProductResponse","description":""},"com.wix.stores.catalog.product.api.v3.SearchProductsRequest":{"type":"object","properties":{"search":{"description":"WQL expression. Please pay attention that unlike other arrays when you want to filter by `inventory` or `variants` instead of standard array operators you must use `$matchItems` (for usage see examples).\nIt means that product will be returned only if one or more items satisfy all filters specified in $matchItems.\nFor example, if you have 2 variants: one visible with price 10 and another one not visible with price 20, when inside $matchItems you specify `visible:true` and `price > 15` nothing will be returned because there are no variants which satisfy both conditions.\nYou still can use `$isEmpty` and `$exists` operators for fields listed above.\nSee examples to understand supported capabilities.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.CursorSearch","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"A list of requested fields to be included 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"}}},"title":"SearchProductsRequest","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.CursorSearch":{"type":"object","properties":{"filter":{"description":"Filter object.\n\nLearn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"List of sort objects.\n\nLearn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).","maxItems":10,"title":"sort","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"aggregations":{"description":"Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.","maxItems":10,"title":"aggregations","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Free text to match in searchable fields.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"timeZone":{"description":"UTC offset or IANA time zone. Valid values are\nISO 8601 UTC offsets, such as +02:00 or -06:00,\nand IANA time zone IDs, such as Europe/Rome\n\nAffects all filters and aggregations returned values.\nYou may override this behavior in a specific filter by providing\ntimestamps including time zone. e.g. `\"2023-12-20T10:52:34.795Z\"`","maxLength":50,"title":"timeZone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorSearch","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.CursorSearch.pagingMethod"}]},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.CursorSearch.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"cursorPaging":{"description":"Cursor paging options.\n\nLearn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","maxLength":512,"title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.","title":"order","type":"string","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation":{"type":"object","properties":{"name":{"description":"User-defined name of aggregation, should be unique, will appear in aggregation results","maxLength":100,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Type of aggregation, client must provide matching aggregation field below","title":"type","type":"string","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldPath":{"description":"Field to aggregate by, use dot notation to specify json path","maxLength":200,"title":"fieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Aggregation","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.kind"}]},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.kind":{"type":"object","title":"kind","properties":{"value":{"description":"Value aggregation","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.ValueAggregation","summary":"value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"range":{"description":"Range aggregation","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.RangeAggregation","summary":"range","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"Scalar aggregation","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.ScalarAggregation","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateHistogram":{"description":"Date histogram aggregation","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.DateHistogramAggregation","summary":"dateHistogram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nested":{"description":"Nested aggregation","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.NestedAggregation","summary":"nested","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.RangeAggregation.RangeBucket":{"type":"object","properties":{"from":{"description":"Inclusive lower bound of the range. Required if to is not given","title":"from","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"to":{"description":"Exclusive upper bound of the range. Required if from is not given","title":"to","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeBucket","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.ValueAggregation.SortType":{"type":"string","description":"","title":"SortType","enum":["COUNT","VALUE"]},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.ValueAggregation.SortDirection":{"type":"string","description":"","title":"SortDirection","enum":["DESC","ASC"]},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.ValueAggregation.MissingValues":{"type":"string","description":"","title":"MissingValues","enum":["EXCLUDE","INCLUDE"]},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.ValueAggregation.IncludeMissingValuesOptions":{"type":"object","properties":{"addToBucket":{"description":"Can specify custom bucket name. Defaults are [string -> \"N/A\"], [int -> \"0\"], [bool -> \"false\"] ...","maxLength":20,"title":"addToBucket","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IncludeMissingValuesOptions","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.ScalarType":{"type":"string","description":"","title":"ScalarType","enum":["UNKNOWN_SCALAR_TYPE","COUNT_DISTINCT","MIN","MAX","SUM","AVG"]},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.ValueAggregation":{"type":"object","properties":{"sortType":{"description":"Should sort by number of matches or value of the field","title":"sortType","type":"string","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.ValueAggregation.SortType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sortDirection":{"description":"Should sort in ascending or descending order","title":"sortDirection","type":"string","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.ValueAggregation.SortDirection","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"limit":{"description":"How many aggregations would you like to return? Can be between 1 and 250. 10 is the default.","title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"missingValues":{"description":"Should missing values be included or excluded from the aggregation results. Default is EXCLUDE","title":"missingValues","type":"string","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.ValueAggregation.MissingValues","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValueAggregation","description":"","oneOf":[{"description":"","summary":"options","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.ValueAggregation.options"}]},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.ValueAggregation.options":{"type":"object","title":"options","properties":{"includeOptions":{"description":"Options for including missing values","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.ValueAggregation.IncludeMissingValuesOptions","summary":"includeOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.NestedAggregation.NestedAggregationType":{"type":"string","description":"","title":"NestedAggregationType","enum":["UNKNOWN_AGGREGATION_TYPE","VALUE","RANGE","SCALAR","DATE_HISTOGRAM"]},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.RangeAggregation":{"type":"object","properties":{"buckets":{"description":"List of range buckets, where during aggregation each entity will be placed in the first bucket where its value falls into based on provided range bounds","maxItems":50,"title":"buckets","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.RangeAggregation.RangeBucket"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeAggregation","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.ScalarAggregation":{"type":"object","properties":{"type":{"description":"Define the operator for the scalar aggregation","title":"type","type":"string","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.ScalarType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ScalarAggregation","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.DateHistogramAggregation":{"type":"object","properties":{"interval":{"description":"Interval for date histogram aggregation","title":"interval","type":"string","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.DateHistogramAggregation.Interval","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DateHistogramAggregation","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.DateHistogramAggregation.Interval":{"type":"string","description":"","title":"Interval","enum":["UNKNOWN_INTERVAL","YEAR","MONTH","WEEK","DAY","HOUR","MINUTE","SECOND"]},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.NestedAggregation.NestedAggregationItem":{"type":"object","properties":{"name":{"description":"User-defined name of aggregation, should be unique, will appear in aggregation results","maxLength":100,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Type of aggregation, client must provide matching aggregation field below","title":"type","type":"string","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.NestedAggregation.NestedAggregationType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldPath":{"description":"Field to aggregate by, use dont notation to specify json path","maxLength":200,"title":"fieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedAggregationItem","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.NestedAggregation.NestedAggregationItem.kind"}]},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.NestedAggregation.NestedAggregationItem.kind":{"type":"object","title":"kind","properties":{"value":{"description":"Value aggregation","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.ValueAggregation","summary":"value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"range":{"description":"Range aggregation","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.RangeAggregation","summary":"range","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"Scalar aggregation","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.ScalarAggregation","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateHistogram":{"description":"Date histogram aggregation","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.DateHistogramAggregation","summary":"dateHistogram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationType":{"type":"string","description":"","title":"AggregationType","enum":["UNKNOWN_AGGREGATION_TYPE","VALUE","RANGE","SCALAR","DATE_HISTOGRAM","NESTED"]},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.NestedAggregation":{"type":"object","properties":{"nestedAggregations":{"description":"Flattened list of aggregations, where each next aggregation is nested within previous one","minItems":2,"maxItems":3,"title":"nestedAggregations","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.Aggregation.NestedAggregation.NestedAggregationItem"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedAggregation","description":"Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one"},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.SearchDetails":{"type":"object","properties":{"mode":{"description":"Defines how separate search terms in `expression` are combined","title":"mode","type":"string","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.SearchDetails.Mode","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"expression":{"description":"Search term or expression","maxLength":100,"title":"expression","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path","maxLength":200,"maxItems":20,"title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fuzzy":{"description":"Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm)","title":"fuzzy","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SearchDetails","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.SearchDetails.Mode":{"type":"string","description":"","title":"Mode","enum":["OR","AND"]},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.CursorPaging":{"type":"object","properties":{"limit":{"description":"Maximum number of items to return in the results.","minimum":0,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursor":{"description":"Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request.","maxLength":16000,"title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPaging","description":""},"com.wix.stores.catalog.product.api.v3.SearchProductsResponse":{"type":"object","properties":{"products":{"description":"Products which satisfy the provided query.","title":"products","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging metadata. Contains cursor which can be used in next query.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.CursorPagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"aggregationData":{"description":"Aggregation data.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData","summary":"aggregationData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SearchProductsResponse","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.CursorPagingMetadata":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Cursor strings that point to the next page, previous page, or both.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hasNext":{"description":"Whether there are more pages to retrieve following the current page.\n\n+ `true`: Another page of results can be retrieved.\n+ `false`: This is the last page.","title":"hasNext","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPagingMetadata","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor string pointing to the next page in the list of results.","maxLength":16000,"title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to the previous page in the list of results.","maxLength":16000,"title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData":{"type":"object","properties":{"results":{"description":"key = aggregation name (as derived from search request)","maxItems":10000,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AggregationData","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.ValueResults.ValueAggregationResult":{"type":"object","properties":{"value":{"description":"Value of the field","maxLength":100,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Count of entities with this value","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValueAggregationResult","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.RangeResults.RangeAggregationResult":{"type":"object","properties":{"from":{"description":"Inclusive lower bound of the range","title":"from","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"to":{"description":"Exclusive upper bound of the range","title":"to","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Count of entities in this range","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeAggregationResult","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.NestedAggregationResults":{"type":"object","properties":{"name":{"description":"User-defined name of aggregation, matches the one provided in request","maxLength":100,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Type of aggregation that matches result","title":"type","type":"string","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldPath":{"description":"Field to aggregate by, matches the one provided in request","maxLength":200,"title":"fieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedAggregationResults","description":"","oneOf":[{"description":"","summary":"result","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.NestedAggregationResults.result"}]},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.NestedAggregationResults.result":{"type":"object","title":"result","properties":{"values":{"description":"Value aggregation results","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.ValueResults","summary":"values","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ranges":{"description":"Range aggregation results","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.RangeResults","summary":"ranges","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"Scalar aggregation results","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.ScalarResult","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.ValueResults":{"type":"object","properties":{"results":{"description":"List of value aggregations","maxItems":250,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.ValueResults.ValueAggregationResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValueResults","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.RangeResults":{"type":"object","properties":{"results":{"description":"List of ranges returned in same order as requested","maxItems":50,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.RangeResults.RangeAggregationResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeResults","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.ScalarResult":{"type":"object","properties":{"type":{"description":"Type of scalar aggregation","title":"type","type":"string","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.ScalarType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"value":{"description":"Value of the scalar aggregation","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ScalarResult","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.GroupByValueResults.NestedValueAggregationResult":{"type":"object","properties":{"value":{"description":"Value of the field","maxLength":1000,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nestedResults":{"description":"Nested aggregations","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.NestedAggregationResults","summary":"nestedResults","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedValueAggregationResult","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults.ValueResult":{"type":"object","properties":{"value":{"description":"Value of the field","maxLength":1000,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Count of entities with this value","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValueResult","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults.RangeResult":{"type":"object","properties":{"from":{"description":"Inclusive lower bound of the range","title":"from","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"to":{"description":"Exclusive upper bound of the range","title":"to","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Count of entities in this range","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeResult","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults.ScalarResult":{"type":"object","properties":{"value":{"description":"Value of the scalar aggregation","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ScalarResult","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults.NestedResultValue":{"type":"object","properties":{},"title":"NestedResultValue","description":"","oneOf":[{"description":"","summary":"result","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults.NestedResultValue.result"}]},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults.NestedResultValue.result":{"type":"object","title":"result","properties":{"value":{"description":"Value aggregation result","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults.ValueResult","summary":"value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"range":{"description":"Range aggregation result","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults.RangeResult","summary":"range","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"Scalar aggregation result","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults.ScalarResult","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateHistogram":{"description":"Date histogram aggregation result","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults.ValueResult","summary":"dateHistogram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults.Results":{"type":"object","properties":{"results":{"description":"List of nested aggregations","title":"results","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults.NestedResultValue"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Results","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.DateHistogramResults.DateHistogramResult":{"type":"object","properties":{"value":{"description":"Date in ISO 8601 format","maxLength":100,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Count of documents in the bucket","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DateHistogramResult","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.GroupByValueResults":{"type":"object","properties":{"results":{"description":"List of value aggregations","maxItems":1000,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.GroupByValueResults.NestedValueAggregationResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GroupByValueResults","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.DateHistogramResults":{"type":"object","properties":{"results":{"description":"List of date histogram aggregations","maxItems":200,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.DateHistogramResults.DateHistogramResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DateHistogramResults","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults":{"type":"object","properties":{"results":{"description":"List of nested aggregations","maxItems":1000,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults.Results"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedResults","description":"Results of `NESTED` aggregation type in a flattened form\naggregations in resulting array are keyed by requested aggregation `name`."},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults":{"type":"object","properties":{"name":{"description":"User-defined name of aggregation as derived from search request","maxLength":100,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Type of aggregation that must match provided kind as derived from search request","title":"type","type":"string","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldPath":{"description":"Field to aggregate by as derived from search request","maxLength":200,"title":"fieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AggregationResults","description":"","oneOf":[{"description":"","summary":"result","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.result"}]},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.result":{"type":"object","title":"result","properties":{"values":{"description":"Value aggregation results","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.ValueResults","summary":"values","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ranges":{"description":"Range aggregation results","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.RangeResults","summary":"ranges","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"Scalar aggregation results","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.ScalarResult","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"groupedByValue":{"description":"Group by value aggregation results","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.GroupByValueResults","summary":"groupedByValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateHistogram":{"description":"Date histogram aggregation results","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.DateHistogramResults","summary":"dateHistogram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nested":{"description":"Nested aggregation results","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData.AggregationResults.NestedResults","summary":"nested","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.stores.catalog.product.api.v3.EventuallyConsistentQueryProductsRequest":{"type":"object","properties":{"query":{"description":"WQL expression. Please pay attention that unlike other arrays when you want to filter by `inventory`, `options` or `variants` instead of standard array operators you must use `$matchItems` (for usage see examples).\nIt means that product will be returned only if one or more items satisfy all filters specified in $matchItems.\nFor example, if you have 2 variants: one visible with price 10 and another one not visible with price 20, when inside $matchItems you specify `visible:true` and `price > 15` nothing will be returned because there are no variants which satisfy both conditions.\nYou still can use `$isEmpty` and `$exists` operators for fields listed above.\nSee examples to understand supported capabilities.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.CursorQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"A list of requested fields to be included 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"}}},"title":"EventuallyConsistentQueryProductsRequest","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.CursorQuery":{"type":"object","properties":{"filter":{"description":"Filter object.\n\nLearn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object.\n\nLearn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).","maxItems":5,"title":"sort","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorQuery","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.CursorQuery.pagingMethod"}]},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.CursorQuery.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"cursorPaging":{"description":"Cursor paging options.\n\nLearn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.stores.catalog.product.api.v3.EventuallyConsistentQueryProductsResponse":{"type":"object","properties":{"products":{"description":"Products which satisfy the provided query.","title":"products","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging metadata. Contains cursor which can be used in next query.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.CursorPagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EventuallyConsistentQueryProductsResponse","description":""},"com.wix.stores.catalog.product.api.v3.QueryProductsRequest":{"type":"object","properties":{"query":{"description":"WQL expression","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.CursorQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"A list of requested fields to be included 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"}}},"title":"QueryProductsRequest","description":""},"com.wix.stores.catalog.product.api.v3.QueryProductsResponse":{"type":"object","properties":{"products":{"description":"The retrieved Products","title":"products","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging metadata.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.CursorPagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryProductsResponse","description":""},"com.wix.stores.catalog.product.api.v3.DeprecatedSearchProductsWithOffsetRequest":{"type":"object","properties":{"search":{"description":"Filter and sort with limit/offset based paging","$ref":"#/components/schemas/com.wix.ecommerce.commons.api.PlatformOffsetSearch","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"A list of requested fields to be included 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"}}},"title":"DeprecatedSearchProductsWithOffsetRequest","description":""},"com.wix.ecommerce.commons.api.PlatformOffsetSearch":{"type":"object","properties":{"filter":{"description":"A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf)","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object in the form [{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]","title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"aggregations":{"description":"Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.","title":"aggregations","type":"array","items":{"$ref":"#/components/schemas/wix.common.Aggregation"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"free text to match in searchable fields","$ref":"#/components/schemas/wix.common.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PlatformOffsetSearch","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wix.ecommerce.commons.api.PlatformOffsetSearch.pagingMethod"}]},"com.wix.ecommerce.commons.api.PlatformOffsetSearch.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"paging":{"description":"Pointer to page of results using offset. Can not be used together with 'cursor_paging'","$ref":"#/components/schemas/com.wix.ecommerce.commons.api.PlatformPaging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","maxLength":512,"title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.","title":"order","type":"string","$ref":"#/components/schemas/wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"wix.common.Aggregation":{"type":"object","properties":{"name":{"description":"User-defined name of aggregation, should be unique, will appear in aggregation results","maxLength":100,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Type of aggregation, client must provide matching aggregation field below","title":"type","type":"string","$ref":"#/components/schemas/wix.common.AggregationType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldPath":{"description":"Field to aggregate by, use dot notation to specify json path","maxLength":200,"title":"fieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"groupBy":{"description":"deprecated, use `nested` instead","$ref":"#/components/schemas/wix.common.Aggregation.GroupByAggregation","summary":"groupBy","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"message":"deprecated, use `nested` instead","replacedBy":"nested","targetRemovalDate":"2024-03-30"}}}},"title":"Aggregation","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/wix.common.Aggregation.kind"}]},"wix.common.Aggregation.kind":{"type":"object","title":"kind","properties":{"value":{"description":"Value aggregation","$ref":"#/components/schemas/wix.common.Aggregation.ValueAggregation","summary":"value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"range":{"description":"Range aggregation","$ref":"#/components/schemas/wix.common.Aggregation.RangeAggregation","summary":"range","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"Scalar aggregation","$ref":"#/components/schemas/wix.common.Aggregation.ScalarAggregation","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateHistogram":{"description":"Date histogram aggregation","$ref":"#/components/schemas/wix.common.Aggregation.DateHistogramAggregation","summary":"dateHistogram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nested":{"description":"Nested aggregation","$ref":"#/components/schemas/wix.common.Aggregation.NestedAggregation","summary":"nested","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.Aggregation.RangeAggregation.RangeBucket":{"type":"object","properties":{"from":{"description":"Inclusive lower bound of the range. Required if to is not given","title":"from","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"to":{"description":"Exclusive upper bound of the range. Required if from is not given","title":"to","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeBucket","description":""},"wix.common.Aggregation.ValueAggregation.SortType":{"type":"string","description":"","title":"SortType","enum":["COUNT","VALUE"]},"wix.common.Aggregation.ValueAggregation.SortDirection":{"type":"string","description":"","title":"SortDirection","enum":["DESC","ASC"]},"wix.common.Aggregation.ValueAggregation.MissingValues":{"type":"string","description":"","title":"MissingValues","enum":["EXCLUDE","INCLUDE"]},"wix.common.Aggregation.ValueAggregation.IncludeMissingValuesOptions":{"type":"object","properties":{"addToBucket":{"description":"Can specify custom bucket name. Defaults are [string -> \"N/A\"], [int -> \"0\"], [bool -> \"false\"] ...","maxLength":20,"title":"addToBucket","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IncludeMissingValuesOptions","description":""},"wix.common.ScalarType":{"type":"string","description":"","title":"ScalarType","enum":["UNKNOWN_SCALAR_TYPE","COUNT_DISTINCT","MIN","MAX","SUM","AVG"]},"wix.common.Aggregation.ValueAggregation":{"type":"object","properties":{"sortType":{"description":"Should sort by number of matches or value of the field","title":"sortType","type":"string","$ref":"#/components/schemas/wix.common.Aggregation.ValueAggregation.SortType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sortDirection":{"description":"Should sort in ascending or descending order","title":"sortDirection","type":"string","$ref":"#/components/schemas/wix.common.Aggregation.ValueAggregation.SortDirection","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"limit":{"description":"How many aggregations would you like to return? Can be between 1 and 250. 10 is the default.","title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"missingValues":{"description":"Should missing values be included or excluded from the aggregation results. Default is EXCLUDE","title":"missingValues","type":"string","$ref":"#/components/schemas/wix.common.Aggregation.ValueAggregation.MissingValues","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValueAggregation","description":"","oneOf":[{"description":"","summary":"options","$ref":"#/components/schemas/wix.common.Aggregation.ValueAggregation.options"}]},"wix.common.Aggregation.ValueAggregation.options":{"type":"object","title":"options","properties":{"includeOptions":{"description":"Options for including missing values","$ref":"#/components/schemas/wix.common.Aggregation.ValueAggregation.IncludeMissingValuesOptions","summary":"includeOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.Aggregation.NestedAggregation.NestedAggregationType":{"type":"string","description":"","title":"NestedAggregationType","enum":["UNKNOWN_AGGREGATION_TYPE","VALUE","RANGE","SCALAR","DATE_HISTOGRAM"]},"wix.common.Aggregation.RangeAggregation":{"type":"object","properties":{"buckets":{"description":"List of range buckets, where during aggregation each entity will be placed in the first bucket where its value falls into based on provided range bounds","maxItems":50,"title":"buckets","type":"array","items":{"$ref":"#/components/schemas/wix.common.Aggregation.RangeAggregation.RangeBucket"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeAggregation","description":""},"wix.common.Aggregation.ScalarAggregation":{"type":"object","properties":{"type":{"description":"Define the operator for the scalar aggregation","title":"type","type":"string","$ref":"#/components/schemas/wix.common.ScalarType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ScalarAggregation","description":""},"wix.common.Aggregation.DateHistogramAggregation":{"type":"object","properties":{"interval":{"description":"Interval for date histogram aggregation","title":"interval","type":"string","$ref":"#/components/schemas/wix.common.Aggregation.DateHistogramAggregation.Interval","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DateHistogramAggregation","description":""},"wix.common.Aggregation.DateHistogramAggregation.Interval":{"type":"string","description":"","title":"Interval","enum":["UNKNOWN_INTERVAL","YEAR","MONTH","WEEK","DAY","HOUR","MINUTE","SECOND"]},"wix.common.Aggregation.NestedAggregation.NestedAggregationItem":{"type":"object","properties":{"name":{"description":"User-defined name of aggregation, should be unique, will appear in aggregation results","maxLength":100,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Type of aggregation, client must provide matching aggregation field below","title":"type","type":"string","$ref":"#/components/schemas/wix.common.Aggregation.NestedAggregation.NestedAggregationType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldPath":{"description":"Field to aggregate by, use dont notation to specify json path","maxLength":200,"title":"fieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedAggregationItem","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/wix.common.Aggregation.NestedAggregation.NestedAggregationItem.kind"}]},"wix.common.Aggregation.NestedAggregation.NestedAggregationItem.kind":{"type":"object","title":"kind","properties":{"value":{"description":"Value aggregation","$ref":"#/components/schemas/wix.common.Aggregation.ValueAggregation","summary":"value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"range":{"description":"Range aggregation","$ref":"#/components/schemas/wix.common.Aggregation.RangeAggregation","summary":"range","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"Scalar aggregation","$ref":"#/components/schemas/wix.common.Aggregation.ScalarAggregation","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateHistogram":{"description":"Date histogram aggregation","$ref":"#/components/schemas/wix.common.Aggregation.DateHistogramAggregation","summary":"dateHistogram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.AggregationType":{"type":"string","description":"","title":"AggregationType","enum":["UNKNOWN_AGGREGATION_TYPE","VALUE","RANGE","SCALAR","DATE_HISTOGRAM","NESTED"]},"wix.common.Aggregation.NestedAggregation":{"type":"object","properties":{"nestedAggregations":{"description":"Flattened list of aggregations, where each next aggregation is nested within previous one","minItems":2,"maxItems":3,"title":"nestedAggregations","type":"array","items":{"$ref":"#/components/schemas/wix.common.Aggregation.NestedAggregation.NestedAggregationItem"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedAggregation","description":"Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one"},"wix.common.Aggregation.GroupByAggregation":{"type":"object","properties":{"name":{"description":"User-defined name of aggregation, should be unique, will appear in aggregation results","maxLength":100,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldPath":{"description":"Field to aggregate by","maxLength":200,"title":"fieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GroupByAggregation","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/wix.common.Aggregation.GroupByAggregation.kind"}]},"wix.common.Aggregation.GroupByAggregation.kind":{"type":"object","title":"kind","properties":{"value":{"description":"Value aggregation configuration","$ref":"#/components/schemas/wix.common.Aggregation.ValueAggregation","summary":"value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.SearchDetails":{"type":"object","properties":{"mode":{"description":"Defines how separate search terms in `expression` are combined","title":"mode","type":"string","$ref":"#/components/schemas/wix.common.SearchDetails.Mode","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"expression":{"description":"Search term or expression","maxLength":100,"title":"expression","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path","maxLength":200,"maxItems":20,"title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fuzzy":{"description":"Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm)","title":"fuzzy","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SearchDetails","description":""},"wix.common.SearchDetails.Mode":{"type":"string","description":"","title":"Mode","enum":["OR","AND"]},"com.wix.ecommerce.commons.api.PlatformPaging":{"type":"object","properties":{"limit":{"description":"Number of items to load.","minimum":0,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Number of items to skip in the current sort order.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PlatformPaging","description":""},"com.wix.stores.catalog.product.api.v3.DeprecatedSearchProductsWithOffsetResponse":{"type":"object","properties":{"products":{"description":"Products which satisfy the provided query.","title":"products","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging metadata.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.PagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"aggregationData":{"description":"Aggregation data.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.AggregationData","summary":"aggregationData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeprecatedSearchProductsWithOffsetResponse","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.PagingMetadata":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Offset that was requested.","title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"Total number of items that match the query.","title":"total","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tooManyToCount":{"description":"Flag that indicates the server failed to calculate the `total` field.","title":"tooManyToCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PagingMetadata","description":""},"com.wix.stores.catalog.product.api.v3.CountProductsRequest":{"type":"object","properties":{"filter":{"description":"A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf)\nTo understand supported filters and limitations see `SearchProducts` method.","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"free text to match in searchable fields","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CountProductsRequest","description":""},"com.wix.stores.catalog.product.api.v3.CountProductsResponse":{"type":"object","properties":{"count":{"description":"The amount of products which apply to the request","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CountProductsResponse","description":""},"com.wix.stores.catalog.product.api.v3.DoNotCallBulkCreateProductsRequest":{"type":"object","properties":{"products":{"description":"List of products to be created.","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 entity in the response.","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"A list of requested fields to be included in the response. Relevant only if `return_entity` true.","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"}}},"title":"DoNotCallBulkCreateProductsRequest","description":""},"com.wix.stores.catalog.product.api.v3.DoNotCallBulkCreateProductsResponse":{"type":"object","properties":{"results":{"description":"Products created by bulk action.","minItems":1,"maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.BulkProductResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DoNotCallBulkCreateProductsResponse","description":""},"com.wix.stores.catalog.product.api.v3.BulkProductResult":{"type":"object","properties":{"itemMetadata":{"description":"Bulk action metadata for product.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"item":{"description":"Full product entity.\n\nReturned only if `returnEntity: true` is passed in the request.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product","summary":"item","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkProductResult","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.ItemMetadata":{"type":"object","properties":{"id":{"description":"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originalIndex":{"description":"Index of the item within the request array. Allows for correlation between request and response items.","title":"originalIndex","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"success":{"description":"Whether the requested action was successful for this item. When `false`, the `error` field is populated.","title":"success","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"error":{"description":"Details about the error in case of failure.","$ref":"#/components/schemas/wix.api.ApplicationError","summary":"error","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemMetadata","description":""},"com.wix.stores.catalog.product.api.v3.upstream.wix.common.BulkActionMetadata":{"type":"object","properties":{"totalSuccesses":{"description":"Number of items that were successfully processed.","title":"totalSuccesses","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalFailures":{"description":"Number of items that couldn't be processed.","title":"totalFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"undetailedFailures":{"description":"Number of failures without details because detailed failure threshold was exceeded.","title":"undetailedFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkActionMetadata","description":""},"com.wix.stores.catalog.product.api.v3.DoNotCallBulkUpdateProductsRequest":{"type":"object","properties":{"products":{"description":"List of products to be updated.","minItems":1,"maxItems":100,"title":"products","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.MaskedProduct"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the full product entity in the response.","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"A list of requested fields to be included in the response. Relevant only if `return_entity` true.","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"}}},"title":"DoNotCallBulkUpdateProductsRequest","description":""},"com.wix.stores.catalog.product.api.v3.MaskedProduct":{"type":"object","properties":{"product":{"description":"product to be updated, may be partial.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product","summary":"product","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MaskedProduct","description":""},"com.wix.stores.catalog.product.api.v3.DoNotCallBulkUpdateProductsResponse":{"type":"object","properties":{"results":{"description":"Products updated by bulk action.","minItems":1,"maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.BulkProductResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DoNotCallBulkUpdateProductsResponse","description":""},"com.wix.stores.catalog.product.api.v3.BulkUpdateProductsByFilterRequest":{"type":"object","properties":{"filter":{"description":"Filter object in the following format:\n`\"filter\" : {\n\"name\": \"value1\",\n\"categoryIds\":{\"$in\":[\"categoryId1\", \"categoryId2\"]}\n}`\nExample of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"product":{"description":"Product with new field values.","$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/com.wix.stores.catalog.product.api.v3.upstream.wix.common.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateProductsByFilterRequest","description":""},"com.wix.stores.catalog.product.api.v3.BulkUpdateProductsByFilterResponse":{"type":"object","properties":{"jobId":{"description":"Job ID.\n\nPass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..","format":"GUID","title":"jobId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateProductsByFilterResponse","description":""},"com.wix.stores.catalog.product.api.v3.BulkDeleteProductsRequest":{"type":"object","properties":{"productIds":{"description":"IDs of products to be deleted.","minLength":1,"maxLength":36,"minItems":1,"maxItems":100,"title":"productIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDeleteProductsRequest","description":""},"com.wix.stores.catalog.product.api.v3.BulkDeleteProductsResponse":{"type":"object","properties":{"results":{"description":"Products deleted by bulk action.","minItems":1,"maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.BulkDeleteProductsResponse.BulkProductResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDeleteProductsResponse","description":""},"com.wix.stores.catalog.product.api.v3.BulkDeleteProductsResponse.BulkProductResult":{"type":"object","properties":{"itemMetadata":{"description":"Information about successful action or error for failure.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkProductResult","description":""},"com.wix.stores.catalog.product.api.v3.BulkDeleteProductsByFilterRequest":{"type":"object","properties":{"filter":{"description":"Filter object in the following format:\n`\"filter\" : {\n\"basePriceRange.minValue\": {\"$lte\": 5.99}\n}`\nExample of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Free text to match in searchable fields","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDeleteProductsByFilterRequest","description":""},"com.wix.stores.catalog.product.api.v3.BulkDeleteProductsByFilterResponse":{"type":"object","properties":{"jobId":{"description":"Job ID.\n\nPass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..","format":"GUID","title":"jobId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDeleteProductsByFilterResponse","description":""},"com.wix.stores.catalog.product.api.v3.UpdateExtendedFieldsRequest":{"type":"object","properties":{"productId":{"description":"ID of the entity to update.","minLength":1,"maxLength":36,"title":"productId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"namespace":{"description":"Identifier for the app whose extended fields are being updated.","minLength":4,"maxLength":150,"title":"namespace","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"namespaceData":{"description":"Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured.","title":"namespaceData","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"A list of requested fields to be included 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"}}},"title":"UpdateExtendedFieldsRequest","description":""},"com.wix.stores.catalog.product.api.v3.UpdateExtendedFieldsResponse":{"type":"object","properties":{"product":{"description":"The updated Product","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.Product","summary":"product","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateExtendedFieldsResponse","description":""},"com.wix.stores.catalog.product.api.v3.BulkAddInfoSectionsToProductsByFilterRequest":{"type":"object","properties":{"filter":{"description":"Filter object in the following format:\n`\"filter\" : {\n\"basePriceRange.minValue\": {\"$lte\": 5.99}\n}`\nExample of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"infoSectionIds":{"description":"Info sections to be added","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/com.wix.stores.catalog.product.api.v3.upstream.wix.common.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkAddInfoSectionsToProductsByFilterRequest","description":""},"com.wix.stores.catalog.product.api.v3.BulkAddInfoSectionsToProductsByFilterResponse":{"type":"object","properties":{"jobId":{"description":"Job ID.\n\nPass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..","format":"GUID","title":"jobId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkAddInfoSectionsToProductsByFilterResponse","description":""},"com.wix.stores.catalog.product.api.v3.BulkAddInfoSectionsToProductsRequest":{"type":"object","properties":{"products":{"description":"Products to be updated with id and revision.","minItems":1,"maxItems":100,"title":"products","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ProductIdWithRevision"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"infoSectionIds":{"description":"Products to be updated with id and revision.\nInfo section to be added","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 all updated product entities in the response. Default: false","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"A list of requested fields to be included 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"}}},"title":"BulkAddInfoSectionsToProductsRequest","description":""},"com.wix.stores.catalog.product.api.v3.ProductIdWithRevision":{"type":"object","properties":{"productId":{"description":"ID of product.","minLength":1,"maxLength":36,"title":"productId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"The revision of the Product","title":"revision","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ProductIdWithRevision","description":""},"com.wix.stores.catalog.product.api.v3.BulkAddInfoSectionsToProductsResponse":{"type":"object","properties":{"results":{"description":"Products updated by bulk action.","minItems":1,"maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.BulkProductResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkAddInfoSectionsToProductsResponse","description":""},"com.wix.stores.catalog.product.api.v3.BulkRemoveInfoSectionsFromProductsByFilterRequest":{"type":"object","properties":{"filter":{"description":"Filter object in the following format:\n`\"filter\" : {\n\"name\": \"value1\",\n\"categoryIds\":{\"$in\":[\"categoryId1\", \"categoryId2\"]}\n}`\nExample of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"infoSectionIds":{"description":"Info sections to be removed","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/com.wix.stores.catalog.product.api.v3.upstream.wix.common.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkRemoveInfoSectionsFromProductsByFilterRequest","description":""},"com.wix.stores.catalog.product.api.v3.BulkRemoveInfoSectionsFromProductsByFilterResponse":{"type":"object","properties":{"jobId":{"description":"Job ID.\n\nPass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..","format":"GUID","title":"jobId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkRemoveInfoSectionsFromProductsByFilterResponse","description":""},"com.wix.stores.catalog.product.api.v3.BulkRemoveInfoSectionsFromProductsRequest":{"type":"object","properties":{"products":{"description":"Products to be updated with id and revision.","minItems":1,"maxItems":100,"title":"products","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.ProductIdWithRevision"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"infoSectionIds":{"description":"Info section to be removed.","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 all updated product entities in the response. Default: false","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"A list of requested fields to be included in the response.","maxItems":5,"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"}}},"title":"BulkRemoveInfoSectionsFromProductsRequest","description":""},"com.wix.stores.catalog.product.api.v3.BulkRemoveInfoSectionsFromProductsResponse":{"type":"object","properties":{"results":{"description":"Products updated by bulk action.","minItems":1,"maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.BulkProductResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkRemoveInfoSectionsFromProductsResponse","description":""},"com.wix.stores.catalog.product.api.v3.BulkUpdateVariantsByFilterRequest":{"type":"object","properties":{"filter":{"description":"Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"variant":{"description":"Variant with new field values.","$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/com.wix.stores.catalog.product.api.v3.upstream.wix.common.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateVariantsByFilterRequest","description":""},"com.wix.stores.catalog.product.api.v3.BulkUpdateVariantsByFilterResponse":{"type":"object","properties":{"jobId":{"description":"Job ID.\n\nPass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..","format":"GUID","title":"jobId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateVariantsByFilterResponse","description":""},"com.wix.stores.catalog.product.api.v3.BulkAdjustVariantsByFilterRequest":{"type":"object","properties":{"filter":{"description":"Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$contains`","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"basePrice":{"description":"The amount or percentage to change the variants price by","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.AdjustValue","summary":"basePrice","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"salePrice":{"description":"The amount or percentage to change the variants sale price by","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.AdjustValue","summary":"salePrice","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cost":{"description":"The amount or percentage to change the variants cost by","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.AdjustValue","summary":"cost","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"salePriceFromBasePrice":{"description":"Set variant sale price from base price by applying provided discount to it.\nFor example variant base price 100$, variant sale price 95$, requested `sale_price_from_base_price.percentage` is 10, then old sale price ignored and new sale price set to 90 (100$ - 10%)","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.UnsignedAdjustValue","summary":"salePriceFromBasePrice","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rounding":{"description":"Defines rounding strategy of new calculated prices. Default: CURRENCY_PRECISION.","title":"rounding","type":"string","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.BulkAdjustVariantsByFilterRequest.RoundingStrategy","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Free text to match in searchable fields","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.upstream.wix.common.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkAdjustVariantsByFilterRequest","description":""},"com.wix.stores.catalog.product.api.v3.AdjustValue":{"type":"object","properties":{},"title":"AdjustValue","description":"","oneOf":[{"description":"","summary":"adjustValue","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.AdjustValue.adjustValue"}]},"com.wix.stores.catalog.product.api.v3.AdjustValue.adjustValue":{"type":"object","title":"adjustValue","properties":{"amount":{"description":"A decimal value to increase or reduce from the original value, can be negative.","title":"amount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"-999999999","lte":"999999999","maxScale":2}}},"percentage":{"description":"The percentage value to increase or reduce from the current value, can be negative.","minimum":-100,"maximum":1000,"title":"percentage","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.stores.catalog.product.api.v3.UnsignedAdjustValue":{"type":"object","properties":{},"title":"UnsignedAdjustValue","description":"","oneOf":[{"description":"","summary":"adjustValue","$ref":"#/components/schemas/com.wix.stores.catalog.product.api.v3.UnsignedAdjustValue.adjustValue"}]},"com.wix.stores.catalog.product.api.v3.UnsignedAdjustValue.adjustValue":{"type":"object","title":"adjustValue","properties":{"amount":{"description":"A decimal value to reduce from the original value.","title":"amount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0","lte":"999999999","maxScale":2}}},"percentage":{"description":"The percentage value to reduce from the original value.","minimum":0,"maximum":100,"title":"percentage","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.stores.catalog.product.api.v3.BulkAdjustVariantsByFilterRequest.RoundingStrategy":{"type":"string","description":"","title":"RoundingStrategy","enum":["UNKNOWN_ROUNDING_STRATEGY","NO_ROUNDING","CURRENCY_PRECISION","NEAREST_WHOLE_NUMBER"]},"com.wix.stores.catalog.product.api.v3.BulkAdjustVariantsByFilterResponse":{"type":"object","properties":{"jobId":{"description":"Job ID.\n\nPass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..","format":"GUID","title":"jobId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkAdjustVariantsByFilterResponse","description":""},"com.wix.stores.catalog.inventory.api.v3.BulkInventoryItemAction":{"type":"object","properties":{"inventoryItems":{"description":"Inventory items.","maxItems":1000,"title":"inventoryItems","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.inventory.api.v3.InventoryItem"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkInventoryItemAction","description":""}}},"title":"Product","description":"Short description of ProductService","fqdn":"wix.stores.catalog.v3.product"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About Products\n\nThe Products API allows you to create and manage a store's products. \n\nWith the products API you can:\n- [Create](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/create-product) and [Bulk Create Products](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-create-products)\n- [Update](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/update-product) and [Bulk Update Products](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-update-products)\n- [Delete](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/delete-product) and [Bulk Delete Products](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-delete-products)\n- [Get](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/get-product), [Search](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/search-products), [Query](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/query-products), and [Count Products](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/count-products)\n- [Bulk Update Variants](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-update-product-variants-by-filter)\n- [Bulk Add](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-add-products-to-categories-by-filter) and [Bulk Remove Products From Categories](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-remove-products-from-categories-by-filter)\n- And more\n\n## Before you begin\nIt’s important to note the following points before starting to code:\n- The site owner must install the Wix Stores app.\n\n## Sample flows\n* [Add and arrange products in category](slug::sample-use-cases-and-flows#Add-and-arrange-products-in-category*fallback::./sample-flows.md#Add-and-arrange-products-in-category)\n* [Prepare store for Christmas Sale](slug::sample-use-cases-and-flows#Prepare-store-for-christmas-sale*fallback::./sample-flows.md#Prepare-store-for-christmas-sale)\n"},{"displayName":"Sample Use Cases and Flows","slugifyName":"sample-use-cases-and-flows","content":"# Sample Use Cases and Flows\n\nThis article shares a possible use case your app could support, as well as sample flows that could support this use case.\nThis can be a helpful jumping-off point as you plan your app's implementation.\n\n## Add and arrange products in category\n\nHelp merchants to manage their products by using categories. For this we will be using the [Categories API](fallback::https://dev.wix.com/docs/rest/business-management/categories/introduction).\n\n1. Call [Create Category](fallback::https://dev.wix.com/docs/rest/business-management/categories/create-category) and pass `\"@wix/stores\"` to the `treeReference.appNamespace` field.\n2. Save `category.id` from the response. \n3. Call [Bulk Add Items To Category](fallback::https://dev.wix.com/docs/rest/business-management/categories/bulk-add-items-to-category) and pass the `items` you want to add to the category. After products added to category you can rearrange them for example to promote some products to be displayed in the beginning. Note that you can arrange only 100 products, more products can be added but you cannot control arrangement of them. Call [Set Arranged Items](fallback::https://dev.wix.com/docs/rest/business-management/categories/set-arranged-items) endpoint. Pass exactly same params as in step 2 but now `items` must be in same order in which you want to see them.\n4. Now you can load all products that belongs to given category and keep their arrangement by calling [Search Products](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/search-products) endpoint of ProductService with next body \n\n```json\n{\n \"search\": {\n \"sort\": [\n {\n \"selectItemsBy\": [\n {\n \"directCategoriesInfo.categories.id\": \"\"\n }\n ],\n \"fieldName\": \"directCategoriesInfo.categories.index\",\n \"order\": \"ASC\"\n }\n ],\n \"filter\": {\n \"directCategoriesInfo.categories\": {\n \"$matchItems\": [\n {\n \"id\": \"\"\n }\n ]\n }\n }\n }\n}\n```\nReplace `` with real category id from step 1. Pay attention to `sort.selectItemsBy` parameter where you must pass filter by categoryId, this allows you to sort products by arrangement that you set in CategoriesService on step 3.\n\n## Prepare store for Christmas Sale\nBefore big sale merchant might want to prepare store by creating a new category for products on sale, adding ribbons to products to catch visitors' attention and of course setting new sale price. Let's see how to do it step by step.\n1. [Add and arrange products in category](fallback::#add-and-arrange-products-in-category). This will allow visitor to filter by this category on storefront category page (if merchant enabled this filter in editor). Also it allows merchant to control which products visitor will see first.\n2. Create new ribbon by calling [Create Ribbon](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/ribbons-v3/create-ribbon) endpoint of external RibbonService. Save `ribbon.id` that you received in response.\n3. To add ribbon \"Sale!\" to all products in category call [Bulk Update Products By Filter](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-update-products-by-filter) endpoint. In `filter` send filter by category id. In `product` send only `ribbon`. So your request will look like:\n```json\n{\n \"filter\": {\n \"directCategoriesInfo.categories.id\": \"\"\n },\n \"product\": {\n \"ribbon\": {\n \"id\": \"\"\n }\n }\n}\n```\n4. Finally we need to update sale prices. For simplicity let's consider single product with one variant which has basePrice 100$ and salePrice 90$.\n\na) If you want to adjust all sale prices by some specific amount or percentage which depends on original sale price value call [Bulk Adjust Product Variants By Filter](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-adjust-product-variants-by-filter). For example if you want to decrease current sale prices by 10% pass next body:\n```json\n{\n \"salePrice\": {\n \"percentage\": -10\n }\n}\n```\nAfter this call example product will have basePrice 100$ and salePrice 81$.\n\nb) If you want to calculate new sale prices from base price by applying some discount to it call [Bulk Adjust Product Variants By Filter](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-adjust-product-variants-by-filter) with `salePriceFromSasePrice`. For example if you want to set sale as 20% discount from base price pass next body:\n```json\n{\n \"salePriceFromBasePrice\": {\n \"percentage\": 20\n }\n}\n```\nAfter this call example product will have basePrice 100$ and salePrice 80$.\n\nc) If you want to set exact sale price same for all variants of all products call [Bulk Update Product Variants By Filter](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-update-product-variants-by-filter) endpoint with variant with desired sale price:\n```json\n{\n \"variant\": {\n \"price\": {\n \"salePrice\": {\n \"amount\": \"75\"\n }\n }\n }\n}\n```\nAfter this call example product will have basePrice 100$ and salePrice 75$.\n"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}

Count Products

Permission Scopes