inner content

{"id":"1f76dbc2-7401-4614-8e43-1c41508e15de","createdDate":"2024-03-27T12:38:18.472Z","updatedDate":"2024-03-27T12:38:18.472Z","resourceId":"f4df6095-927c-469f-8541-d1dd0d33f547","api":{"schema":{"object":{"displayName":"Product Object","description":"","slug":"product-object","$ref":"#/components/schemas/wix.catalog.api.v1.Product","legacyExamples":[{"title":"Product","content":"{\n \"product\": {\n \"id\": \"91f7ac8b-2baa-289c-aa50-6d64764f35d3\",\n \"name\": \"Colombian Arabica\",\n \"slug\": \"colombian-arabica-1\",\n \"visible\": true,\n \"productType\": \"physical\",\n \"description\": \"

The best organic coffee that Colombia has to offer.

\",\n \"stock\": {\n \"trackInventory\": false,\n \"inStock\": true,\n \"inventoryStatus\": \"IN_STOCK\"\n },\n \"weightRange\": {\n \"minValue\": 0.25,\n \"maxValue\": 1\n },\n \"price\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 30,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$30.00\",\n \"pricePerUnit\": \"$0.12\"\n },\n \"pricePerUnit\": 0.12\n },\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 30,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$30.00\",\n \"pricePerUnit\": \"$0.12\"\n },\n \"pricePerUnit\": 0.12\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 30,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$30.00\",\n \"pricePerUnit\": \"$0.12\"\n },\n \"pricePerUnit\": 0.12\n },\n \"priceRange\": {\n \"minValue\": 35,\n \"maxValue\": 70\n },\n \"costRange\": {\n \"minValue\": 20,\n \"maxValue\": 40\n },\n \"pricePerUnitData\": {\n \"totalQuantity\": 250,\n \"totalMeasurementUnit\": \"G\",\n \"baseQuantity\": 1,\n \"baseMeasurementUnit\": \"G\"\n },\n \"additionalInfoSections\": [\n {\n \"title\": \"Storage recommendations\",\n \"description\": \"

To preserve your beans' fresh roasted flavor as long as possible, store them in an opaque, air-tight container at room temperature.

\\n\"\n }\n ],\n \"ribbons\": [\n {\n \"text\": \"Organic and Fair trade\"\n }\n ],\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_6000,h_3376,q_90/file.jpg\",\n \"width\": 6000,\n \"height\": 3376\n },\n \"id\": \"nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_6000,h_3376,q_90/file.jpg\",\n \"width\": 6000,\n \"height\": 3376\n },\n \"id\": \"nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg\"\n }\n ]\n },\n \"customTextFields\": [\n {\n \"title\": \"What would you like us to print on the custom label?\",\n \"maxLength\": 200,\n \"mandatory\": false\n }\n ],\n \"manageVariants\": true,\n \"productOptions\": [\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Weight\",\n \"choices\": [\n {\n \"value\": \"250g\",\n \"description\": \"250g\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"500g\",\n \"description\": \"500g\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n }\n ]\n },\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Ground for\",\n \"choices\": [\n {\n \"value\": \"Stovetop\",\n \"description\": \"Stovetop\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"Filter\",\n \"description\": \"Filter\",\n \"inStock\": true,\n \"visible\": true\n }\n ]\n }\n ],\n \"productPageUrl\": {\n \"base\": \"https://wixsite.com/examplestore\",\n \"path\": \"/product-page/colombian-arabica-1\"\n },\n \"numericId\": \"1586693639134000\",\n \"inventoryItemId\": \"6e085374-d455-d763-55af-929b89b0ca2c\",\n \"discount\": {\n \"type\": \"AMOUNT\",\n \"value\": 5\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\",\n \"00000000-000000-000000-000000000001\"\n ],\n \"variants\": [\n {\n \"id\": \"00000000-0000-0020-0005-a316e6ba5b37\",\n \"choices\": {\n \"Weight\": \"250g\",\n \"Ground for\": \"Stovetop\"\n },\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 30,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$30.00\",\n \"pricePerUnit\": \"$0.12\"\n },\n \"pricePerUnit\": 0.12\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 30,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$30.00\",\n \"pricePerUnit\": \"$0.12\"\n },\n \"pricePerUnit\": 0.12\n },\n \"costAndProfitData\": {\n \"itemCost\": 20,\n \"formattedItemCost\": \"$20.00\",\n \"profit\": 10,\n \"formattedProfit\": \"$10.00\",\n \"profitMargin\": 0.3333\n },\n \"weight\": 0.25,\n \"sku\": \"10001\",\n \"visible\": true\n }\n },\n {\n \"id\": \"00000000-0000-0021-0005-a316e6ba5b37\",\n \"choices\": {\n \"Weight\": \"250g\",\n \"Ground for\": \"Filter\"\n },\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 30,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$30.00\",\n \"pricePerUnit\": \"$0.12\"\n },\n \"pricePerUnit\": 0.12\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 30,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$30.00\",\n \"pricePerUnit\": \"$0.12\"\n },\n \"pricePerUnit\": 0.12\n },\n \"costAndProfitData\": {\n \"itemCost\": 20,\n \"formattedItemCost\": \"$20.00\",\n \"profit\": 10,\n \"formattedProfit\": \"$10.00\",\n \"profitMargin\": 0.3333\n },\n \"weight\": 0.25,\n \"sku\": \"10003\",\n \"visible\": true\n }\n },\n {\n \"id\": \"00000000-0000-003f-0005-a316e6ba5b37\",\n \"choices\": {\n \"Weight\": \"500g\",\n \"Ground for\": \"Stovetop\"\n },\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 65,\n \"discountedPrice\": 60,\n \"formatted\": {\n \"price\": \"$65.00\",\n \"discountedPrice\": \"$60.00\",\n \"pricePerUnit\": \"$0.24\"\n },\n \"pricePerUnit\": 0.24\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 65,\n \"discountedPrice\": 60,\n \"formatted\": {\n \"price\": \"$65.00\",\n \"discountedPrice\": \"$60.00\",\n \"pricePerUnit\": \"$0.24\"\n },\n \"pricePerUnit\": 0.24\n },\n \"costAndProfitData\": {\n \"itemCost\": 40,\n \"formattedItemCost\": \"$40.00\",\n \"profit\": 20,\n \"formattedProfit\": \"$20.00\",\n \"profitMargin\": 0.3333\n },\n \"weight\": 0.5,\n \"sku\": \"10002\",\n \"visible\": true\n }\n },\n {\n \"id\": \"00000000-0000-0040-0005-a316e6ba5b37\",\n \"choices\": {\n \"Weight\": \"500g\",\n \"Ground for\": \"Filter\"\n },\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 70,\n \"discountedPrice\": 65,\n \"formatted\": {\n \"price\": \"$70.00\",\n \"discountedPrice\": \"$65.00\",\n \"pricePerUnit\": \"$0.26\"\n },\n \"pricePerUnit\": 0.26\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 70,\n \"discountedPrice\": 65,\n \"formatted\": {\n \"price\": \"$70.00\",\n \"discountedPrice\": \"$65.00\",\n \"pricePerUnit\": \"$0.26\"\n },\n \"pricePerUnit\": 0.26\n },\n \"costAndProfitData\": {\n \"itemCost\": 40,\n \"formattedItemCost\": \"$40.00\",\n \"profit\": 25,\n \"formattedProfit\": \"$25.00\",\n \"profitMargin\": 0.3846\n },\n \"weight\": 1,\n \"sku\": \"10004\",\n \"visible\": true\n }\n }\n ],\n \"lastUpdated\": \"2022-07-12T10:02:26.664Z\",\n \"createdDate\": \"2020-04-12T12:13:59.134Z\",\n \"seoData\": {\n \"tags\": [\n {\n \"type\": \"title\",\n \"children\": \"Colombian Arabica | Organic and Fair Trade\",\n \"custom\": false,\n \"disabled\": false\n },\n {\n \"type\": \"meta\",\n \"props\": {\n \"name\": \"description\",\n \"content\": \"The best organic fair trade coffee that Colombia has to offer.\"\n },\n \"children\": \"\",\n \"custom\": false,\n \"disabled\": false\n }\n ]\n },\n \"ribbon\": \"Organic and Fair trade\",\n \"brand\": \"Coffee Company\"\n }\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"methods":[{"summary":"Create Product","description":"Creates a new product.","operationId":"wix.catalog.api.v1.CatalogWriteApi.CreateProduct","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.CreateProductResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v1/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v1/products","destinationPath":"/v1/products","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateProductRequest","description":"","properties":{"product":{"description":"Product information.","$ref":"#/components/schemas/wix.catalog.api.v1.Product","summary":"product","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["product.name","product.priceData","product.priceData.price","product.costAndProfitData.itemCost"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.CreateProductRequest","responseMessage":"wix.catalog.api.v1.CreateProductResponse"},"legacyExamples":[{"name":"CreateProduct","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/products' \\\n --data-binary '{\n \"product\": {\n \"name\": \"T-shirt\",\n \"productType\": \"physical\",\n \"priceData\": {\n \"price\": 10.5\n },\n \"costAndProfitData\": {\n \"itemCost\": 7\n },\n \"description\": \"nice summer t-shirt\",\n \"sku\": \"123df\",\n \"visible\": false,\n \"ribbon\": \"Sale\",\n \"brand\": \"Nice\",\n \"weight\": 0.2,\n \"discount\": {\n \t\"type\": \"AMOUNT\",\n \t\"value\": 1\n },\n \"manageVariants\": true,\n \"productOptions\": [\n {\n \"name\": \"Size\",\n \"choices\": [\n {\n \"value\": \"S\",\n \"description\": \"S\"\n },\n {\n \"value\": \"L\",\n \"description\": \"L\"\n }\n ]\n }\n ]\n }\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"product\": {\n \"id\": \"4224c24b-5a58-4d14-8793-623e812fa377\",\n \"name\": \"T-shirt\",\n \"slug\": \"t-shirt\",\n \"visible\": false,\n \"productType\": \"physical\",\n \"description\": \"nice summer t-shirt\",\n \"weightRange\": {\n \"minValue\": 0,\n \"maxValue\": 0.2\n },\n \"stock\": {\n \"trackInventory\": false,\n \"inStock\": true,\n \"inventoryStatus\": \"IN_STOCK\"\n },\n \"price\": {\n \"currency\": \"USD\",\n \"price\": 10.5,\n \"discountedPrice\": 9.5,\n \"formatted\": {\n \"price\": \"$10.50\",\n \"discountedPrice\": \"$9.50\"\n }\n },\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 10.5,\n \"discountedPrice\": 9.5,\n \"formatted\": {\n \"price\": \"$10.50\",\n \"discountedPrice\": \"$9.50\"\n }\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 10.5,\n \"discountedPrice\": 9.5,\n \"formatted\": {\n \"price\": \"$10.50\",\n \"discountedPrice\": \"$9.50\"\n }\n },\n \"priceRange\": {\n \"minValue\": 10.5,\n \"maxValue\": 10.5\n },\n \"costRange\": {\n \"minValue\": 0,\n \"maxValue\": 7\n },\n \"additionalInfoSections\": [],\n \"ribbons\": [\n {\n \"text\": \"Sale\"\n }\n ],\n \"media\": {\n \"items\": []\n },\n \"customTextFields\": [],\n \"manageVariants\": true,\n \"productOptions\": [\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Size\",\n \"choices\": [\n {\n \"value\": \"S\",\n \"description\": \"S\",\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"L\",\n \"description\": \"L\",\n \"inStock\": true,\n \"visible\": true\n }\n ]\n }\n ],\n \"productPageUrl\": {\n \"base\": \"https://wixsite.com/examplestore\",\n \"path\": \"/product-page/t-shirt\"\n },\n \"numericId\": \"1657626871550000\",\n \"inventoryItemId\": \"bddb3db4-a5a7-b2eb-786c-9dc17ed05c88\",\n \"discount\": {\n \"type\": \"AMOUNT\",\n \"value\": 1\n },\n \"collectionIds\": [\n \"00000000-000000-000000-000000000001\"\n ],\n \"variants\": [\n {\n \"id\": \"05519a6e-222b-413a-957c-0ef7a32779b5\",\n \"choices\": {\n \"Size\": \"S\"\n },\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 10.5,\n \"discountedPrice\": 9.5,\n \"formatted\": {\n \"price\": \"$10.50\",\n \"discountedPrice\": \"$9.50\"\n }\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 10.5,\n \"discountedPrice\": 9.5,\n \"formatted\": {\n \"price\": \"$10.50\",\n \"discountedPrice\": \"$9.50\"\n }\n },\n \"costAndProfitData\": {\n \"itemCost\": 7,\n \"formattedItemCost\": \"$7.00\",\n \"profit\": 2.5,\n \"formattedProfit\": \"$2.50\",\n \"profitMargin\": 0.2632\n },\n \"weight\": 0.2,\n \"sku\": \"123df\",\n \"visible\": false\n }\n },\n {\n \"id\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"choices\": {\n \"Size\": \"L\"\n },\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 10.5,\n \"discountedPrice\": 9.5,\n \"formatted\": {\n \"price\": \"$10.50\",\n \"discountedPrice\": \"$9.50\"\n }\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 10.5,\n \"discountedPrice\": 9.5,\n \"formatted\": {\n \"price\": \"$10.50\",\n \"discountedPrice\": \"$9.50\"\n }\n },\n \"costAndProfitData\": {\n \"itemCost\": 7,\n \"formattedItemCost\": \"$7.00\",\n \"profit\": 2.5,\n \"formattedProfit\": \"$2.50\",\n \"profitMargin\": 0.2632\n },\n \"weight\": 0.2,\n \"sku\": \"123df\",\n \"visible\": false\n }\n }\n ],\n \"lastUpdated\": \"2022-07-12T11:54:31.550Z\",\n \"createdDate\": \"2022-07-12T11:54:31.550Z\",\n \"ribbon\": \"Sale\",\n \"brand\": \"Nice\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/products","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.CreateProductRequest","responseMessage":"wix.catalog.api.v1.CreateProductResponse"},"legacyExamples":[{"name":"CreateProduct","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/products' \\\n --data-binary '{\n \"product\": {\n \"name\": \"T-shirt\",\n \"productType\": \"physical\",\n \"priceData\": {\n \"price\": 10.5\n },\n \"costAndProfitData\": {\n \"itemCost\": 7\n },\n \"description\": \"nice summer t-shirt\",\n \"sku\": \"123df\",\n \"visible\": false,\n \"ribbon\": \"Sale\",\n \"brand\": \"Nice\",\n \"weight\": 0.2,\n \"discount\": {\n \t\"type\": \"AMOUNT\",\n \t\"value\": 1\n },\n \"manageVariants\": true,\n \"productOptions\": [\n {\n \"name\": \"Size\",\n \"choices\": [\n {\n \"value\": \"S\",\n \"description\": \"S\"\n },\n {\n \"value\": \"L\",\n \"description\": \"L\"\n }\n ]\n }\n ]\n }\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"product\": {\n \"id\": \"4224c24b-5a58-4d14-8793-623e812fa377\",\n \"name\": \"T-shirt\",\n \"slug\": \"t-shirt\",\n \"visible\": false,\n \"productType\": \"physical\",\n \"description\": \"nice summer t-shirt\",\n \"weightRange\": {\n \"minValue\": 0,\n \"maxValue\": 0.2\n },\n \"stock\": {\n \"trackInventory\": false,\n \"inStock\": true,\n \"inventoryStatus\": \"IN_STOCK\"\n },\n \"price\": {\n \"currency\": \"USD\",\n \"price\": 10.5,\n \"discountedPrice\": 9.5,\n \"formatted\": {\n \"price\": \"$10.50\",\n \"discountedPrice\": \"$9.50\"\n }\n },\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 10.5,\n \"discountedPrice\": 9.5,\n \"formatted\": {\n \"price\": \"$10.50\",\n \"discountedPrice\": \"$9.50\"\n }\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 10.5,\n \"discountedPrice\": 9.5,\n \"formatted\": {\n \"price\": \"$10.50\",\n \"discountedPrice\": \"$9.50\"\n }\n },\n \"priceRange\": {\n \"minValue\": 10.5,\n \"maxValue\": 10.5\n },\n \"costRange\": {\n \"minValue\": 0,\n \"maxValue\": 7\n },\n \"additionalInfoSections\": [],\n \"ribbons\": [\n {\n \"text\": \"Sale\"\n }\n ],\n \"media\": {\n \"items\": []\n },\n \"customTextFields\": [],\n \"manageVariants\": true,\n \"productOptions\": [\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Size\",\n \"choices\": [\n {\n \"value\": \"S\",\n \"description\": \"S\",\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"L\",\n \"description\": \"L\",\n \"inStock\": true,\n \"visible\": true\n }\n ]\n }\n ],\n \"productPageUrl\": {\n \"base\": \"https://wixsite.com/examplestore\",\n \"path\": \"/product-page/t-shirt\"\n },\n \"numericId\": \"1657626871550000\",\n \"inventoryItemId\": \"bddb3db4-a5a7-b2eb-786c-9dc17ed05c88\",\n \"discount\": {\n \"type\": \"AMOUNT\",\n \"value\": 1\n },\n \"collectionIds\": [\n \"00000000-000000-000000-000000000001\"\n ],\n \"variants\": [\n {\n \"id\": \"05519a6e-222b-413a-957c-0ef7a32779b5\",\n \"choices\": {\n \"Size\": \"S\"\n },\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 10.5,\n \"discountedPrice\": 9.5,\n \"formatted\": {\n \"price\": \"$10.50\",\n \"discountedPrice\": \"$9.50\"\n }\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 10.5,\n \"discountedPrice\": 9.5,\n \"formatted\": {\n \"price\": \"$10.50\",\n \"discountedPrice\": \"$9.50\"\n }\n },\n \"costAndProfitData\": {\n \"itemCost\": 7,\n \"formattedItemCost\": \"$7.00\",\n \"profit\": 2.5,\n \"formattedProfit\": \"$2.50\",\n \"profitMargin\": 0.2632\n },\n \"weight\": 0.2,\n \"sku\": \"123df\",\n \"visible\": false\n }\n },\n {\n \"id\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"choices\": {\n \"Size\": \"L\"\n },\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 10.5,\n \"discountedPrice\": 9.5,\n \"formatted\": {\n \"price\": \"$10.50\",\n \"discountedPrice\": \"$9.50\"\n }\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 10.5,\n \"discountedPrice\": 9.5,\n \"formatted\": {\n \"price\": \"$10.50\",\n \"discountedPrice\": \"$9.50\"\n }\n },\n \"costAndProfitData\": {\n \"itemCost\": 7,\n \"formattedItemCost\": \"$7.00\",\n \"profit\": 2.5,\n \"formattedProfit\": \"$2.50\",\n \"profitMargin\": 0.2632\n },\n \"weight\": 0.2,\n \"sku\": \"123df\",\n \"visible\": false\n }\n }\n ],\n \"lastUpdated\": \"2022-07-12T11:54:31.550Z\",\n \"createdDate\": \"2022-07-12T11:54:31.550Z\",\n \"ribbon\": \"Sale\",\n \"brand\": \"Nice\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Create Product","slugifiedName":"create-product"}},{"summary":"Update Product","description":"Updates specified fields in a product.","operationId":"wix.catalog.api.v1.CatalogWriteApi.UpdateProduct","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"product.id","description":"Product ID (generated automatically by the catalog).","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.UpdateProductResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v1/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v1/products","destinationPath":"/v1/products","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateProductRequest","description":"","properties":{"product":{"description":"","$ref":"#/components/schemas/wix.catalog.api.v1.Product","summary":"product","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["product.id","product"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.UpdateProductRequest","responseMessage":"wix.catalog.api.v1.UpdateProductResponse"},"legacyExamples":[{"name":"UpdateProduct","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X PATCH \\\n 'https://www.wixapis.com/stores/v1/products/83f41911-5375-4ede-aafa-68f8b6dee9e2' \\\n --data-binary '{\n \"product\": {\n \"name\": \"T-shirt\",\n \"productType\": \"physical\",\n \"priceData\": {\n \"price\": 12.5\n },\n \"description\": \"nice summer t-shirt\",\n \"sku\": \"123df\",\n \"visible\": false,\n \"weight\": 0.2,\n \"ribbon\": \"Sold Out\",\n \"brand\": \"Nice\",\n \"discount\": {\n \t\"type\": \"AMOUNT\",\n \t\"value\": 2\n },\n \"productOptions\": [\n {\n \"name\": \"Size\",\n \"choices\": [\n {\n \"value\": \"S\",\n \"description\": \"Small\"\n }\n ]\n }\n ]\n }\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"product\": {\n \"id\": \"83f41911-5375-4ede-aafa-68f8b6dee9e2\",\n \"name\": \"T-shirt\",\n \"slug\": \"t-shirt-1\",\n \"visible\": false,\n \"productType\": \"physical\",\n \"description\": \"nice summer t-shirt\",\n \"stock\": {\n \"trackInventory\": false,\n \"inStock\": true\n },\n \"price\": {\n \"currency\": \"USD\",\n \"price\": 12.5,\n \"discountedPrice\": 10.5,\n \"formatted\": {\n \"price\": \"$12.50\",\n \"discountedPrice\": \"$10.50\"\n }\n },\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 12.5,\n \"discountedPrice\": 10.5,\n \"formatted\": {\n \"price\": \"$12.50\",\n \"discountedPrice\": \"$10.50\"\n }\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 12.5,\n \"discountedPrice\": 10.5,\n \"formatted\": {\n \"price\": \"$12.50\",\n \"discountedPrice\": \"$10.50\"\n }\n },\n \"additionalInfoSections\": [],\n \"ribbons\": [\n {\n \"text\": \"Sold Out\"\n }\n ],\n \"media\": {\n \"items\": []\n },\n \"customTextFields\": [],\n \"manageVariants\": true,\n \"productOptions\": [\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Size\",\n \"choices\": [\n {\n \"value\": \"S\",\n \"description\": \"Small\",\n \"inStock\": true,\n \"visible\": true\n }\n ]\n }\n ],\n \"productPageUrl\": {\n \"base\": \"https://roysha.wixsite.com/roycoffeestore\",\n \"path\": \"/product-page/t-shirt-1\"\n },\n \"numericId\": \"1620048324853000\",\n \"inventoryItemId\": \"7c0be6ee-ac8a-b121-5505-97074921161d\",\n \"discount\": {\n \"type\": \"AMOUNT\",\n \"value\": 2\n },\n \"collectionIds\": [],\n \"variants\": [\n {\n \"id\": \"9a86bab7-0558-48a7-a953-0594e6d5534d\",\n \"choices\": {\n \"Size\": \"Small\"\n },\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 12.5,\n \"discountedPrice\": 10.5,\n \"formatted\": {\n \"price\": \"$12.50\",\n \"discountedPrice\": \"$10.50\"\n }\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 12.5,\n \"discountedPrice\": 10.5,\n \"formatted\": {\n \"price\": \"$12.50\",\n \"discountedPrice\": \"$10.50\"\n }\n },\n \"weight\": 0.2,\n \"sku\": \"123df\",\n \"visible\": false\n }\n }\n ],\n \"lastUpdated\": \"2021-05-03T13:44:17.610Z\",\n \"ribbon\": \"Sold Out\",\n \"brand\": \"Nice\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"patch","path":"/v1/products/{product.id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.UpdateProductRequest","responseMessage":"wix.catalog.api.v1.UpdateProductResponse"},"legacyExamples":[{"name":"UpdateProduct","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X PATCH \\\n 'https://www.wixapis.com/stores/v1/products/83f41911-5375-4ede-aafa-68f8b6dee9e2' \\\n --data-binary '{\n \"product\": {\n \"name\": \"T-shirt\",\n \"productType\": \"physical\",\n \"priceData\": {\n \"price\": 12.5\n },\n \"description\": \"nice summer t-shirt\",\n \"sku\": \"123df\",\n \"visible\": false,\n \"weight\": 0.2,\n \"ribbon\": \"Sold Out\",\n \"brand\": \"Nice\",\n \"discount\": {\n \t\"type\": \"AMOUNT\",\n \t\"value\": 2\n },\n \"productOptions\": [\n {\n \"name\": \"Size\",\n \"choices\": [\n {\n \"value\": \"S\",\n \"description\": \"Small\"\n }\n ]\n }\n ]\n }\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"product\": {\n \"id\": \"83f41911-5375-4ede-aafa-68f8b6dee9e2\",\n \"name\": \"T-shirt\",\n \"slug\": \"t-shirt-1\",\n \"visible\": false,\n \"productType\": \"physical\",\n \"description\": \"nice summer t-shirt\",\n \"stock\": {\n \"trackInventory\": false,\n \"inStock\": true\n },\n \"price\": {\n \"currency\": \"USD\",\n \"price\": 12.5,\n \"discountedPrice\": 10.5,\n \"formatted\": {\n \"price\": \"$12.50\",\n \"discountedPrice\": \"$10.50\"\n }\n },\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 12.5,\n \"discountedPrice\": 10.5,\n \"formatted\": {\n \"price\": \"$12.50\",\n \"discountedPrice\": \"$10.50\"\n }\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 12.5,\n \"discountedPrice\": 10.5,\n \"formatted\": {\n \"price\": \"$12.50\",\n \"discountedPrice\": \"$10.50\"\n }\n },\n \"additionalInfoSections\": [],\n \"ribbons\": [\n {\n \"text\": \"Sold Out\"\n }\n ],\n \"media\": {\n \"items\": []\n },\n \"customTextFields\": [],\n \"manageVariants\": true,\n \"productOptions\": [\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Size\",\n \"choices\": [\n {\n \"value\": \"S\",\n \"description\": \"Small\",\n \"inStock\": true,\n \"visible\": true\n }\n ]\n }\n ],\n \"productPageUrl\": {\n \"base\": \"https://roysha.wixsite.com/roycoffeestore\",\n \"path\": \"/product-page/t-shirt-1\"\n },\n \"numericId\": \"1620048324853000\",\n \"inventoryItemId\": \"7c0be6ee-ac8a-b121-5505-97074921161d\",\n \"discount\": {\n \"type\": \"AMOUNT\",\n \"value\": 2\n },\n \"collectionIds\": [],\n \"variants\": [\n {\n \"id\": \"9a86bab7-0558-48a7-a953-0594e6d5534d\",\n \"choices\": {\n \"Size\": \"Small\"\n },\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 12.5,\n \"discountedPrice\": 10.5,\n \"formatted\": {\n \"price\": \"$12.50\",\n \"discountedPrice\": \"$10.50\"\n }\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 12.5,\n \"discountedPrice\": 10.5,\n \"formatted\": {\n \"price\": \"$12.50\",\n \"discountedPrice\": \"$10.50\"\n }\n },\n \"weight\": 0.2,\n \"sku\": \"123df\",\n \"visible\": false\n }\n }\n ],\n \"lastUpdated\": \"2021-05-03T13:44:17.610Z\",\n \"ribbon\": \"Sold Out\",\n \"brand\": \"Nice\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Update Product","slugifiedName":"update-product"}},{"summary":"Delete Product","description":"Deletes a product.","operationId":"wix.catalog.api.v1.CatalogWriteApi.DeleteProduct","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"ID of the product to delete.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.DeleteProductResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v1/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v1/products","destinationPath":"/v1/products","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.DeleteProductRequest","responseMessage":"wix.catalog.api.v1.DeleteProductResponse"},"legacyExamples":[{"name":"DeleteProduct","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X DELETE \\\n 'https://www.wixapis.com/stores/v1/products/1044e7e4-37d1-0705-c5b3-623baae212fd' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"delete","path":"/v1/products/{id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.DeleteProductRequest","responseMessage":"wix.catalog.api.v1.DeleteProductResponse"},"legacyExamples":[{"name":"DeleteProduct","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X DELETE \\\n 'https://www.wixapis.com/stores/v1/products/1044e7e4-37d1-0705-c5b3-623baae212fd' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Delete Product","slugifiedName":"delete-product"}},{"summary":"Update Product Variants","description":"Updates variants of a specified product.","operationId":"wix.catalog.api.v1.CatalogWriteApi.UpdateVariants","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"ID of the product with managed variants.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.UpdateVariantsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v1/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v1/products","destinationPath":"/v1/products","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateVariantsRequest","description":"","properties":{"variants":{"description":"Variant info to update.","title":"variants","type":"array","items":{"$ref":"#/components/schemas/wix.catalog.api.v1.VariantOverride"},"x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["id"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.UpdateVariantsRequest","responseMessage":"wix.catalog.api.v1.UpdateVariantsResponse"},"legacyExamples":[{"name":"UpdateVariants","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X PATCH \\\n 'https://www.wixapis.com/stores/v1/products/1044e7e4-37d1-0705-c5b3-623baae212fd/variants' \\\n --data-binary '{\n \"variants\": [\n {\n \"choices\": {\n \"Size\": 'S',\n \"Color\": 'Blue'\n },\n \"price\": 100\n }\n ]\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"variants\": [\n {\n \"id\": \"00000000-0000-0020-0005-92338aaf6c4a\",\n \"choices\": {\n \"Size\": \"S\",\n \"Color\": \"Blue\"\n },\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 100,\n \"discountedPrice\": 100,\n \"formatted\": {\n \"price\": \"$100.00\",\n \"discountedPrice\": \"$100.00\"\n }\n },\n \"weight\": 0,\n \"sku\": \"\",\n \"visible\": true\n }\n }\n ]\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"patch","path":"/v1/products/{id}/variants","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.UpdateVariantsRequest","responseMessage":"wix.catalog.api.v1.UpdateVariantsResponse"},"legacyExamples":[{"name":"UpdateVariants","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X PATCH \\\n 'https://www.wixapis.com/stores/v1/products/1044e7e4-37d1-0705-c5b3-623baae212fd/variants' \\\n --data-binary '{\n \"variants\": [\n {\n \"choices\": {\n \"Size\": 'S',\n \"Color\": 'Blue'\n },\n \"price\": 100\n }\n ]\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"variants\": [\n {\n \"id\": \"00000000-0000-0020-0005-92338aaf6c4a\",\n \"choices\": {\n \"Size\": \"S\",\n \"Color\": \"Blue\"\n },\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 100,\n \"discountedPrice\": 100,\n \"formatted\": {\n \"price\": \"$100.00\",\n \"discountedPrice\": \"$100.00\"\n }\n },\n \"weight\": 0,\n \"sku\": \"\",\n \"visible\": true\n }\n }\n ]\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Update Product Variants","slugifiedName":"update-product-variants"}},{"summary":"Reset All Product Variant Data","description":"Resets the data (such as the price and the weight) of all variants for a given product to their default values.","operationId":"wix.catalog.api.v1.CatalogWriteApi.ResetAllVariantData","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Product ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.ResetAllVariantDataResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v1/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v1/products","destinationPath":"/v1/products","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"ResetAllVariantDataRequest","description":"","properties":{},"deprecated":false,"required":["id"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.ResetAllVariantDataRequest","responseMessage":"wix.catalog.api.v1.ResetAllVariantDataResponse"},"legacyExamples":[{"name":"ResetAllVariantData","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/products/1044e7e4-37d1-0705-c5b3-623baae212fd/variants/resetToDefault' \\\n --data-binary '{}' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/products/{id}/variants/resetToDefault","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.ResetAllVariantDataRequest","responseMessage":"wix.catalog.api.v1.ResetAllVariantDataResponse"},"legacyExamples":[{"name":"ResetAllVariantData","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/products/1044e7e4-37d1-0705-c5b3-623baae212fd/variants/resetToDefault' \\\n --data-binary '{}' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Reset All Product Variant Data","slugifiedName":"reset-all-product-variant-data"}},{"summary":"Add Products To Collection","description":"Adds products to a specified collection.","operationId":"wix.catalog.api.v1.CatalogWriteApi.AddProductsToCollection","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Collection ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.AddProductsToCollectionResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v1/collections","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v1/collections","destinationPath":"/v1/collections","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"AddProductsToCollectionRequest","description":"","properties":{"productIds":{"description":"IDs of the products to add to the collection, separated by commas.","maxItems":1000,"title":"productIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["id"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.AddProductsToCollectionRequest","responseMessage":"wix.catalog.api.v1.AddProductsToCollectionResponse"},"legacyExamples":[{"name":"AddProductsToCollection","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/collections/1044e7e4-37d1-0705-c5b3-623baae212fd/productIds' \\\n --data-binary '{\n \"productIds\": [\n \"a60fef92-ee29-070f-a7ed-9bbc3cc1c2f4\",\n \"d9cd1d2f-8318-486b-a6f3-aa0c4e81ccd2\"\n ]\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/collections/{id}/productIds","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.AddProductsToCollectionRequest","responseMessage":"wix.catalog.api.v1.AddProductsToCollectionResponse"},"legacyExamples":[{"name":"AddProductsToCollection","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/collections/1044e7e4-37d1-0705-c5b3-623baae212fd/productIds' \\\n --data-binary '{\n \"productIds\": [\n \"a60fef92-ee29-070f-a7ed-9bbc3cc1c2f4\",\n \"d9cd1d2f-8318-486b-a6f3-aa0c4e81ccd2\"\n ]\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Add Products To Collection","slugifiedName":"add-products-to-collection"}},{"summary":"Remove Products From Collection","description":"Deletes products from a specified collection.","operationId":"wix.catalog.api.v1.CatalogWriteApi.RemoveProductsFromCollection","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Collection ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.RemoveProductsFromCollectionResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v1/collections","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v1/collections","destinationPath":"/v1/collections","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"RemoveProductsFromCollectionRequest","description":"","properties":{"productIds":{"description":"IDs of the products to remove from the collection.","maxItems":1000,"title":"productIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["id","productIds"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.RemoveProductsFromCollectionRequest","responseMessage":"wix.catalog.api.v1.RemoveProductsFromCollectionResponse"},"legacyExamples":[{"name":"RemoveProductsFromCollection","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/collections/1044e7e4-37d1-0705-c5b3-623baae212fd/productIds/delete' \\\n --data-binary '{\n \"productIds\": [\n \"a60fef92-ee29-070f-a7ed-9bbc3cc1c2f4\",\n \"d9cd1d2f-8318-486b-a6f3-aa0c4e81ccd2\"\n ]\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/collections/{id}/productIds/delete","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.RemoveProductsFromCollectionRequest","responseMessage":"wix.catalog.api.v1.RemoveProductsFromCollectionResponse"},"legacyExamples":[{"name":"RemoveProductsFromCollection","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/collections/1044e7e4-37d1-0705-c5b3-623baae212fd/productIds/delete' \\\n --data-binary '{\n \"productIds\": [\n \"a60fef92-ee29-070f-a7ed-9bbc3cc1c2f4\",\n \"d9cd1d2f-8318-486b-a6f3-aa0c4e81ccd2\"\n ]\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Remove Products From Collection","slugifiedName":"remove-products-from-collection"}},{"summary":"Add Product Media","description":"Adds media items to a specified product, either via URL or existing media ID.","operationId":"wix.catalog.api.v1.CatalogWriteApi.AddProductMedia","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Product ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.AddProductMediaResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v1/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v1/products","destinationPath":"/v1/products","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"AddProductMediaRequest","description":"","properties":{"media":{"description":"Sources of media items already uploaded to the Wix site.","minItems":1,"maxItems":50,"title":"media","type":"array","items":{"$ref":"#/components/schemas/wix.catalog.api.v1.MediaDataForWrite"},"x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["id"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.AddProductMediaRequest","responseMessage":"wix.catalog.api.v1.AddProductMediaResponse"},"legacyExamples":[{"name":"AddProductMedia","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/products/1044e7e4-37d1-0705-c5b3-623baae212fd/media' \\\n --data-binary '{\n \"media\": [\n {\n \"mediaId\": \"9cc22d8b8d5244aba9ed73fb1783fc26.jpg\"\n },\n {\n \"url\": \"https://your-site-url/image.jpeg\",\n \"choice\": {\n \"option\": \"Color\",\n \"choice\": \"Blue\"\n }\n },\n {\n \"mediaId\": \"11062b_382eeb350464462c8f9150e4d3e40f2b\"\n }\n ]\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/products/{id}/media","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.AddProductMediaRequest","responseMessage":"wix.catalog.api.v1.AddProductMediaResponse"},"legacyExamples":[{"name":"AddProductMedia","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/products/1044e7e4-37d1-0705-c5b3-623baae212fd/media' \\\n --data-binary '{\n \"media\": [\n {\n \"mediaId\": \"9cc22d8b8d5244aba9ed73fb1783fc26.jpg\"\n },\n {\n \"url\": \"https://your-site-url/image.jpeg\",\n \"choice\": {\n \"option\": \"Color\",\n \"choice\": \"Blue\"\n }\n },\n {\n \"mediaId\": \"11062b_382eeb350464462c8f9150e4d3e40f2b\"\n }\n ]\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Add Product Media","slugifiedName":"add-product-media"}},{"summary":"Remove Product Media","description":"Removes specified media items from a product.\nPass an empty array to remove all media items.","operationId":"wix.catalog.api.v1.CatalogWriteApi.RemoveProductMedia","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Product ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.RemoveProductMediaResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v1/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v1/products","destinationPath":"/v1/products","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"RemoveProductMediaRequest","description":"","properties":{"mediaIds":{"description":"List of media IDs to remove. Pass an empty array to delete all media items for the product.","maxItems":50,"title":"mediaIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["id"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.RemoveProductMediaRequest","responseMessage":"wix.catalog.api.v1.RemoveProductMediaResponse"},"legacyExamples":[{"name":"RemoveProductMedia","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/products/1044e7e4-37d1-0705-c5b3-623baae212fd/media/delete' \\\n --data-binary '{\n \"mediaIds\": [\n \"mediaId1\",\n \"mediaId2\"\n ]\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/products/{id}/media/delete","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.RemoveProductMediaRequest","responseMessage":"wix.catalog.api.v1.RemoveProductMediaResponse"},"legacyExamples":[{"name":"RemoveProductMedia","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/products/1044e7e4-37d1-0705-c5b3-623baae212fd/media/delete' \\\n --data-binary '{\n \"mediaIds\": [\n \"mediaId1\",\n \"mediaId2\"\n ]\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Remove Product Media","slugifiedName":"remove-product-media"}},{"summary":"Add Product Media To Choices","description":"Links media items that are already associated with a specific product to a choice within the same product.\n\nMedia items can only be set for choices within one option at a time - e.g., if you set media items for some or all of the choices within the Colors option (blue, green, and red), you won't be able to also assign media items to choices within the Size option (S, M, and L).\n\nTo remove all existing media items, call the [Remove Product Media From Choices](https://dev.wix.com/api/rest/wix-stores/catalog/products/remove-product-media-from-choices) endpoint.","operationId":"wix.catalog.api.v1.CatalogWriteApi.AddProductMediaToChoices","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Product ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.AddProductMediaToChoicesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v1/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v1/products","destinationPath":"/v1/products","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"AddProductMediaToChoicesRequest","description":"","properties":{"media":{"description":"Product media items and the choices to add the media to.","minItems":1,"maxItems":10,"title":"media","type":"array","items":{"$ref":"#/components/schemas/wix.catalog.api.v1.MediaAssignmentToChoice"},"x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["id","media.option","media.choice"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.AddProductMediaToChoicesRequest","responseMessage":"wix.catalog.api.v1.AddProductMediaToChoicesResponse"},"legacyExamples":[{"name":"AddProductMediaToChoices","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/products/1044e7e4-37d1-0705-c5b3-623baae212fd/choices/media' \\\n --data-binary '{\n \"option\": \"Color\",\n \"choice\": \"blue\",\n \"mediaIds\": [\n \"9cc22d8b8d5244aba9ed73fb1783fc26.jpg\",\n \"fljseif3l4ij3l4ijl3r32fwfwf23234.jpg\"\n ]\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"patch","path":"/v1/products/{id}/choices/media","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.AddProductMediaToChoicesRequest","responseMessage":"wix.catalog.api.v1.AddProductMediaToChoicesResponse"},"legacyExamples":[{"name":"AddProductMediaToChoices","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/products/1044e7e4-37d1-0705-c5b3-623baae212fd/choices/media' \\\n --data-binary '{\n \"option\": \"Color\",\n \"choice\": \"blue\",\n \"mediaIds\": [\n \"9cc22d8b8d5244aba9ed73fb1783fc26.jpg\",\n \"fljseif3l4ij3l4ijl3r32fwfwf23234.jpg\"\n ]\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Add Product Media To Choices","slugifiedName":"add-product-media-to-choices"}},{"summary":"Remove Product Media From Choices","description":"Removes media items from all or some of a product's choices.\n(Media items can only be set for choices within one option at a time - e.g., if you set media items for some or all of the choices within the Colors option (blue, green, and red), you won't be able to also assign media items to choices within the Size option (S, M, and L).)","operationId":"wix.catalog.api.v1.CatalogWriteApi.RemoveProductMediaFromChoices","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Product ID from whose choices to remove media items.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.RemoveProductMediaFromChoicesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v1/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v1/products","destinationPath":"/v1/products","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"RemoveProductMediaFromChoicesRequest","description":"","properties":{"media":{"description":"Media to remove from choices. If an empty array is passed, all media will be removed from all choices for the given product.","minItems":1,"maxItems":10,"title":"media","type":"array","items":{"$ref":"#/components/schemas/wix.catalog.api.v1.MediaAssignmentToChoice"},"x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["id"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.RemoveProductMediaFromChoicesRequest","responseMessage":"wix.catalog.api.v1.RemoveProductMediaFromChoicesResponse"},"legacyExamples":[{"name":"RemoveProductMediaFromChoices","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/products/1044e7e4-37d1-0705-c5b3-623baae212fd/choices/media/delete' \\\n --data-binary '{\n \"option\": \"Color\",\n \"choice\": \"blue\",\n \"mediaIds\": [\n \"9cc22d8b8d5244aba9ed73fb1783fc26.jpg\",\n \"fljseif3l4ij3l4ijl3r32fwfwf23234.jpg\"\n ]\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/products/{id}/choices/media/delete","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.RemoveProductMediaFromChoicesRequest","responseMessage":"wix.catalog.api.v1.RemoveProductMediaFromChoicesResponse"},"legacyExamples":[{"name":"RemoveProductMediaFromChoices","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/products/1044e7e4-37d1-0705-c5b3-623baae212fd/choices/media/delete' \\\n --data-binary '{\n \"option\": \"Color\",\n \"choice\": \"blue\",\n \"mediaIds\": [\n \"9cc22d8b8d5244aba9ed73fb1783fc26.jpg\",\n \"fljseif3l4ij3l4ijl3r32fwfwf23234.jpg\"\n ]\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Remove Product Media From Choices","slugifiedName":"remove-product-media-from-choices"}},{"summary":"Delete Product Options","description":"Delete all options from a specific product. Only available when [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is disabled.","operationId":"wix.catalog.api.v1.CatalogWriteApi.DeleteProductOptions","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"ID of the product with options to delete.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.DeleteProductOptionsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v1/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v1/products","destinationPath":"/v1/products","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.DeleteProductOptionsRequest","responseMessage":"wix.catalog.api.v1.DeleteProductOptionsResponse"},"legacyExamples":[{"name":"DeleteProductOptions","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X DELETE \\\n 'https://www.wixapis.com/stores/v1/products/1044e7e4-37d1-0705-c5b3-623baae212fd/options' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"delete","path":"/v1/products/{id}/options","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.DeleteProductOptionsRequest","responseMessage":"wix.catalog.api.v1.DeleteProductOptionsResponse"},"legacyExamples":[{"name":"DeleteProductOptions","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X DELETE \\\n 'https://www.wixapis.com/stores/v1/products/1044e7e4-37d1-0705-c5b3-623baae212fd/options' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Delete Product Options","slugifiedName":"delete-product-options"}},{"summary":"Remove Brand","description":"Deletes a product's brand.","operationId":"wix.catalog.api.v1.CatalogWriteApi.RemoveBrand","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Product ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.RemoveProductBrandResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v1/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v1/products","destinationPath":"/v1/products","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"RemoveProductBrandRequest","description":"","properties":{},"deprecated":false,"required":["id"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.RemoveProductBrandRequest","responseMessage":"wix.catalog.api.v1.RemoveProductBrandResponse"},"legacyExamples":[{"name":"RemoveBrand","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/products/1044e7e4-37d1-0705-c5b3-623baae212fd/remove-brand' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/products/{id}/remove-brand","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.RemoveProductBrandRequest","responseMessage":"wix.catalog.api.v1.RemoveProductBrandResponse"},"legacyExamples":[{"name":"RemoveBrand","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/products/1044e7e4-37d1-0705-c5b3-623baae212fd/remove-brand' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Remove Brand","slugifiedName":"remove-brand"}},{"summary":"Create Collection","description":"Creates a new collection.","operationId":"wix.catalog.api.v1.CatalogWriteApi.CreateCollection","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.CreateCollectionResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v1/collections","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v1/collections","destinationPath":"/v1/collections","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateCollectionRequest","description":"","properties":{"collection":{"description":"Collection info.","$ref":"#/components/schemas/wix.catalog.api.v1.Collection","summary":"collection","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["collection","collection.name"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.CreateCollectionRequest","responseMessage":"wix.catalog.api.v1.CreateCollectionResponse"},"legacyExamples":[{"name":"CreateCollection","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/collections' \\\n --data-binary '{\n \t\"collection\": {\n \t\t\"name\": \"My New Collection\"\n \t}\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"collection\": {\n \"id\": \"81093e7d-a251-4a22-a238-df3aa816f3dc\",\n \"name\": \"My New Collection\",\n \"slug\": \"my-new-collection\",\n \"visible\": true,\n \"media\": {\n \"items\": []\n }\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/collections","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.CreateCollectionRequest","responseMessage":"wix.catalog.api.v1.CreateCollectionResponse"},"legacyExamples":[{"name":"CreateCollection","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/collections' \\\n --data-binary '{\n \t\"collection\": {\n \t\t\"name\": \"My New Collection\"\n \t}\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"collection\": {\n \"id\": \"81093e7d-a251-4a22-a238-df3aa816f3dc\",\n \"name\": \"My New Collection\",\n \"slug\": \"my-new-collection\",\n \"visible\": true,\n \"media\": {\n \"items\": []\n }\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Create Collection","slugifiedName":"create-collection"}},{"summary":"Update Collection Properties","description":"Updates specified properties of a collection.\nTo add products to a collection, call the [Add Products to Collection](https://dev.wix.com/api/rest/wix-stores/catalog/collections/add-products-to-collection) endpoint.","operationId":"wix.catalog.api.v1.CatalogWriteApi.UpdateCollection","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"collection.id","description":"Collection ID (generated automatically by the catalog).","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.UpdateCollectionResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v1/collections","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v1/collections","destinationPath":"/v1/collections","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateCollectionRequest","description":"","properties":{"collection":{"description":"Collection info.","$ref":"#/components/schemas/wix.catalog.api.v1.Collection","summary":"collection","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["collection","collection.id"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.UpdateCollectionRequest","responseMessage":"wix.catalog.api.v1.UpdateCollectionResponse"},"legacyExamples":[{"name":"UpdateCollection","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X PATCH \\\n 'https://www.wixapis.com/stores/v1/collections/81093e7d-a251-4a22-a238-df3aa816f3dc' \\\n --data-binary '{\n \t\"collection\": {\n \t\t\"name\": \"Updated name\"\n \t}\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"collection\": {\n \"id\": \"81093e7d-a251-4a22-a238-df3aa816f3dc\",\n \"name\": \"Updated name\",\n \"media\": {\n \"items\": []\n }\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"patch","path":"/v1/collections/{collection.id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.UpdateCollectionRequest","responseMessage":"wix.catalog.api.v1.UpdateCollectionResponse"},"legacyExamples":[{"name":"UpdateCollection","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X PATCH \\\n 'https://www.wixapis.com/stores/v1/collections/81093e7d-a251-4a22-a238-df3aa816f3dc' \\\n --data-binary '{\n \t\"collection\": {\n \t\t\"name\": \"Updated name\"\n \t}\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"collection\": {\n \"id\": \"81093e7d-a251-4a22-a238-df3aa816f3dc\",\n \"name\": \"Updated name\",\n \"media\": {\n \"items\": []\n }\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Update Collection Properties","slugifiedName":"update-collection-properties"}},{"summary":"Delete Collection","description":"Deletes a collection.","operationId":"wix.catalog.api.v1.CatalogWriteApi.DeleteCollection","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"ID of the collection to delete.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.DeleteCollectionResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v1/collections","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v1/collections","destinationPath":"/v1/collections","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.DeleteCollectionRequest","responseMessage":"wix.catalog.api.v1.DeleteCollectionResponse"},"legacyExamples":[{"name":"DeleteCollection","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X DELETE \\\n 'https://www.wixapis.com/stores/v1/collections/81093e7d-a251-4a22-a238-df3aa816f3dc' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"delete","path":"/v1/collections/{id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.DeleteCollectionRequest","responseMessage":"wix.catalog.api.v1.DeleteCollectionResponse"},"legacyExamples":[{"name":"DeleteCollection","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X DELETE \\\n 'https://www.wixapis.com/stores/v1/collections/81093e7d-a251-4a22-a238-df3aa816f3dc' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Delete Collection","slugifiedName":"delete-collection"}},{"summary":"Remove Ribbon","description":"Deletes a product's ribbon.","operationId":"wix.catalog.api.v1.CatalogWriteApi.RemoveRibbon","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Product ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.RemoveProductRibbonResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v1/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v1/products","destinationPath":"/v1/products","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"RemoveProductRibbonRequest","description":"","properties":{},"deprecated":false,"required":["id"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.RemoveProductRibbonRequest","responseMessage":"wix.catalog.api.v1.RemoveProductRibbonResponse"},"legacyExamples":[{"name":"RemoveRibbon","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/products/1044e7e4-37d1-0705-c5b3-623baae212fd/remove-ribbon' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/products/{id}/remove-ribbon","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.RemoveProductRibbonRequest","responseMessage":"wix.catalog.api.v1.RemoveProductRibbonResponse"},"legacyExamples":[{"name":"RemoveRibbon","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/products/1044e7e4-37d1-0705-c5b3-623baae212fd/remove-ribbon' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Remove Ribbon","slugifiedName":"remove-ribbon"}},{"summary":"Bulk Update Product Property","description":"Updates a specified property for up to 100 products at a time.","operationId":"wix.catalog.api.v1.CatalogWriteApi.BulkUpdateProducts","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.BulkUpdateProductsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v1/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v1/bulk/products","destinationPath":"/v1/bulk/products","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkUpdateProductsRequest","description":"","properties":{"ids":{"description":"Product IDs.","minItems":1,"maxItems":100,"title":"ids","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"set":{"description":"Field to update.","$ref":"#/components/schemas/wix.catalog.api.v1.SetValue","summary":"set","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["ids"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.BulkUpdateProductsRequest","responseMessage":"wix.catalog.api.v1.BulkUpdateProductsResponse"},"legacyExamples":[{"name":"BulkUpdateProducts","type":"METHOD","content":{"title":"Update the cost of 3 products","request":"curl -X POST \\\n https://www.wixapis.com/stores/v1/bulk/products/update \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"ids\": [\n \"80a584c3-78c1-4e2f-84f8-b8d0bf65b518\",\n \"e5419878-8284-4f02-98bb-087e1d8dc781\",\n \"cc30ba06-2b9a-4962-8b34-7a265d495d7e\"\n ],\n \"set\": {\n \"cost\": 2\n }\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"80a584c3-78c1-4e2f-84f8-b8d0bf65b518\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"e5419878-8284-4f02-98bb-087e1d8dc781\",\n \"originalIndex\": 1,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"cc30ba06-2b9a-4962-8b34-7a265d495d7e\",\n \"originalIndex\": 2,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 3,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}},{"name":"BulkUpdateProducts","type":"METHOD","order":2,"content":{"title":"Update the price of 5 products","request":"curl -X POST \\\n https://www.wixapis.com/stores/v1/bulk/products/update \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"ids\": [\n \"bb6ddd51-7295-4fc8-8a4f-2521485c738d\",\n \"c36bbdbe-fbf8-4a43-810e-a0abdffe70ae\",\n \"2966543c-2b2f-4ca1-862c-6a04736c1063\",\n \"c9adb138-96f8-4f08-8626-9fef2445c490\",\n \"4ed1aa2c-c441-4e3f-8e57-a18886bf52bb\"\n ],\n \"set\": {\n \"price\": 10.25\n }\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"bb6ddd51-7295-4fc8-8a4f-2521485c738d\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"c36bbdbe-fbf8-4a43-810e-a0abdffe70ae\",\n \"originalIndex\": 1,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"2966543c-2b2f-4ca1-862c-6a04736c1063\",\n \"originalIndex\": 2,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"c9adb138-96f8-4f08-8626-9fef2445c490\",\n \"originalIndex\": 3,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"4ed1aa2c-c441-4e3f-8e57-a18886bf52bb\",\n \"originalIndex\": 4,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 5,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}},{"name":"BulkUpdateProducts","type":"METHOD","order":3,"content":{"title":"Update the ribbon of 1 product","request":"curl -X POST \\\n https://www.wixapis.com/stores/v1/bulk/products/update \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"ids\": [\n \"bb6ddd51-7295-4fc8-8a4f-2521485c738d\"\n ],\n \"set\": {\n \"ribbon\": \"Sale\"\n }\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"bb6ddd51-7295-4fc8-8a4f-2521485c738d\",\n \"originalIndex\": 0,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}},{"name":"BulkUpdateProducts","type":"METHOD","order":5,"content":{"title":"Update the brand of 1 product","request":"curl -X POST \\\n https://www.wixapis.com/stores/v1/bulk/products/update \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"ids\": [\n \"bb6ddd51-7295-4fc8-8a4f-2521485c738d\"\n ],\n \"set\": {\n \"brand\": \"Nice\"\n }\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"bb6ddd51-7295-4fc8-8a4f-2521485c738d\",\n \"originalIndex\": 0,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}},{"name":"BulkUpdateProducts","type":"METHOD","order":4,"content":{"title":"Partially update the weight of 2 products","description":"1 product was found and successfully updated, while the other product was not found","request":"curl -X POST \\\n https://www.wixapis.com/stores/v1/bulk/products/update \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"ids\": [\n \"bb6ddd51-7295-4fc8-8a4f-2521485c738d\",\n \"4deb9c8d-7aba-45e1-9d83-bf99b479b5bb\"\n ],\n \"set\": {\n \"weight\": \"2.64\"\n }\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"bb6ddd51-7295-4fc8-8a4f-2521485c738d\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"4deb9c8d-7aba-45e1-9d83-bf99b479b5bb\",\n \"originalIndex\": 1,\n \"success\": false,\n \"error\": {\n \"code\": \"PRODUCT_NOT_FOUND\",\n \"description\": \"Product is not found\"\n }\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 1,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/bulk/products/update","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.BulkUpdateProductsRequest","responseMessage":"wix.catalog.api.v1.BulkUpdateProductsResponse"},"legacyExamples":[{"name":"BulkUpdateProducts","type":"METHOD","content":{"title":"Update the cost of 3 products","request":"curl -X POST \\\n https://www.wixapis.com/stores/v1/bulk/products/update \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"ids\": [\n \"80a584c3-78c1-4e2f-84f8-b8d0bf65b518\",\n \"e5419878-8284-4f02-98bb-087e1d8dc781\",\n \"cc30ba06-2b9a-4962-8b34-7a265d495d7e\"\n ],\n \"set\": {\n \"cost\": 2\n }\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"80a584c3-78c1-4e2f-84f8-b8d0bf65b518\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"e5419878-8284-4f02-98bb-087e1d8dc781\",\n \"originalIndex\": 1,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"cc30ba06-2b9a-4962-8b34-7a265d495d7e\",\n \"originalIndex\": 2,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 3,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}},{"name":"BulkUpdateProducts","type":"METHOD","order":2,"content":{"title":"Update the price of 5 products","request":"curl -X POST \\\n https://www.wixapis.com/stores/v1/bulk/products/update \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"ids\": [\n \"bb6ddd51-7295-4fc8-8a4f-2521485c738d\",\n \"c36bbdbe-fbf8-4a43-810e-a0abdffe70ae\",\n \"2966543c-2b2f-4ca1-862c-6a04736c1063\",\n \"c9adb138-96f8-4f08-8626-9fef2445c490\",\n \"4ed1aa2c-c441-4e3f-8e57-a18886bf52bb\"\n ],\n \"set\": {\n \"price\": 10.25\n }\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"bb6ddd51-7295-4fc8-8a4f-2521485c738d\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"c36bbdbe-fbf8-4a43-810e-a0abdffe70ae\",\n \"originalIndex\": 1,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"2966543c-2b2f-4ca1-862c-6a04736c1063\",\n \"originalIndex\": 2,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"c9adb138-96f8-4f08-8626-9fef2445c490\",\n \"originalIndex\": 3,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"4ed1aa2c-c441-4e3f-8e57-a18886bf52bb\",\n \"originalIndex\": 4,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 5,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}},{"name":"BulkUpdateProducts","type":"METHOD","order":3,"content":{"title":"Update the ribbon of 1 product","request":"curl -X POST \\\n https://www.wixapis.com/stores/v1/bulk/products/update \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"ids\": [\n \"bb6ddd51-7295-4fc8-8a4f-2521485c738d\"\n ],\n \"set\": {\n \"ribbon\": \"Sale\"\n }\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"bb6ddd51-7295-4fc8-8a4f-2521485c738d\",\n \"originalIndex\": 0,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}},{"name":"BulkUpdateProducts","type":"METHOD","order":5,"content":{"title":"Update the brand of 1 product","request":"curl -X POST \\\n https://www.wixapis.com/stores/v1/bulk/products/update \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"ids\": [\n \"bb6ddd51-7295-4fc8-8a4f-2521485c738d\"\n ],\n \"set\": {\n \"brand\": \"Nice\"\n }\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"bb6ddd51-7295-4fc8-8a4f-2521485c738d\",\n \"originalIndex\": 0,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}},{"name":"BulkUpdateProducts","type":"METHOD","order":4,"content":{"title":"Partially update the weight of 2 products","description":"1 product was found and successfully updated, while the other product was not found","request":"curl -X POST \\\n https://www.wixapis.com/stores/v1/bulk/products/update \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"ids\": [\n \"bb6ddd51-7295-4fc8-8a4f-2521485c738d\",\n \"4deb9c8d-7aba-45e1-9d83-bf99b479b5bb\"\n ],\n \"set\": {\n \"weight\": \"2.64\"\n }\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"bb6ddd51-7295-4fc8-8a4f-2521485c738d\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"4deb9c8d-7aba-45e1-9d83-bf99b479b5bb\",\n \"originalIndex\": 1,\n \"success\": false,\n \"error\": {\n \"code\": \"PRODUCT_NOT_FOUND\",\n \"description\": \"Product is not found\"\n }\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 1,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Update Product Property","slugifiedName":"bulk-update-product-property"}},{"summary":"Bulk Adjust Product Properties","description":"Adjusts a specified numerical property for up to 100 products at a time.\nThe property can be increased or decreased either by percentage or amount.","operationId":"wix.catalog.api.v1.CatalogWriteApi.BulkAdjustProductProperties","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.BulkAdjustProductPropertiesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v1/bulk/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v1/bulk/products","destinationPath":"/v1/bulk/products","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkAdjustProductPropertiesRequest","description":"","properties":{"ids":{"description":"Product IDs.","minItems":1,"maxItems":100,"title":"ids","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"adjust":{"description":"Numerical property to adjust.","$ref":"#/components/schemas/wix.catalog.api.v1.AdjustValue","summary":"adjust","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["ids"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.BulkAdjustProductPropertiesRequest","responseMessage":"wix.catalog.api.v1.BulkAdjustProductPropertiesResponse"},"legacyExamples":[{"name":"BulkAdjustProductProperties","type":"METHOD","order":2,"content":{"title":"Adjust the price of 2 products by percentage","request":"curl -X POST \\\n https://www.wixapis.com/stores/v1/bulk/products/adjust-properties \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"ids\": [\n \"bfcafbe6-b671-4ebe-8e3d-49f242cef188\",\n \"e5419878-8284-4f02-98bb-087e1d8dc781\"\n ],\n \"adjust\": {\n \"price\": {\n \"percentage\": {\n \"roundToInt\": false,\n \"rate\": 200\n }\n }\n }\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"bfcafbe6-b671-4ebe-8e3d-49f242cef188\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"e5419878-8284-4f02-98bb-087e1d8dc781\",\n \"originalIndex\": 1,\n \"success\": true\n }\n },\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}},{"name":"BulkAdjustProductProperties","type":"METHOD","content":{"title":"Adjust the price of 3 products by amount","request":"curl -X POST \\\n https://www.wixapis.com/stores/v1/bulk/products/adjust-properties \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"ids\": [\n \"80a584c3-78c1-4e2f-84f8-b8d0bf65b518\",\n \"e5419878-8284-4f02-98bb-087e1d8dc781\",\n \"cc30ba06-2b9a-4962-8b34-7a265d495d7e\"\n ],\n \"adjust\": {\n \"price\": {\n \"amount\": 30\n }\n }\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"80a584c3-78c1-4e2f-84f8-b8d0bf65b518\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"e5419878-8284-4f02-98bb-087e1d8dc781\",\n \"originalIndex\": 1,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"cc30ba06-2b9a-4962-8b34-7a265d495d7e\",\n \"originalIndex\": 2,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 3,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/bulk/products/adjust-properties","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogWriteApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_PRODUCTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.BulkAdjustProductPropertiesRequest","responseMessage":"wix.catalog.api.v1.BulkAdjustProductPropertiesResponse"},"legacyExamples":[{"name":"BulkAdjustProductProperties","type":"METHOD","order":2,"content":{"title":"Adjust the price of 2 products by percentage","request":"curl -X POST \\\n https://www.wixapis.com/stores/v1/bulk/products/adjust-properties \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"ids\": [\n \"bfcafbe6-b671-4ebe-8e3d-49f242cef188\",\n \"e5419878-8284-4f02-98bb-087e1d8dc781\"\n ],\n \"adjust\": {\n \"price\": {\n \"percentage\": {\n \"roundToInt\": false,\n \"rate\": 200\n }\n }\n }\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"bfcafbe6-b671-4ebe-8e3d-49f242cef188\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"e5419878-8284-4f02-98bb-087e1d8dc781\",\n \"originalIndex\": 1,\n \"success\": true\n }\n },\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}},{"name":"BulkAdjustProductProperties","type":"METHOD","content":{"title":"Adjust the price of 3 products by amount","request":"curl -X POST \\\n https://www.wixapis.com/stores/v1/bulk/products/adjust-properties \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"ids\": [\n \"80a584c3-78c1-4e2f-84f8-b8d0bf65b518\",\n \"e5419878-8284-4f02-98bb-087e1d8dc781\",\n \"cc30ba06-2b9a-4962-8b34-7a265d495d7e\"\n ],\n \"adjust\": {\n \"price\": {\n \"amount\": 30\n }\n }\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"80a584c3-78c1-4e2f-84f8-b8d0bf65b518\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"e5419878-8284-4f02-98bb-087e1d8dc781\",\n \"originalIndex\": 1,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"cc30ba06-2b9a-4962-8b34-7a265d495d7e\",\n \"originalIndex\": 2,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 3,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Adjust Product Properties","slugifiedName":"bulk-adjust-product-properties"}},{"summary":"Query Products","description":"Returns a list of up to 100 products, given the provided paging, sorting and filtering.\nSee [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.","operationId":"wix.catalog.api.v1.CatalogReadApi.QueryProducts","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.QueryProductsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores-reader/v1/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores-reader/v1/products","destinationPath":"/v1/products","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryProductsRequest","description":"","properties":{"query":{"description":"","$ref":"#/components/schemas/wix.catalog.api.v1.Query","summary":"query","x-wix-docs":{"exposure":"PUBLIC"}},"includeVariants":{"description":"Whether variants should be included in the response.","title":"includeVariants","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"includeHiddenProducts":{"description":"Whether hidden products should be included in the response. Requires permissions to manage products.","title":"includeHiddenProducts","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"includeMerchantSpecificData":{"description":"Whether merchant specific data should be included in the response. Requires permissions to manage products.","title":"includeMerchantSpecificData","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogReadApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.READ_PRODUCTS"],"externalPermissionScopes":[{"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":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.stores.catalog.proxy.catalog-read-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.QueryProductsRequest","responseMessage":"wix.catalog.api.v1.QueryProductsResponse"},"legacyExamples":[{"name":"QueryProducts","type":"METHOD","order":1,"content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/products/query' \\\n --data-binary '{\n \"includeVariants\": true\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"products\": [\n {\n \"id\": \"131604aa-169f-d3e8-f076-a967b03e880c\",\n \"name\": \"T-Shirt\",\n \"slug\": \"t-shirt\",\n \"visible\": true,\n \"productType\": \"physical\",\n \"description\": \"

Made from 100% cotton

\",\n \"stock\": {\n \"trackInventory\": true,\n \"quantity\": 300,\n \"inStock\": true\n },\n \"price\": {\n \"currency\": \"USD\",\n \"price\": 10,\n \"discountedPrice\": 10,\n \"formatted\": {\n \"price\": \"$10.00\",\n \"discountedPrice\": \"$10.00\"\n }\n },\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 10,\n \"discountedPrice\": 10,\n \"formatted\": {\n \"price\": \"$10.00\",\n \"discountedPrice\": \"$10.00\"\n }\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 10,\n \"discountedPrice\": 10,\n \"formatted\": {\n \"price\": \"$10.00\",\n \"discountedPrice\": \"$10.00\"\n }\n },\n \"additionalInfoSections\": [\n {\n \"title\": \"Care Instructions\",\n \"description\": \"

Wash with similar colors

\\n\"\n }\n ],\n \"ribbons\": [\n {\n \"text\": \"Soft and comfy\"\n }\n ],\n \"ribbon\": \"Soft and comfy\",\n \"brand\": \"Nice\",\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg/v1/fit/w_1500,h_1500,q_90/file.jpg\",\n \"width\": 1500,\n \"height\": 1500\n },\n \"id\": \"c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg/v1/fit/w_1500,h_1500,q_90/file.jpg\",\n \"width\": 1500,\n \"height\": 1500\n },\n \"id\": \"c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg\"\n },\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg/v1/fit/w_1280,h_1600,q_90/file.jpg\",\n \"width\": 1280,\n \"height\": 1600\n },\n \"id\": \"c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg\"\n }\n ]\n },\n \"customTextFields\": [\n {\n \"title\": \"What would like us to print on the t-shirt?\",\n \"maxLength\": 100,\n \"mandatory\": false\n }\n ],\n \"manageVariants\": true,\n \"productOptions\": [\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Size\",\n \"choices\": [\n {\n \"value\": \"Small\",\n \"description\": \"Small\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"Medium\",\n \"description\": \"Medium\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"Large\",\n \"description\": \"Large\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n }\n ]\n },\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Color\",\n \"choices\": [\n {\n \"value\": \"White\",\n \"description\": \"White\",\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg/v1/fit/w_1500,h_1500,q_90/file.jpg\",\n \"width\": 1500,\n \"height\": 1500\n },\n \"id\": \"c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg/v1/fit/w_1500,h_1500,q_90/file.jpg\",\n \"width\": 1500,\n \"height\": 1500\n },\n \"id\": \"c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg\"\n }\n ]\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"Black\",\n \"description\": \"Black\",\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg/v1/fit/w_1280,h_1600,q_90/file.jpg\",\n \"width\": 1280,\n \"height\": 1600\n },\n \"id\": \"c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg/v1/fit/w_1280,h_1600,q_90/file.jpg\",\n \"width\": 1280,\n \"height\": 1600\n },\n \"id\": \"c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg\"\n }\n ]\n },\n \"inStock\": true,\n \"visible\": true\n }\n ]\n }\n ],\n \"productPageUrl\": {\n \"base\": \"www.my-website.com\",\n \"path\": \"/product-page/t-shirt\"\n },\n \"numericId\": \"1608035843758000\",\n \"inventoryItemId\": \"ece9fb55-e960-2c17-0f89-56984fc177f3\",\n \"discount\": {\n \"type\": \"NONE\",\n \"value\": 0\n },\n \"collectionIds\": [],\n \"variants\": [\n {\n \"id\": \"c9f8678b-af10-4dc2-8e0e-3e823a5491df\",\n \"choices\": {\n \"Size\": \"Small\",\n \"Color\": \"White\"\n },\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 10,\n \"discountedPrice\": 10,\n \"formatted\": {\n \"price\": \"$10.00\",\n \"discountedPrice\": \"$10.00\"\n }\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 10,\n \"discountedPrice\": 10,\n \"formatted\": {\n \"price\": \"$10.00\",\n \"discountedPrice\": \"$10.00\"\n }\n },\n \"weight\": 0.3,\n \"sku\": \"10000\",\n \"visible\": true\n }\n },\n {\n \"id\": \"44be1f7b-d32d-419d-b04d-a2a9342cf9e6\",\n \"choices\": {\n \"Size\": \"Small\",\n \"Color\": \"Black\"\n },\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 10,\n \"discountedPrice\": 10,\n \"formatted\": {\n \"price\": \"$10.00\",\n \"discountedPrice\": \"$10.00\"\n }\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 10,\n \"discountedPrice\": 10,\n \"formatted\": {\n \"price\": \"$10.00\",\n \"discountedPrice\": \"$10.00\"\n }\n },\n \"weight\": 0.3,\n \"sku\": \"10003\",\n \"visible\": true\n }\n },\n {\n \"id\": \"75f7dbd2-9c6c-47bb-8d39-fe7de085a942\",\n \"choices\": {\n \"Size\": \"Medium\",\n \"Color\": \"White\"\n },\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 10,\n \"discountedPrice\": 10,\n \"formatted\": {\n \"price\": \"$10.00\",\n \"discountedPrice\": \"$10.00\"\n }\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 10,\n \"discountedPrice\": 10,\n \"formatted\": {\n \"price\": \"$10.00\",\n \"discountedPrice\": \"$10.00\"\n }\n },\n \"weight\": 0.3,\n \"sku\": \"10001\",\n \"visible\": true\n }\n },\n {\n \"id\": \"9fbd21c2-6480-4428-89f6-304d48f081e2\",\n \"choices\": {\n \"Size\": \"Medium\",\n \"Color\": \"Black\"\n },\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 10,\n \"discountedPrice\": 10,\n \"formatted\": {\n \"price\": \"$10.00\",\n \"discountedPrice\": \"$10.00\"\n }\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 10,\n \"discountedPrice\": 10,\n \"formatted\": {\n \"price\": \"$10.00\",\n \"discountedPrice\": \"$10.00\"\n }\n },\n \"weight\": 0.3,\n \"sku\": \"10004\",\n \"visible\": true\n }\n },\n {\n \"id\": \"e9f502a9-a770-4441-a407-b9d043c22b85\",\n \"choices\": {\n \"Size\": \"Large\",\n \"Color\": \"White\"\n },\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 10,\n \"discountedPrice\": 10,\n \"formatted\": {\n \"price\": \"$10.00\",\n \"discountedPrice\": \"$10.00\"\n }\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 10,\n \"discountedPrice\": 10,\n \"formatted\": {\n \"price\": \"$10.00\",\n \"discountedPrice\": \"$10.00\"\n }\n },\n \"weight\": 0.3,\n \"sku\": \"10002\",\n \"visible\": true\n }\n },\n {\n \"id\": \"c9904f6b-d82f-4872-a4d9-de5ef5580126\",\n \"choices\": {\n \"Size\": \"Large\",\n \"Color\": \"Black\"\n },\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 10,\n \"discountedPrice\": 10,\n \"formatted\": {\n \"price\": \"$10.00\",\n \"discountedPrice\": \"$10.00\"\n }\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 10,\n \"discountedPrice\": 10,\n \"formatted\": {\n \"price\": \"$10.00\",\n \"discountedPrice\": \"$10.00\"\n }\n },\n \"weight\": 0.3,\n \"sku\": \"10005\",\n \"visible\": true\n }\n }\n ],\n \"lastUpdated\": \"2020-12-15T14:00:27.415Z\",\n \"seoData\": {\n \"tags\": [\n {\n \"type\": \"title\",\n \"children\": \"T-Shirt\",\n \"custom\": false,\n \"disabled\": false\n },\n {\n \"type\": \"meta\",\n \"props\": {\n \"name\": \"description\",\n \"content\": \"Made from 100% organic cotton\"\n },\n \"children\": \"\",\n \"custom\": false,\n \"disabled\": false\n }\n ]\n }\n },\n {\n \"id\": \"0873ed58-f88d-77d1-4566-afd4c50d253e\",\n \"name\": \"Digital product\",\n \"slug\": \"digital-product\",\n \"visible\": true,\n \"productType\": \"digital\",\n \"description\": \"

A digital product delivered upon payment

\",\n \"sku\": \"\",\n \"weight\": 0,\n \"stock\": {\n \"trackInventory\": false,\n \"inStock\": true\n },\n \"price\": {\n \"currency\": \"USD\",\n \"price\": 20,\n \"discountedPrice\": 20,\n \"formatted\": {\n \"price\": \"$20.00\",\n \"discountedPrice\": \"$20.00\"\n }\n },\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 20,\n \"discountedPrice\": 20,\n \"formatted\": {\n \"price\": \"$20.00\",\n \"discountedPrice\": \"$20.00\"\n }\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 20,\n \"discountedPrice\": 20,\n \"formatted\": {\n \"price\": \"$20.00\",\n \"discountedPrice\": \"$20.00\"\n }\n },\n \"additionalInfoSections\": [],\n \"ribbons\": [\n {\n \"text\": \"New arrival\"\n }\n ],\n \"ribbon\": \"New arrival\",\n \"brand\": \"Nice\",\n \"media\": {\n \"items\": []\n },\n \"customTextFields\": [],\n \"manageVariants\": false,\n \"productOptions\": [],\n \"productPageUrl\": {\n \"base\": \"https://www.my-website.com\",\n \"path\": \"/product-page/digital-product\"\n },\n \"numericId\": \"1608041194964000\",\n \"inventoryItemId\": \"f78c12a7-0772-882e-ba99-502b3af2dac1\",\n \"discount\": {\n \"type\": \"NONE\",\n \"value\": 0\n },\n \"collectionIds\": [],\n \"variants\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"choices\": {},\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 20,\n \"discountedPrice\": 20,\n \"formatted\": {\n \"price\": \"$20.00\",\n \"discountedPrice\": \"$20.00\"\n }\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 20,\n \"discountedPrice\": 20,\n \"formatted\": {\n \"price\": \"$20.00\",\n \"discountedPrice\": \"$20.00\"\n }\n },\n \"weight\": 0,\n \"sku\": \"\",\n \"visible\": true\n }\n }\n ],\n \"lastUpdated\": \"2020-12-15T14:06:34.964Z\"\n }\n ],\n \"metadata\": {\n \"items\": 100,\n \"offset\": 0\n },\n \"totalResults\": 2\n}\n~~~"}},{"name":"QueryProducts","type":"METHOD","order":4,"content":{"title":"","description":"","request":"~~~cURL\ncurl 'https://www.wixapis.com/stores/v1/products/query' \\\n--data-binary '{\n \"query\": {\"sort\":\"[{\\\"price\\\": \\\"desc\\\"}]\"}}' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{\n \"products\": [\n {\n \"id\": \"91f7ac8b-2baa-289c-aa50-6d64764f35d3\",\n \"name\": \"Colombian Arabica\",\n \"slug\": \"colombian-arabica-1\",\n \"visible\": true,\n \"productType\": \"physical\",\n \"description\": \"

The best organic coffee that Colombia has to offer.

\",\n \"stock\": {\n \"trackInventory\": false,\n \"inStock\": true\n },\n \"price\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 30,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$30.00\",\n \"pricePerUnit\": \"$0.12\"\n },\n \"pricePerUnit\": 0.12\n },\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 30,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$30.00\",\n \"pricePerUnit\": \"$0.12\"\n },\n \"pricePerUnit\": 0.12\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 30,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$30.00\",\n \"pricePerUnit\": \"$0.12\"\n },\n \"pricePerUnit\": 0.12\n },\n \"pricePerUnitData\": {\n \"totalQuantity\": 250,\n \"totalMeasurementUnit\": \"G\",\n \"baseQuantity\": 1,\n \"baseMeasurementUnit\": \"G\"\n },\n \"additionalInfoSections\": [\n {\n \"title\": \"Storage recommendations\",\n \"description\": \"

To preserve your beans' fresh roasted flavor as long as possible, store them in an opaque, air-tight container at room temperature.

Specially grown Arabica coffee from the Brazilian highlands.

\",\n \"stock\": {\n \"trackInventory\": false,\n \"inStock\": true\n },\n \"price\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 26.25,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$26.25\",\n \"pricePerUnit\": \"$0.11\"\n },\n \"pricePerUnit\": 0.11\n },\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 26.25,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$26.25\",\n \"pricePerUnit\": \"$0.11\"\n },\n \"pricePerUnit\": 0.11\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 26.25,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$26.25\",\n \"pricePerUnit\": \"$0.11\"\n },\n \"pricePerUnit\": 0.11\n },\n \"pricePerUnitData\": {\n \"totalQuantity\": 250,\n \"totalMeasurementUnit\": \"G\",\n \"baseQuantity\": 1,\n \"baseMeasurementUnit\": \"G\"\n },\n \"additionalInfoSections\": [],\n \"ribbons\": [],\n \"ribbon\": \"\",\n \"brand\": \"Coffee Company\",\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_4517,h_2992,q_90/file.jpg\",\n \"width\": 4517,\n \"height\": 2992\n },\n \"id\": \"nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_4517,h_2992,q_90/file.jpg\",\n \"width\": 4517,\n \"height\": 2992\n },\n \"id\": \"nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg\"\n }\n ]\n },\n \"customTextFields\": [\n {\n \"title\": \"What would you like written on the custom label?\",\n \"maxLength\": 200,\n \"mandatory\": false\n }\n ],\n \"manageVariants\": true,\n \"productOptions\": [\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Weight\",\n \"choices\": [\n {\n \"value\": \"250g\",\n \"description\": \"250g\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"500g\",\n \"description\": \"500g\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n }\n ]\n },\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Ground for\",\n \"choices\": [\n {\n \"value\": \"Stovetop\",\n \"description\": \"Stovetop\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"Filter\",\n \"description\": \"Filter\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n }\n ]\n }\n ],\n \"productPageUrl\": {\n \"base\": \"https://www.my-website.com\",\n \"path\": \"/product-page/brazilian-arabica\"\n },\n \"numericId\": \"1586693925142000\",\n \"inventoryItemId\": \"f9ebed63-7888-60c4-b201-47f5ab20ef2a\",\n \"discount\": {\n \"type\": \"PERCENT\",\n \"value\": 25\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"variants\": [],\n \"lastUpdated\": \"2020-12-15T13:50:40.739Z\",\n \"seoData\": {\n \"tags\": [\n {\n \"type\": \"title\",\n \"children\": \"Brazilian Arabica\",\n \"custom\": false,\n \"disabled\": false\n },\n {\n \"type\": \"meta\",\n \"props\": {\n \"name\": \"description\",\n \"content\": \"Specially grown coffee from the Brazilian highlands.\"\n },\n \"children\": \"\",\n \"custom\": false,\n \"disabled\": false\n }\n ]\n }\n },\n {\n \"id\": \"5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a\",\n \"name\": \"Indonesian Blend\",\n \"slug\": \"indonesian-blend\",\n \"visible\": true,\n \"productType\": \"physical\",\n \"description\": \"

Half Java Arabica, half Bali Robusta - big flavor with a big kick.

\",\n \"stock\": {\n \"trackInventory\": false,\n \"inStock\": true\n },\n \"price\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 35,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$35.00\",\n \"pricePerUnit\": \"$0.14\"\n },\n \"pricePerUnit\": 0.14\n },\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 35,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$35.00\",\n \"pricePerUnit\": \"$0.14\"\n },\n \"pricePerUnit\": 0.14\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 35,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$35.00\",\n \"pricePerUnit\": \"$0.14\"\n },\n \"pricePerUnit\": 0.14\n },\n \"pricePerUnitData\": {\n \"totalQuantity\": 250,\n \"totalMeasurementUnit\": \"G\",\n \"baseQuantity\": 1,\n \"baseMeasurementUnit\": \"G\"\n },\n \"additionalInfoSections\": [],\n \"ribbons\": [],\n \"ribbon\": \"\",\n \"brand\": \"Coffee Company\",\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg\",\n \"width\": 2977,\n \"height\": 3951\n },\n \"id\": \"nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg\",\n \"width\": 2977,\n \"height\": 3951\n },\n \"id\": \"nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg\"\n }\n ]\n },\n \"customTextFields\": [\n {\n \"title\": \"What would you like written on the custom label?\",\n \"maxLength\": 200,\n \"mandatory\": false\n }\n ],\n \"manageVariants\": true,\n \"productOptions\": [\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Weight\",\n \"choices\": [\n {\n \"value\": \"250g\",\n \"description\": \"250g\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"500g\",\n \"description\": \"500g\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n }\n ]\n },\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Ground for\",\n \"choices\": [\n {\n \"value\": \"Stovetop\",\n \"description\": \"Stovetop\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"Filter\",\n \"description\": \"Filter\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n }\n ]\n }\n ],\n \"productPageUrl\": {\n \"base\": \"https://www.my-website.com\",\n \"path\": \"/product-page/indonesian-blend\"\n },\n \"numericId\": \"1586694163605000\",\n \"inventoryItemId\": \"ac890613-46d1-1056-1b5e-0b0b7f55f2c5\",\n \"discount\": {\n \"type\": \"NONE\",\n \"value\": 0\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"variants\": [],\n \"lastUpdated\": \"2020-12-15T13:49:43.442Z\",\n \"seoData\": {\n \"tags\": [\n {\n \"type\": \"title\",\n \"children\": \"Indonesian Blend | ApiPlayground\",\n \"custom\": false,\n \"disabled\": false\n },\n {\n \"type\": \"meta\",\n \"props\": {\n \"name\": \"description\",\n \"content\": \"Half Java Arabica, half Bali Robusta - big flavor with a biggish kick.\"\n },\n \"children\": \"\",\n \"custom\": false,\n \"disabled\": false\n },\n {\n \"type\": \"meta\",\n \"props\": {\n \"name\": \"robots\",\n \"content\": \"index\"\n },\n \"children\": \"\",\n \"custom\": false,\n \"disabled\": false\n }\n ]\n }\n },\n {\n \"id\": \"0873ed58-f88d-77d1-4566-afd4c50d253e\",\n \"name\": \"Digital product\",\n \"slug\": \"digital-product\",\n \"visible\": true,\n \"productType\": \"digital\",\n \"description\": \"

A digital product delivered upon payment

\",\n \"sku\": \"\",\n \"weight\": 0,\n \"brand\": \"Nice\",\n \"stock\": {\n \"trackInventory\": false,\n \"inStock\": true\n },\n \"price\": {\n \"currency\": \"USD\",\n \"price\": 20,\n \"discountedPrice\": 20,\n \"formatted\": {\n \"price\": \"$20.00\",\n \"discountedPrice\": \"$20.00\"\n }\n },\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 20,\n \"discountedPrice\": 20,\n \"formatted\": {\n \"price\": \"$20.00\",\n \"discountedPrice\": \"$20.00\"\n }\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 20,\n \"discountedPrice\": 20,\n \"formatted\": {\n \"price\": \"$20.00\",\n \"discountedPrice\": \"$20.00\"\n }\n },\n \"additionalInfoSections\": [],\n \"ribbons\": [\n {\n \"text\": \"New arrival\"\n }\n ],\n \"ribbon\": \"New arrival\",\n \"media\": {\n \"items\": []\n },\n \"customTextFields\": [],\n \"manageVariants\": false,\n \"productOptions\": [],\n \"productPageUrl\": {\n \"base\": \"https://www.my-website.com\",\n \"path\": \"/product-page/digital-product\"\n },\n \"numericId\": \"1608041194964000\",\n \"inventoryItemId\": \"f78c12a7-0772-882e-ba99-502b3af2dac1\",\n \"discount\": {\n \"type\": \"NONE\",\n \"value\": 0\n },\n \"collectionIds\": [],\n \"variants\": [],\n \"lastUpdated\": \"2020-12-15T14:06:34.964Z\"\n },\n {\n \"id\": \"131604aa-169f-d3e8-f076-a967b03e880c\",\n \"name\": \"T-Shirt\",\n \"slug\": \"t-shirt\",\n \"visible\": true,\n \"productType\": \"physical\",\n \"description\": \"

Made from 100% cotton

Wash with similar colors

\\n\"\n }\n ],\n \"ribbons\": [\n {\n \"text\": \"Soft and comfy\"\n }\n ],\n \"ribbon\": \"Soft and comfy\",\n \"brand\": \"Bananas\",\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg/v1/fit/w_1500,h_1500,q_90/file.jpg\",\n \"width\": 1500,\n \"height\": 1500\n },\n \"id\": \"c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg/v1/fit/w_1500,h_1500,q_90/file.jpg\",\n \"width\": 1500,\n \"height\": 1500\n },\n \"id\": \"c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg\"\n },\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg/v1/fit/w_1280,h_1600,q_90/file.jpg\",\n \"width\": 1280,\n \"height\": 1600\n },\n \"id\": \"c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg\"\n }\n ]\n },\n \"customTextFields\": [\n {\n \"title\": \"What would like us to print on the t-shirt?\",\n \"maxLength\": 100,\n \"mandatory\": false\n }\n ],\n \"manageVariants\": true,\n \"productOptions\": [\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Size\",\n \"choices\": [\n {\n \"value\": \"Small\",\n \"description\": \"Small\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"Medium\",\n \"description\": \"Medium\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"Large\",\n \"description\": \"Large\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n }\n ]\n },\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Color\",\n \"choices\": [\n {\n \"value\": \"White\",\n \"description\": \"White\",\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg/v1/fit/w_1500,h_1500,q_90/file.jpg\",\n \"width\": 1500,\n \"height\": 1500\n },\n \"id\": \"c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg/v1/fit/w_1500,h_1500,q_90/file.jpg\",\n \"width\": 1500,\n \"height\": 1500\n },\n \"id\": \"c43190_d99f81734a054ee2bacf6b9ebe81a438~mv2.jpg\"\n }\n ]\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"Black\",\n \"description\": \"Black\",\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg/v1/fit/w_1280,h_1600,q_90/file.jpg\",\n \"width\": 1280,\n \"height\": 1600\n },\n \"id\": \"c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg/v1/fit/w_1280,h_1600,q_90/file.jpg\",\n \"width\": 1280,\n \"height\": 1600\n },\n \"id\": \"c43190_2c01c9a0195d4356b6d014818ca5841a~mv2.jpg\"\n }\n ]\n },\n \"inStock\": true,\n \"visible\": true\n }\n ]\n }\n ],\n \"productPageUrl\": {\n \"base\": \"https://www.my-website.com\",\n \"path\": \"/product-page/t-shirt\"\n },\n \"numericId\": \"1608035843758000\",\n \"inventoryItemId\": \"ece9fb55-e960-2c17-0f89-56984fc177f3\",\n \"discount\": {\n \"type\": \"NONE\",\n \"value\": 0\n },\n \"collectionIds\": [],\n \"variants\": [],\n \"lastUpdated\": \"2020-12-15T14:00:27.415Z\",\n \"seoData\": {\n \"tags\": [\n {\n \"type\": \"title\",\n \"children\": \"T-Shirt\",\n \"custom\": false,\n \"disabled\": false\n },\n {\n \"type\": \"meta\",\n \"props\": {\n \"name\": \"description\",\n \"content\": \"Made from 100% organic cotton\"\n },\n \"children\": \"\",\n \"custom\": false,\n \"disabled\": false\n }\n ]\n }\n }\n ],\n \"metadata\": {\n \"items\": 100,\n \"offset\": 0\n },\n \"totalResults\": 5\n}\n~~~"}},{"name":"QueryProducts","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/products/query' \\\n --data-binary '{}' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"products\": [\n {\n \"id\": \"c329246b-d521-feb4-85f5-539ca992d73a\",\n \"name\": \"Indonesian Blend (no variants)\",\n \"slug\": \"indonesian-blend-no-variants\",\n \"visible\": true,\n \"productType\": \"physical\",\n \"description\": \"

Half Java Arabica, half Bali Robusta - big flavor with a big kick.

\",\n \"sku\": \"\",\n \"weight\": 0,\n \"weightRange\": {\n \"minValue\": 0,\n \"maxValue\": 0\n },\n \"stock\": {\n \"trackInventory\": false,\n \"inStock\": true,\n \"inventoryStatus\": \"IN_STOCK\"\n },\n \"price\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 35,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$35.00\",\n \"pricePerUnit\": \"$0.14\"\n },\n \"pricePerUnit\": 0.14\n },\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 35,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$35.00\",\n \"pricePerUnit\": \"$0.14\"\n },\n \"pricePerUnit\": 0.14\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 35,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$35.00\",\n \"pricePerUnit\": \"$0.14\"\n },\n \"pricePerUnit\": 0.14\n },\n \"priceRange\": {\n \"minValue\": 35,\n \"maxValue\": 35\n },\n \"costRange\": {\n \"minValue\": 0,\n \"maxValue\": 0\n },\n \"pricePerUnitData\": {\n \"totalQuantity\": 0.25,\n \"totalMeasurementUnit\": \"KG\",\n \"baseQuantity\": 1,\n \"baseMeasurementUnit\": \"G\"\n },\n \"additionalInfoSections\": [],\n \"ribbons\": [],\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg\",\n \"width\": 2977,\n \"height\": 3951\n },\n \"id\": \"nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg\",\n \"width\": 2977,\n \"height\": 3951\n },\n \"id\": \"nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg\"\n }\n ]\n },\n \"customTextFields\": [\n {\n \"title\": \"What would you like written on the custom label?\",\n \"maxLength\": 200,\n \"mandatory\": false\n }\n ],\n \"manageVariants\": false,\n \"productOptions\": [],\n \"productPageUrl\": {\n \"base\": \"https://wixsite.com/examplestore\",\n \"path\": \"/product-page/indonesian-blend-no-variants\"\n },\n \"numericId\": \"1637847968287000\",\n \"inventoryItemId\": \"3cd6db94-2ade-014b-7a0a-ac63566d28c5\",\n \"discount\": {\n \"type\": \"NONE\",\n \"value\": 0\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\",\n \"00000000-000000-000000-000000000001\"\n ],\n \"variants\": [],\n \"lastUpdated\": \"2021-11-25T13:46:08.683Z\",\n \"createdDate\": \"2021-11-25T13:46:08.287Z\",\n \"ribbon\": \"\"\n },\n {\n \"id\": \"4d93fb7e-e612-612f-5c27-81b35b503ad7\",\n \"name\": \"Ethiopian Yirgacheffe\",\n \"slug\": \"ethiopian-yirgacheffe\",\n \"visible\": true,\n \"productType\": \"physical\",\n \"description\": \"

The best organic coffee that Ethiopia has to offer.

\",\n \"sku\": \"\",\n \"weight\": 0,\n \"weightRange\": {\n \"minValue\": 0,\n \"maxValue\": 0\n },\n \"stock\": {\n \"trackInventory\": true,\n \"quantity\": 0,\n \"inStock\": false,\n \"inventoryStatus\": \"OUT_OF_STOCK\"\n },\n \"price\": {\n \"currency\": \"USD\",\n \"price\": 36,\n \"discountedPrice\": 36,\n \"formatted\": {\n \"price\": \"$36.00\",\n \"discountedPrice\": \"$36.00\",\n \"pricePerUnit\": \"$0.14\"\n },\n \"pricePerUnit\": 0.14\n },\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 36,\n \"discountedPrice\": 36,\n \"formatted\": {\n \"price\": \"$36.00\",\n \"discountedPrice\": \"$36.00\",\n \"pricePerUnit\": \"$0.14\"\n },\n \"pricePerUnit\": 0.14\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 36,\n \"discountedPrice\": 36,\n \"formatted\": {\n \"price\": \"$36.00\",\n \"discountedPrice\": \"$36.00\",\n \"pricePerUnit\": \"$0.14\"\n },\n \"pricePerUnit\": 0.14\n },\n \"priceRange\": {\n \"minValue\": 36,\n \"maxValue\": 36\n },\n \"costRange\": {\n \"minValue\": 25,\n \"maxValue\": 25\n },\n \"pricePerUnitData\": {\n \"totalQuantity\": 250,\n \"totalMeasurementUnit\": \"G\",\n \"baseQuantity\": 1,\n \"baseMeasurementUnit\": \"G\"\n },\n \"additionalInfoSections\": [\n {\n \"title\": \"Storage recommendations\",\n \"description\": \"

To preserve your beans' fresh roasted flavor as long as possible, store them in an opaque, air-tight container at room temperature.

\\n\"\n }\n ],\n \"ribbons\": [\n {\n \"text\": \"Fair trade\"\n }\n ],\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_3653676645776b41303259~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_3653676645776b41303259~mv2.jpg/v1/fit/w_8440,h_5626,q_90/file.jpg\",\n \"width\": 8440,\n \"height\": 5626\n },\n \"id\": \"nsplsh_3653676645776b41303259~mv2.jpg\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_3653676645776b41303259~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_3653676645776b41303259~mv2.jpg/v1/fit/w_8440,h_5626,q_90/file.jpg\",\n \"width\": 8440,\n \"height\": 5626\n },\n \"id\": \"nsplsh_3653676645776b41303259~mv2.jpg\"\n }\n ]\n },\n \"customTextFields\": [\n {\n \"title\": \"What would you like us to print on the custom label?\",\n \"maxLength\": 200,\n \"mandatory\": false\n }\n ],\n \"manageVariants\": false,\n \"productOptions\": [\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Weight\",\n \"choices\": [\n {\n \"value\": \"250g\",\n \"description\": \"250g\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": false,\n \"visible\": true\n },\n {\n \"value\": \"500g\",\n \"description\": \"500g\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": false,\n \"visible\": true\n }\n ]\n },\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Ground for\",\n \"choices\": [\n {\n \"value\": \"Stovetop\",\n \"description\": \"Stovetop\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": false,\n \"visible\": true\n },\n {\n \"value\": \"Filter\",\n \"description\": \"Filter\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": false,\n \"visible\": true\n }\n ]\n }\n ],\n \"productPageUrl\": {\n \"base\": \"https://wixsite.com/examplestore\",\n \"path\": \"/product-page/ethiopian-yirgacheffe\"\n },\n \"numericId\": \"1624362238998000\",\n \"inventoryItemId\": \"b26c0481-19ed-9ed0-a3d8-7e4ca4afc528\",\n \"discount\": {\n \"type\": \"NONE\",\n \"value\": 0\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\",\n \"00000000-000000-000000-000000000001\"\n ],\n \"variants\": [],\n \"lastUpdated\": \"2021-12-06T11:24:30.164Z\",\n \"createdDate\": \"2021-06-22T11:43:58.998Z\",\n \"ribbon\": \"Fair trade\",\n \"brand\": \"Coffee Company\"\n },\n {\n \"id\": \"5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a\",\n \"name\": \"Indonesian Blend\",\n \"slug\": \"indonesian-blend\",\n \"visible\": true,\n \"productType\": \"physical\",\n \"description\": \"

Half Java Arabica, half Bali Robusta - big flavor with a big kick.

\",\n \"weightRange\": {\n \"minValue\": 0.5,\n \"maxValue\": 1\n },\n \"stock\": {\n \"trackInventory\": false,\n \"inStock\": true,\n \"inventoryStatus\": \"IN_STOCK\"\n },\n \"price\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 35,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$35.00\",\n \"pricePerUnit\": \"$0.14\"\n },\n \"pricePerUnit\": 0.14\n },\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 35,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$35.00\",\n \"pricePerUnit\": \"$0.14\"\n },\n \"pricePerUnit\": 0.14\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 35,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$35.00\",\n \"pricePerUnit\": \"$0.14\"\n },\n \"pricePerUnit\": 0.14\n },\n \"priceRange\": {\n \"minValue\": 35,\n \"maxValue\": 55\n },\n \"costRange\": {\n \"minValue\": 20,\n \"maxValue\": 40\n },\n \"pricePerUnitData\": {\n \"totalQuantity\": 0.25,\n \"totalMeasurementUnit\": \"KG\",\n \"baseQuantity\": 1,\n \"baseMeasurementUnit\": \"G\"\n },\n \"additionalInfoSections\": [\n {\n \"title\": \"Best for\",\n \"description\": \"

Filter, espresso, and moka pot

\\n\"\n }\n ],\n \"ribbons\": [\n {\n \"text\": \"New Arrival\"\n }\n ],\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg\",\n \"width\": 2977,\n \"height\": 3951\n },\n \"id\": \"nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg\",\n \"width\": 2977,\n \"height\": 3951\n },\n \"id\": \"nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg\"\n }\n ]\n },\n \"customTextFields\": [\n {\n \"title\": \"What would you like written on the custom label?\",\n \"maxLength\": 100,\n \"mandatory\": false\n }\n ],\n \"manageVariants\": true,\n \"productOptions\": [\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Weight\",\n \"choices\": [\n {\n \"value\": \"250g\",\n \"description\": \"250g\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"500g\",\n \"description\": \"500g\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n }\n ]\n },\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Ground for\",\n \"choices\": [\n {\n \"value\": \"Stovetop\",\n \"description\": \"Stovetop\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"Filter\",\n \"description\": \"Filter\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n }\n ]\n }\n ],\n \"productPageUrl\": {\n \"base\": \"https://wixsite.com/examplestore\",\n \"path\": \"/product-page/indonesian-blend\"\n },\n \"numericId\": \"1586694163605000\",\n \"inventoryItemId\": \"ac890613-46d1-1056-1b5e-0b0b7f55f2c5\",\n \"discount\": {\n \"type\": \"NONE\",\n \"value\": 0\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\",\n \"00000000-000000-000000-000000000001\"\n ],\n \"variants\": [],\n \"lastUpdated\": \"2022-07-12T09:58:33.584Z\",\n \"createdDate\": \"2020-04-12T12:22:43.605Z\",\n \"seoData\": {\n \"tags\": [\n {\n \"type\": \"title\",\n \"children\": \"Indonesian Blend\",\n \"custom\": false,\n \"disabled\": false\n },\n {\n \"type\": \"meta\",\n \"props\": {\n \"name\": \"description\",\n \"content\": \"Half Java Arabica, half Bali Robusta - big flavor with a biggish kick.\"\n },\n \"children\": \"\",\n \"custom\": false,\n \"disabled\": false\n },\n {\n \"type\": \"meta\",\n \"props\": {\n \"name\": \"robots\",\n \"content\": \"index\"\n },\n \"children\": \"\",\n \"custom\": false,\n \"disabled\": false\n }\n ]\n },\n \"ribbon\": \"New Arrival\",\n \"brand\": \"Coffee Company\"\n },\n {\n \"id\": \"0614129c-8777-9f3b-4dfe-b80a54df10d5\",\n \"name\": \"Brazilian Arabica\",\n \"slug\": \"brazilian-arabica\",\n \"visible\": true,\n \"productType\": \"physical\",\n \"description\": \"

Specially grown Arabica coffee from the Brazilian highlands.

\",\n \"weightRange\": {\n \"minValue\": 0.25,\n \"maxValue\": 0.5\n },\n \"stock\": {\n \"trackInventory\": false,\n \"inStock\": true,\n \"inventoryStatus\": \"IN_STOCK\"\n },\n \"price\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 26.25,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$26.25\",\n \"pricePerUnit\": \"$0.11\"\n },\n \"pricePerUnit\": 0.11\n },\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 26.25,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$26.25\",\n \"pricePerUnit\": \"$0.11\"\n },\n \"pricePerUnit\": 0.11\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 26.25,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$26.25\",\n \"pricePerUnit\": \"$0.11\"\n },\n \"pricePerUnit\": 0.11\n },\n \"priceRange\": {\n \"minValue\": 35,\n \"maxValue\": 65\n },\n \"costRange\": {\n \"minValue\": 0,\n \"maxValue\": 0\n },\n \"pricePerUnitData\": {\n \"totalQuantity\": 250,\n \"totalMeasurementUnit\": \"G\",\n \"baseQuantity\": 1,\n \"baseMeasurementUnit\": \"G\"\n },\n \"additionalInfoSections\": [],\n \"ribbons\": [],\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_4517,h_2992,q_90/file.jpg\",\n \"width\": 4517,\n \"height\": 2992\n },\n \"id\": \"nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_4517,h_2992,q_90/file.jpg\",\n \"width\": 4517,\n \"height\": 2992\n },\n \"id\": \"nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg\"\n }\n ]\n },\n \"customTextFields\": [\n {\n \"title\": \"What would you like written on the custom label?\",\n \"maxLength\": 200,\n \"mandatory\": false\n }\n ],\n \"manageVariants\": true,\n \"productOptions\": [\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Weight\",\n \"choices\": [\n {\n \"value\": \"250g\",\n \"description\": \"250g\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"500g\",\n \"description\": \"500g\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n }\n ]\n },\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Ground for\",\n \"choices\": [\n {\n \"value\": \"Stovetop\",\n \"description\": \"Stovetop\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"Filter\",\n \"description\": \"Filter\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n }\n ]\n }\n ],\n \"productPageUrl\": {\n \"base\": \"https://wixsite.com/examplestore\",\n \"path\": \"/product-page/brazilian-arabica\"\n },\n \"numericId\": \"1586693925142000\",\n \"inventoryItemId\": \"f9ebed63-7888-60c4-b201-47f5ab20ef2a\",\n \"discount\": {\n \"type\": \"PERCENT\",\n \"value\": 25\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\",\n \"00000000-000000-000000-000000000001\"\n ],\n \"variants\": [],\n \"lastUpdated\": \"2021-05-09T08:45:58.767Z\",\n \"createdDate\": \"2020-04-12T12:18:45.142Z\",\n \"seoData\": {\n \"tags\": [\n {\n \"type\": \"title\",\n \"children\": \"Brazilian Arabica\",\n \"custom\": false,\n \"disabled\": false\n },\n {\n \"type\": \"meta\",\n \"props\": {\n \"name\": \"description\",\n \"content\": \"Specially grow coffee from the Brazilian highlands.\"\n },\n \"children\": \"\",\n \"custom\": false,\n \"disabled\": false\n }\n ]\n },\n \"ribbon\": \"\"\n },\n {\n \"id\": \"91f7ac8b-2baa-289c-aa50-6d64764f35d3\",\n \"name\": \"Colombian Arabica\",\n \"slug\": \"colombian-arabica-1\",\n \"visible\": true,\n \"productType\": \"physical\",\n \"description\": \"

The best organic coffee that Colombia has to offer.

\",\n \"weightRange\": {\n \"minValue\": 0.25,\n \"maxValue\": 1\n },\n \"stock\": {\n \"trackInventory\": false,\n \"inStock\": true,\n \"inventoryStatus\": \"IN_STOCK\"\n },\n \"price\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 30,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$30.00\",\n \"pricePerUnit\": \"$0.12\"\n },\n \"pricePerUnit\": 0.12\n },\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 30,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$30.00\",\n \"pricePerUnit\": \"$0.12\"\n },\n \"pricePerUnit\": 0.12\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 30,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$30.00\",\n \"pricePerUnit\": \"$0.12\"\n },\n \"pricePerUnit\": 0.12\n },\n \"priceRange\": {\n \"minValue\": 35,\n \"maxValue\": 70\n },\n \"costRange\": {\n \"minValue\": 20,\n \"maxValue\": 40\n },\n \"pricePerUnitData\": {\n \"totalQuantity\": 250,\n \"totalMeasurementUnit\": \"G\",\n \"baseQuantity\": 1,\n \"baseMeasurementUnit\": \"G\"\n },\n \"additionalInfoSections\": [\n {\n \"title\": \"Storage recommendations\",\n \"description\": \"

To preserve your beans' fresh roasted flavor as long as possible, store them in an opaque, air-tight container at room temperature.

A digital product delivered upon payment

\",\n \"sku\": \"\",\n \"weight\": 0,\n \"stock\": {\n \"trackInventory\": false,\n \"inStock\": true\n },\n \"price\": {\n \"currency\": \"USD\",\n \"price\": 20,\n \"discountedPrice\": 20,\n \"formatted\": {\n \"price\": \"$20.00\",\n \"discountedPrice\": \"$20.00\"\n }\n },\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 20,\n \"discountedPrice\": 20,\n \"formatted\": {\n \"price\": \"$20.00\",\n \"discountedPrice\": \"$20.00\"\n }\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 20,\n \"discountedPrice\": 20,\n \"formatted\": {\n \"price\": \"$20.00\",\n \"discountedPrice\": \"$20.00\"\n }\n },\n \"additionalInfoSections\": [],\n \"ribbons\": [\n {\n \"text\": \"New arrival\"\n }\n ],\n \"ribbon\": \"New arrival\",\n \"brand\": \"Nice\",\n \"media\": {\n \"items\": []\n },\n \"customTextFields\": [],\n \"manageVariants\": false,\n \"productOptions\": [],\n \"productPageUrl\": {\n \"base\": \"https://www.my-website.com\",\n \"path\": \"/product-page/digital-product\"\n },\n \"numericId\": \"1608041194964000\",\n \"inventoryItemId\": \"f78c12a7-0772-882e-ba99-502b3af2dac1\",\n \"discount\": {\n \"type\": \"NONE\",\n \"value\": 0\n },\n \"collectionIds\": [],\n \"variants\": [],\n \"lastUpdated\": \"2020-12-15T14:06:34.964Z\"\n }\n ],\n \"metadata\": {\n \"items\": 100,\n \"offset\": 0\n },\n \"totalResults\": 1\n}\n~~~"}},{"name":"QueryProducts","type":"METHOD","order":2,"content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/products/query' \\\n --data-binary '{\n \"query\": {\n \"filter\": \"{\\\"price\\\": \\\"20\\\"}\"\n }\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"products\": [\n {\n \"id\": \"0873ed58-f88d-77d1-4566-afd4c50d253e\",\n \"name\": \"Digital product\",\n \"slug\": \"digital-product\",\n \"visible\": true,\n \"productType\": \"digital\",\n \"description\": \"

A digital product delivered upon payment

\",\n \"sku\": \"\",\n \"weight\": 0,\n \"stock\": {\n \"trackInventory\": false,\n \"inStock\": true\n },\n \"price\": {\n \"currency\": \"USD\",\n \"price\": 20,\n \"discountedPrice\": 20,\n \"formatted\": {\n \"price\": \"$20.00\",\n \"discountedPrice\": \"$20.00\"\n }\n },\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 20,\n \"discountedPrice\": 20,\n \"formatted\": {\n \"price\": \"$20.00\",\n \"discountedPrice\": \"$20.00\"\n }\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 20,\n \"discountedPrice\": 20,\n \"formatted\": {\n \"price\": \"$20.00\",\n \"discountedPrice\": \"$20.00\"\n }\n },\n \"additionalInfoSections\": [],\n \"ribbons\": [\n {\n \"text\": \"New arrival\"\n }\n ],\n \"ribbon\": \"New arrival\",\n \"brand\": \"Nice\",\n \"media\": {\n \"items\": []\n },\n \"customTextFields\": [],\n \"manageVariants\": false,\n \"productOptions\": [],\n \"productPageUrl\": {\n \"base\": \"https://www.my-website.com\",\n \"path\": \"/product-page/digital-product\"\n },\n \"numericId\": \"1608041194964000\",\n \"inventoryItemId\": \"f78c12a7-0772-882e-ba99-502b3af2dac1\",\n \"discount\": {\n \"type\": \"NONE\",\n \"value\": 0\n },\n \"collectionIds\": [],\n \"variants\": [],\n \"lastUpdated\": \"2020-12-15T14:06:34.964Z\"\n }\n ],\n \"metadata\": {\n \"items\": 100,\n \"offset\": 0\n },\n \"totalResults\": 1\n}\n~~~"}},{"name":"QueryProducts","type":"METHOD","order":3,"content":{"title":"","description":"","request":"~~~cURL\ncurl 'https://www.wixapis.com/stores/v1/products/query' \\\n--data-binary '{\n \"query\": {\n \"filter\": \"{\\\"collections.id\\\": { \\\"$hasSome\\\": [\\\"32fd0b3a-2d38-2235-7754-78a3f819274a\\\"]} }\"\n }\n }' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{\n \"products\": [\n {\n \"id\": \"5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a\",\n \"name\": \"Indonesian Blend\",\n \"slug\": \"indonesian-blend\",\n \"visible\": true,\n \"productType\": \"physical\",\n \"description\": \"

Half Java Arabica, half Bali Robusta - big flavor with a big kick.

\",\n \"stock\": {\n \"trackInventory\": false,\n \"inStock\": true\n },\n \"price\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 35,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$35.00\",\n \"pricePerUnit\": \"$0.14\"\n },\n \"pricePerUnit\": 0.14\n },\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 35,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$35.00\",\n \"pricePerUnit\": \"$0.14\"\n },\n \"pricePerUnit\": 0.14\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 35,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$35.00\",\n \"pricePerUnit\": \"$0.14\"\n },\n \"pricePerUnit\": 0.14\n },\n \"pricePerUnitData\": {\n \"totalQuantity\": 250,\n \"totalMeasurementUnit\": \"G\",\n \"baseQuantity\": 1,\n \"baseMeasurementUnit\": \"G\"\n },\n \"additionalInfoSections\": [],\n \"ribbons\": [],\n \"ribbon\": \"\",\n \"brand\": \"Coffee Company\",\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg\",\n \"width\": 2977,\n \"height\": 3951\n },\n \"id\": \"nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg\",\n \"width\": 2977,\n \"height\": 3951\n },\n \"id\": \"nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg\"\n }\n ]\n },\n \"customTextFields\": [\n {\n \"title\": \"What would you like written on the custom label?\",\n \"maxLength\": 200,\n \"mandatory\": false\n }\n ],\n \"manageVariants\": true,\n \"productOptions\": [\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Weight\",\n \"choices\": [\n {\n \"value\": \"250g\",\n \"description\": \"250g\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"500g\",\n \"description\": \"500g\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n }\n ]\n },\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Ground for\",\n \"choices\": [\n {\n \"value\": \"Stovetop\",\n \"description\": \"Stovetop\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"Filter\",\n \"description\": \"Filter\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n }\n ]\n }\n ],\n \"productPageUrl\": {\n \"base\": \"https://www.my-website.com/\",\n \"path\": \"/product-page/indonesian-blend\"\n },\n \"numericId\": \"1586694163605000\",\n \"inventoryItemId\": \"ac890613-46d1-1056-1b5e-0b0b7f55f2c5\",\n \"discount\": {\n \"type\": \"NONE\",\n \"value\": 0\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"variants\": [],\n \"lastUpdated\": \"2020-12-15T13:49:43.442Z\",\n \"seoData\": {\n \"tags\": [\n {\n \"type\": \"title\",\n \"children\": \"Indonesian Blend | ApiPlayground\",\n \"custom\": false,\n \"disabled\": false\n },\n {\n \"type\": \"meta\",\n \"props\": {\n \"name\": \"description\",\n \"content\": \"Half Java Arabica, half Bali Robusta - big flavor with a biggish kick.\"\n },\n \"children\": \"\",\n \"custom\": false,\n \"disabled\": false\n },\n {\n \"type\": \"meta\",\n \"props\": {\n \"name\": \"robots\",\n \"content\": \"index\"\n },\n \"children\": \"\",\n \"custom\": false,\n \"disabled\": false\n }\n ]\n }\n },\n {\n \"id\": \"0614129c-8777-9f3b-4dfe-b80a54df10d5\",\n \"name\": \"Brazilian Arabica\",\n \"slug\": \"brazilian-arabica\",\n \"visible\": true,\n \"productType\": \"physical\",\n \"description\": \"

Specially grown Arabica coffee from the Brazilian highlands.

\",\n \"stock\": {\n \"trackInventory\": false,\n \"inStock\": true\n },\n \"price\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 26.25,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$26.25\",\n \"pricePerUnit\": \"$0.11\"\n },\n \"pricePerUnit\": 0.11\n },\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 26.25,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$26.25\",\n \"pricePerUnit\": \"$0.11\"\n },\n \"pricePerUnit\": 0.11\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 26.25,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$26.25\",\n \"pricePerUnit\": \"$0.11\"\n },\n \"pricePerUnit\": 0.11\n },\n \"pricePerUnitData\": {\n \"totalQuantity\": 250,\n \"totalMeasurementUnit\": \"G\",\n \"baseQuantity\": 1,\n \"baseMeasurementUnit\": \"G\"\n },\n \"additionalInfoSections\": [],\n \"ribbons\": [],\n \"ribbon\": \"\",\n \"brand\": \"Coffee Company\",\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_4517,h_2992,q_90/file.jpg\",\n \"width\": 4517,\n \"height\": 2992\n },\n \"id\": \"nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_4517,h_2992,q_90/file.jpg\",\n \"width\": 4517,\n \"height\": 2992\n },\n \"id\": \"nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg\"\n }\n ]\n },\n \"customTextFields\": [\n {\n \"title\": \"What would you like written on the custom label?\",\n \"maxLength\": 200,\n \"mandatory\": false\n }\n ],\n \"manageVariants\": true,\n \"productOptions\": [\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Weight\",\n \"choices\": [\n {\n \"value\": \"250g\",\n \"description\": \"250g\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"500g\",\n \"description\": \"500g\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n }\n ]\n },\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Ground for\",\n \"choices\": [\n {\n \"value\": \"Stovetop\",\n \"description\": \"Stovetop\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"Filter\",\n \"description\": \"Filter\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n }\n ]\n }\n ],\n \"productPageUrl\": {\n \"base\": \"https://www.my-website.com/\",\n \"path\": \"/product-page/brazilian-arabica\"\n },\n \"numericId\": \"1586693925142000\",\n \"inventoryItemId\": \"f9ebed63-7888-60c4-b201-47f5ab20ef2a\",\n \"discount\": {\n \"type\": \"PERCENT\",\n \"value\": 25\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"variants\": [],\n \"lastUpdated\": \"2020-12-15T13:50:40.739Z\",\n \"seoData\": {\n \"tags\": [\n {\n \"type\": \"title\",\n \"children\": \"Brazilian Arabica\",\n \"custom\": false,\n \"disabled\": false\n },\n {\n \"type\": \"meta\",\n \"props\": {\n \"name\": \"description\",\n \"content\": \"Specially grown coffee from the Brazilian highlands.\"\n },\n \"children\": \"\",\n \"custom\": false,\n \"disabled\": false\n }\n ]\n }\n },\n {\n \"id\": \"91f7ac8b-2baa-289c-aa50-6d64764f35d3\",\n \"name\": \"Colombian Arabica\",\n \"slug\": \"colombian-arabica-1\",\n \"visible\": true,\n \"productType\": \"physical\",\n \"description\": \"

The best organic coffee that Colombia has to offer.

To preserve your beans' fresh roasted flavor as long as possible, store them in an opaque, air-tight container at room temperature.

\\n\"\n }\n ],\n \"ribbons\": [\n {\n \"text\": \"Organic and Fair trade\"\n }\n ],\n \"ribbon\": \"Organic and Fair trade\",\n \"brand\": \"Coffee Company\",\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_6000,h_3376,q_90/file.jpg\",\n \"width\": 6000,\n \"height\": 3376\n },\n \"id\": \"nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_6000,h_3376,q_90/file.jpg\",\n \"width\": 6000,\n \"height\": 3376\n },\n \"id\": \"nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg\"\n }\n ]\n },\n \"customTextFields\": [\n {\n \"title\": \"What would you like us to print on the custom label?\",\n \"maxLength\": 200,\n \"mandatory\": false\n }\n ],\n \"manageVariants\": true,\n \"productOptions\": [\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Weight\",\n \"choices\": [\n {\n \"value\": \"250g\",\n \"description\": \"250g\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"500g\",\n \"description\": \"500g\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n }\n ]\n },\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Ground for\",\n \"choices\": [\n {\n \"value\": \"Stovetop\",\n \"description\": \"Stovetop\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"Filter\",\n \"description\": \"Filter\",\n \"inStock\": true,\n \"visible\": true\n }\n ]\n }\n ],\n \"productPageUrl\": {\n \"base\": \"https://www.my-website.com/\",\n \"path\": \"/product-page/colombian-arabica-1\"\n },\n \"numericId\": \"1586693639134000\",\n \"inventoryItemId\": \"6e085374-d455-d763-55af-929b89b0ca2c\",\n \"discount\": {\n \"type\": \"AMOUNT\",\n \"value\": 5\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"variants\": [],\n \"lastUpdated\": \"2020-12-15T12:08:32.975Z\",\n \"seoData\": {\n \"tags\": [\n {\n \"type\": \"title\",\n \"children\": \"Colombian Arabica | Organic and Fair Trade\",\n \"custom\": false,\n \"disabled\": false\n },\n {\n \"type\": \"meta\",\n \"props\": {\n \"name\": \"description\",\n \"content\": \"The best organic fair trade coffee that Colombia has to offer.\"\n },\n \"children\": \"\",\n \"custom\": false,\n \"disabled\": false\n }\n ]\n }\n }\n ],\n \"metadata\": {\n \"items\": 100,\n \"offset\": 0\n },\n \"totalResults\": 3\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/products/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogReadApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.READ_PRODUCTS"],"externalPermissionScopes":[{"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":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.stores.catalog.proxy.catalog-read-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.QueryProductsRequest","responseMessage":"wix.catalog.api.v1.QueryProductsResponse"},"legacyExamples":[{"name":"QueryProducts","type":"METHOD","order":1,"content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/products/query' \\\n --data-binary '{\n \"includeVariants\": true\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"products\": [\n {\n \"id\": \"131604aa-169f-d3e8-f076-a967b03e880c\",\n \"name\": \"T-Shirt\",\n \"slug\": \"t-shirt\",\n \"visible\": true,\n \"productType\": \"physical\",\n \"description\": \"

Made from 100% cotton

Wash with similar colors

A digital product delivered upon payment

The best organic coffee that Colombia has to offer.

To preserve your beans' fresh roasted flavor as long as possible, store them in an opaque, air-tight container at room temperature.

Specially grown Arabica coffee from the Brazilian highlands.

Half Java Arabica, half Bali Robusta - big flavor with a big kick.

A digital product delivered upon payment

Made from 100% cotton

Wash with similar colors

Half Java Arabica, half Bali Robusta - big flavor with a big kick.

The best organic coffee that Ethiopia has to offer.

To preserve your beans' fresh roasted flavor as long as possible, store them in an opaque, air-tight container at room temperature.

Half Java Arabica, half Bali Robusta - big flavor with a big kick.

Filter, espresso, and moka pot

Specially grown Arabica coffee from the Brazilian highlands.

The best organic coffee that Colombia has to offer.

To preserve your beans' fresh roasted flavor as long as possible, store them in an opaque, air-tight container at room temperature.

A digital product delivered upon payment

\",\n \"sku\": \"\",\n \"weight\": 0,\n \"stock\": {\n \"trackInventory\": false,\n \"inStock\": true\n },\n \"price\": {\n \"currency\": \"USD\",\n \"price\": 20,\n \"discountedPrice\": 20,\n \"formatted\": {\n \"price\": \"$20.00\",\n \"discountedPrice\": \"$20.00\"\n }\n },\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 20,\n \"discountedPrice\": 20,\n \"formatted\": {\n \"price\": \"$20.00\",\n \"discountedPrice\": \"$20.00\"\n }\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 20,\n \"discountedPrice\": 20,\n \"formatted\": {\n \"price\": \"$20.00\",\n \"discountedPrice\": \"$20.00\"\n }\n },\n \"additionalInfoSections\": [],\n \"ribbons\": [\n {\n \"text\": \"New arrival\"\n }\n ],\n \"ribbon\": \"New arrival\",\n \"brand\": \"Nice\",\n \"media\": {\n \"items\": []\n },\n \"customTextFields\": [],\n \"manageVariants\": false,\n \"productOptions\": [],\n \"productPageUrl\": {\n \"base\": \"https://www.my-website.com\",\n \"path\": \"/product-page/digital-product\"\n },\n \"numericId\": \"1608041194964000\",\n \"inventoryItemId\": \"f78c12a7-0772-882e-ba99-502b3af2dac1\",\n \"discount\": {\n \"type\": \"NONE\",\n \"value\": 0\n },\n \"collectionIds\": [],\n \"variants\": [],\n \"lastUpdated\": \"2020-12-15T14:06:34.964Z\"\n }\n ],\n \"metadata\": {\n \"items\": 100,\n \"offset\": 0\n },\n \"totalResults\": 1\n}\n~~~"}},{"name":"QueryProducts","type":"METHOD","order":2,"content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/products/query' \\\n --data-binary '{\n \"query\": {\n \"filter\": \"{\\\"price\\\": \\\"20\\\"}\"\n }\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"products\": [\n {\n \"id\": \"0873ed58-f88d-77d1-4566-afd4c50d253e\",\n \"name\": \"Digital product\",\n \"slug\": \"digital-product\",\n \"visible\": true,\n \"productType\": \"digital\",\n \"description\": \"

A digital product delivered upon payment

\",\n \"sku\": \"\",\n \"weight\": 0,\n \"stock\": {\n \"trackInventory\": false,\n \"inStock\": true\n },\n \"price\": {\n \"currency\": \"USD\",\n \"price\": 20,\n \"discountedPrice\": 20,\n \"formatted\": {\n \"price\": \"$20.00\",\n \"discountedPrice\": \"$20.00\"\n }\n },\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 20,\n \"discountedPrice\": 20,\n \"formatted\": {\n \"price\": \"$20.00\",\n \"discountedPrice\": \"$20.00\"\n }\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 20,\n \"discountedPrice\": 20,\n \"formatted\": {\n \"price\": \"$20.00\",\n \"discountedPrice\": \"$20.00\"\n }\n },\n \"additionalInfoSections\": [],\n \"ribbons\": [\n {\n \"text\": \"New arrival\"\n }\n ],\n \"ribbon\": \"New arrival\",\n \"brand\": \"Nice\",\n \"media\": {\n \"items\": []\n },\n \"customTextFields\": [],\n \"manageVariants\": false,\n \"productOptions\": [],\n \"productPageUrl\": {\n \"base\": \"https://www.my-website.com\",\n \"path\": \"/product-page/digital-product\"\n },\n \"numericId\": \"1608041194964000\",\n \"inventoryItemId\": \"f78c12a7-0772-882e-ba99-502b3af2dac1\",\n \"discount\": {\n \"type\": \"NONE\",\n \"value\": 0\n },\n \"collectionIds\": [],\n \"variants\": [],\n \"lastUpdated\": \"2020-12-15T14:06:34.964Z\"\n }\n ],\n \"metadata\": {\n \"items\": 100,\n \"offset\": 0\n },\n \"totalResults\": 1\n}\n~~~"}},{"name":"QueryProducts","type":"METHOD","order":3,"content":{"title":"","description":"","request":"~~~cURL\ncurl 'https://www.wixapis.com/stores/v1/products/query' \\\n--data-binary '{\n \"query\": {\n \"filter\": \"{\\\"collections.id\\\": { \\\"$hasSome\\\": [\\\"32fd0b3a-2d38-2235-7754-78a3f819274a\\\"]} }\"\n }\n }' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{\n \"products\": [\n {\n \"id\": \"5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a\",\n \"name\": \"Indonesian Blend\",\n \"slug\": \"indonesian-blend\",\n \"visible\": true,\n \"productType\": \"physical\",\n \"description\": \"

Half Java Arabica, half Bali Robusta - big flavor with a big kick.

\",\n \"stock\": {\n \"trackInventory\": false,\n \"inStock\": true\n },\n \"price\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 35,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$35.00\",\n \"pricePerUnit\": \"$0.14\"\n },\n \"pricePerUnit\": 0.14\n },\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 35,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$35.00\",\n \"pricePerUnit\": \"$0.14\"\n },\n \"pricePerUnit\": 0.14\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 35,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$35.00\",\n \"pricePerUnit\": \"$0.14\"\n },\n \"pricePerUnit\": 0.14\n },\n \"pricePerUnitData\": {\n \"totalQuantity\": 250,\n \"totalMeasurementUnit\": \"G\",\n \"baseQuantity\": 1,\n \"baseMeasurementUnit\": \"G\"\n },\n \"additionalInfoSections\": [],\n \"ribbons\": [],\n \"ribbon\": \"\",\n \"brand\": \"Coffee Company\",\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg\",\n \"width\": 2977,\n \"height\": 3951\n },\n \"id\": \"nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg\",\n \"width\": 2977,\n \"height\": 3951\n },\n \"id\": \"nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg\"\n }\n ]\n },\n \"customTextFields\": [\n {\n \"title\": \"What would you like written on the custom label?\",\n \"maxLength\": 200,\n \"mandatory\": false\n }\n ],\n \"manageVariants\": true,\n \"productOptions\": [\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Weight\",\n \"choices\": [\n {\n \"value\": \"250g\",\n \"description\": \"250g\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"500g\",\n \"description\": \"500g\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n }\n ]\n },\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Ground for\",\n \"choices\": [\n {\n \"value\": \"Stovetop\",\n \"description\": \"Stovetop\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"Filter\",\n \"description\": \"Filter\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n }\n ]\n }\n ],\n \"productPageUrl\": {\n \"base\": \"https://www.my-website.com/\",\n \"path\": \"/product-page/indonesian-blend\"\n },\n \"numericId\": \"1586694163605000\",\n \"inventoryItemId\": \"ac890613-46d1-1056-1b5e-0b0b7f55f2c5\",\n \"discount\": {\n \"type\": \"NONE\",\n \"value\": 0\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"variants\": [],\n \"lastUpdated\": \"2020-12-15T13:49:43.442Z\",\n \"seoData\": {\n \"tags\": [\n {\n \"type\": \"title\",\n \"children\": \"Indonesian Blend | ApiPlayground\",\n \"custom\": false,\n \"disabled\": false\n },\n {\n \"type\": \"meta\",\n \"props\": {\n \"name\": \"description\",\n \"content\": \"Half Java Arabica, half Bali Robusta - big flavor with a biggish kick.\"\n },\n \"children\": \"\",\n \"custom\": false,\n \"disabled\": false\n },\n {\n \"type\": \"meta\",\n \"props\": {\n \"name\": \"robots\",\n \"content\": \"index\"\n },\n \"children\": \"\",\n \"custom\": false,\n \"disabled\": false\n }\n ]\n }\n },\n {\n \"id\": \"0614129c-8777-9f3b-4dfe-b80a54df10d5\",\n \"name\": \"Brazilian Arabica\",\n \"slug\": \"brazilian-arabica\",\n \"visible\": true,\n \"productType\": \"physical\",\n \"description\": \"

Specially grown Arabica coffee from the Brazilian highlands.

\",\n \"stock\": {\n \"trackInventory\": false,\n \"inStock\": true\n },\n \"price\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 26.25,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$26.25\",\n \"pricePerUnit\": \"$0.11\"\n },\n \"pricePerUnit\": 0.11\n },\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 26.25,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$26.25\",\n \"pricePerUnit\": \"$0.11\"\n },\n \"pricePerUnit\": 0.11\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 26.25,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$26.25\",\n \"pricePerUnit\": \"$0.11\"\n },\n \"pricePerUnit\": 0.11\n },\n \"pricePerUnitData\": {\n \"totalQuantity\": 250,\n \"totalMeasurementUnit\": \"G\",\n \"baseQuantity\": 1,\n \"baseMeasurementUnit\": \"G\"\n },\n \"additionalInfoSections\": [],\n \"ribbons\": [],\n \"ribbon\": \"\",\n \"brand\": \"Coffee Company\",\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_4517,h_2992,q_90/file.jpg\",\n \"width\": 4517,\n \"height\": 2992\n },\n \"id\": \"nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_4517,h_2992,q_90/file.jpg\",\n \"width\": 4517,\n \"height\": 2992\n },\n \"id\": \"nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg\"\n }\n ]\n },\n \"customTextFields\": [\n {\n \"title\": \"What would you like written on the custom label?\",\n \"maxLength\": 200,\n \"mandatory\": false\n }\n ],\n \"manageVariants\": true,\n \"productOptions\": [\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Weight\",\n \"choices\": [\n {\n \"value\": \"250g\",\n \"description\": \"250g\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"500g\",\n \"description\": \"500g\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n }\n ]\n },\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Ground for\",\n \"choices\": [\n {\n \"value\": \"Stovetop\",\n \"description\": \"Stovetop\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"Filter\",\n \"description\": \"Filter\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n }\n ]\n }\n ],\n \"productPageUrl\": {\n \"base\": \"https://www.my-website.com/\",\n \"path\": \"/product-page/brazilian-arabica\"\n },\n \"numericId\": \"1586693925142000\",\n \"inventoryItemId\": \"f9ebed63-7888-60c4-b201-47f5ab20ef2a\",\n \"discount\": {\n \"type\": \"PERCENT\",\n \"value\": 25\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"variants\": [],\n \"lastUpdated\": \"2020-12-15T13:50:40.739Z\",\n \"seoData\": {\n \"tags\": [\n {\n \"type\": \"title\",\n \"children\": \"Brazilian Arabica\",\n \"custom\": false,\n \"disabled\": false\n },\n {\n \"type\": \"meta\",\n \"props\": {\n \"name\": \"description\",\n \"content\": \"Specially grown coffee from the Brazilian highlands.\"\n },\n \"children\": \"\",\n \"custom\": false,\n \"disabled\": false\n }\n ]\n }\n },\n {\n \"id\": \"91f7ac8b-2baa-289c-aa50-6d64764f35d3\",\n \"name\": \"Colombian Arabica\",\n \"slug\": \"colombian-arabica-1\",\n \"visible\": true,\n \"productType\": \"physical\",\n \"description\": \"

The best organic coffee that Colombia has to offer.

To preserve your beans' fresh roasted flavor as long as possible, store them in an opaque, air-tight container at room temperature.

\\n\"\n }\n ],\n \"ribbons\": [\n {\n \"text\": \"Organic and Fair trade\"\n }\n ],\n \"ribbon\": \"Organic and Fair trade\",\n \"brand\": \"Coffee Company\",\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_6000,h_3376,q_90/file.jpg\",\n \"width\": 6000,\n \"height\": 3376\n },\n \"id\": \"nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_6000,h_3376,q_90/file.jpg\",\n \"width\": 6000,\n \"height\": 3376\n },\n \"id\": \"nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg\"\n }\n ]\n },\n \"customTextFields\": [\n {\n \"title\": \"What would you like us to print on the custom label?\",\n \"maxLength\": 200,\n \"mandatory\": false\n }\n ],\n \"manageVariants\": true,\n \"productOptions\": [\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Weight\",\n \"choices\": [\n {\n \"value\": \"250g\",\n \"description\": \"250g\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"500g\",\n \"description\": \"500g\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n }\n ]\n },\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Ground for\",\n \"choices\": [\n {\n \"value\": \"Stovetop\",\n \"description\": \"Stovetop\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"Filter\",\n \"description\": \"Filter\",\n \"inStock\": true,\n \"visible\": true\n }\n ]\n }\n ],\n \"productPageUrl\": {\n \"base\": \"https://www.my-website.com/\",\n \"path\": \"/product-page/colombian-arabica-1\"\n },\n \"numericId\": \"1586693639134000\",\n \"inventoryItemId\": \"6e085374-d455-d763-55af-929b89b0ca2c\",\n \"discount\": {\n \"type\": \"AMOUNT\",\n \"value\": 5\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"variants\": [],\n \"lastUpdated\": \"2020-12-15T12:08:32.975Z\",\n \"seoData\": {\n \"tags\": [\n {\n \"type\": \"title\",\n \"children\": \"Colombian Arabica | Organic and Fair Trade\",\n \"custom\": false,\n \"disabled\": false\n },\n {\n \"type\": \"meta\",\n \"props\": {\n \"name\": \"description\",\n \"content\": \"The best organic fair trade coffee that Colombia has to offer.\"\n },\n \"children\": \"\",\n \"custom\": false,\n \"disabled\": false\n }\n ]\n }\n }\n ],\n \"metadata\": {\n \"items\": 100,\n \"offset\": 0\n },\n \"totalResults\": 3\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Query Products","slugifiedName":"query-products"}},{"summary":"Get Product","description":"Retrieves a product with the provided ID.","operationId":"wix.catalog.api.v1.CatalogReadApi.GetProduct","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Requested product ID.","x-wix-docs":{"exposure":"PUBLIC"}},{"name":"includeMerchantSpecificData","in":"query","description":"Whether merchant specific data, such as cost and profit data, should be included in the response. Requires permissions to manage products.","required":false,"schema":{"description":"Whether merchant specific data, such as cost and profit data, should be included in the response. Requires permissions to manage products.","title":"includeMerchantSpecificData","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}}],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.GetProductResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores-reader/v1/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores-reader/v1/products","destinationPath":"/v1/products","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogReadApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.READ_PRODUCTS"],"externalPermissionScopes":[{"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":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.stores.catalog.proxy.catalog-read-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.GetProductRequest","responseMessage":"wix.catalog.api.v1.GetProductResponse"},"legacyExamples":[{"name":"GetProduct","type":"METHOD","content":{"title":"Get Product including merchant-specific data","request":"curl -X GET \\\n 'https: //www.wixapis.com/stores/v1/products/91f7ac8b-2baa-289c-aa50-6d64764f35d3?includeMerchantSpecificData=true' \\\n -H 'Authorization: '","response":"{\n \"product\": {\n \"id\": \"91f7ac8b-2baa-289c-aa50-6d64764f35d3\",\n \"name\": \"Colombian Arabica\",\n \"slug\": \"colombian-arabica-1\",\n \"visible\": true,\n \"productType\": \"physical\",\n \"description\": \"

The best organic coffee that Colombia has to offer.

To preserve your beans' fresh roasted flavor as long as possible, store them in an opaque, air-tight container at room temperature.

The best organic coffee that Colombia has to offer.

To preserve your beans' fresh roasted flavor as long as possible, store them in an opaque, air-tight container at room temperature.

\\n\"\n }\n ],\n \"ribbons\": [\n {\n \"text\": \"Organic and Fair trade\"\n }\n ],\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_6000,h_3376,q_90/file.jpg\",\n \"width\": 6000,\n \"height\": 3376\n },\n \"id\": \"nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_6000,h_3376,q_90/file.jpg\",\n \"width\": 6000,\n \"height\": 3376\n },\n \"id\": \"nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg\"\n }\n ]\n },\n \"customTextFields\": [\n {\n \"title\": \"What would you like us to print on the custom label?\",\n \"maxLength\": 200,\n \"mandatory\": false\n }\n ],\n \"manageVariants\": true,\n \"productOptions\": [\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Weight\",\n \"choices\": [\n {\n \"value\": \"250g\",\n \"description\": \"250g\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"500g\",\n \"description\": \"500g\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n }\n ]\n },\n {\n \"optionType\": \"drop_down\",\n \"name\": \"Ground for\",\n \"choices\": [\n {\n \"value\": \"Stovetop\",\n \"description\": \"Stovetop\",\n \"media\": {\n \"items\": []\n },\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"Filter\",\n \"description\": \"Filter\",\n \"inStock\": true,\n \"visible\": true\n }\n ]\n }\n ],\n \"productPageUrl\": {\n \"base\": \"https://wixsite.com/examplestore\",\n \"path\": \"/product-page/colombian-arabica-1\"\n },\n \"numericId\": \"1586693639134000\",\n \"inventoryItemId\": \"6e085374-d455-d763-55af-929b89b0ca2c\",\n \"discount\": {\n \"type\": \"AMOUNT\",\n \"value\": 5\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\",\n \"00000000-000000-000000-000000000001\"\n ],\n \"variants\": [\n {\n \"id\": \"00000000-0000-0020-0005-a316e6ba5b37\",\n \"choices\": {\n \"Weight\": \"250g\",\n \"Ground for\": \"Stovetop\"\n },\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 30,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$30.00\",\n \"pricePerUnit\": \"$0.12\"\n },\n \"pricePerUnit\": 0.12\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 30,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$30.00\",\n \"pricePerUnit\": \"$0.12\"\n },\n \"pricePerUnit\": 0.12\n },\n \"costAndProfitData\": {\n \"itemCost\": 20,\n \"formattedItemCost\": \"$20.00\",\n \"profit\": 10,\n \"formattedProfit\": \"$10.00\",\n \"profitMargin\": 0.3333\n },\n \"weight\": 0.25,\n \"sku\": \"10001\",\n \"visible\": true\n }\n },\n {\n \"id\": \"00000000-0000-0021-0005-a316e6ba5b37\",\n \"choices\": {\n \"Weight\": \"250g\",\n \"Ground for\": \"Filter\"\n },\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 30,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$30.00\",\n \"pricePerUnit\": \"$0.12\"\n },\n \"pricePerUnit\": 0.12\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 30,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$30.00\",\n \"pricePerUnit\": \"$0.12\"\n },\n \"pricePerUnit\": 0.12\n },\n \"costAndProfitData\": {\n \"itemCost\": 20,\n \"formattedItemCost\": \"$20.00\",\n \"profit\": 10,\n \"formattedProfit\": \"$10.00\",\n \"profitMargin\": 0.3333\n },\n \"weight\": 0.25,\n \"sku\": \"10003\",\n \"visible\": true\n }\n },\n {\n \"id\": \"00000000-0000-003f-0005-a316e6ba5b37\",\n \"choices\": {\n \"Weight\": \"500g\",\n \"Ground for\": \"Stovetop\"\n },\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 65,\n \"discountedPrice\": 60,\n \"formatted\": {\n \"price\": \"$65.00\",\n \"discountedPrice\": \"$60.00\",\n \"pricePerUnit\": \"$0.24\"\n },\n \"pricePerUnit\": 0.24\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 65,\n \"discountedPrice\": 60,\n \"formatted\": {\n \"price\": \"$65.00\",\n \"discountedPrice\": \"$60.00\",\n \"pricePerUnit\": \"$0.24\"\n },\n \"pricePerUnit\": 0.24\n },\n \"costAndProfitData\": {\n \"itemCost\": 40,\n \"formattedItemCost\": \"$40.00\",\n \"profit\": 20,\n \"formattedProfit\": \"$20.00\",\n \"profitMargin\": 0.3333\n },\n \"weight\": 0.5,\n \"sku\": \"10002\",\n \"visible\": true\n }\n },\n {\n \"id\": \"00000000-0000-0040-0005-a316e6ba5b37\",\n \"choices\": {\n \"Weight\": \"500g\",\n \"Ground for\": \"Filter\"\n },\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 70,\n \"discountedPrice\": 65,\n \"formatted\": {\n \"price\": \"$70.00\",\n \"discountedPrice\": \"$65.00\",\n \"pricePerUnit\": \"$0.26\"\n },\n \"pricePerUnit\": 0.26\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 70,\n \"discountedPrice\": 65,\n \"formatted\": {\n \"price\": \"$70.00\",\n \"discountedPrice\": \"$65.00\",\n \"pricePerUnit\": \"$0.26\"\n },\n \"pricePerUnit\": 0.26\n },\n \"costAndProfitData\": {\n \"itemCost\": 40,\n \"formattedItemCost\": \"$40.00\",\n \"profit\": 25,\n \"formattedProfit\": \"$25.00\",\n \"profitMargin\": 0.3846\n },\n \"weight\": 1,\n \"sku\": \"10004\",\n \"visible\": true\n }\n }\n ],\n \"lastUpdated\": \"2022-07-12T10:02:26.664Z\",\n \"createdDate\": \"2020-04-12T12:13:59.134Z\",\n \"seoData\": {\n \"tags\": [\n {\n \"type\": \"title\",\n \"children\": \"Colombian Arabica | Organic and Fair Trade\",\n \"custom\": false,\n \"disabled\": false\n },\n {\n \"type\": \"meta\",\n \"props\": {\n \"name\": \"description\",\n \"content\": \"The best organic fair trade coffee that Colombia has to offer.\"\n },\n \"children\": \"\",\n \"custom\": false,\n \"disabled\": false\n }\n ]\n },\n \"ribbon\": \"Organic and Fair trade\",\n \"brand\": \"Coffee Company\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Get Product","slugifiedName":"get-product"}},{"summary":"Query Collections","description":"Retrieves a list of up to 100 collections, given the provided paging, sorting and filtering.\nSee [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.","operationId":"wix.catalog.api.v1.CatalogReadApi.QueryCollections","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.QueryCollectionsResponse","description":""}},"deprecated":false,"servers":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryCollectionsRequest","description":"","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/wix.catalog.api.v1.Query","summary":"query","x-wix-docs":{"exposure":"PUBLIC"}},"includeNumberOfProducts":{"description":"Whether number of products should be included in the response.","title":"includeNumberOfProducts","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"includeDescription":{"description":"Wether to include collection description in the response. When `false` is passed, `collection.description` will return null.","title":"includeDescription","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogReadApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.READ_PRODUCTS"],"externalPermissionScopes":[{"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":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.stores.catalog.proxy.catalog-read-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.QueryCollectionsRequest","responseMessage":"wix.catalog.api.v1.QueryCollectionsResponse"},"legacyExamples":[{"name":"QueryCollections","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/collections/query' \\\n --data-binary '{\n \"query\": {},\n \"includeNumberOfProducts\": true,\n \"includeDescription\": true\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"collections\": [\n {\n \"id\": \"00000000-000000-000000-000000000001\",\n \"name\": \"All Products\",\n \"slug\": \"all-products\",\n \"visible\": true,\n \"description\": \"All of the products in the store\",\n \"media\": {\n \"items\": []\n },\n \"numberOfProducts\": 6\n },\n {\n \"id\": \"32fd0b3a-2d38-2235-7754-78a3f819274a\",\n \"name\": \"Coffee Products\",\n \"slug\": \"coffee-products\",\n \"visible\": true,\n \"description\": \"Coffee related products\",\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.jpg/v1/fit/w_6630,h_5304,q_90/file.jpg\",\n \"width\": 6630,\n \"height\": 5304\n },\n \"id\": \"\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.jpg/v1/fit/w_6630,h_5304,q_90/file.jpg\",\n \"width\": 6630,\n \"height\": 5304\n },\n \"id\": \"\"\n }\n ]\n },\n \"numberOfProducts\": 5\n }\n ],\n \"metadata\": {\n \"items\": 100,\n \"offset\": 0\n },\n \"totalResults\": 2\n}\n~~~"}},{"name":"QueryCollections","type":"METHOD","order":2,"content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/collections/query' \\\n --data-binary '{\n \"query\": {\n \"filter\": {\n \"name\": \"my collection\"\n }\n }\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"collections\": [\n {\n \"id\": \"00000000-000000-000000-000000000001\",\n \"name\": \"my collection\",\n \"slug\": \"my-collection\",\n \"visible\": true,\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/697bc8_43b2c20a2d4144c797ca3cf4d2a7290f~mv2_d_2489_2251_s_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/697bc8_43b2c20a2d4144c797ca3cf4d2a7290f~mv2_d_2489_2251_s_2.jpg/v1/fit/w_2489,h_2251,q_90/file.jpg\",\n \"width\": 2489,\n \"height\": 2251\n },\n \"id\": \"\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/697bc8_43b2c20a2d4144c797ca3cf4d2a7290f~mv2_d_2489_2251_s_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/697bc8_43b2c20a2d4144c797ca3cf4d2a7290f~mv2_d_2489_2251_s_2.jpg/v1/fit/w_2489,h_2251,q_90/file.jpg\",\n \"width\": 2489,\n \"height\": 2251\n },\n \"id\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"7f79cca8-80b6-d24b-e6f8-356187d95050\",\n \"name\": \"C A C T I\",\n \"slug\": \"c-a-c-t-i\",\n \"visible\": true,\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/697bc8_49e72a53cd064655ba1991bf1d7c1deb~mv2_d_1920_1920_s_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/697bc8_49e72a53cd064655ba1991bf1d7c1deb~mv2_d_1920_1920_s_2.jpg/v1/fit/w_1920,h_1920,q_90/file.jpg\",\n \"width\": 1920,\n \"height\": 1920\n },\n \"id\": \"\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/697bc8_49e72a53cd064655ba1991bf1d7c1deb~mv2_d_1920_1920_s_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/697bc8_49e72a53cd064655ba1991bf1d7c1deb~mv2_d_1920_1920_s_2.jpg/v1/fit/w_1920,h_1920,q_90/file.jpg\",\n \"width\": 1920,\n \"height\": 1920\n },\n \"id\": \"\"\n }\n ]\n }\n }\n ],\n \"metadata\": {\n \"items\": 100,\n \"offset\": 0\n },\n \"totalResults\": 2\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/collections/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogReadApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.READ_PRODUCTS"],"externalPermissionScopes":[{"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":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.stores.catalog.proxy.catalog-read-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.QueryCollectionsRequest","responseMessage":"wix.catalog.api.v1.QueryCollectionsResponse"},"legacyExamples":[{"name":"QueryCollections","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/collections/query' \\\n --data-binary '{\n \"query\": {},\n \"includeNumberOfProducts\": true,\n \"includeDescription\": true\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"collections\": [\n {\n \"id\": \"00000000-000000-000000-000000000001\",\n \"name\": \"All Products\",\n \"slug\": \"all-products\",\n \"visible\": true,\n \"description\": \"All of the products in the store\",\n \"media\": {\n \"items\": []\n },\n \"numberOfProducts\": 6\n },\n {\n \"id\": \"32fd0b3a-2d38-2235-7754-78a3f819274a\",\n \"name\": \"Coffee Products\",\n \"slug\": \"coffee-products\",\n \"visible\": true,\n \"description\": \"Coffee related products\",\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.jpg/v1/fit/w_6630,h_5304,q_90/file.jpg\",\n \"width\": 6630,\n \"height\": 5304\n },\n \"id\": \"\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.jpg/v1/fit/w_6630,h_5304,q_90/file.jpg\",\n \"width\": 6630,\n \"height\": 5304\n },\n \"id\": \"\"\n }\n ]\n },\n \"numberOfProducts\": 5\n }\n ],\n \"metadata\": {\n \"items\": 100,\n \"offset\": 0\n },\n \"totalResults\": 2\n}\n~~~"}},{"name":"QueryCollections","type":"METHOD","order":2,"content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/collections/query' \\\n --data-binary '{\n \"query\": {\n \"filter\": {\n \"name\": \"my collection\"\n }\n }\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"collections\": [\n {\n \"id\": \"00000000-000000-000000-000000000001\",\n \"name\": \"my collection\",\n \"slug\": \"my-collection\",\n \"visible\": true,\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/697bc8_43b2c20a2d4144c797ca3cf4d2a7290f~mv2_d_2489_2251_s_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/697bc8_43b2c20a2d4144c797ca3cf4d2a7290f~mv2_d_2489_2251_s_2.jpg/v1/fit/w_2489,h_2251,q_90/file.jpg\",\n \"width\": 2489,\n \"height\": 2251\n },\n \"id\": \"\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/697bc8_43b2c20a2d4144c797ca3cf4d2a7290f~mv2_d_2489_2251_s_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/697bc8_43b2c20a2d4144c797ca3cf4d2a7290f~mv2_d_2489_2251_s_2.jpg/v1/fit/w_2489,h_2251,q_90/file.jpg\",\n \"width\": 2489,\n \"height\": 2251\n },\n \"id\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"7f79cca8-80b6-d24b-e6f8-356187d95050\",\n \"name\": \"C A C T I\",\n \"slug\": \"c-a-c-t-i\",\n \"visible\": true,\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/697bc8_49e72a53cd064655ba1991bf1d7c1deb~mv2_d_1920_1920_s_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/697bc8_49e72a53cd064655ba1991bf1d7c1deb~mv2_d_1920_1920_s_2.jpg/v1/fit/w_1920,h_1920,q_90/file.jpg\",\n \"width\": 1920,\n \"height\": 1920\n },\n \"id\": \"\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/697bc8_49e72a53cd064655ba1991bf1d7c1deb~mv2_d_1920_1920_s_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/697bc8_49e72a53cd064655ba1991bf1d7c1deb~mv2_d_1920_1920_s_2.jpg/v1/fit/w_1920,h_1920,q_90/file.jpg\",\n \"width\": 1920,\n \"height\": 1920\n },\n \"id\": \"\"\n }\n ]\n }\n }\n ],\n \"metadata\": {\n \"items\": 100,\n \"offset\": 0\n },\n \"totalResults\": 2\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Query Collections","slugifiedName":"query-collections"}},{"summary":"Get Collection","description":"Retrieves a collection with the provided ID.","operationId":"wix.catalog.api.v1.CatalogReadApi.GetCollection","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Requested collection ID.","x-wix-docs":{"exposure":"PUBLIC"}},{"name":"includeNumberOfProducts","in":"query","description":"Whether to return the `collection.numberOfProducts` field in the response.\nDefaults to `false`, in which case the value of `collection.numberOfProducts` will be `0`.","required":false,"schema":{"description":"Whether to return the `collection.numberOfProducts` field in the response.\nDefaults to `false`, in which case the value of `collection.numberOfProducts` will be `0`.","title":"includeNumberOfProducts","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}}],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.GetCollectionResponse","description":""}},"deprecated":false,"servers":[],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogReadApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.READ_PRODUCTS"],"externalPermissionScopes":[{"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":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.stores.catalog.proxy.catalog-read-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.GetCollectionRequest","responseMessage":"wix.catalog.api.v1.GetCollectionResponse"},"legacyExamples":[{"name":"GetCollection","type":"METHOD","content":{"title":"Get Collection and include number of products","request":"curl -X GET \\\n 'https://www.wixapis.com/stores/v1/collections/32fd0b3a-2d38-2235-7754-78a3f819274a?includeNumberOfProducts=true' \\\n -H 'Authorization: '","response":"{\n \"collection\": {\n \"id\": \"32fd0b3a-2d38-2235-7754-78a3f819274a\",\n \"name\": \"Coffee Products\",\n \"slug\": \"coffee-products\",\n \"visible\": true,\n \"description\": \"Some Coffee Products\",\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.jpg/v1/fit/w_6630,h_5304,q_90/file.jpg\",\n \"width\": 6630,\n \"height\": 5304\n },\n \"id\": \"\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.jpg/v1/fit/w_6630,h_5304,q_90/file.jpg\",\n \"width\": 6630,\n \"height\": 5304\n },\n \"id\": \"\"\n }\n ]\n },\n \"numberOfProducts\": 5\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"get","path":"/v1/collections/{id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogReadApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.READ_PRODUCTS"],"externalPermissionScopes":[{"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":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.stores.catalog.proxy.catalog-read-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.GetCollectionRequest","responseMessage":"wix.catalog.api.v1.GetCollectionResponse"},"legacyExamples":[{"name":"GetCollection","type":"METHOD","content":{"title":"Get Collection and include number of products","request":"curl -X GET \\\n 'https://www.wixapis.com/stores/v1/collections/32fd0b3a-2d38-2235-7754-78a3f819274a?includeNumberOfProducts=true' \\\n -H 'Authorization: '","response":"{\n \"collection\": {\n \"id\": \"32fd0b3a-2d38-2235-7754-78a3f819274a\",\n \"name\": \"Coffee Products\",\n \"slug\": \"coffee-products\",\n \"visible\": true,\n \"description\": \"Some Coffee Products\",\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.jpg/v1/fit/w_6630,h_5304,q_90/file.jpg\",\n \"width\": 6630,\n \"height\": 5304\n },\n \"id\": \"\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.jpg/v1/fit/w_6630,h_5304,q_90/file.jpg\",\n \"width\": 6630,\n \"height\": 5304\n },\n \"id\": \"\"\n }\n ]\n },\n \"numberOfProducts\": 5\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Get Collection","slugifiedName":"get-collection"}},{"summary":"Get Collection By Slug","description":"Retrieves a collection with the provided slug.","operationId":"wix.catalog.api.v1.CatalogReadApi.GetCollectionBySlug","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"slug","description":"Slug of the collection to retrieve.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.GetCollectionBySlugResponse","description":""}},"deprecated":false,"servers":[],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogReadApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.READ_PRODUCTS"],"externalPermissionScopes":[{"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":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.stores.catalog.proxy.catalog-read-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.GetCollectionBySlugRequest","responseMessage":"wix.catalog.api.v1.GetCollectionBySlugResponse"},"legacyExamples":[{"name":"GetCollectionBySlug","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET \\\n 'https://www.wixapis.com/stores/v1/collections/slug/coffee-products' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"collection\": {\n \"id\": \"32fd0b3a-2d38-2235-7754-78a3f819274a\",\n \"name\": \"Coffee Products\",\n \"slug\": \"coffee-products\",\n \"visible\": true,\n \"description\": \"Some Coffee Products\",\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.jpg/v1/fit/w_6630,h_5304,q_90/file.jpg\",\n \"width\": 6630,\n \"height\": 5304\n },\n \"id\": \"\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.jpg/v1/fit/w_6630,h_5304,q_90/file.jpg\",\n \"width\": 6630,\n \"height\": 5304\n },\n \"id\": \"\"\n }\n ]\n },\n \"numberOfProducts\": 5\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"get","path":"/v1/collections/slug/{slug}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogReadApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.READ_PRODUCTS"],"externalPermissionScopes":[{"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":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.stores.catalog.proxy.catalog-read-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.GetCollectionBySlugRequest","responseMessage":"wix.catalog.api.v1.GetCollectionBySlugResponse"},"legacyExamples":[{"name":"GetCollectionBySlug","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET \\\n 'https://www.wixapis.com/stores/v1/collections/slug/coffee-products' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"collection\": {\n \"id\": \"32fd0b3a-2d38-2235-7754-78a3f819274a\",\n \"name\": \"Coffee Products\",\n \"slug\": \"coffee-products\",\n \"visible\": true,\n \"description\": \"Some Coffee Products\",\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.jpg/v1/fit/w_6630,h_5304,q_90/file.jpg\",\n \"width\": 6630,\n \"height\": 5304\n },\n \"id\": \"\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.jpg/v1/fit/w_6630,h_5304,q_90/file.jpg\",\n \"width\": 6630,\n \"height\": 5304\n },\n \"id\": \"\"\n }\n ]\n },\n \"numberOfProducts\": 5\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Get Collection By Slug","slugifiedName":"get-collection-by-slug"}},{"summary":"Get Product Options Availability","description":"Gets the availability of relevant product variants based on the product ID and selections provided. See [Use Cases](https://dev.wix.com/api/rest/wix-stores/catalog/use-cases) for an example.","operationId":"wix.catalog.api.v1.CatalogReadApi.ProductOptionsAvailability","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Requested product ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.ProductOptionsAvailabilityResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores-reader/v1/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores-reader/v1/products","destinationPath":"/v1/products","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"ProductOptionsAvailabilityRequest","description":"","properties":{"options":{"description":"Array containing the selected options. For example, `[\"color\": \"Blue\", \"size\": \"Large\"]`.","title":"options","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"type":"string"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["id"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogReadApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.READ_PRODUCTS"],"externalPermissionScopes":[{"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":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.stores.catalog.proxy.catalog-read-proxy","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.ProductOptionsAvailabilityRequest","responseMessage":"wix.catalog.api.v1.ProductOptionsAvailabilityResponse"},"legacyExamples":[{"name":"ProductOptionsAvailability","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/products/1044e7e4-37d1-0705-c5b3-623baae212fd/productOptionsAvailability' \\\n --data-binary '{\n \"options\": {\n \"Size\": \"S\",\n \"Color\": \"Green\"\n }\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"productOptions\": [\n {\n \"optionType\": \"color\",\n \"name\": \"Color\",\n \"choices\": [\n {\n \"value\": \"#008000\",\n \"description\": \"Green\",\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"#800080\",\n \"description\": \"Purple\",\n \"inStock\": true,\n \"visible\": true\n }\n ]\n }\n ],\n \"availableForPurchase\": false\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/products/{id}/productOptionsAvailability","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogReadApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.READ_PRODUCTS"],"externalPermissionScopes":[{"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":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.stores.catalog.proxy.catalog-read-proxy","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.ProductOptionsAvailabilityRequest","responseMessage":"wix.catalog.api.v1.ProductOptionsAvailabilityResponse"},"legacyExamples":[{"name":"ProductOptionsAvailability","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/products/1044e7e4-37d1-0705-c5b3-623baae212fd/productOptionsAvailability' \\\n --data-binary '{\n \"options\": {\n \"Size\": \"S\",\n \"Color\": \"Green\"\n }\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"productOptions\": [\n {\n \"optionType\": \"color\",\n \"name\": \"Color\",\n \"choices\": [\n {\n \"value\": \"#008000\",\n \"description\": \"Green\",\n \"inStock\": true,\n \"visible\": true\n },\n {\n \"value\": \"#800080\",\n \"description\": \"Purple\",\n \"inStock\": true,\n \"visible\": true\n }\n ]\n }\n ],\n \"availableForPurchase\": false\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Get Product Options Availability","slugifiedName":"get-product-options-availability"}},{"summary":"Query Product Variants","description":"Retrieves product variants, based on either choices (option-choice key-value pairs) or variant IDs.\nSee [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.","operationId":"wix.catalog.api.v1.CatalogReadApi.QueryProductVariants","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Requested product ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.QueryProductVariantsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores-reader/v1/products","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores-reader/v1/products","destinationPath":"/v1/products","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryProductVariantsRequest","description":"","properties":{"choices":{"description":"The specific choices available or chosen from within a selection (e.g., choosing the red Selection triggers the red Choice).\nYou may specify all the relevant choices for a specific variant, or only some of the options, which will return all corresponding variants (not relevant when passing variant IDs).","title":"choices","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"type":"string"}},"x-wix-docs":{"exposure":"PUBLIC"}},"variantIds":{"description":"List of variant IDs (not relevant when passing choices).","title":"variantIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"paging":{"description":"","$ref":"#/components/schemas/wix.catalog.api.v1.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC"}},"includeMerchantSpecificData":{"description":"Whether merchant specific data should be included in the response. Requires permissions to manage products.","title":"includeMerchantSpecificData","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["id"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogReadApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.READ_PRODUCTS"],"externalPermissionScopes":[{"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":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.stores.catalog.proxy.catalog-read-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.QueryProductVariantsRequest","responseMessage":"wix.catalog.api.v1.QueryProductVariantsResponse"},"legacyExamples":[{"name":"QueryProductVariants","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/products/0614129c-8777-9f3b-4dfe-b80a54df10d5/variants/query' \\\n --data-binary '{\n \"choices\": {\n \"Weight\": \"250g\"\n },\n \"includeMerchantSpecificData\": true\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"variants\": [\n {\n \"id\": \"00000000-0000-0020-0005-a316e6ba5b37\",\n \"choices\": {\n \"Weight\": \"250g\",\n \"Ground for\": \"Stovetop\"\n },\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 30,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$30.00\",\n \"pricePerUnit\": \"$0.12\"\n },\n \"pricePerUnit\": 0.12\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 30,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$30.00\",\n \"pricePerUnit\": \"$0.12\"\n },\n \"pricePerUnit\": 0.12\n },\n \"costAndProfitData\": {\n \"itemCost\": 20,\n \"formattedItemCost\": \"$20.00\",\n \"profit\": 10,\n \"formattedProfit\": \"$10.00\",\n \"profitMargin\": 0.3333\n },\n \"weight\": 0.25,\n \"sku\": \"10001\",\n \"visible\": true\n }\n },\n {\n \"id\": \"00000000-0000-0021-0005-a316e6ba5b37\",\n \"choices\": {\n \"Weight\": \"250g\",\n \"Ground for\": \"Filter\"\n },\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 30,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$30.00\",\n \"pricePerUnit\": \"$0.12\"\n },\n \"pricePerUnit\": 0.12\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 30,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$30.00\",\n \"pricePerUnit\": \"$0.12\"\n },\n \"pricePerUnit\": 0.12\n },\n \"costAndProfitData\": {\n \"itemCost\": 20,\n \"formattedItemCost\": \"$20.00\",\n \"profit\": 10,\n \"formattedProfit\": \"$10.00\",\n \"profitMargin\": 0.3333\n },\n \"weight\": 0.25,\n \"sku\": \"10003\",\n \"visible\": true\n }\n }\n ],\n \"metadata\": {\n \"items\": 2,\n \"offset\": 0\n },\n \"totalResults\": 2\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/products/{id}/variants/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogReadApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.READ_PRODUCTS"],"externalPermissionScopes":[{"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":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.stores.catalog.proxy.catalog-read-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.QueryProductVariantsRequest","responseMessage":"wix.catalog.api.v1.QueryProductVariantsResponse"},"legacyExamples":[{"name":"QueryProductVariants","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/products/0614129c-8777-9f3b-4dfe-b80a54df10d5/variants/query' \\\n --data-binary '{\n \"choices\": {\n \"Weight\": \"250g\"\n },\n \"includeMerchantSpecificData\": true\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"variants\": [\n {\n \"id\": \"00000000-0000-0020-0005-a316e6ba5b37\",\n \"choices\": {\n \"Weight\": \"250g\",\n \"Ground for\": \"Stovetop\"\n },\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 30,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$30.00\",\n \"pricePerUnit\": \"$0.12\"\n },\n \"pricePerUnit\": 0.12\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 30,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$30.00\",\n \"pricePerUnit\": \"$0.12\"\n },\n \"pricePerUnit\": 0.12\n },\n \"costAndProfitData\": {\n \"itemCost\": 20,\n \"formattedItemCost\": \"$20.00\",\n \"profit\": 10,\n \"formattedProfit\": \"$10.00\",\n \"profitMargin\": 0.3333\n },\n \"weight\": 0.25,\n \"sku\": \"10001\",\n \"visible\": true\n }\n },\n {\n \"id\": \"00000000-0000-0021-0005-a316e6ba5b37\",\n \"choices\": {\n \"Weight\": \"250g\",\n \"Ground for\": \"Filter\"\n },\n \"variant\": {\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 30,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$30.00\",\n \"pricePerUnit\": \"$0.12\"\n },\n \"pricePerUnit\": 0.12\n },\n \"convertedPriceData\": {\n \"currency\": \"USD\",\n \"price\": 35,\n \"discountedPrice\": 30,\n \"formatted\": {\n \"price\": \"$35.00\",\n \"discountedPrice\": \"$30.00\",\n \"pricePerUnit\": \"$0.12\"\n },\n \"pricePerUnit\": 0.12\n },\n \"costAndProfitData\": {\n \"itemCost\": 20,\n \"formattedItemCost\": \"$20.00\",\n \"profit\": 10,\n \"formattedProfit\": \"$10.00\",\n \"profitMargin\": 0.3333\n },\n \"weight\": 0.25,\n \"sku\": \"10003\",\n \"visible\": true\n }\n }\n ],\n \"metadata\": {\n \"items\": 2,\n \"offset\": 0\n },\n \"totalResults\": 2\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Query Product Variants","slugifiedName":"query-product-variants"}},{"summary":"Query Store Variants","description":"Retrieves up to 100 store variants, given the provided paging, filtering, and sorting.","operationId":"wix.catalog.api.v1.CatalogReadApi.QueryStoreVariants","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.QueryStoreVariantsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores-reader/v1/variants","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores-reader/v1/variants","destinationPath":"/v1/variants","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryStoreVariantsRequest","description":"","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/com.wix.ecommerce.commons.api.PlatformQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogReadApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.READ_PRODUCTS"],"externalPermissionScopes":[{"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":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.stores.catalog.proxy.catalog-read-proxy","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.QueryStoreVariantsRequest","responseMessage":"wix.catalog.api.v1.QueryStoreVariantsResponse"},"legacyExamples":[{"name":"QueryStoreVariants","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/variants/query' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"variants\": [\n {\n \"id\": \"5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a-00000000-0000-0020-0005-ad9cdc10d3b8\",\n \"variantId\": \"00000000-0000-0020-0005-ad9cdc10d3b8\",\n \"productId\": \"5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a\",\n \"variantName\": \"250g | Stovetop\",\n \"productName\": \"Indonesian Blend\",\n \"managedVariant\": true,\n \"sku\": \"\",\n \"stock\": {\n \"trackQuantity\": false,\n \"inStock\": true\n },\n \"choices\": {\n \"Weight\": \"250g\",\n \"Ground for\": \"Stovetop\"\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"media\": {\n \"image\": {\n \"id\": \"nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg\",\n \"height\": 3951,\n \"width\": 2977\n }\n },\n \"customFields\": {}\n },\n {\n \"id\": \"5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a-00000000-0000-0021-0005-ad9cdc10d3b8\",\n \"variantId\": \"00000000-0000-0021-0005-ad9cdc10d3b8\",\n \"productId\": \"5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a\",\n \"variantName\": \"250g | Filter\",\n \"productName\": \"Indonesian Blend\",\n \"managedVariant\": true,\n \"sku\": \"\",\n \"stock\": {\n \"trackQuantity\": false,\n \"inStock\": true\n },\n \"choices\": {\n \"Weight\": \"250g\",\n \"Ground for\": \"Filter\"\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"media\": {\n \"image\": {\n \"id\": \"nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg\",\n \"height\": 3951,\n \"width\": 2977\n }\n },\n \"customFields\": {}\n },\n {\n \"id\": \"5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a-00000000-0000-003f-0005-ad9cdc10d3b8\",\n \"variantId\": \"00000000-0000-003f-0005-ad9cdc10d3b8\",\n \"productId\": \"5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a\",\n \"variantName\": \"500g | Stovetop\",\n \"productName\": \"Indonesian Blend\",\n \"managedVariant\": true,\n \"sku\": \"\",\n \"stock\": {\n \"trackQuantity\": false,\n \"inStock\": true\n },\n \"choices\": {\n \"Weight\": \"500g\",\n \"Ground for\": \"Stovetop\"\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"media\": {\n \"image\": {\n \"id\": \"nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg\",\n \"height\": 3951,\n \"width\": 2977\n }\n },\n \"customFields\": {}\n },\n {\n \"id\": \"5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a-00000000-0000-0040-0005-ad9cdc10d3b8\",\n \"variantId\": \"00000000-0000-0040-0005-ad9cdc10d3b8\",\n \"productId\": \"5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a\",\n \"variantName\": \"500g | Filter\",\n \"productName\": \"Indonesian Blend\",\n \"managedVariant\": true,\n \"sku\": \"\",\n \"stock\": {\n \"trackQuantity\": false,\n \"inStock\": true\n },\n \"choices\": {\n \"Weight\": \"500g\",\n \"Ground for\": \"Filter\"\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"media\": {\n \"image\": {\n \"id\": \"nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg\",\n \"height\": 3951,\n \"width\": 2977\n }\n },\n \"customFields\": {}\n },\n {\n \"id\": \"0614129c-8777-9f3b-4dfe-b80a54df10d5-00000000-0000-0020-0005-a316f7c67df7\",\n \"variantId\": \"00000000-0000-0020-0005-a316f7c67df7\",\n \"productId\": \"0614129c-8777-9f3b-4dfe-b80a54df10d5\",\n \"variantName\": \"250g | Stovetop\",\n \"productName\": \"Brazilian Arabica\",\n \"managedVariant\": true,\n \"sku\": \"\",\n \"stock\": {\n \"trackQuantity\": false,\n \"quantity\": 0,\n \"inStock\": true\n },\n \"choices\": {\n \"Weight\": \"250g\",\n \"Ground for\": \"Stovetop\"\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"media\": {\n \"image\": {\n \"id\": \"nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_4517,h_2992,q_90/file.jpg\",\n \"height\": 2992,\n \"width\": 4517\n }\n },\n \"customFields\": {}\n },\n {\n \"id\": \"0614129c-8777-9f3b-4dfe-b80a54df10d5-00000000-0000-0021-0005-a316f7c67df7\",\n \"variantId\": \"00000000-0000-0021-0005-a316f7c67df7\",\n \"productId\": \"0614129c-8777-9f3b-4dfe-b80a54df10d5\",\n \"variantName\": \"250g | Filter\",\n \"productName\": \"Brazilian Arabica\",\n \"managedVariant\": true,\n \"sku\": \"\",\n \"stock\": {\n \"trackQuantity\": false,\n \"quantity\": 0,\n \"inStock\": true\n },\n \"choices\": {\n \"Weight\": \"250g\",\n \"Ground for\": \"Filter\"\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"media\": {\n \"image\": {\n \"id\": \"nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_4517,h_2992,q_90/file.jpg\",\n \"height\": 2992,\n \"width\": 4517\n }\n },\n \"customFields\": {}\n },\n {\n \"id\": \"0614129c-8777-9f3b-4dfe-b80a54df10d5-00000000-0000-003f-0005-a316f7c67df7\",\n \"variantId\": \"00000000-0000-003f-0005-a316f7c67df7\",\n \"productId\": \"0614129c-8777-9f3b-4dfe-b80a54df10d5\",\n \"variantName\": \"500g | Stovetop\",\n \"productName\": \"Brazilian Arabica\",\n \"managedVariant\": true,\n \"sku\": \"\",\n \"stock\": {\n \"trackQuantity\": false,\n \"quantity\": 0,\n \"inStock\": true\n },\n \"choices\": {\n \"Weight\": \"500g\",\n \"Ground for\": \"Stovetop\"\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"media\": {\n \"image\": {\n \"id\": \"nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_4517,h_2992,q_90/file.jpg\",\n \"height\": 2992,\n \"width\": 4517\n }\n },\n \"customFields\": {}\n },\n {\n \"id\": \"0614129c-8777-9f3b-4dfe-b80a54df10d5-00000000-0000-0040-0005-a316f7c67df7\",\n \"variantId\": \"00000000-0000-0040-0005-a316f7c67df7\",\n \"productId\": \"0614129c-8777-9f3b-4dfe-b80a54df10d5\",\n \"variantName\": \"500g | Filter\",\n \"productName\": \"Brazilian Arabica\",\n \"managedVariant\": true,\n \"sku\": \"\",\n \"stock\": {\n \"trackQuantity\": false,\n \"quantity\": 0,\n \"inStock\": true\n },\n \"choices\": {\n \"Weight\": \"500g\",\n \"Ground for\": \"Filter\"\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"media\": {\n \"image\": {\n \"id\": \"nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_4517,h_2992,q_90/file.jpg\",\n \"height\": 2992,\n \"width\": 4517\n }\n },\n \"customFields\": {}\n },\n {\n \"id\": \"91f7ac8b-2baa-289c-aa50-6d64764f35d3-00000000-0000-0020-0005-a316e6ba5b37\",\n \"variantId\": \"00000000-0000-0020-0005-a316e6ba5b37\",\n \"productId\": \"91f7ac8b-2baa-289c-aa50-6d64764f35d3\",\n \"variantName\": \"250g | Stovetop\",\n \"productName\": \"Colombian Arabica\",\n \"managedVariant\": true,\n \"sku\": \"10001\",\n \"stock\": {\n \"trackQuantity\": false,\n \"quantity\": 0,\n \"inStock\": true\n },\n \"choices\": {\n \"Weight\": \"250g\",\n \"Ground for\": \"Stovetop\"\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"media\": {\n \"image\": {\n \"id\": \"nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_6000,h_3376,q_90/file.jpg\",\n \"height\": 3376,\n \"width\": 6000\n }\n },\n \"customFields\": {}\n },\n {\n \"id\": \"91f7ac8b-2baa-289c-aa50-6d64764f35d3-00000000-0000-0021-0005-a316e6ba5b37\",\n \"variantId\": \"00000000-0000-0021-0005-a316e6ba5b37\",\n \"productId\": \"91f7ac8b-2baa-289c-aa50-6d64764f35d3\",\n \"variantName\": \"250g | Filter\",\n \"productName\": \"Colombian Arabica\",\n \"managedVariant\": true,\n \"sku\": \"10003\",\n \"stock\": {\n \"trackQuantity\": false,\n \"quantity\": 0,\n \"inStock\": true\n },\n \"choices\": {\n \"Weight\": \"250g\",\n \"Ground for\": \"Filter\"\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"media\": {\n \"image\": {\n \"id\": \"nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_6000,h_3376,q_90/file.jpg\",\n \"height\": 3376,\n \"width\": 6000\n }\n },\n \"customFields\": {}\n },\n {\n \"id\": \"91f7ac8b-2baa-289c-aa50-6d64764f35d3-00000000-0000-003f-0005-a316e6ba5b37\",\n \"variantId\": \"00000000-0000-003f-0005-a316e6ba5b37\",\n \"productId\": \"91f7ac8b-2baa-289c-aa50-6d64764f35d3\",\n \"variantName\": \"500g | Stovetop\",\n \"productName\": \"Colombian Arabica\",\n \"managedVariant\": true,\n \"sku\": \"10002\",\n \"stock\": {\n \"trackQuantity\": false,\n \"quantity\": 0,\n \"inStock\": true\n },\n \"choices\": {\n \"Weight\": \"500g\",\n \"Ground for\": \"Stovetop\"\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"media\": {\n \"image\": {\n \"id\": \"nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_6000,h_3376,q_90/file.jpg\",\n \"height\": 3376,\n \"width\": 6000\n }\n },\n \"customFields\": {}\n },\n {\n \"id\": \"91f7ac8b-2baa-289c-aa50-6d64764f35d3-00000000-0000-0040-0005-a316e6ba5b37\",\n \"variantId\": \"00000000-0000-0040-0005-a316e6ba5b37\",\n \"productId\": \"91f7ac8b-2baa-289c-aa50-6d64764f35d3\",\n \"variantName\": \"500g | Filter\",\n \"productName\": \"Colombian Arabica\",\n \"managedVariant\": true,\n \"sku\": \"10004\",\n \"stock\": {\n \"trackQuantity\": false,\n \"quantity\": 0,\n \"inStock\": true\n },\n \"choices\": {\n \"Weight\": \"500g\",\n \"Ground for\": \"Filter\"\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"media\": {\n \"image\": {\n \"id\": \"nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_6000,h_3376,q_90/file.jpg\",\n \"height\": 3376,\n \"width\": 6000\n }\n },\n \"customFields\": {}\n }\n ],\n \"metadata\": {\n \"count\": 12,\n \"offset\": 0,\n \"total\": 12,\n \"cursors\": {}\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/variants/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogReadApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.READ_PRODUCTS"],"externalPermissionScopes":[{"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":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.stores.catalog.proxy.catalog-read-proxy","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.QueryStoreVariantsRequest","responseMessage":"wix.catalog.api.v1.QueryStoreVariantsResponse"},"legacyExamples":[{"name":"QueryStoreVariants","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/stores/v1/variants/query' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"variants\": [\n {\n \"id\": \"5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a-00000000-0000-0020-0005-ad9cdc10d3b8\",\n \"variantId\": \"00000000-0000-0020-0005-ad9cdc10d3b8\",\n \"productId\": \"5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a\",\n \"variantName\": \"250g | Stovetop\",\n \"productName\": \"Indonesian Blend\",\n \"managedVariant\": true,\n \"sku\": \"\",\n \"stock\": {\n \"trackQuantity\": false,\n \"inStock\": true\n },\n \"choices\": {\n \"Weight\": \"250g\",\n \"Ground for\": \"Stovetop\"\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"media\": {\n \"image\": {\n \"id\": \"nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg\",\n \"height\": 3951,\n \"width\": 2977\n }\n },\n \"customFields\": {}\n },\n {\n \"id\": \"5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a-00000000-0000-0021-0005-ad9cdc10d3b8\",\n \"variantId\": \"00000000-0000-0021-0005-ad9cdc10d3b8\",\n \"productId\": \"5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a\",\n \"variantName\": \"250g | Filter\",\n \"productName\": \"Indonesian Blend\",\n \"managedVariant\": true,\n \"sku\": \"\",\n \"stock\": {\n \"trackQuantity\": false,\n \"inStock\": true\n },\n \"choices\": {\n \"Weight\": \"250g\",\n \"Ground for\": \"Filter\"\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"media\": {\n \"image\": {\n \"id\": \"nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg\",\n \"height\": 3951,\n \"width\": 2977\n }\n },\n \"customFields\": {}\n },\n {\n \"id\": \"5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a-00000000-0000-003f-0005-ad9cdc10d3b8\",\n \"variantId\": \"00000000-0000-003f-0005-ad9cdc10d3b8\",\n \"productId\": \"5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a\",\n \"variantName\": \"500g | Stovetop\",\n \"productName\": \"Indonesian Blend\",\n \"managedVariant\": true,\n \"sku\": \"\",\n \"stock\": {\n \"trackQuantity\": false,\n \"inStock\": true\n },\n \"choices\": {\n \"Weight\": \"500g\",\n \"Ground for\": \"Stovetop\"\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"media\": {\n \"image\": {\n \"id\": \"nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg\",\n \"height\": 3951,\n \"width\": 2977\n }\n },\n \"customFields\": {}\n },\n {\n \"id\": \"5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a-00000000-0000-0040-0005-ad9cdc10d3b8\",\n \"variantId\": \"00000000-0000-0040-0005-ad9cdc10d3b8\",\n \"productId\": \"5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a\",\n \"variantName\": \"500g | Filter\",\n \"productName\": \"Indonesian Blend\",\n \"managedVariant\": true,\n \"sku\": \"\",\n \"stock\": {\n \"trackQuantity\": false,\n \"inStock\": true\n },\n \"choices\": {\n \"Weight\": \"500g\",\n \"Ground for\": \"Filter\"\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"media\": {\n \"image\": {\n \"id\": \"nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg\",\n \"height\": 3951,\n \"width\": 2977\n }\n },\n \"customFields\": {}\n },\n {\n \"id\": \"0614129c-8777-9f3b-4dfe-b80a54df10d5-00000000-0000-0020-0005-a316f7c67df7\",\n \"variantId\": \"00000000-0000-0020-0005-a316f7c67df7\",\n \"productId\": \"0614129c-8777-9f3b-4dfe-b80a54df10d5\",\n \"variantName\": \"250g | Stovetop\",\n \"productName\": \"Brazilian Arabica\",\n \"managedVariant\": true,\n \"sku\": \"\",\n \"stock\": {\n \"trackQuantity\": false,\n \"quantity\": 0,\n \"inStock\": true\n },\n \"choices\": {\n \"Weight\": \"250g\",\n \"Ground for\": \"Stovetop\"\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"media\": {\n \"image\": {\n \"id\": \"nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_4517,h_2992,q_90/file.jpg\",\n \"height\": 2992,\n \"width\": 4517\n }\n },\n \"customFields\": {}\n },\n {\n \"id\": \"0614129c-8777-9f3b-4dfe-b80a54df10d5-00000000-0000-0021-0005-a316f7c67df7\",\n \"variantId\": \"00000000-0000-0021-0005-a316f7c67df7\",\n \"productId\": \"0614129c-8777-9f3b-4dfe-b80a54df10d5\",\n \"variantName\": \"250g | Filter\",\n \"productName\": \"Brazilian Arabica\",\n \"managedVariant\": true,\n \"sku\": \"\",\n \"stock\": {\n \"trackQuantity\": false,\n \"quantity\": 0,\n \"inStock\": true\n },\n \"choices\": {\n \"Weight\": \"250g\",\n \"Ground for\": \"Filter\"\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"media\": {\n \"image\": {\n \"id\": \"nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_4517,h_2992,q_90/file.jpg\",\n \"height\": 2992,\n \"width\": 4517\n }\n },\n \"customFields\": {}\n },\n {\n \"id\": \"0614129c-8777-9f3b-4dfe-b80a54df10d5-00000000-0000-003f-0005-a316f7c67df7\",\n \"variantId\": \"00000000-0000-003f-0005-a316f7c67df7\",\n \"productId\": \"0614129c-8777-9f3b-4dfe-b80a54df10d5\",\n \"variantName\": \"500g | Stovetop\",\n \"productName\": \"Brazilian Arabica\",\n \"managedVariant\": true,\n \"sku\": \"\",\n \"stock\": {\n \"trackQuantity\": false,\n \"quantity\": 0,\n \"inStock\": true\n },\n \"choices\": {\n \"Weight\": \"500g\",\n \"Ground for\": \"Stovetop\"\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"media\": {\n \"image\": {\n \"id\": \"nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_4517,h_2992,q_90/file.jpg\",\n \"height\": 2992,\n \"width\": 4517\n }\n },\n \"customFields\": {}\n },\n {\n \"id\": \"0614129c-8777-9f3b-4dfe-b80a54df10d5-00000000-0000-0040-0005-a316f7c67df7\",\n \"variantId\": \"00000000-0000-0040-0005-a316f7c67df7\",\n \"productId\": \"0614129c-8777-9f3b-4dfe-b80a54df10d5\",\n \"variantName\": \"500g | Filter\",\n \"productName\": \"Brazilian Arabica\",\n \"managedVariant\": true,\n \"sku\": \"\",\n \"stock\": {\n \"trackQuantity\": false,\n \"quantity\": 0,\n \"inStock\": true\n },\n \"choices\": {\n \"Weight\": \"500g\",\n \"Ground for\": \"Filter\"\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"media\": {\n \"image\": {\n \"id\": \"nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_4517,h_2992,q_90/file.jpg\",\n \"height\": 2992,\n \"width\": 4517\n }\n },\n \"customFields\": {}\n },\n {\n \"id\": \"91f7ac8b-2baa-289c-aa50-6d64764f35d3-00000000-0000-0020-0005-a316e6ba5b37\",\n \"variantId\": \"00000000-0000-0020-0005-a316e6ba5b37\",\n \"productId\": \"91f7ac8b-2baa-289c-aa50-6d64764f35d3\",\n \"variantName\": \"250g | Stovetop\",\n \"productName\": \"Colombian Arabica\",\n \"managedVariant\": true,\n \"sku\": \"10001\",\n \"stock\": {\n \"trackQuantity\": false,\n \"quantity\": 0,\n \"inStock\": true\n },\n \"choices\": {\n \"Weight\": \"250g\",\n \"Ground for\": \"Stovetop\"\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"media\": {\n \"image\": {\n \"id\": \"nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_6000,h_3376,q_90/file.jpg\",\n \"height\": 3376,\n \"width\": 6000\n }\n },\n \"customFields\": {}\n },\n {\n \"id\": \"91f7ac8b-2baa-289c-aa50-6d64764f35d3-00000000-0000-0021-0005-a316e6ba5b37\",\n \"variantId\": \"00000000-0000-0021-0005-a316e6ba5b37\",\n \"productId\": \"91f7ac8b-2baa-289c-aa50-6d64764f35d3\",\n \"variantName\": \"250g | Filter\",\n \"productName\": \"Colombian Arabica\",\n \"managedVariant\": true,\n \"sku\": \"10003\",\n \"stock\": {\n \"trackQuantity\": false,\n \"quantity\": 0,\n \"inStock\": true\n },\n \"choices\": {\n \"Weight\": \"250g\",\n \"Ground for\": \"Filter\"\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"media\": {\n \"image\": {\n \"id\": \"nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_6000,h_3376,q_90/file.jpg\",\n \"height\": 3376,\n \"width\": 6000\n }\n },\n \"customFields\": {}\n },\n {\n \"id\": \"91f7ac8b-2baa-289c-aa50-6d64764f35d3-00000000-0000-003f-0005-a316e6ba5b37\",\n \"variantId\": \"00000000-0000-003f-0005-a316e6ba5b37\",\n \"productId\": \"91f7ac8b-2baa-289c-aa50-6d64764f35d3\",\n \"variantName\": \"500g | Stovetop\",\n \"productName\": \"Colombian Arabica\",\n \"managedVariant\": true,\n \"sku\": \"10002\",\n \"stock\": {\n \"trackQuantity\": false,\n \"quantity\": 0,\n \"inStock\": true\n },\n \"choices\": {\n \"Weight\": \"500g\",\n \"Ground for\": \"Stovetop\"\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"media\": {\n \"image\": {\n \"id\": \"nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_6000,h_3376,q_90/file.jpg\",\n \"height\": 3376,\n \"width\": 6000\n }\n },\n \"customFields\": {}\n },\n {\n \"id\": \"91f7ac8b-2baa-289c-aa50-6d64764f35d3-00000000-0000-0040-0005-a316e6ba5b37\",\n \"variantId\": \"00000000-0000-0040-0005-a316e6ba5b37\",\n \"productId\": \"91f7ac8b-2baa-289c-aa50-6d64764f35d3\",\n \"variantName\": \"500g | Filter\",\n \"productName\": \"Colombian Arabica\",\n \"managedVariant\": true,\n \"sku\": \"10004\",\n \"stock\": {\n \"trackQuantity\": false,\n \"quantity\": 0,\n \"inStock\": true\n },\n \"choices\": {\n \"Weight\": \"500g\",\n \"Ground for\": \"Filter\"\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"media\": {\n \"image\": {\n \"id\": \"nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/v1/fit/w_6000,h_3376,q_90/file.jpg\",\n \"height\": 3376,\n \"width\": 6000\n }\n },\n \"customFields\": {}\n }\n ],\n \"metadata\": {\n \"count\": 12,\n \"offset\": 0,\n \"total\": 12,\n \"cursors\": {}\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Query Store Variants","slugifiedName":"query-store-variants"}},{"summary":"Get Store Variant","description":"Retrieves a store variant with the provided ID.","operationId":"wix.catalog.api.v1.CatalogReadApi.GetStoreVariant","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Store variant ID. Comprised of the `productId` and the `variantId`, separated by a hyphen. For example, `{productId}-{variantId}`.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.catalog.api.v1.GetStoreVariantResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores-reader/v1/variants","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores-reader/v1/variants","destinationPath":"/v1/variants","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogReadApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.READ_PRODUCTS"],"externalPermissionScopes":[{"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":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.stores.catalog.proxy.catalog-read-proxy","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.GetStoreVariantRequest","responseMessage":"wix.catalog.api.v1.GetStoreVariantResponse"},"legacyExamples":[{"name":"GetStoreVariant","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET \\\n 'https: //www.wixapis.com/stores/v1/variants/0614129c-8777-9f3b-4dfe-b80a54df10d5-00000000-0000-0020-0005-a316f7c67df7' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"variant\": {\n \"id\": \"0614129c-8777-9f3b-4dfe-b80a54df10d5-00000000-0000-0020-0005-a316f7c67df7\",\n \"variantId\": \"00000000-0000-0020-0005-a316f7c67df7\",\n \"productId\": \"0614129c-8777-9f3b-4dfe-b80a54df10d5\",\n \"variantName\": \"250g | Stovetop\",\n \"productName\": \"Brazilian Arabica\",\n \"managedVariant\": true,\n \"sku\": \"\",\n \"stock\": {\n \"trackQuantity\": false,\n \"quantity\": 0,\n \"inStock\": true\n },\n \"choices\": {\n \"Weight\": \"250g\",\n \"Ground for\": \"Stovetop\"\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"media\": {\n \"image\": {\n \"id\": \"nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_4517,h_2992,q_90/file.jpg\",\n \"height\": 2992,\n \"width\": 4517\n }\n },\n \"customFields\": {}\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"get","path":"/v1/variants/{id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.catalog.api.v1.CatalogReadApi","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.READ_PRODUCTS"],"externalPermissionScopes":[{"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":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-catalog-api","serviceArtifactId":"com.wixpress.stores.catalog.proxy.catalog-read-proxy","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.catalog.api.v1.GetStoreVariantRequest","responseMessage":"wix.catalog.api.v1.GetStoreVariantResponse"},"legacyExamples":[{"name":"GetStoreVariant","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET \\\n 'https: //www.wixapis.com/stores/v1/variants/0614129c-8777-9f3b-4dfe-b80a54df10d5-00000000-0000-0020-0005-a316f7c67df7' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"variant\": {\n \"id\": \"0614129c-8777-9f3b-4dfe-b80a54df10d5-00000000-0000-0020-0005-a316f7c67df7\",\n \"variantId\": \"00000000-0000-0020-0005-a316f7c67df7\",\n \"productId\": \"0614129c-8777-9f3b-4dfe-b80a54df10d5\",\n \"variantName\": \"250g | Stovetop\",\n \"productName\": \"Brazilian Arabica\",\n \"managedVariant\": true,\n \"sku\": \"\",\n \"stock\": {\n \"trackQuantity\": false,\n \"quantity\": 0,\n \"inStock\": true\n },\n \"choices\": {\n \"Weight\": \"250g\",\n \"Ground for\": \"Stovetop\"\n },\n \"collectionIds\": [\n \"32fd0b3a-2d38-2235-7754-78a3f819274a\"\n ],\n \"media\": {\n \"image\": {\n \"id\": \"nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_4517,h_2992,q_90/file.jpg\",\n \"height\": 2992,\n \"width\": 4517\n }\n },\n \"customFields\": {}\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Get Store Variant","slugifiedName":"get-store-variant"}}],"webhooks":[{"summary":"Product Product Created","title":"Product Product Created","description":"Triggered when a product is created.","permissions":["WIX_STORES.READ_PRODUCTS"],"payload":{"schemaName":"wix.catalog.api.v1.event.ProductCreated"},"exposure":"PUBLIC","maturity":"GA","slug":"product_created","eventTopic":"wixStores-catalog-product-created","serviceName":"wix.catalog.api.v1.CatalogReadApi","domainEvent":"NOT_DOMAIN_EVENT","externalPermissionScopes":[{"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":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"com.wix.ecommerce.catalog.api.v1.ProductCreated","legacyExamples":[{"name":"Product Created","type":"LEGACY_EVENT","content":"{\n \"productId\": \"6693f74a-2a79-0bb7-00ef-2b8581bc8757\",\n \"name\": \"my product\",\n \"priceData\": {\n \"currency\": \"USD\",\n \"price\": 32,\n \"discountedPrice\": 30.4,\n \"formatted\": {\n \"price\": \"32.00 ₪\",\n \"discountedPrice\": \"30.40 ₪\"\n }\n },\n \"visible\": true,\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/689fa9dd0c7f47d4b45a0b78afccdc8a.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/689fa9dd0c7f47d4b45a0b78afccdc8a.jpg/v1/fit/w_5760,h_3840,q_90/file.jpg\",\n \"width\": 5760,\n \"height\": 3840\n },\n \"id\": \"689fa9dd0c7f47d4b45a0b78afccdc8a.jpg\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/689fa9dd0c7f47d4b45a0b78afccdc8a.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/689fa9dd0c7f47d4b45a0b78afccdc8a.jpg/v1/fit/w_5760,h_3840,q_90/file.jpg\",\n \"width\": 5760,\n \"height\": 3840\n },\n \"id\": \"689fa9dd0c7f47d4b45a0b78afccdc8a.jpg\"\n }\n ]\n },\n \"sku\": \"38473\",\n \"productPageUrl\": {\n \"base\": \"https://my-website.com\",\n \"path\": \"/product-page/my-product\"\n }\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/wix.catalog.api.v1.event.ProductCreated","triggeredEvents":[],"contentLink":{"displayName":"Product Created","slugifiedName":"product-created"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Product Product Changed","title":"Product Product Changed","description":"Triggered when a product is changed.","permissions":["WIX_STORES.READ_PRODUCTS"],"payload":{"schemaName":"wix.catalog.api.v1.event.ProductChanged"},"exposure":"PUBLIC","maturity":"GA","slug":"product_changed","eventTopic":"wixStores-catalog-product-changed","serviceName":"wix.catalog.api.v1.CatalogReadApi","domainEvent":"NOT_DOMAIN_EVENT","externalPermissionScopes":[{"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":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"com.wix.ecommerce.catalog.api.v1.ProductChanged","legacyExamples":[{"name":"Product Changed","type":"LEGACY_EVENT","content":"{\n \"productId\": \"a60fef92-ee29-070f-a7ed-9bbc3cc1c2f4\",\n \"changedFields\": [\n \"priceData\"\n ]\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/wix.catalog.api.v1.event.ProductChanged","triggeredEvents":[],"contentLink":{"displayName":"Product Changed","slugifiedName":"product-changed"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Product Product Deleted","title":"Product Product Deleted","description":"Triggered when a product is deleted.","permissions":["WIX_STORES.READ_PRODUCTS"],"payload":{"schemaName":"wix.catalog.api.v1.event.ProductDeleted"},"exposure":"PUBLIC","maturity":"GA","slug":"product_deleted","eventTopic":"wixStores-catalog-product-deleted","serviceName":"wix.catalog.api.v1.CatalogReadApi","domainEvent":"NOT_DOMAIN_EVENT","externalPermissionScopes":[{"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":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"com.wix.ecommerce.catalog.api.v1.ProductDeleted","legacyExamples":[{"name":"Product Deleted","type":"LEGACY_EVENT","content":"{\n \"productId\": \"135101-thisIs-135101-someId\"\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/wix.catalog.api.v1.event.ProductDeleted","triggeredEvents":[],"contentLink":{"displayName":"Product Deleted","slugifiedName":"product-deleted"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Collection Created","title":"Product Collection Created","description":"Triggered when a collection is created.","permissions":["WIX_STORES.READ_PRODUCTS"],"payload":{"schemaName":"wix.catalog.api.v1.event.CollectionCreated"},"exposure":"PUBLIC","maturity":"GA","slug":"collection_created","eventTopic":"wixStores-catalog-collection-created","serviceName":"wix.catalog.api.v1.CatalogReadApi","domainEvent":"NOT_DOMAIN_EVENT","externalPermissionScopes":[{"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":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"com.wix.ecommerce.catalog.api.v1.CollectionCreated","legacyExamples":[{"name":"Collection Created","type":"LEGACY_EVENT","content":"{\n \"collectionId\": \"1044e7e4-37d1-0705-c5b3-623baae212fd\",\n \"name\": \"My collection\",\n \"slug\": \"my-collection\",\n \"visible\": true,\n \"media\": {\n \"mainMedia\": {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/bc001baa4397444f809fa5f147c28a9e.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/bc001baa4397444f809fa5f147c28a9e.jpg/v1/fit/w_1920,h_1280,q_90/file.jpg\",\n \"width\": 1920,\n \"height\": 1280\n },\n \"id\": \"\"\n },\n \"items\": [\n {\n \"thumbnail\": {\n \"url\": \"https://static.wixstatic.com/media/bc001baa4397444f809fa5f147c28a9e.jpg/v1/fit/w_50,h_50,q_90/file.jpg\",\n \"width\": 50,\n \"height\": 50\n },\n \"mediaType\": \"image\",\n \"title\": \"\",\n \"image\": {\n \"url\": \"https://static.wixstatic.com/media/bc001baa4397444f809fa5f147c28a9e.jpg/v1/fit/w_1920,h_1280,q_90/file.jpg\",\n \"width\": 1920,\n \"height\": 1280\n },\n \"id\": \"\"\n }\n ]\n }\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/wix.catalog.api.v1.event.CollectionCreated","triggeredEvents":[],"contentLink":{"displayName":"Collection Created","slugifiedName":"collection-created"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Collection Changed","title":"Product Collection Changed","description":"Triggered when a collection is changed.","permissions":["WIX_STORES.READ_PRODUCTS"],"payload":{"schemaName":"wix.catalog.api.v1.event.CollectionChanged"},"exposure":"PUBLIC","maturity":"GA","slug":"collection_changed","eventTopic":"wixStores-catalog-collection-changed","serviceName":"wix.catalog.api.v1.CatalogReadApi","domainEvent":"NOT_DOMAIN_EVENT","externalPermissionScopes":[{"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":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"com.wix.ecommerce.catalog.api.v1.CollectionChanged","legacyExamples":[{"name":"Collection Changed","type":"LEGACY_EVENT","content":"{\n \"collectionId\": \"6547efe0-3dc4-bd30-3042-c71427ff2589\",\n \"changedFields\": [\"name\"]\n}\n"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/wix.catalog.api.v1.event.CollectionChanged","triggeredEvents":[],"contentLink":{"displayName":"Collection Changed","slugifiedName":"collection-changed"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Collection Deleted","title":"Product Collection Deleted","description":"Triggered when a collection is deleted.","permissions":["WIX_STORES.READ_PRODUCTS"],"payload":{"schemaName":"wix.catalog.api.v1.event.CollectionDeleted"},"exposure":"PUBLIC","maturity":"GA","slug":"collection_deleted","eventTopic":"wixStores-catalog-collection-deleted","serviceName":"wix.catalog.api.v1.CatalogReadApi","domainEvent":"NOT_DOMAIN_EVENT","externalPermissionScopes":[{"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":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"com.wix.ecommerce.catalog.api.v1.CollectionDeleted","legacyExamples":[{"name":"Collection Deleted","type":"LEGACY_EVENT","content":"{\n \"collectionId\": \"135101-thisIs-135101-someId\"\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/wix.catalog.api.v1.event.CollectionDeleted","triggeredEvents":[],"contentLink":{"displayName":"Collection Deleted","slugifiedName":"collection-deleted"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Variants Changed","title":"Product Variants Changed","description":"Triggered when a product variant is changed.","permissions":["WIX_STORES.READ_PRODUCTS"],"payload":{"schemaName":"wix.catalog.api.v1.event.VariantsChanged"},"exposure":"PUBLIC","maturity":"GA","slug":"variants_changed","eventTopic":"wixStores-catalog-variants-changed","serviceName":"wix.catalog.api.v1.CatalogReadApi","domainEvent":"NOT_DOMAIN_EVENT","externalPermissionScopes":[{"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":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"com.wix.ecommerce.catalog.api.v1.VariantsChanged","legacyExamples":[{"name":"Variants Changed","type":"LEGACY_EVENT","content":"{\n \"productId\": \"7e4f023f-53d2-70da-30bb-31662b3c095f\",\n \"variants\": [\n {\n \"variantId\": \"00000000-0000-0002-0005-918e4641acb0\",\n \"choices\": { \"Size\": \"large\" },\n \"changedFields\": [\"sku\", \"price\"]\n },\n {\n \"variantId\": \"00000000-0000-0001-0005-918e4641acb0\",\n \"choices\": { \"Size\": \"small\" },\n \"changedFields\": [\"sku\", \"price\"]\n },\n {\n \"variantId\": \"00000000-0000-0004-0005-918e4641acb0\",\n \"choices\": { \"Size\": \"mySize\" },\n \"changedFields\": [\"sku\"]\n }\n ]\n}\n"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/wix.catalog.api.v1.event.VariantsChanged","triggeredEvents":[],"contentLink":{"displayName":"Variants Changed","slugifiedName":"variants-changed"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# Catalog Service\n\n## About This API\n\nWix Stores creates a catalog of store owners’ items for purchase and allows store owners to create smaller collections of products by type or theme. A catalog organizes the store’s products and collections and facilitates inventory management. With the Wix Stores Catalog API you can query individual products, collections or the entire catalog, as well as create products and add their media.\n\nQuerying the products and collections in the catalog enables you to coordinate a store’s inventory across other sales platforms (e.g., Facebook marketplace), or inventory management tools (e.g., NetSuite, TradeGecko), among other uses.\n\n## Terminology\n- **The catalog** is a complete list of all the store’s products.\n- **Collections** are themed groupings of items for purchase that a store owner can create to organize their products (e.g., Spring 2019, Running shoes, etc.). Products can belong to multiple collections.\n- **Options** are property types that customers can select within the specific product - e.g., color and size.\n- **Choices** are the available selections within each option - e.g., red and green choices under the Color option.\n- **Variants** are combinations of different product options and choices - e.g., a red shirt in size large.\nA variant can override the following values from the parent product:\n - Price\n - SKU\n - Weight\n - Inventory\n\n## Error handling\n| Status code | Description |\n| --- | --- |\n| 200 |Success|\n| 400 |Invalid input (e.g., when the filter format is not valid or when providing invalid options when calling productOptionsAvailability)|\n| 401 |Invalid authorization token, or Wix stores is not installed|\n| 404 |Requested product or collection is not found|\n| 500 |Unexpected error|\n","sourceRepo":"git@github.com:wix-private/ecom.git","path":"docs/intro.md"},{"displayName":"Filter and Sort","slugifyName":"filter-and-sort","content":"# Filter and sort\n\n## Query Language\n\nEndpoints that allow querying follow these format [guidelines](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language).\n\n## Query Products\n\n### Fields That Allow Filtering\n\n| Field | Operators | Sorting Allowed|\n|-------------------------| --- | --- |\n| name |$eq,$ne,$hasSome,$contains,$startsWith|Allowed|\n| description |$eq,$ne,$hasSome,$contains,$startsWith||\n| sku |$eq,$ne,$hasSome,$contains,$startsWith|Allowed|\n| id |$eq,$ne,$hasSome|Allowed|\n| price |$eq,$ne,$hasSome,$lt,$lte,$gt,$gte|Allowed|\n| numericId |$eq,$ne,$hasSome,$lt,$lte,$gt,$gte|Allowed|\n| productType |$eq,$ne,$hasSome|Allowed|\n| slug |$eq,$ne,$hasSome,$contains,$startsWith|Allowed|\n| collections.id |$eq,$ne,$hasSome,$hasAll||\n| options.\\

Product Changed

Permission Scopes