{"id":"88d2b9bd-5392-4d52-aba1-3b09bf4a0a5c","createdDate":"2024-08-15T14:18:44.027Z","updatedDate":"2024-08-15T14:18:44.027Z","resourceId":"aacb54e3-3d6a-4ff5-963a-e2d4d822ec50","api":{"schema":{"object":{"displayName":"Customization Object","description":"Customizations include options and modifiers which can later be applied to products.\nOptions are designed to add variations to a product, where modifiers add a customizable change to the product but without creating another variant.","slug":"customization-object","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Customization","legacyExamples":[{"title":"Customization","content":"{\n \"customization\": {\n \"id\": \"dc6f0f6d-046c-4bc2-be51-e7116d59600c\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:35:15.526Z\",\n \"updatedDate\": \"2024-06-26T09:35:15.526Z\",\n \"key\": \"Size\",\n \"name\": \"Size\",\n \"customizationType\": \"PRODUCT_OPTION\",\n \"customizationRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"ac176428-2e1d-4d76-8f15-d8bbfd6a2421\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Small\",\n \"name\": \"Small\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"c8ede484-8a79-4080-9ff6-28aa32ed2e92\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Medium\",\n \"name\": \"Medium\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"26c631c9-7339-4f55-a093-29abf78ec9c2\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Large\",\n \"name\": \"Large\",\n \"assignedProductsCount\": 0\n }]\n }\n }\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"methods":[{"summary":"Create Customization","description":"Creates a customization.","operationId":"wix.stores.catalog.customization.v3.CustomizationService.CreateCustomization","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.CreateCustomizationResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/customizations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/customizations","destinationPath":"/v3/customizations","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateCustomizationRequest","description":"","properties":{"customization":{"description":"Customization to create.","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Customization","summary":"customization","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["customization","customization.name","customization.customizationType","customization.choicesSettings.choices","customization.freeTextInput.title","customization.customizationRenderType","customization.customizationSettings"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Customization Created","description":"Triggered when a customization is created.","permissions":["WIX_STORES.CUSTOMIZATION_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.stores.catalog.v3.customization","serviceName":"wix.stores.catalog.customization.v3.CustomizationService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.customization_created","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.customization.v3.CustomizationService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"OPTIONS_LIMIT_EXCEEDED"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"MODIFIERS_LIMIT_EXCEEDED"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INVALID_CUSTOMIZATION_RENDER_TYPE"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_FREE_TEXT_SETTINGS"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.CUSTOMIZATION_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores.catalog:customization","serviceArtifactId":"com.wixpress.stores.catalog.customization","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.customization.v3.CreateCustomizationRequest","responseMessage":"wix.stores.catalog.customization.v3.CreateCustomizationResponse"},"legacyExamples":[{"name":"CreateCustomization","type":"METHOD","order":4,"content":{"title":"Create Customization of type Modifier","description":"Creates a customization with a text choices modifier","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/customizations' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"customization\": {\n \"customizationRenderType\": \"TEXT_CHOICES\",\n \"customizationType\": \"MODIFIER\",\n \"name\": \"Material\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceType\": \"CHOICE_TEXT\",\n \"name\": \"Cotton\"\n },\n {\n \"choiceType\": \"CHOICE_TEXT\",\n \"name\": \"Polyester\"\n },\n {\n \"choiceType\": \"CHOICE_TEXT\",\n \"name\": \"Wool\"\n }\n ]\n }\n }\n }'","response":"{\n \"customization\": {\n \"id\": \"ba08f3a1-66c8-4f90-8f84-02b3ce0a35fd\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T12:23:02.352Z\",\n \"updatedDate\": \"2024-06-26T12:23:02.352Z\",\n \"key\": \"Material\",\n \"name\": \"Material\",\n \"customizationType\": \"MODIFIER\",\n \"customizationRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"7c92d94c-7268-46eb-9da8-36809e02d873\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Cotton\",\n \"name\": \"Cotton\",\n \"assignedProductsCount\": 0\n },\n {\n \"id\": \"19e63e76-e7eb-486a-8519-77c17ba33896\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Polyester\",\n \"name\": \"Polyester\",\n \"assignedProductsCount\": 0\n },\n {\n \"id\": \"1a2e8974-4ab9-459d-85d8-fa36cf1eb240\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Wool\",\n \"name\": \"Wool\",\n \"assignedProductsCount\": 0\n }]\n }\n }\n }"}},{"name":"CreateCustomization","type":"METHOD","order":3,"content":{"title":"Create Customization of type Modifier","description":"Creates a customization with a free text modifier","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/customizations' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"customization\": {\n \"customizationRenderType\": \"FREE_TEXT\",\n \"customizationType\": \"MODIFIER\",\n \"name\": \"Name for Personalization\",\n \"freeTextInput\": {\n \"title\": \"Add your name for personalization\"\n }\n }\n }'","response":"{\n \"customization\": {\n \"id\": \"e514685b-10ff-4706-ac9e-6fd4b912ccbf\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:57:22.530Z\",\n \"updatedDate\": \"2024-06-26T09:57:22.530Z\",\n \"key\": \"Name for Personalization\",\n \"name\": \"Name for Personalization\",\n \"customizationType\": \"MODIFIER\",\n \"customizationRenderType\": \"FREE_TEXT\",\n \"freeTextInput\": {\n \"minCharCount\": 0,\n \"maxCharCount\": 0,\n \"title\": \"Add your name for personalization\",\n \"key\": \"Add your name for personalization\"\n }\n }\n}"}},{"name":"CreateCustomization","type":"METHOD","order":2,"content":{"title":"Create Customization of type Option","description":"Creates a customization with a swatch choices option","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/customizations' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"customization\": {\n \"customizationType\": \"PRODUCT_OPTION\",\n \"customizationRenderType\": \"SWATCH_CHOICES\",\n \"name\": \"Color\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceType\": \"ONE_COLOR\",\n \"name\": \"Blue\",\n \"colorCode\": \"#0000FF\"\n },\n {\n \"choiceType\": \"ONE_COLOR\",\n \"name\": \"Yellow\",\n \"colorCode\": \"#FFFF00\"\n },\n {\n \"choiceType\": \"ONE_COLOR\",\n \"name\": \"Green\",\n \"colorCode\": \"#008000\"\n }\n ]\n }\n \t}\n }'","response":"{\n \"customization\": {\n \"id\": \"06b6abfd-002d-437d-ad08-91f8537cd96d\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:44:11.306Z\",\n \"updatedDate\": \"2024-06-26T09:44:11.306Z\",\n \"key\": \"Color\",\n \"name\": \"Color\",\n \"customizationType\": \"PRODUCT_OPTION\",\n \"customizationRenderType\": \"SWATCH_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"92e94db7-832c-42fd-be1e-55670df24ccf\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Blue\",\n \"name\": \"Blue\",\n \"colorCode\": \"#0000FF\",\n \"assignedProductsCount\": 0\n },\n {\n \"id\": \"30be51d2-cc1e-4ef6-84c0-ac59f9410bc2\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Yellow\",\n \"name\": \"Yellow\",\n \"colorCode\": \"#FFFF00\",\n \"assignedProductsCount\": 0\n },\n {\n \"id\": \"4e787c64-8901-4031-b4cc-63bb9fa0a96a\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Green\",\n \"name\": \"Green\",\n \"colorCode\": \"#008000\",\n \"assignedProductsCount\": 0\n }]\n }\n }\n}"}},{"name":"CreateCustomization","type":"METHOD","order":5,"content":{"title":"Create Customization of type Modifier","description":"Creates a customization with a swatch choices modifier","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/customizations' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"customization\": {\n \"customizationType\": \"MODIFIER\",\n \"customizationRenderType\": \"SWATCH_CHOICES\",\n \"name\": \"Color\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceType\": \"ONE_COLOR\",\n \"name\": \"Pink\",\n \"colorCode\": \"#FFC0CB\"\n },\n {\n \"choiceType\": \"ONE_COLOR\",\n \"name\": \"Black\",\n \"colorCode\": \"#000000\"\n }\n ]\n }\n \t}\n }'","response":"{\n \"customization\": {\n \"id\": \"4c7fd83b-f17b-4e2f-a0ce-4758201fd464\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T12:28:39.958Z\",\n \"updatedDate\": \"2024-06-26T12:28:39.958Z\",\n \"key\": \"Color\",\n \"name\": \"Color\",\n \"customizationType\": \"MODIFIER\",\n \"customizationRenderType\": \"SWATCH_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"13c85ae2-35b4-4fe8-8fa7-0b76605f4cd9\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Pink\",\n \"name\": \"Pink\",\n \"colorCode\": \"#FFC0CB\",\n \"assignedProductsCount\": 0\n },\n {\n \"id\": \"50189405-71d3-44e4-8e2c-ac6b286db1f9\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Black\",\n \"name\": \"Black\",\n \"colorCode\": \"#000000\",\n \"assignedProductsCount\": 0\n }]\n }\n }\n }"}},{"name":"CreateCustomization","type":"METHOD","order":1,"content":{"title":"Create Customization of type Option","description":"Creates a customization with a text choices option","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/customizations' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"customization\": {\n \"customizationRenderType\": \"TEXT_CHOICES\",\n \"customizationType\": \"PRODUCT_OPTION\",\n \"name\": \"Size\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceType\": \"CHOICE_TEXT\",\n \"name\": \"Small\"\n },\n {\n \"choiceType\": \"CHOICE_TEXT\",\n \"name\": \"Medium\"\n },\n {\n \"choiceType\": \"CHOICE_TEXT\",\n \"name\": \"Large\"\n }\n ]\n }\n }\n }'","response":"{\n \"customization\": {\n \"id\": \"8de17a9a-d6b2-4ec9-a088-ce79d6ef38c7\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:35:15.526Z\",\n \"updatedDate\": \"2024-06-26T09:35:15.526Z\",\n \"key\": \"Size\",\n \"name\": \"Size\",\n \"customizationType\": \"PRODUCT_OPTION\",\n \"customizationRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"6d3aa7cc-f6c3-4516-ab2d-9099cb46d693\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Small\",\n \"name\": \"Small\",\n \"assignedProductsCount\": 0\n },\n {\n \"id\": \"eb0285fd-2a42-44c4-b113-8c111ead2ca2\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Medium\",\n \"name\": \"Medium\",\n \"assignedProductsCount\": 0\n },\n {\n \"id\": \"66e4c999-8dbb-4a1a-b8ee-c7de1f24e4eb\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Large\",\n \"name\": \"Large\",\n \"assignedProductsCount\": 0\n }]\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/customizations","rpcOnly":false,"triggeredEvents":[{"title":"Customization Created","description":"Triggered when a customization is created.","permissions":["WIX_STORES.CUSTOMIZATION_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.stores.catalog.v3.customization","serviceName":"wix.stores.catalog.customization.v3.CustomizationService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.customization_created","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.customization.v3.CustomizationService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"OPTIONS_LIMIT_EXCEEDED"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"MODIFIERS_LIMIT_EXCEEDED"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INVALID_CUSTOMIZATION_RENDER_TYPE"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_FREE_TEXT_SETTINGS"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.CUSTOMIZATION_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores.catalog:customization","serviceArtifactId":"com.wixpress.stores.catalog.customization","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.customization.v3.CreateCustomizationRequest","responseMessage":"wix.stores.catalog.customization.v3.CreateCustomizationResponse"},"legacyExamples":[{"name":"CreateCustomization","type":"METHOD","order":4,"content":{"title":"Create Customization of type Modifier","description":"Creates a customization with a text choices modifier","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/customizations' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"customization\": {\n \"customizationRenderType\": \"TEXT_CHOICES\",\n \"customizationType\": \"MODIFIER\",\n \"name\": \"Material\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceType\": \"CHOICE_TEXT\",\n \"name\": \"Cotton\"\n },\n {\n \"choiceType\": \"CHOICE_TEXT\",\n \"name\": \"Polyester\"\n },\n {\n \"choiceType\": \"CHOICE_TEXT\",\n \"name\": \"Wool\"\n }\n ]\n }\n }\n }'","response":"{\n \"customization\": {\n \"id\": \"ba08f3a1-66c8-4f90-8f84-02b3ce0a35fd\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T12:23:02.352Z\",\n \"updatedDate\": \"2024-06-26T12:23:02.352Z\",\n \"key\": \"Material\",\n \"name\": \"Material\",\n \"customizationType\": \"MODIFIER\",\n \"customizationRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"7c92d94c-7268-46eb-9da8-36809e02d873\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Cotton\",\n \"name\": \"Cotton\",\n \"assignedProductsCount\": 0\n },\n {\n \"id\": \"19e63e76-e7eb-486a-8519-77c17ba33896\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Polyester\",\n \"name\": \"Polyester\",\n \"assignedProductsCount\": 0\n },\n {\n \"id\": \"1a2e8974-4ab9-459d-85d8-fa36cf1eb240\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Wool\",\n \"name\": \"Wool\",\n \"assignedProductsCount\": 0\n }]\n }\n }\n }"}},{"name":"CreateCustomization","type":"METHOD","order":3,"content":{"title":"Create Customization of type Modifier","description":"Creates a customization with a free text modifier","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/customizations' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"customization\": {\n \"customizationRenderType\": \"FREE_TEXT\",\n \"customizationType\": \"MODIFIER\",\n \"name\": \"Name for Personalization\",\n \"freeTextInput\": {\n \"title\": \"Add your name for personalization\"\n }\n }\n }'","response":"{\n \"customization\": {\n \"id\": \"e514685b-10ff-4706-ac9e-6fd4b912ccbf\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:57:22.530Z\",\n \"updatedDate\": \"2024-06-26T09:57:22.530Z\",\n \"key\": \"Name for Personalization\",\n \"name\": \"Name for Personalization\",\n \"customizationType\": \"MODIFIER\",\n \"customizationRenderType\": \"FREE_TEXT\",\n \"freeTextInput\": {\n \"minCharCount\": 0,\n \"maxCharCount\": 0,\n \"title\": \"Add your name for personalization\",\n \"key\": \"Add your name for personalization\"\n }\n }\n}"}},{"name":"CreateCustomization","type":"METHOD","order":2,"content":{"title":"Create Customization of type Option","description":"Creates a customization with a swatch choices option","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/customizations' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"customization\": {\n \"customizationType\": \"PRODUCT_OPTION\",\n \"customizationRenderType\": \"SWATCH_CHOICES\",\n \"name\": \"Color\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceType\": \"ONE_COLOR\",\n \"name\": \"Blue\",\n \"colorCode\": \"#0000FF\"\n },\n {\n \"choiceType\": \"ONE_COLOR\",\n \"name\": \"Yellow\",\n \"colorCode\": \"#FFFF00\"\n },\n {\n \"choiceType\": \"ONE_COLOR\",\n \"name\": \"Green\",\n \"colorCode\": \"#008000\"\n }\n ]\n }\n \t}\n }'","response":"{\n \"customization\": {\n \"id\": \"06b6abfd-002d-437d-ad08-91f8537cd96d\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:44:11.306Z\",\n \"updatedDate\": \"2024-06-26T09:44:11.306Z\",\n \"key\": \"Color\",\n \"name\": \"Color\",\n \"customizationType\": \"PRODUCT_OPTION\",\n \"customizationRenderType\": \"SWATCH_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"92e94db7-832c-42fd-be1e-55670df24ccf\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Blue\",\n \"name\": \"Blue\",\n \"colorCode\": \"#0000FF\",\n \"assignedProductsCount\": 0\n },\n {\n \"id\": \"30be51d2-cc1e-4ef6-84c0-ac59f9410bc2\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Yellow\",\n \"name\": \"Yellow\",\n \"colorCode\": \"#FFFF00\",\n \"assignedProductsCount\": 0\n },\n {\n \"id\": \"4e787c64-8901-4031-b4cc-63bb9fa0a96a\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Green\",\n \"name\": \"Green\",\n \"colorCode\": \"#008000\",\n \"assignedProductsCount\": 0\n }]\n }\n }\n}"}},{"name":"CreateCustomization","type":"METHOD","order":5,"content":{"title":"Create Customization of type Modifier","description":"Creates a customization with a swatch choices modifier","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/customizations' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"customization\": {\n \"customizationType\": \"MODIFIER\",\n \"customizationRenderType\": \"SWATCH_CHOICES\",\n \"name\": \"Color\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceType\": \"ONE_COLOR\",\n \"name\": \"Pink\",\n \"colorCode\": \"#FFC0CB\"\n },\n {\n \"choiceType\": \"ONE_COLOR\",\n \"name\": \"Black\",\n \"colorCode\": \"#000000\"\n }\n ]\n }\n \t}\n }'","response":"{\n \"customization\": {\n \"id\": \"4c7fd83b-f17b-4e2f-a0ce-4758201fd464\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T12:28:39.958Z\",\n \"updatedDate\": \"2024-06-26T12:28:39.958Z\",\n \"key\": \"Color\",\n \"name\": \"Color\",\n \"customizationType\": \"MODIFIER\",\n \"customizationRenderType\": \"SWATCH_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"13c85ae2-35b4-4fe8-8fa7-0b76605f4cd9\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Pink\",\n \"name\": \"Pink\",\n \"colorCode\": \"#FFC0CB\",\n \"assignedProductsCount\": 0\n },\n {\n \"id\": \"50189405-71d3-44e4-8e2c-ac6b286db1f9\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Black\",\n \"name\": \"Black\",\n \"colorCode\": \"#000000\",\n \"assignedProductsCount\": 0\n }]\n }\n }\n }"}},{"name":"CreateCustomization","type":"METHOD","order":1,"content":{"title":"Create Customization of type Option","description":"Creates a customization with a text choices option","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/customizations' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"customization\": {\n \"customizationRenderType\": \"TEXT_CHOICES\",\n \"customizationType\": \"PRODUCT_OPTION\",\n \"name\": \"Size\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceType\": \"CHOICE_TEXT\",\n \"name\": \"Small\"\n },\n {\n \"choiceType\": \"CHOICE_TEXT\",\n \"name\": \"Medium\"\n },\n {\n \"choiceType\": \"CHOICE_TEXT\",\n \"name\": \"Large\"\n }\n ]\n }\n }\n }'","response":"{\n \"customization\": {\n \"id\": \"8de17a9a-d6b2-4ec9-a088-ce79d6ef38c7\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:35:15.526Z\",\n \"updatedDate\": \"2024-06-26T09:35:15.526Z\",\n \"key\": \"Size\",\n \"name\": \"Size\",\n \"customizationType\": \"PRODUCT_OPTION\",\n \"customizationRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"6d3aa7cc-f6c3-4516-ab2d-9099cb46d693\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Small\",\n \"name\": \"Small\",\n \"assignedProductsCount\": 0\n },\n {\n \"id\": \"eb0285fd-2a42-44c4-b113-8c111ead2ca2\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Medium\",\n \"name\": \"Medium\",\n \"assignedProductsCount\": 0\n },\n {\n \"id\": \"66e4c999-8dbb-4a1a-b8ee-c7de1f24e4eb\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Large\",\n \"name\": \"Large\",\n \"assignedProductsCount\": 0\n }]\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Create Customization","slugifiedName":"create-customization"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Customization write in v3 catalog","scopeId":"SCOPE.STORES.CUSTOMIZATION_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Get Customization","description":"Retrieves a customization.","operationId":"wix.stores.catalog.customization.v3.CustomizationService.GetCustomization","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"customizationId","description":"Customization ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"fields","in":"query","description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","required":false,"schema":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.GetCustomizationResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/customizations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/customizations","destinationPath":"/v3/customizations","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.stores.catalog.customization.v3.CustomizationService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.CUSTOMIZATION_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.stores.catalog:customization","serviceArtifactId":"com.wixpress.stores.catalog.customization","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.customization.v3.GetCustomizationRequest","responseMessage":"wix.stores.catalog.customization.v3.GetCustomizationResponse"},"legacyExamples":[{"name":"GetCustomization","type":"METHOD","content":{"title":"Get Customization","description":"Get a Customization based on its ID","request":"curl -X GET \\\n 'https://www.wixapis.com/stores/v3/customizations/06b6abfd-002d-437d-ad08-91f8537cd96d' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\","response":"{\n \"customization\": {\n \"id\": \"06b6abfd-002d-437d-ad08-91f8537cd96d\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-27T06:28:28.275Z\",\n \"updatedDate\": \"2024-06-27T06:59:41.470Z\",\n \"key\": \"Color\",\n \"name\": \"Color\",\n \"customizationType\": \"PRODUCT_OPTION\",\n \"customizationRenderType\": \"SWATCH_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"ef6bf1ca-bdc8-4158-af95-c299de38dec6\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Purple\",\n \"name\": \"Purple\",\n \"colorCode\": \"#A020F0\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"2d5f3333-2202-49ac-9587-8953bf201c6e\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Orange\",\n \"name\": \"Orange\",\n \"colorCode\": \"#FFA500\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"92e94db7-832c-42fd-be1e-55670df24ccf\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Blue\",\n \"name\": \"Blue\",\n \"colorCode\": \"#0000FF\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"30be51d2-cc1e-4ef6-84c0-ac59f9410bc2\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Yellow\",\n \"name\": \"Yellow\",\n \"colorCode\": \"#FFFF00\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"4e787c64-8901-4031-b4cc-63bb9fa0a96a\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Green\",\n \"name\": \"Green\",\n \"colorCode\": \"#008000\",\n \"assignedProductsCount\": 0\n }]\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"get","path":"/v3/customizations/{customizationId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.stores.catalog.customization.v3.CustomizationService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.CUSTOMIZATION_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.stores.catalog:customization","serviceArtifactId":"com.wixpress.stores.catalog.customization","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.customization.v3.GetCustomizationRequest","responseMessage":"wix.stores.catalog.customization.v3.GetCustomizationResponse"},"legacyExamples":[{"name":"GetCustomization","type":"METHOD","content":{"title":"Get Customization","description":"Get a Customization based on its ID","request":"curl -X GET \\\n 'https://www.wixapis.com/stores/v3/customizations/06b6abfd-002d-437d-ad08-91f8537cd96d' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\","response":"{\n \"customization\": {\n \"id\": \"06b6abfd-002d-437d-ad08-91f8537cd96d\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-27T06:28:28.275Z\",\n \"updatedDate\": \"2024-06-27T06:59:41.470Z\",\n \"key\": \"Color\",\n \"name\": \"Color\",\n \"customizationType\": \"PRODUCT_OPTION\",\n \"customizationRenderType\": \"SWATCH_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"ef6bf1ca-bdc8-4158-af95-c299de38dec6\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Purple\",\n \"name\": \"Purple\",\n \"colorCode\": \"#A020F0\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"2d5f3333-2202-49ac-9587-8953bf201c6e\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Orange\",\n \"name\": \"Orange\",\n \"colorCode\": \"#FFA500\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"92e94db7-832c-42fd-be1e-55670df24ccf\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Blue\",\n \"name\": \"Blue\",\n \"colorCode\": \"#0000FF\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"30be51d2-cc1e-4ef6-84c0-ac59f9410bc2\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Yellow\",\n \"name\": \"Yellow\",\n \"colorCode\": \"#FFFF00\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"4e787c64-8901-4031-b4cc-63bb9fa0a96a\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Green\",\n \"name\": \"Green\",\n \"colorCode\": \"#008000\",\n \"assignedProductsCount\": 0\n }]\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Get Customization","slugifiedName":"get-customization"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Read customizations in v3 catalog","scopeId":"SCOPE.STORES.CUSTOMIZATION_READ"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Delete Customization","description":"Deletes a customization.\n\n> **Note:** A customization cannot be deleted if it is assigned to one or more products.","operationId":"wix.stores.catalog.customization.v3.CustomizationService.DeleteCustomization","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"customizationId","description":"Customization ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.DeleteCustomizationResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/customizations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/customizations","destinationPath":"/v3/customizations","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Customization Deleted","description":"Triggered when a customization is deleted.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.stores.catalog.v3.customization","serviceName":"wix.stores.catalog.customization.v3.CustomizationService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.customization_deleted","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.customization.v3.CustomizationService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.CUSTOMIZATION_DELETE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores.catalog:customization","serviceArtifactId":"com.wixpress.stores.catalog.customization","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.customization.v3.DeleteCustomizationRequest","responseMessage":"wix.stores.catalog.customization.v3.DeleteCustomizationResponse"},"legacyExamples":[{"name":"DeleteCustomization","type":"METHOD","content":{"title":"Delete Customization","description":"Deletes a Customization based on its id","request":"curl -X DELETE \\\n 'https://www.wixapis.com/stores/v3/customizations/c4a4cc7b-caff-41dd-b23a-1f0bf4730c06' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"delete","path":"/v3/customizations/{customizationId}","rpcOnly":false,"triggeredEvents":[{"title":"Customization Deleted","description":"Triggered when a customization is deleted.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.stores.catalog.v3.customization","serviceName":"wix.stores.catalog.customization.v3.CustomizationService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.customization_deleted","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.customization.v3.CustomizationService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.CUSTOMIZATION_DELETE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores.catalog:customization","serviceArtifactId":"com.wixpress.stores.catalog.customization","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.customization.v3.DeleteCustomizationRequest","responseMessage":"wix.stores.catalog.customization.v3.DeleteCustomizationResponse"},"legacyExamples":[{"name":"DeleteCustomization","type":"METHOD","content":{"title":"Delete Customization","description":"Deletes a Customization based on its id","request":"curl -X DELETE \\\n 'https://www.wixapis.com/stores/v3/customizations/c4a4cc7b-caff-41dd-b23a-1f0bf4730c06' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Delete Customization","slugifiedName":"delete-customization"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Customization write in v3 catalog","scopeId":"SCOPE.STORES.CUSTOMIZATION_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Update Customization","description":"Updates a customization.\n\nEach time the customization is updated, `revision` increments by 1.\nThe current `revision` must be passed when updating the customization.\nThis ensures you're working with the latest customization and prevents unintended overwrites.","operationId":"wix.stores.catalog.customization.v3.CustomizationService.UpdateCustomization","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"customization.id","description":"Customization ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.UpdateCustomizationResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/customizations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/customizations","destinationPath":"/v3/customizations","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateCustomizationRequest","description":"","properties":{"customization":{"description":"Customization to update.","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Customization","summary":"customization","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["customization","customization.id","customization.revision"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Customization Updated","description":"Triggered when a customization is updated.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.customization","serviceName":"wix.stores.catalog.customization.v3.CustomizationService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.customization_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.customization.v3.CustomizationService","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FIELD_MASK_VALUE_NOT_SUPPORTED"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.CUSTOMIZATION_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores.catalog:customization","serviceArtifactId":"com.wixpress.stores.catalog.customization","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.customization.v3.UpdateCustomizationRequest","responseMessage":"wix.stores.catalog.customization.v3.UpdateCustomizationResponse"},"legacyExamples":[{"name":"UpdateCustomization","type":"METHOD","content":{"title":"Update customization","request":"curl -X PATCH \\\n 'https://www.wixapis.com/stores/v3/customizations/00b0882f-f9bd-44a1-b228-1d68ee607242' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"customization\": {\n \"customizationRenderType\": \"TEXT_CHOICES\",\n \"customizationType\": \"MODIFIER\",\n \"name\": \"Fabric\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceType\": \"CHOICE_TEXT\",\n \"name\": \"Silk\"\n },\n {\n \"choiceType\": \"CHOICE_TEXT\",\n \"name\": \"Polyester\"\n },\n {\n \"choiceType\": \"CHOICE_TEXT\",\n \"name\": \"Wool\"\n }\n ]\n },\n \"revision\": 3\n }\n }'","response":"{\n \"customization\": {\n \"id\": \"8a5e9c3b-6d8a-4a3b-9b6e-7a8d6b9e1c4f\",\n \"revision\": \"4\",\n \"createdDate\": \"2024-06-26T12:23:02.352Z\",\n \"updatedDate\": \"2024-06-27T12:42:08.613Z\",\n \"key\": \"Fabric\",\n \"name\": \"Fabric\",\n \"customizationType\": \"MODIFIER\",\n \"customizationRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"1a9e7c5b-8b6d-4c3e-9a8b-7a6e8d9c3b4e\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Cotton\",\n \"name\": \"Cotton\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"6c8b4d7a-3b2e-4a9d-8b5e-7a8d6b9e4f1a\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Polyester\",\n \"name\": \"Polyester\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"3a7e8b5c-6d8a-4c2e-9b5e-7a6e8d9c1b3a\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Wool\",\n \"name\": \"Wool\",\n \"assignedProductsCount\": 0\n }]\n }\n }\n }"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"patch","path":"/v3/customizations/{customization.id}","rpcOnly":false,"triggeredEvents":[{"title":"Customization Updated","description":"Triggered when a customization is updated.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.customization","serviceName":"wix.stores.catalog.customization.v3.CustomizationService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.customization_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.customization.v3.CustomizationService","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FIELD_MASK_VALUE_NOT_SUPPORTED"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.CUSTOMIZATION_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores.catalog:customization","serviceArtifactId":"com.wixpress.stores.catalog.customization","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.customization.v3.UpdateCustomizationRequest","responseMessage":"wix.stores.catalog.customization.v3.UpdateCustomizationResponse"},"legacyExamples":[{"name":"UpdateCustomization","type":"METHOD","content":{"title":"Update customization","request":"curl -X PATCH \\\n 'https://www.wixapis.com/stores/v3/customizations/00b0882f-f9bd-44a1-b228-1d68ee607242' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"customization\": {\n \"customizationRenderType\": \"TEXT_CHOICES\",\n \"customizationType\": \"MODIFIER\",\n \"name\": \"Fabric\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"choiceType\": \"CHOICE_TEXT\",\n \"name\": \"Silk\"\n },\n {\n \"choiceType\": \"CHOICE_TEXT\",\n \"name\": \"Polyester\"\n },\n {\n \"choiceType\": \"CHOICE_TEXT\",\n \"name\": \"Wool\"\n }\n ]\n },\n \"revision\": 3\n }\n }'","response":"{\n \"customization\": {\n \"id\": \"8a5e9c3b-6d8a-4a3b-9b6e-7a8d6b9e1c4f\",\n \"revision\": \"4\",\n \"createdDate\": \"2024-06-26T12:23:02.352Z\",\n \"updatedDate\": \"2024-06-27T12:42:08.613Z\",\n \"key\": \"Fabric\",\n \"name\": \"Fabric\",\n \"customizationType\": \"MODIFIER\",\n \"customizationRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"1a9e7c5b-8b6d-4c3e-9a8b-7a6e8d9c3b4e\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Cotton\",\n \"name\": \"Cotton\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"6c8b4d7a-3b2e-4a9d-8b5e-7a8d6b9e4f1a\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Polyester\",\n \"name\": \"Polyester\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"3a7e8b5c-6d8a-4c2e-9b5e-7a6e8d9c1b3a\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Wool\",\n \"name\": \"Wool\",\n \"assignedProductsCount\": 0\n }]\n }\n }\n }"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Update Customization","slugifiedName":"update-customization"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Customization write in v3 catalog","scopeId":"SCOPE.STORES.CUSTOMIZATION_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Query Customizations","description":"Retrieves a list of up to 100 customizations, given the provided filtering, sorting, and cursor paging.\nPass supported values to the `fields` array in the request to include those fields in the response.\n\n\nQuery Customizations runs with these defaults, which you can override:\n\n- `createdDate` is sorted in `DESC` order\n- `cursorPaging.limit` is `100`\n\nFor field support for filters and sorting,\nsee [Customizations: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/customizations-v3/supported-filters-and-sorting).\n\nTo learn about working with _Query_ endpoints, see\n[API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),\nand [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).","operationId":"wix.stores.catalog.customization.v3.CustomizationService.QueryCustomizations","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.QueryCustomizationsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/customizations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/customizations","destinationPath":"/v3/customizations","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryCustomizationsRequest","description":"","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.upstream.wix.common.CursorQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.stores.catalog.customization.v3.CustomizationService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.CUSTOMIZATION_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.stores.catalog:customization","serviceArtifactId":"com.wixpress.stores.catalog.customization","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.customization.v3.QueryCustomizationsRequest","responseMessage":"wix.stores.catalog.customization.v3.QueryCustomizationsResponse"},"legacyExamples":[{"name":"QueryCustomizations","type":"METHOD","order":2,"content":{"title":"Query Customization, part 2 of paging","description":"Queries Existing Customizations by customizationRenderType; sorted by name in ascending order; second part of paging","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/customizations/query' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"query\": {\n \"cursorPaging\": {\n \"cursor\": \"A3mXp6TqVw4R9Lk25c10e662746f5ce9e2145f16.DljyP8VnR3djdXN0b21pemF0aW9uUmVuZGVyVHlwZRINGgt0ZXh0Q2hvaWNlcxoSCgRuYW1lGgoaCE1hdGVyaWFsIiQ2YWUwYzdiOC04ZmE5LTRlMWYtYTJkMi0yODc1MzliNzMzMmQ\"\n }\n }\n }'","response":"{\n \"customizations\": [{\n \"id\": \"22b1b7a7-2d97-4a27-a370-54ca63cb3b89\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:35:15.526Z\",\n \"updatedDate\": \"2024-06-26T09:35:15.526Z\",\n \"key\": \"Size\",\n \"name\": \"Size\",\n \"customizationType\": \"PRODUCT_OPTION\",\n \"customizationRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"1a64166b-668a-48bb-bbf2-f02741dc97df\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Small\",\n \"name\": \"Small\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"91679c59-e7fb-42b5-8044-fdf5075f1d88\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Medium\",\n \"name\": \"Medium\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"92fb4222-fbd9-4c24-9f3a-f71ed5214853\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Large\",\n \"name\": \"Large\",\n \"assignedProductsCount\": 0\n }]\n }\n }],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {\n \"prev\": \"A7k9l2Df8nT4xQea0acd494fa8bd382b4e1cf2e9.Pq4RzTnL7xM1UvG2yWsvbWl6YXRpb25SZW5kZXJUeXBlEg0aC3RleHRDaG9pY2VzGg4KBG5hbWUaBhoEU2l6ZSIkNmFkMWNlMTYtOGZkYi00ZGRhLWIxZjgtODEzY2JmMjkxMTAx\"\n },\n \"hasNext\": false\n }\n}"}},{"name":"QueryCustomizations","type":"METHOD","order":1,"content":{"title":"Query Customization, part 1 of paging","description":"Queries Existing Customizations by customizationRenderType; sorted by name in ascending order; first part of paging with limit of 2 results per page","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/customizations/query' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"query\": {\n \"sort\": [\n {\n \"order\": \"ASC\",\n \"fieldName\": \"name\"\n }\n ],\n \"filter\": {\n \"customizationRenderType\": \"TEXT_CHOICES\"\n },\n \"cursorPaging\": {\n \"limit\": 2\n }\n }\n}'","response":"{\n \"customizations\": [{\n \"id\": \"43415448-872d-4712-b083-98eec60029eb\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T13:40:20.890Z\",\n \"updatedDate\": \"2024-06-26T13:40:20.890Z\",\n \"key\": \"Fit\",\n \"name\": \"Fit\",\n \"customizationType\": \"PRODUCT_OPTION\",\n \"customizationRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"0e43cf83-d068-4c61-acd5-39c9496635b2\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Regular\",\n \"name\": \"Regular\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"043dd792-d3a6-473d-a9fb-4d77f5914a5b\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Slim\",\n \"name\": \"Slim\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"4ea85ba9-3df1-412b-b7b5-e2f04ae8f376\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Loose\",\n \"name\": \"Loose\",\n \"assignedProductsCount\": 0\n }]\n }\n }, {\n \"id\": \"ddd6c829-457d-4394-9c11-a1270f3c7086\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T12:23:02.352Z\",\n \"updatedDate\": \"2024-06-26T12:23:02.352Z\",\n \"key\": \"Material\",\n \"name\": \"Material\",\n \"customizationType\": \"MODIFIER\",\n \"customizationRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"23fdfaa4-8b5e-4723-83e4-ca060f3e3d2d\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Cotton\",\n \"name\": \"Cotton\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"307eb76d-11c8-4dde-b34d-4c3e26e553f6\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Polyester\",\n \"name\": \"Polyester\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"5247ac83-aab7-45dc-9375-438da979c361\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Wool\",\n \"name\": \"Wool\",\n \"assignedProductsCount\": 0\n }]\n }\n }],\n \"pagingMetadata\": {\n \"count\": 2,\n \"cursors\": {\n \"next\": \"B7k9Nm4Xp8Q2Rf6Vy3W0Zz2746f5ce9e2145f16.Tz4nQjRpWkLmYxN8u5vFsD2gHW9uUmVuZGVyVHlwZRINGgt0ZXh0Q2hvaWNlcxoSCgRuYW1lGgoaCE1hdGVyaWFsIiQ2YWUwYzdiOC04ZmE5LTRlMWYtYTJkMi0yODc1MzliNzMzMmQ\"\n },\n \"hasNext\": true\n }\n}"}},{"name":"QueryCustomizations","type":"METHOD","order":3,"content":{"title":"Query Customization with one result","description":"Queries Existing Customizations by customizationRenderType;","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/customizations/query' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"query\": {\n \"filter\": {\n \"customizationRenderType\": \"SWATCH_CHOICES\"\n },\n \"cursorPaging\": {\n \"limit\": 10\n }\n }\n}'","response":"{\n \"customizations\": [{\n \"id\": \"06b6abfd-002d-437d-ad08-91f8537cd96d\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:44:11.306Z\",\n \"updatedDate\": \"2024-06-26T09:44:11.306Z\",\n \"key\": \"Color\",\n \"name\": \"Color\",\n \"customizationType\": \"PRODUCT_OPTION\",\n \"customizationRenderType\": \"SWATCH_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"92e94db7-832c-42fd-be1e-55670df24ccf\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Blue\",\n \"name\": \"Blue\",\n \"colorCode\": \"#0000FF\",\n \"assignedProductsCount\": 0\n },\n {\n \"id\": \"30be51d2-cc1e-4ef6-84c0-ac59f9410bc2\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Yellow\",\n \"name\": \"Yellow\",\n \"colorCode\": \"#FFFF00\",\n \"assignedProductsCount\": 0\n },\n {\n \"id\": \"4e787c64-8901-4031-b4cc-63bb9fa0a96a\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Green\",\n \"name\": \"Green\",\n \"colorCode\": \"#008000\",\n \"assignedProductsCount\": 0\n }]\n }\n }],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {\n \"next\": null\n },\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/customizations/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.stores.catalog.customization.v3.CustomizationService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.CUSTOMIZATION_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.stores.catalog:customization","serviceArtifactId":"com.wixpress.stores.catalog.customization","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.customization.v3.QueryCustomizationsRequest","responseMessage":"wix.stores.catalog.customization.v3.QueryCustomizationsResponse"},"legacyExamples":[{"name":"QueryCustomizations","type":"METHOD","order":2,"content":{"title":"Query Customization, part 2 of paging","description":"Queries Existing Customizations by customizationRenderType; sorted by name in ascending order; second part of paging","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/customizations/query' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"query\": {\n \"cursorPaging\": {\n \"cursor\": \"A3mXp6TqVw4R9Lk25c10e662746f5ce9e2145f16.DljyP8VnR3djdXN0b21pemF0aW9uUmVuZGVyVHlwZRINGgt0ZXh0Q2hvaWNlcxoSCgRuYW1lGgoaCE1hdGVyaWFsIiQ2YWUwYzdiOC04ZmE5LTRlMWYtYTJkMi0yODc1MzliNzMzMmQ\"\n }\n }\n }'","response":"{\n \"customizations\": [{\n \"id\": \"22b1b7a7-2d97-4a27-a370-54ca63cb3b89\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:35:15.526Z\",\n \"updatedDate\": \"2024-06-26T09:35:15.526Z\",\n \"key\": \"Size\",\n \"name\": \"Size\",\n \"customizationType\": \"PRODUCT_OPTION\",\n \"customizationRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"1a64166b-668a-48bb-bbf2-f02741dc97df\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Small\",\n \"name\": \"Small\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"91679c59-e7fb-42b5-8044-fdf5075f1d88\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Medium\",\n \"name\": \"Medium\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"92fb4222-fbd9-4c24-9f3a-f71ed5214853\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Large\",\n \"name\": \"Large\",\n \"assignedProductsCount\": 0\n }]\n }\n }],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {\n \"prev\": \"A7k9l2Df8nT4xQea0acd494fa8bd382b4e1cf2e9.Pq4RzTnL7xM1UvG2yWsvbWl6YXRpb25SZW5kZXJUeXBlEg0aC3RleHRDaG9pY2VzGg4KBG5hbWUaBhoEU2l6ZSIkNmFkMWNlMTYtOGZkYi00ZGRhLWIxZjgtODEzY2JmMjkxMTAx\"\n },\n \"hasNext\": false\n }\n}"}},{"name":"QueryCustomizations","type":"METHOD","order":1,"content":{"title":"Query Customization, part 1 of paging","description":"Queries Existing Customizations by customizationRenderType; sorted by name in ascending order; first part of paging with limit of 2 results per page","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/customizations/query' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"query\": {\n \"sort\": [\n {\n \"order\": \"ASC\",\n \"fieldName\": \"name\"\n }\n ],\n \"filter\": {\n \"customizationRenderType\": \"TEXT_CHOICES\"\n },\n \"cursorPaging\": {\n \"limit\": 2\n }\n }\n}'","response":"{\n \"customizations\": [{\n \"id\": \"43415448-872d-4712-b083-98eec60029eb\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T13:40:20.890Z\",\n \"updatedDate\": \"2024-06-26T13:40:20.890Z\",\n \"key\": \"Fit\",\n \"name\": \"Fit\",\n \"customizationType\": \"PRODUCT_OPTION\",\n \"customizationRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"0e43cf83-d068-4c61-acd5-39c9496635b2\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Regular\",\n \"name\": \"Regular\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"043dd792-d3a6-473d-a9fb-4d77f5914a5b\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Slim\",\n \"name\": \"Slim\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"4ea85ba9-3df1-412b-b7b5-e2f04ae8f376\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Loose\",\n \"name\": \"Loose\",\n \"assignedProductsCount\": 0\n }]\n }\n }, {\n \"id\": \"ddd6c829-457d-4394-9c11-a1270f3c7086\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T12:23:02.352Z\",\n \"updatedDate\": \"2024-06-26T12:23:02.352Z\",\n \"key\": \"Material\",\n \"name\": \"Material\",\n \"customizationType\": \"MODIFIER\",\n \"customizationRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"23fdfaa4-8b5e-4723-83e4-ca060f3e3d2d\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Cotton\",\n \"name\": \"Cotton\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"307eb76d-11c8-4dde-b34d-4c3e26e553f6\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Polyester\",\n \"name\": \"Polyester\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"5247ac83-aab7-45dc-9375-438da979c361\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Wool\",\n \"name\": \"Wool\",\n \"assignedProductsCount\": 0\n }]\n }\n }],\n \"pagingMetadata\": {\n \"count\": 2,\n \"cursors\": {\n \"next\": \"B7k9Nm4Xp8Q2Rf6Vy3W0Zz2746f5ce9e2145f16.Tz4nQjRpWkLmYxN8u5vFsD2gHW9uUmVuZGVyVHlwZRINGgt0ZXh0Q2hvaWNlcxoSCgRuYW1lGgoaCE1hdGVyaWFsIiQ2YWUwYzdiOC04ZmE5LTRlMWYtYTJkMi0yODc1MzliNzMzMmQ\"\n },\n \"hasNext\": true\n }\n}"}},{"name":"QueryCustomizations","type":"METHOD","order":3,"content":{"title":"Query Customization with one result","description":"Queries Existing Customizations by customizationRenderType;","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/customizations/query' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"query\": {\n \"filter\": {\n \"customizationRenderType\": \"SWATCH_CHOICES\"\n },\n \"cursorPaging\": {\n \"limit\": 10\n }\n }\n}'","response":"{\n \"customizations\": [{\n \"id\": \"06b6abfd-002d-437d-ad08-91f8537cd96d\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:44:11.306Z\",\n \"updatedDate\": \"2024-06-26T09:44:11.306Z\",\n \"key\": \"Color\",\n \"name\": \"Color\",\n \"customizationType\": \"PRODUCT_OPTION\",\n \"customizationRenderType\": \"SWATCH_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"92e94db7-832c-42fd-be1e-55670df24ccf\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Blue\",\n \"name\": \"Blue\",\n \"colorCode\": \"#0000FF\",\n \"assignedProductsCount\": 0\n },\n {\n \"id\": \"30be51d2-cc1e-4ef6-84c0-ac59f9410bc2\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Yellow\",\n \"name\": \"Yellow\",\n \"colorCode\": \"#FFFF00\",\n \"assignedProductsCount\": 0\n },\n {\n \"id\": \"4e787c64-8901-4031-b4cc-63bb9fa0a96a\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Green\",\n \"name\": \"Green\",\n \"colorCode\": \"#008000\",\n \"assignedProductsCount\": 0\n }]\n }\n }],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {\n \"next\": null\n },\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Query Customizations","slugifiedName":"query-customizations"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Read customizations in v3 catalog","scopeId":"SCOPE.STORES.CUSTOMIZATION_READ"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Bulk Create Customizations","description":"Creates multiple brands.","operationId":"wix.stores.catalog.customization.v3.CustomizationService.BulkCreateCustomizations","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.BulkCreateCustomizationsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/bulk/customizations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/customizations","destinationPath":"/v3/bulk/customizations","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkCreateCustomizationsRequest","description":"","properties":{"customizations":{"description":"Customizations to create.","minItems":1,"maxItems":100,"title":"customizations","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Customization"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the full customization entities in the response.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["customizations"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Customization Created","description":"Triggered when a customization is created.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.stores.catalog.v3.customization","serviceName":"wix.stores.catalog.customization.v3.CustomizationService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.customization_created","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.customization.v3.CustomizationService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"OPTIONS_LIMIT_EXCEEDED"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"MODIFIERS_LIMIT_EXCEEDED"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DOESNT_SUPPORT_CHOICES"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CHOICES_LIMIT_EXCEEDED","errorSchemaName":"wix.stores.catalog.customization.v3.CustomizationIdsWrapper"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.CUSTOMIZATION_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores.catalog:customization","serviceArtifactId":"com.wixpress.stores.catalog.customization","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.customization.v3.BulkCreateCustomizationsRequest","responseMessage":"wix.stores.catalog.customization.v3.BulkCreateCustomizationsResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/customizations/create","rpcOnly":false,"triggeredEvents":[{"title":"Customization Created","description":"Triggered when a customization is created.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.stores.catalog.v3.customization","serviceName":"wix.stores.catalog.customization.v3.CustomizationService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.customization_created","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.customization.v3.CustomizationService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"OPTIONS_LIMIT_EXCEEDED"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"MODIFIERS_LIMIT_EXCEEDED"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DOESNT_SUPPORT_CHOICES"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CHOICES_LIMIT_EXCEEDED","errorSchemaName":"wix.stores.catalog.customization.v3.CustomizationIdsWrapper"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.CUSTOMIZATION_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores.catalog:customization","serviceArtifactId":"com.wixpress.stores.catalog.customization","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.customization.v3.BulkCreateCustomizationsRequest","responseMessage":"wix.stores.catalog.customization.v3.BulkCreateCustomizationsResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Create Customizations","slugifiedName":"bulk-create-customizations"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Customization write in v3 catalog","scopeId":"SCOPE.STORES.CUSTOMIZATION_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Add Customization Choices","description":"Adds choices to a customization.","operationId":"wix.stores.catalog.customization.v3.CustomizationService.AddCustomizationChoices","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"customizationId","description":"Customization ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.AddCustomizationChoicesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/customizations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/customizations","destinationPath":"/v3/customizations","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"AddCustomizationChoicesRequest","description":"","properties":{"choices":{"description":"Choices to add.","minItems":1,"maxItems":100,"title":"choices","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Choice"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["customizationId","choices"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Customization Updated","description":"Triggered when a customization is updated.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.customization","serviceName":"wix.stores.catalog.customization.v3.CustomizationService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.customization_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.customization.v3.CustomizationService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CHOICES_LIMIT_EXCEEDED"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DOESNT_SUPPORT_CHOICES"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.CUSTOMIZATION_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores.catalog:customization","serviceArtifactId":"com.wixpress.stores.catalog.customization","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.customization.v3.AddCustomizationChoicesRequest","responseMessage":"wix.stores.catalog.customization.v3.AddCustomizationChoicesResponse"},"legacyExamples":[{"name":"AddCustomizationChoices","type":"METHOD","content":{"title":"Add Customization Choices","description":"Adds given choices to an existing customization by its id","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/customizations/06b6abfd-002d-437d-ad08-91f8537cd96d/add-choices' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"choices\": [\n {\n \"choiceType\": \"ONE_COLOR\",\n \"name\": \"Purple\",\n \"colorCode\": \"#A020F0\"\n }\n ]\n }'","response":"{\n \"customization\": {\n \"id\": \"06b6abfd-002d-437d-ad08-91f8537cd96d\",\n \"revision\": \"4\",\n \"createdDate\": \"2024-06-26T09:44:11.306Z\",\n \"updatedDate\": \"2024-07-03T08:40:32.789Z\",\n \"key\": \"Color\",\n \"name\": \"Color\",\n \"customizationType\": \"PRODUCT_OPTION\",\n \"customizationRenderType\": \"SWATCH_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"92e94db7-832c-42fd-be1e-55670df24ccf\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Blue\",\n \"name\": \"Blue\",\n \"colorCode\": \"#0000FF\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"30be51d2-cc1e-4ef6-84c0-ac59f9410bc2\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Yellow\",\n \"name\": \"Yellow\",\n \"colorCode\": \"#FFFF00\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"4e787c64-8901-4031-b4cc-63bb9fa0a96a\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Green\",\n \"name\": \"Green\",\n \"colorCode\": \"#008000\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"ef6bf1ca-bdc8-4158-af95-c299de38dec6\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Purple\",\n \"name\": \"Purple\",\n \"colorCode\": \"#A020F0\",\n \"assignedProductsCount\": 0\n }]\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/customizations/{customizationId}/add-choices","rpcOnly":false,"triggeredEvents":[{"title":"Customization Updated","description":"Triggered when a customization is updated.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.customization","serviceName":"wix.stores.catalog.customization.v3.CustomizationService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.customization_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.customization.v3.CustomizationService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CHOICES_LIMIT_EXCEEDED"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DOESNT_SUPPORT_CHOICES"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.CUSTOMIZATION_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores.catalog:customization","serviceArtifactId":"com.wixpress.stores.catalog.customization","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.customization.v3.AddCustomizationChoicesRequest","responseMessage":"wix.stores.catalog.customization.v3.AddCustomizationChoicesResponse"},"legacyExamples":[{"name":"AddCustomizationChoices","type":"METHOD","content":{"title":"Add Customization Choices","description":"Adds given choices to an existing customization by its id","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/customizations/06b6abfd-002d-437d-ad08-91f8537cd96d/add-choices' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"choices\": [\n {\n \"choiceType\": \"ONE_COLOR\",\n \"name\": \"Purple\",\n \"colorCode\": \"#A020F0\"\n }\n ]\n }'","response":"{\n \"customization\": {\n \"id\": \"06b6abfd-002d-437d-ad08-91f8537cd96d\",\n \"revision\": \"4\",\n \"createdDate\": \"2024-06-26T09:44:11.306Z\",\n \"updatedDate\": \"2024-07-03T08:40:32.789Z\",\n \"key\": \"Color\",\n \"name\": \"Color\",\n \"customizationType\": \"PRODUCT_OPTION\",\n \"customizationRenderType\": \"SWATCH_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"92e94db7-832c-42fd-be1e-55670df24ccf\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Blue\",\n \"name\": \"Blue\",\n \"colorCode\": \"#0000FF\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"30be51d2-cc1e-4ef6-84c0-ac59f9410bc2\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Yellow\",\n \"name\": \"Yellow\",\n \"colorCode\": \"#FFFF00\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"4e787c64-8901-4031-b4cc-63bb9fa0a96a\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Green\",\n \"name\": \"Green\",\n \"colorCode\": \"#008000\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"ef6bf1ca-bdc8-4158-af95-c299de38dec6\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Purple\",\n \"name\": \"Purple\",\n \"colorCode\": \"#A020F0\",\n \"assignedProductsCount\": 0\n }]\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Add Customization Choices","slugifiedName":"add-customization-choices"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Customization write in v3 catalog","scopeId":"SCOPE.STORES.CUSTOMIZATION_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Set Customization Choices","description":"Sets a customization's choices. Any and all existing choices will be overridden.\n\n> **Note:** A choice cannot be overridden if it is assigned to one or more products.","operationId":"wix.stores.catalog.customization.v3.CustomizationService.SetCustomizationChoices","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"customizationId","description":"Customization ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.SetCustomizationChoicesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/customizations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/customizations","destinationPath":"/v3/customizations","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"SetCustomizationChoicesRequest","description":"","properties":{"choices":{"description":"Choices to set.","minItems":1,"maxItems":100,"title":"choices","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Choice"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["choices","customizationId"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Customization Updated","description":"Triggered when a customization is updated.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.customization","serviceName":"wix.stores.catalog.customization.v3.CustomizationService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.customization_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.customization.v3.CustomizationService","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DOESNT_SUPPORT_CHOICES"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CHOICES_LIMIT_EXCEEDED","errorSchemaName":"wix.stores.catalog.customization.v3.CustomizationIdsWrapper"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.CUSTOMIZATION_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores.catalog:customization","serviceArtifactId":"com.wixpress.stores.catalog.customization","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.customization.v3.SetCustomizationChoicesRequest","responseMessage":"wix.stores.catalog.customization.v3.SetCustomizationChoicesResponse"},"legacyExamples":[{"name":"SetCustomizationChoices","type":"METHOD","content":{"title":"Sets choices to an existing customization","description":"Sets given choices to an existing customization instead of their current ones","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/customizations/4c7fd83b-f17b-4e2f-a0ce-4758201fd464/set-choices' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"choices\": [\n {\n \"choiceType\": \"ONE_COLOR\",\n \"name\": \"White\",\n \"colorCode\": \"#FFFFFF\"\n },\n {\n \"choiceType\": \"ONE_COLOR\",\n \"name\": \"Red\",\n \"colorCode\": \"#FF0000\"\n }\n ]\n }'","response":"{\n \"customization\": {\n \"id\": \"6f13ad1c-c49e-4279-b49c-35f8b6c05eaf\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-27T12:32:48.120Z\",\n \"updatedDate\": \"2024-07-03T08:36:53.175Z\",\n \"key\": \"Color Scheme\",\n \"name\": \"Color Scheme\",\n \"customizationType\": \"MODIFIER\",\n \"customizationRenderType\": \"SWATCH_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"0045afd2-d037-43a8-b2e6-60a015fc75cd\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"White\",\n \"name\": \"White\",\n \"colorCode\": \"#FFFFFF\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"c0a1be19-4f1a-4843-9e1f-8befd0602ad9\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Red\",\n \"name\": \"Red\",\n \"colorCode\": \"#FF0000\",\n \"assignedProductsCount\": 0\n }]\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/customizations/{customizationId}/set-choices","rpcOnly":false,"triggeredEvents":[{"title":"Customization Updated","description":"Triggered when a customization is updated.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.customization","serviceName":"wix.stores.catalog.customization.v3.CustomizationService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.customization_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.customization.v3.CustomizationService","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DOESNT_SUPPORT_CHOICES"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CHOICES_LIMIT_EXCEEDED","errorSchemaName":"wix.stores.catalog.customization.v3.CustomizationIdsWrapper"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.CUSTOMIZATION_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores.catalog:customization","serviceArtifactId":"com.wixpress.stores.catalog.customization","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.customization.v3.SetCustomizationChoicesRequest","responseMessage":"wix.stores.catalog.customization.v3.SetCustomizationChoicesResponse"},"legacyExamples":[{"name":"SetCustomizationChoices","type":"METHOD","content":{"title":"Sets choices to an existing customization","description":"Sets given choices to an existing customization instead of their current ones","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/customizations/4c7fd83b-f17b-4e2f-a0ce-4758201fd464/set-choices' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"choices\": [\n {\n \"choiceType\": \"ONE_COLOR\",\n \"name\": \"White\",\n \"colorCode\": \"#FFFFFF\"\n },\n {\n \"choiceType\": \"ONE_COLOR\",\n \"name\": \"Red\",\n \"colorCode\": \"#FF0000\"\n }\n ]\n }'","response":"{\n \"customization\": {\n \"id\": \"6f13ad1c-c49e-4279-b49c-35f8b6c05eaf\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-27T12:32:48.120Z\",\n \"updatedDate\": \"2024-07-03T08:36:53.175Z\",\n \"key\": \"Color Scheme\",\n \"name\": \"Color Scheme\",\n \"customizationType\": \"MODIFIER\",\n \"customizationRenderType\": \"SWATCH_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"0045afd2-d037-43a8-b2e6-60a015fc75cd\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"White\",\n \"name\": \"White\",\n \"colorCode\": \"#FFFFFF\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"c0a1be19-4f1a-4843-9e1f-8befd0602ad9\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Red\",\n \"name\": \"Red\",\n \"colorCode\": \"#FF0000\",\n \"assignedProductsCount\": 0\n }]\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Set Customization Choices","slugifiedName":"set-customization-choices"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Customization write in v3 catalog","scopeId":"SCOPE.STORES.CUSTOMIZATION_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Remove Customization Choices","description":"Removes choices from a customization.\n\n+> **Note:** A choice cannot be removed if it is assigned to one or more products.","operationId":"wix.stores.catalog.customization.v3.CustomizationService.RemoveCustomizationChoices","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"customizationId","description":"Customization ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.RemoveCustomizationChoicesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/customizations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/customizations","destinationPath":"/v3/customizations","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"RemoveCustomizationChoicesRequest","description":"","properties":{"choiceIds":{"description":"IDs of choices to remove.","format":"GUID","minItems":1,"maxItems":100,"title":"choiceIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Customization revision.","title":"revision","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["customizationId","choiceIds"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Customization Updated","description":"Triggered when a customization is updated.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.customization","serviceName":"wix.stores.catalog.customization.v3.CustomizationService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.customization_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.customization.v3.CustomizationService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CHOICE_ASSIGNED_TO_PRODUCT"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.CUSTOMIZATION_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores.catalog:customization","serviceArtifactId":"com.wixpress.stores.catalog.customization","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.customization.v3.RemoveCustomizationChoicesRequest","responseMessage":"wix.stores.catalog.customization.v3.RemoveCustomizationChoicesResponse"},"legacyExamples":[{"name":"RemoveCustomizationChoices","type":"METHOD","content":{"title":"Removes choices from existing customization","description":"Removes choices from customization based on the customization and choices id's","request":"curl -X POST \\\n'https://www.wixapis.com/stores/v3/customizations/06b6abfd-002d-437d-ad08-91f8537cd96d/remove-choices' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"choiceIds\": [\n \"ef6bf1ca-bdc8-4158-af95-c299de38dec6\"\n ]\n}'","response":"{\n \"customization\": {\n \"id\": \"06b6abfd-002d-437d-ad08-91f8537cd96d\",\n \"revision\": \"6\",\n \"createdDate\": \"2024-06-26T09:44:11.306Z\",\n \"updatedDate\": \"2024-07-03T08:47:13.456Z\",\n \"key\": \"Color\",\n \"name\": \"Color\",\n \"customizationType\": \"PRODUCT_OPTION\",\n \"customizationRenderType\": \"SWATCH_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"92e94db7-832c-42fd-be1e-55670df24ccf\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Blue\",\n \"name\": \"Blue\",\n \"colorCode\": \"#0000FF\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"30be51d2-cc1e-4ef6-84c0-ac59f9410bc2\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Yellow\",\n \"name\": \"Yellow\",\n \"colorCode\": \"#FFFF00\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"4e787c64-8901-4031-b4cc-63bb9fa0a96a\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Green\",\n \"name\": \"Green\",\n \"colorCode\": \"#008000\",\n \"assignedProductsCount\": 0\n }]\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/customizations/{customizationId}/remove-choices","rpcOnly":false,"triggeredEvents":[{"title":"Customization Updated","description":"Triggered when a customization is updated.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.customization","serviceName":"wix.stores.catalog.customization.v3.CustomizationService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.customization_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.customization.v3.CustomizationService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CHOICE_ASSIGNED_TO_PRODUCT"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.CUSTOMIZATION_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores.catalog:customization","serviceArtifactId":"com.wixpress.stores.catalog.customization","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.customization.v3.RemoveCustomizationChoicesRequest","responseMessage":"wix.stores.catalog.customization.v3.RemoveCustomizationChoicesResponse"},"legacyExamples":[{"name":"RemoveCustomizationChoices","type":"METHOD","content":{"title":"Removes choices from existing customization","description":"Removes choices from customization based on the customization and choices id's","request":"curl -X POST \\\n'https://www.wixapis.com/stores/v3/customizations/06b6abfd-002d-437d-ad08-91f8537cd96d/remove-choices' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"choiceIds\": [\n \"ef6bf1ca-bdc8-4158-af95-c299de38dec6\"\n ]\n}'","response":"{\n \"customization\": {\n \"id\": \"06b6abfd-002d-437d-ad08-91f8537cd96d\",\n \"revision\": \"6\",\n \"createdDate\": \"2024-06-26T09:44:11.306Z\",\n \"updatedDate\": \"2024-07-03T08:47:13.456Z\",\n \"key\": \"Color\",\n \"name\": \"Color\",\n \"customizationType\": \"PRODUCT_OPTION\",\n \"customizationRenderType\": \"SWATCH_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"92e94db7-832c-42fd-be1e-55670df24ccf\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Blue\",\n \"name\": \"Blue\",\n \"colorCode\": \"#0000FF\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"30be51d2-cc1e-4ef6-84c0-ac59f9410bc2\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Yellow\",\n \"name\": \"Yellow\",\n \"colorCode\": \"#FFFF00\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"4e787c64-8901-4031-b4cc-63bb9fa0a96a\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Green\",\n \"name\": \"Green\",\n \"colorCode\": \"#008000\",\n \"assignedProductsCount\": 0\n }]\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Remove Customization Choices","slugifiedName":"remove-customization-choices"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Customization write in v3 catalog","scopeId":"SCOPE.STORES.CUSTOMIZATION_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Bulk Add Customization Choices","description":"Adds choices to multiple customizations.","operationId":"wix.stores.catalog.customization.v3.CustomizationService.BulkAddCustomizationChoices","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.BulkAddCustomizationChoicesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/bulk/customizations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/customizations","destinationPath":"/v3/bulk/customizations","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkAddCustomizationChoicesRequest","description":"","properties":{"customizationsChoices":{"description":"List of customization IDs and choices.","minItems":1,"maxItems":100,"title":"customizationsChoices","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.CustomizationChoices"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the full customization entities in the response.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["customizationsChoices","customizationsChoices.customizationId","customizationsChoices.choices"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Customization Updated","description":"Triggered when a customization is updated.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.customization","serviceName":"wix.stores.catalog.customization.v3.CustomizationService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.customization_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.customization.v3.CustomizationService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CHOICES_LIMIT_EXCEEDED","errorSchemaName":"wix.stores.catalog.customization.v3.CustomizationIdsWrapper"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DOESNT_SUPPORT_CHOICES"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.CUSTOMIZATION_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores.catalog:customization","serviceArtifactId":"com.wixpress.stores.catalog.customization","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.customization.v3.BulkAddCustomizationChoicesRequest","responseMessage":"wix.stores.catalog.customization.v3.BulkAddCustomizationChoicesResponse"},"legacyExamples":[{"name":"BulkAddCustomizationChoices","type":"METHOD","order":2,"content":{"title":"Bulk Add Customization Choices","description":"Adds given sets of choices to their matching customizations, with return entity","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/bulk/customizations/add-choices' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n\t\"customizationsChoices\": [\n {\n \"choices\": [\n {\n \"choiceType\": \"CHOICE_TEXT\",\n \"name\": \"Extra Slim\"\n }\n ],\n \"customizationId\": \"a17b9a5f-85c3-4e54-b914-1a9d3e1b6f26\"\n },\n {\n \"choices\": [\n {\n \"name\": \"Purple\",\n \"choiceType\": \"ONE_COLOR\",\n \"colorCode\": \"#A020F0\"\n },\n {\n \"choiceType\": \"ONE_COLOR\",\n \"name\": \"Orange\",\n \"colorCode\": \"#FFA500\"\n }\n ],\n \"customizationId\": \"55e1b16b-0804-48d5-9b62-0a869d5875c0\"\n }\n ],\n \"returnEntity\": true\n }'","response":"{\n \"results\": [{\n \"itemMetadata\": {\n \"id\": \"a17b9a5f-85c3-4e54-b914-1a9d3e1b6f26\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"customization\": {\n \"id\": \"a17b9a5f-85c3-4e54-b914-1a9d3e1b6f26\",\n \"revision\": \"7\",\n \"createdDate\": \"2024-06-27T12:32:48.120Z\",\n \"updatedDate\": \"2024-07-03T08:40:51.915Z\",\n \"key\": \"Fit\",\n \"name\": \"Fit\",\n \"customizationType\": \"PRODUCT_OPTION\",\n \"customizationRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"b3e55e5a-8c0a-4b34-8360-63d5e9b81c1b\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Extra Slim\",\n \"name\": \"Extra Slim\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"1e1f4a55-d6ed-4c1f-888d-e9d1b51c75c1\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Extra loose\",\n \"name\": \"Extra loose\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"d3a3451a-1560-4e92-9cda-3c07d4b3b062\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Regular\",\n \"name\": \"Regular\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"5eddbd2d-89d2-40ba-93cc-0e379214de25\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Slim\",\n \"name\": \"Slim\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"fea63d5c-d996-4626-9ff8-64f5a8eeb64d\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Loose\",\n \"name\": \"Loose\",\n \"assignedProductsCount\": 0\n }]\n }\n }\n }, {\n \"itemMetadata\": {\n \"id\": \"55e1b16b-0804-48d5-9b62-0a869d5875c0\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"customization\": {\n \"id\": \"55e1b16b-0804-48d5-9b62-0a869d5875c0\",\n \"revision\": \"6\",\n \"createdDate\": \"2024-06-27T12:32:48.120Z\",\n \"updatedDate\": \"2024-07-03T08:40:51.916Z\",\n \"key\": \"Color\",\n \"name\": \"Color\",\n \"customizationType\": \"PRODUCT_OPTION\",\n \"customizationRenderType\": \"SWATCH_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"cb5b0b97-01e2-4fd9-8379-fd1b21db1ea4\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Purple\",\n \"name\": \"Purple\",\n \"colorCode\": \"#A020F0\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"2f0f8d1b-94ec-44a6-b7de-d2c22b1e9dbd\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Orange\",\n \"name\": \"Orange\",\n \"colorCode\": \"#FFA500\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"e7c9b39b-7f5e-418e-87d3-6e900b1237c1\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Blue\",\n \"name\": \"Blue\",\n \"colorCode\": \"#0000FF\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"a380a2e3-d54d-4b95-bae7-7e3065ebd27d\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Yellow\",\n \"name\": \"Yellow\",\n \"colorCode\": \"#FFFF00\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"5efdfc5a-90a5-4111-b4d2-234378b520d1\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Green\",\n \"name\": \"Green\",\n \"colorCode\": \"#008000\",\n \"assignedProductsCount\": 0\n }]\n }\n }\n }],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n }"}},{"name":"BulkAddCustomizationChoices","type":"METHOD","order":1,"content":{"title":"Bulk Add Customization Choices","description":"Adds given sets of choices to their matching customizations, without return entity","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/bulk/customizations/add-choices' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n\t\"customizationsChoices\": [\n {\n \"choices\": [\n {\n \"choiceType\": \"CHOICE_TEXT\",\n \"name\": \"Extra Slim\"\n }\n ],\n \"customizationId\": \"a17b9a5f-85c3-4e54-b914-1a9d3e1b6f26\"\n },\n {\n \"choices\": [\n {\n \"name\": \"Purple\",\n \"choiceType\": \"ONE_COLOR\",\n \"colorCode\": \"#A020F0\"\n },\n {\n \"choiceType\": \"ONE_COLOR\",\n \"name\": \"Orange\",\n \"colorCode\": \"#FFA500\"\n }\n ],\n \"customizationId\": \"a17b9a5f-85c3-4e54-b914-1a9d3e1b6f26\"\n }\n ]\n }'","response":"{\n \"results\": [{\n \"itemMetadata\": {\n \"id\": \"a17b9a5f-85c3-4e54-b914-1a9d3e1b6f26\",\n \"originalIndex\": 0,\n \"success\": true\n }\n }, {\n \"itemMetadata\": {\n \"id\": \"a17b9a5f-85c3-4e54-b914-1a9d3e1b6f26\",\n \"originalIndex\": 1,\n \"success\": true\n }\n }],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n }"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/customizations/add-choices","rpcOnly":false,"triggeredEvents":[{"title":"Customization Updated","description":"Triggered when a customization is updated.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.customization","serviceName":"wix.stores.catalog.customization.v3.CustomizationService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.customization_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.customization.v3.CustomizationService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CHOICES_LIMIT_EXCEEDED","errorSchemaName":"wix.stores.catalog.customization.v3.CustomizationIdsWrapper"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"DOESNT_SUPPORT_CHOICES"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.CUSTOMIZATION_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores.catalog:customization","serviceArtifactId":"com.wixpress.stores.catalog.customization","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.customization.v3.BulkAddCustomizationChoicesRequest","responseMessage":"wix.stores.catalog.customization.v3.BulkAddCustomizationChoicesResponse"},"legacyExamples":[{"name":"BulkAddCustomizationChoices","type":"METHOD","order":2,"content":{"title":"Bulk Add Customization Choices","description":"Adds given sets of choices to their matching customizations, with return entity","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/bulk/customizations/add-choices' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n\t\"customizationsChoices\": [\n {\n \"choices\": [\n {\n \"choiceType\": \"CHOICE_TEXT\",\n \"name\": \"Extra Slim\"\n }\n ],\n \"customizationId\": \"a17b9a5f-85c3-4e54-b914-1a9d3e1b6f26\"\n },\n {\n \"choices\": [\n {\n \"name\": \"Purple\",\n \"choiceType\": \"ONE_COLOR\",\n \"colorCode\": \"#A020F0\"\n },\n {\n \"choiceType\": \"ONE_COLOR\",\n \"name\": \"Orange\",\n \"colorCode\": \"#FFA500\"\n }\n ],\n \"customizationId\": \"55e1b16b-0804-48d5-9b62-0a869d5875c0\"\n }\n ],\n \"returnEntity\": true\n }'","response":"{\n \"results\": [{\n \"itemMetadata\": {\n \"id\": \"a17b9a5f-85c3-4e54-b914-1a9d3e1b6f26\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"customization\": {\n \"id\": \"a17b9a5f-85c3-4e54-b914-1a9d3e1b6f26\",\n \"revision\": \"7\",\n \"createdDate\": \"2024-06-27T12:32:48.120Z\",\n \"updatedDate\": \"2024-07-03T08:40:51.915Z\",\n \"key\": \"Fit\",\n \"name\": \"Fit\",\n \"customizationType\": \"PRODUCT_OPTION\",\n \"customizationRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"b3e55e5a-8c0a-4b34-8360-63d5e9b81c1b\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Extra Slim\",\n \"name\": \"Extra Slim\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"1e1f4a55-d6ed-4c1f-888d-e9d1b51c75c1\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Extra loose\",\n \"name\": \"Extra loose\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"d3a3451a-1560-4e92-9cda-3c07d4b3b062\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Regular\",\n \"name\": \"Regular\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"5eddbd2d-89d2-40ba-93cc-0e379214de25\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Slim\",\n \"name\": \"Slim\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"fea63d5c-d996-4626-9ff8-64f5a8eeb64d\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"Loose\",\n \"name\": \"Loose\",\n \"assignedProductsCount\": 0\n }]\n }\n }\n }, {\n \"itemMetadata\": {\n \"id\": \"55e1b16b-0804-48d5-9b62-0a869d5875c0\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"customization\": {\n \"id\": \"55e1b16b-0804-48d5-9b62-0a869d5875c0\",\n \"revision\": \"6\",\n \"createdDate\": \"2024-06-27T12:32:48.120Z\",\n \"updatedDate\": \"2024-07-03T08:40:51.916Z\",\n \"key\": \"Color\",\n \"name\": \"Color\",\n \"customizationType\": \"PRODUCT_OPTION\",\n \"customizationRenderType\": \"SWATCH_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [{\n \"id\": \"cb5b0b97-01e2-4fd9-8379-fd1b21db1ea4\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Purple\",\n \"name\": \"Purple\",\n \"colorCode\": \"#A020F0\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"2f0f8d1b-94ec-44a6-b7de-d2c22b1e9dbd\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Orange\",\n \"name\": \"Orange\",\n \"colorCode\": \"#FFA500\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"e7c9b39b-7f5e-418e-87d3-6e900b1237c1\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Blue\",\n \"name\": \"Blue\",\n \"colorCode\": \"#0000FF\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"a380a2e3-d54d-4b95-bae7-7e3065ebd27d\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Yellow\",\n \"name\": \"Yellow\",\n \"colorCode\": \"#FFFF00\",\n \"assignedProductsCount\": 0\n }, {\n \"id\": \"5efdfc5a-90a5-4111-b4d2-234378b520d1\",\n \"choiceType\": \"ONE_COLOR\",\n \"key\": \"Green\",\n \"name\": \"Green\",\n \"colorCode\": \"#008000\",\n \"assignedProductsCount\": 0\n }]\n }\n }\n }],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n }"}},{"name":"BulkAddCustomizationChoices","type":"METHOD","order":1,"content":{"title":"Bulk Add Customization Choices","description":"Adds given sets of choices to their matching customizations, without return entity","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/bulk/customizations/add-choices' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n\t\"customizationsChoices\": [\n {\n \"choices\": [\n {\n \"choiceType\": \"CHOICE_TEXT\",\n \"name\": \"Extra Slim\"\n }\n ],\n \"customizationId\": \"a17b9a5f-85c3-4e54-b914-1a9d3e1b6f26\"\n },\n {\n \"choices\": [\n {\n \"name\": \"Purple\",\n \"choiceType\": \"ONE_COLOR\",\n \"colorCode\": \"#A020F0\"\n },\n {\n \"choiceType\": \"ONE_COLOR\",\n \"name\": \"Orange\",\n \"colorCode\": \"#FFA500\"\n }\n ],\n \"customizationId\": \"a17b9a5f-85c3-4e54-b914-1a9d3e1b6f26\"\n }\n ]\n }'","response":"{\n \"results\": [{\n \"itemMetadata\": {\n \"id\": \"a17b9a5f-85c3-4e54-b914-1a9d3e1b6f26\",\n \"originalIndex\": 0,\n \"success\": true\n }\n }, {\n \"itemMetadata\": {\n \"id\": \"a17b9a5f-85c3-4e54-b914-1a9d3e1b6f26\",\n \"originalIndex\": 1,\n \"success\": true\n }\n }],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n }"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Add Customization Choices","slugifiedName":"bulk-add-customization-choices"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Customization write in v3 catalog","scopeId":"SCOPE.STORES.CUSTOMIZATION_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Bulk Update Customizations","description":"Updates multiple customizations.\n\nEach time the customization is updated, `revision` increments by 1.\nThe current `revision` must be passed when updating the customization.\nThis ensures you're working with the latest customization and prevents unintended overwrites.","operationId":"wix.stores.catalog.customization.v3.CustomizationService.BulkUpdateCustomizations","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.BulkUpdateCustomizationsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/bulk/customizations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/customizations","destinationPath":"/v3/bulk/customizations","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkUpdateCustomizationsRequest","description":"","properties":{"customizations":{"description":"List of customizations to update.","minItems":1,"maxItems":100,"title":"customizations","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.MaskedCustomization"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the full customization entities in the response.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["customizations","customizations.customization.name","customizations.customization.revision","customizations.customization.id"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Customization Updated","description":"Triggered when a customization is updated.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.customization","serviceName":"wix.stores.catalog.customization.v3.CustomizationService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.customization_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.customization.v3.CustomizationService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.CUSTOMIZATION_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores.catalog:customization","serviceArtifactId":"com.wixpress.stores.catalog.customization","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.customization.v3.BulkUpdateCustomizationsRequest","responseMessage":"wix.stores.catalog.customization.v3.BulkUpdateCustomizationsResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/customizations/update","rpcOnly":false,"triggeredEvents":[{"title":"Customization Updated","description":"Triggered when a customization is updated.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.customization","serviceName":"wix.stores.catalog.customization.v3.CustomizationService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.customization_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.stores.catalog.customization.v3.CustomizationService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.CUSTOMIZATION_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores.catalog:customization","serviceArtifactId":"com.wixpress.stores.catalog.customization","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.customization.v3.BulkUpdateCustomizationsRequest","responseMessage":"wix.stores.catalog.customization.v3.BulkUpdateCustomizationsResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Update Customizations","slugifiedName":"bulk-update-customizations"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Customization write in v3 catalog","scopeId":"SCOPE.STORES.CUSTOMIZATION_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]}],"webhooks":[{"summary":"Customization Created","title":"Customization Created","description":"Triggered when a customization is created.","permissions":["WIX_STORES.CUSTOMIZATION_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.stores.catalog.v3.customization","serviceName":"wix.stores.catalog.customization.v3.CustomizationService","domainEvent":"CREATED","externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"wix.stores.catalog.v3.customization_created","legacyExamples":[{"name":"CustomizationCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"d48839ac-e6be-4b0f-bc1d-355b29284cd3\",\n \"entityFqdn\": \"wix.stores.catalog.v3.customization\",\n \"slug\": \"created\",\n \"entityId\": \"2bfbbb0f-3323-4313-8b84-0df9df094ba0\",\n \"createdEvent\": {\n \"entityAsJson\": {\n \"id\": \"2bfbbb0f-3323-4313-8b84-0df9df094ba0\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T14:06:45.672Z\",\n \"updatedDate\": \"2024-06-26T14:06:45.672Z\",\n \"key\": \"Sizes\",\n \"name\": \"Sizes\",\n \"customizationType\": \"PRODUCT_OPTION\",\n \"customizationRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"id\": \"ab875db7-c25b-4d40-a41f-03a8edbeca1c\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"XL\",\n \"name\": \"XL\",\n \"assignedProductsCount\": 0\n },\n {\n \"id\": \"c0039c9d-918e-4e2e-b647-a3f6977728f9\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"L\",\n \"name\": \"L\",\n \"assignedProductsCount\": 0\n }\n ]\n }\n }\n },\n \"eventTime\": \"2024-06-26T14:06:45.679626045Z\",\n \"triggeredByAnonymizeRequest\": false,\n \"entityEventSequence\": \"1\"\n }\n\n\n"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Customization","contentLink":{"displayName":"Customization Created","slugifiedName":"customization-created"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Read customizations in v3 catalog","scopeId":"SCOPE.STORES.CUSTOMIZATION_READ"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Customization Updated","title":"Customization Updated","description":"Triggered when a customization is updated.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.customization","serviceName":"wix.stores.catalog.customization.v3.CustomizationService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.customization_updated","legacyExamples":[{"name":"CustomizationUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"eb0d1011-036d-42fe-98bf-022e146108d4\",\n \"entityFqdn\": \"wix.stores.catalog.v3.customization\",\n \"slug\": \"updated\",\n \"entityId\": \"2e686091-e880-40f0-8475-963ef0d547be\",\n \"updatedEvent\": {\n \"currentEntityAsJson\": {\n \"id\": \"2e686091-e880-40f0-8475-963ef0d547be\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-26T14:06:45.672Z\",\n \"updatedDate\": \"2024-06-26T14:18:49.167Z\",\n \"key\": \"Shirt Sizes\",\n \"name\": \"Shirt Sizes\",\n \"customizationType\": \"PRODUCT_OPTION\",\n \"customizationRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"id\": \"5e6526ad-0584-4e38-b25c-162ed92160d3\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"XL\",\n \"name\": \"XL\",\n \"assignedProductsCount\": 0\n },\n {\n \"id\": \"133db3c5-e3fb-4ee4-992d-10c85aae7c12\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"L\",\n \"name\": \"L\",\n \"assignedProductsCount\": 0\n }\n ]\n }\n }\n },\n \"eventTime\": \"2024-06-26T14:18:49.267061172Z\",\n \"triggeredByAnonymizeRequest\": false,\n \"entityEventSequence\": \"2\"\n}\n"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Customization","contentLink":{"displayName":"Customization Updated","slugifiedName":"customization-updated"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[]},{"summary":"Customization Deleted","title":"Customization Deleted","description":"Triggered when a customization is deleted.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.stores.catalog.v3.customization","serviceName":"wix.stores.catalog.customization.v3.CustomizationService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.customization_deleted","legacyExamples":[{"name":"CustomizationDeleted","eventType":"DELETED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"e18d36ef-b012-4105-a3f3-7ae89daf7dd0\",\n \"entityFqdn\": \"wix.stores.catalog.v3.customization\",\n \"slug\": \"deleted\",\n \"entityId\": \"38715c2b-5525-48cf-926d-54f118aa290f\",\n \"deletedEvent\": {\n \"movedToTrash\": true,\n \"deletedEntityAsJson\": {\n \"id\": \"38715c2b-5525-48cf-926d-54f118aa290f\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-26T14:06:45.672Z\",\n \"updatedDate\": \"2024-06-26T14:18:49.167Z\",\n \"key\": \"Shirt Sizes\",\n \"name\": \"Shirt Sizes\",\n \"customizationType\": \"PRODUCT_OPTION\",\n \"customizationRenderType\": \"TEXT_CHOICES\",\n \"choicesSettings\": {\n \"choices\": [\n {\n \"id\": \"fc6029be-036a-4634-967f-b74fd73fa3f5\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"XL\",\n \"name\": \"XL\",\n \"assignedProductsCount\": 0\n },\n {\n \"id\": \"889de7a7-df48-4b5c-b21b-88d79e19662d\",\n \"choiceType\": \"CHOICE_TEXT\",\n \"key\": \"L\",\n \"name\": \"L\",\n \"assignedProductsCount\": 0\n }\n ]\n }\n }\n },\n \"eventTime\": \"2024-06-26T14:28:49.396299332Z\",\n \"triggeredByAnonymizeRequest\": false,\n \"entityEventSequence\": \"12\"\n}\n"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Customization","contentLink":{"displayName":"Customization Deleted","slugifiedName":"customization-deleted"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Customizations API\n\nThe Customization API allows creating and managing customizations, which include options and modifiers, which later will be applied to products, for customer’s customizes or adds on to the product.\nOptions are meant to add variations to a product which required inventory, where modifiers allow users to collect additional information per product from customers without creating variants affecting inventory.\nOptions and modifiers can be defined together on one product. The options will create variants that may be customized by the customer.\nWith the Customization API, you can manage your site's customizations:\n+ Create and manage a bank of Customizations.\n+ Update entire Customizations or just specific fields.\n+ Delete existing Customizations.\n+ Retrieve information about existing customization.\n\n## Before you begin\n\nIt’s important to note the following points before starting to code:\n+ The Customization API only works with the Wix Stores app. Make sure you have installed this app from the [Wix App Market](fallback::https://www.wix.com/app-market/wix-stores).\n\n## Use cases\n\n+ [Set up and retrieve basic customizations for a clothing store](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/customizations-v3/sample-flows)\n\n## Terminology\n\n+ __Customizations__ are property types that customers can select within the specific product - e.g., Color and Size.\n+ If customization affects inventory, sku and so on we call such customization __Option__. Those __Options__ are basically the product's variants. For example, a T-shirt with 2 Color __Options__: Red and Blue. Each has its own price, sku and inventory.\n+ If customization does not affect inventory and sku, we call such customization __Modifier__. Having a modifier will not affect the variants that will be sent to the customer, but it will add specific customization to it.\nFor example if you sell Ice Cream and allow to select one of different Toppings: Vanilla, Caramel or Chocolate - each is a choice of the Toppings Modifier. It doesn't affect available ice creams in stock.\n+ __Choices__ are the available selections within each customization - e.g., Red and Green choices under the Color option customization.\n + CHOICE_TEXT - The corresponding choice type for Text Choices.\n + ONE_COLOR - The corresponding choice type for Swatch Choices. Also includes a parameter for the relevant color scheme.\n+ CustomizationRenderType: The type of the option or modifier, which needs to match for every choice used:\n + TextChoices - Choices that are text based (e.g., \"small\", \"medium\", \"large\"). Needs to be matched with CHOICE_TEXT choices.\n + SwatchChoices - Choices that are colors. Needs to be matched with ONE_COLOR choices.\n + FreeText - Enables entering of free text without giving predefined choices of the customization. Only usable for a Modifier (not an Option).\n+ __Variant__: A single, specific product determined by the combination of selected options (e.g., a red, size M t-shirt).\n\n"},{"displayName":"Sample Flows","slugifyName":"sample-flows","content":"# Sample Flow\n\nThis article shares a possible use case your app could support, as well as a sample flow that could support this use case. This can be a helpful jumping-off point as you plan your app's implementation.\n\n## Set up and retrieve basic customizations for a clothing store\n\n1. [Create a Customization with Option type](fallback::./examples/CreateCustomization.2.curl), which will have different product colors: red, green, blue.\n + Render type must be SwatchChoices and choice types must be ONE_COLOR.\n2. [Create a Customization with Option type](fallback::./examples/CreateCustomization.1.curl), which will have different product sizes: S, M, L, XL.\n + Render type must be TextChoices and choice types must be CHOICE_TEXT.\n3. [Create a Customization with Modifier type](fallback::./examples/CreateCustomization.3.curl), in order to specify free text to be on a product.\n + Render type must be FreeText.\n + Set freeTextInput's title to \"Choose text to be on shirt\", and have a 10 char count minimum.\n4. Use [add customization choices method](fallback::./examples/AddCustomizationChoices.curl) to add more color choices on Color customization (for example add the color yellow - color code #FFFF00).\n5. [Query](fallback::./examples/QueryCustomizations.3.curl) for all the Product options of type SWATCH_CHOICES (colors) - should return one result.\n\n\n## Create product with new option\n\nIn order to assign a new non-existing option to a new product, you can provide the option to the Create Product request.\n\nTo do this, your app can call Create Product with [Create Product](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/create-product)\nand assign a new option to the product by passing a the `name`, `option_render_type` and `choices`:\n```json\n{\n \"product\": {\n \"name\": \"Running Shoes\",\n \"physical_properties\": {},\n \"product_type\": \"PHYSICAL\",\n \"options\": [\n {\n \"name\": \"Size\",\n \"option_render_type\": \"TEXT_CHOICES\",\n \"choices_settings\": {\n \"choices\": [\n {\n \"name\": \"32\",\n \"choice_type\": \"CHOICE_TEXT\"\n },\n {\n \"name\": \"33\",\n \"choice_type\": \"CHOICE_TEXT\"\n },\n {\n \"name\": \"34\",\n \"choice_type\": \"CHOICE_TEXT\"\n }\n ]\n }\n }\n ],\n \"variants_info\": {\n \"variants\": [\n {\n \"choices\": [\n {\n \"option_choice_names\": {\n \"choice_name\": \"32\",\n \"option_name\": \"Size\",\n \"render_type\": \"TEXT_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"base_price\": {\n \"amount\": \"47\"\n }\n }\n },\n {\n \"choices\": [\n {\n \"option_choice_names\": {\n \"choice_name\": \"33\",\n \"option_name\": \"Size\",\n \"render_type\": \"TEXT_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"base_price\": {\n \"amount\": \"47\"\n }\n }\n }\n ]\n }\n }\n}\n```\n> Note that if an option with `option.name` already exists, it will assign the existing option to the product.\n\n## Create product with new modifier\n\nIn order to assign a new non-existing modifier to a new product, you can provide the modifier to the Create Product request.\n\nTo do this, your app can call Create Product with [Create Product](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/create-product)\nand assign a new option to the product by passing a the `name`, `modifier_render_type` and `free_text_settings`:\n```json\n{\n \"product\": {\n \"name\": \"T-Shirt\",\n \"physical_properties\": {},\n \"product_type\": \"PHYSICAL\",\n \"modifiers\": [\n {\n \"name\": \"Text on T-Shirt\",\n \"modifier_render_type\": \"FREE_TEXT\",\n \"mandatory\": true,\n \"free_text_settings\": {\n \"title\": \"Choose text to be on shirt\",\n \"max_char_count\": 20,\n \"min_char_count\": 10\n }\n }\n ],\n \"variants_info\": {\n \"variants\": [\n {\n \"price\": {\n \"base_price\": {\n \"amount\": \"17\"\n }\n }\n }\n ]\n }\n }\n}\n```\n> Note that if a modifier with `modifier.name` already exists, it will assign the existing modifier to the product.\n\n"},{"displayName":"Supported Filters and Sorting","slugifyName":"supported-filters-and-sorting","content":"# Customizations: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting for the customization object:\n\n| Field | Supported Filters | Sortable |\n|---------------------------|------------------------------------------------------------------------|----------|\n| `id` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | Sortable |\n| `createdDate` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$le`, `$gt`, `$ge` | Sortable |\n| `updatedDate` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$le`, `$gt`, `$ge` | Sortable |\n| `name` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | Sortable |\n| `customizationType` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome` | |\n| `customizationRenderType` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome` | |\n\n\n__Related content:__\n[API Query Language](fallback::https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),\n[Query Customizations](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/customizations-v3/query-customizations)"}],"components":{"schemas":{"wix.stores.catalog.customization.v3.Customization":{"type":"object","properties":{"id":{"description":"Customization ID.","minLength":1,"maxLength":36,"readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time the customization is updated.\nTo prevent conflicting changes,\nthe current revision must be passed when updating the customization.\n\nIgnored when creating a customization.","readOnly":true,"title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the customization was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the customization was updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Customization name for options (for example, `\"color\"`, `\"size\"`) and modifiers (for example, `\"greeting card\"`).","minLength":1,"maxLength":50,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"customizationType":{"description":"Customization type.","immutable":true,"title":"customizationType","type":"string","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.CustomizationType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"customizationRenderType":{"description":"Customization render type.\n\nDefines how the customization will be displayed in the storefront.","immutable":true,"title":"customizationRenderType","type":"string","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.CustomizationRenderType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"assignedProductsCount":{"description":"Number of products this customization is assigned to.\n> **Note:** Returned only when you pass `\"ASSIGNED_PRODUCTS_COUNT\"` to the `fields` array in Customizations API requests.","readOnly":true,"title":"assignedProductsCount","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Customization","description":"Customizations include options and modifiers which can later be applied to products.\nOptions are designed to add variations to a product, where modifiers add a customizable change to the product but without creating another variant.","oneOf":[{"description":"","summary":"customizationSettings","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Customization.customizationSettings"}]},"wix.stores.catalog.customization.v3.Customization.customizationSettings":{"type":"object","title":"customizationSettings","properties":{"freeTextInput":{"description":"Free text input settings.\n\n> **Note:** To be passed along with `customizationRenderType: FREE_TEXT`.","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.FreeTextSettings","summary":"freeTextInput","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"choicesSettings":{"description":"Choices settings.\n\n> **Note:** Must be passed along with `customizationRenderType` of `SWATCH_CHOICES` and `TEXT_CHOICES`.","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.ChoicesSettings","summary":"choicesSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"wix.stores.catalog.customization.v3.CustomizationType":{"type":"string","description":"","title":"CustomizationType","enum":["UNKNOWN_CUSTOMIZATION_TYPE","PRODUCT_OPTION","MODIFIER"]},"wix.stores.catalog.customization.v3.CustomizationRenderType":{"type":"string","description":"","title":"CustomizationRenderType","enum":["UNKNOWN_CUSTOMIZATION_RENDER_TYPE","FREE_TEXT","TEXT_CHOICES","SWATCH_CHOICES"]},"wix.stores.catalog.customization.v3.FreeTextSettings":{"type":"object","properties":{"minCharCount":{"description":"Minimum text character length.","title":"minCharCount","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"maxCharCount":{"description":"Maximum text character length.","maximum":500,"title":"maxCharCount","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"defaultAddedPrice":{"description":"Default amount added to a product's price when this choice is assigned to a modifier.","title":"defaultAddedPrice","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0","lte":"999999999","maxScale":3}}},"title":{"description":"Title to display to customer for their free-text input.","minLength":1,"maxLength":150,"title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FreeTextSettings","description":""},"wix.stores.catalog.customization.v3.ChoicesSettings":{"type":"object","properties":{"choices":{"description":"List of choices.","minItems":1,"maxItems":200,"immutable":true,"title":"choices","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Choice"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ChoicesSettings","description":""},"wix.stores.catalog.customization.v3.Choice":{"type":"object","properties":{"id":{"description":"Choice ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"choiceType":{"description":"Choice type.\n\n> **Notes:**\n> + For `customizationRenderType: SWATCH_CHOICES`, the supported `choiceType` values are: `ONE_COLOR`, `MULTIPLE_COLORS`, or `IMAGE`.\n> + For a `customizationRenderType` of `TEXT_CHOICES` and `FREE_TEXT`, the supported `choiceType` value is: `CHOICE_TEXT`.","immutable":true,"title":"choiceType","type":"string","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.ChoiceType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"key":{"description":"A read-only key generated based on choice name. Used for eCommerce integration.","readOnly":true,"minLength":1,"maxLength":50,"title":"key","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Choice name.","minLength":1,"maxLength":50,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"defaultAddedPrice":{"description":"Default amount added to a product's price when this customization is assigned to a modifier.","title":"defaultAddedPrice","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0","lte":"999999999","maxScale":3}}},"assignedProductsCount":{"description":"Number of products this choice is assigned to .","readOnly":true,"title":"assignedProductsCount","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Choice","description":"","oneOf":[{"description":"","summary":"value","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Choice.value"}]},"wix.stores.catalog.customization.v3.Choice.value":{"type":"object","title":"value","properties":{"colorCode":{"description":"Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).","minLength":3,"maxLength":20,"format":"COLOR_HEX","title":"colorCode","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.stores.catalog.customization.v3.ChoiceType":{"type":"string","description":"","title":"ChoiceType","enum":["UNKNOWN_CHOICE_TYPE","CHOICE_TEXT","ONE_COLOR","MULTIPLE_COLORS","IMAGE"]},"wix.stores.catalog.customization.v3.MultipleColors":{"type":"object","properties":{"colorCodes":{"description":"A list of color codes.","minLength":3,"maxLength":20,"minItems":2,"maxItems":2,"title":"colorCodes","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MultipleColors","description":""},"wix.common.Image":{"type":"object","properties":{"id":{"description":"WixMedia image ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"Image URL.","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"Original image height.","readOnly":true,"title":"height","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"Original image width.","readOnly":true,"title":"width","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"altText":{"description":"Image alt text.","title":"altText","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filename":{"description":"Image filename.","readOnly":true,"title":"filename","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Image","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"com.wixpress.html.cache.invalidate.InvalidateCache":{"type":"object","properties":{"reason":{"description":"tell us why you're invalidating the cache. You don't need to add your app name","maxLength":256,"title":"reason","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"localDc":{"description":"Is local DS","title":"localDc","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InvalidateCache","description":"","oneOf":[{"description":"","summary":"getBy","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.getBy"}]},"com.wixpress.html.cache.invalidate.InvalidateCache.getBy":{"type":"object","title":"getBy","properties":{"metaSiteId":{"description":"Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteId":{"description":"Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!","format":"GUID","title":"siteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"app":{"description":"Invalidate by App","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.App","summary":"app","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"page":{"description":"Invalidate by page id","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.Page","summary":"page","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"uri":{"description":"Invalidate by URI path","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.URI","summary":"uri","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"file":{"description":"Invalidate by file (for media files such as PDFs)","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.File","summary":"file","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.html.cache.invalidate.InvalidateCache.App":{"type":"object","properties":{"appDefId":{"description":"The AppDefId","minLength":1,"title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"The instance Id","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"App","description":""},"com.wixpress.html.cache.invalidate.InvalidateCache.Page":{"type":"object","properties":{"metaSiteId":{"description":"the msid the page is on","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pageId":{"description":"Invalidate by Page ID","minLength":1,"title":"pageId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Page","description":""},"com.wixpress.html.cache.invalidate.InvalidateCache.URI":{"type":"object","properties":{"metaSiteId":{"description":"the msid the URI is on","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"uriPath":{"description":"URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes","minLength":1,"title":"uriPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"URI","description":""},"com.wixpress.html.cache.invalidate.InvalidateCache.File":{"type":"object","properties":{"metaSiteId":{"description":"the msid the file is related to","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fileName":{"description":"Invalidate by filename (for media files such as PDFs)","minLength":1,"maxLength":256,"title":"fileName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"File","description":""},"wix.stores.catalog.customization.v3.CreateCustomizationRequest":{"type":"object","properties":{"customization":{"description":"Customization to create.","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Customization","summary":"customization","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateCustomizationRequest","description":""},"wix.stores.catalog.customization.v3.CreateCustomizationResponse":{"type":"object","properties":{"customization":{"description":"Created customization.","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Customization","summary":"customization","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateCustomizationResponse","description":""},"wix.stores.catalog.customization.v3.GetCustomizationRequest":{"type":"object","properties":{"customizationId":{"description":"Customization ID.","format":"GUID","title":"customizationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetCustomizationRequest","description":""},"wix.stores.catalog.customization.v3.RequestedFields":{"type":"string","description":"","title":"RequestedFields","enum":["UNKNOWN_REQUESTED_FIELD","ASSIGNED_PRODUCTS_COUNT"]},"wix.stores.catalog.customization.v3.GetCustomizationResponse":{"type":"object","properties":{"customization":{"description":"Customization.","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Customization","summary":"customization","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetCustomizationResponse","description":""},"wix.stores.catalog.customization.v3.UpdateCustomizationRequest":{"type":"object","properties":{"customization":{"description":"Customization to update.","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Customization","summary":"customization","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateCustomizationRequest","description":""},"google.protobuf.FieldMask":{"type":"object","properties":{"paths":{"description":"","title":"paths","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FieldMask","description":""},"wix.stores.catalog.customization.v3.UpdateCustomizationResponse":{"type":"object","properties":{"customization":{"description":"Updated customization.","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Customization","summary":"customization","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateCustomizationResponse","description":""},"wix.stores.catalog.customization.v3.DeleteCustomizationRequest":{"type":"object","properties":{"customizationId":{"description":"Customization ID.","format":"GUID","title":"customizationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteCustomizationRequest","description":""},"wix.stores.catalog.customization.v3.DeleteCustomizationResponse":{"type":"object","properties":{},"title":"DeleteCustomizationResponse","description":""},"wix.stores.catalog.customization.v3.QueryCustomizationsRequest":{"type":"object","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.upstream.wix.common.CursorQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryCustomizationsRequest","description":""},"wix.stores.catalog.customization.v3.upstream.wix.common.CursorQuery":{"type":"object","properties":{"filter":{"description":"Filter object in the following format:\n`\"filter\" : {\n\"fieldName1\": \"value1\",\n\"fieldName2\":{\"$operator\":\"value2\"}\n}`\nExample of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object in the following format:\n`[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`","maxItems":5,"title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorQuery","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.upstream.wix.common.CursorQuery.pagingMethod"}]},"wix.stores.catalog.customization.v3.upstream.wix.common.CursorQuery.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"cursorPaging":{"description":"Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"wix.stores.catalog.customization.v3.upstream.wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","maxLength":512,"title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.","title":"order","type":"string","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.upstream.wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"wix.stores.catalog.customization.v3.upstream.wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"wix.stores.catalog.customization.v3.upstream.wix.common.CursorPaging":{"type":"object","properties":{"limit":{"description":"Maximum number of items to return in the results.","minimum":0,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursor":{"description":"Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request.","maxLength":16000,"title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPaging","description":""},"wix.stores.catalog.customization.v3.QueryCustomizationsResponse":{"type":"object","properties":{"customizations":{"description":"List of customizations.","minItems":1,"maxItems":100,"title":"customizations","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Customization"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Details on the paged set of results returned.","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.upstream.wix.common.CursorPagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryCustomizationsResponse","description":""},"wix.stores.catalog.customization.v3.upstream.wix.common.CursorPagingMetadata":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Cursor strings that point to the next page, previous page, or both.","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.upstream.wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hasNext":{"description":"Whether there are more pages to retrieve following the current page.\n\n+ `true`: Another page of results can be retrieved.\n+ `false`: This is the last page.","title":"hasNext","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPagingMetadata","description":""},"wix.stores.catalog.customization.v3.upstream.wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor string pointing to the next page in the list of results.","maxLength":16000,"title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to the previous page in the list of results.","maxLength":16000,"title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"wix.stores.catalog.customization.v3.BulkCreateCustomizationsRequest":{"type":"object","properties":{"customizations":{"description":"Customizations to create.","minItems":1,"maxItems":100,"title":"customizations","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Customization"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the full customization entities in the response.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateCustomizationsRequest","description":""},"wix.stores.catalog.customization.v3.BulkCreateCustomizationsResponse":{"type":"object","properties":{"results":{"description":"Customizations created by bulk action.","minItems":1,"maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.BulkCustomizationResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateCustomizationsResponse","description":""},"wix.stores.catalog.customization.v3.BulkCustomizationResult":{"type":"object","properties":{"itemMetadata":{"description":"Bulk action metadata for customization.","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.upstream.wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"customization":{"description":"Full customization entity.\n\nReturned only if `returnEntity: true` is passed in the request.","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Customization","summary":"customization","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCustomizationResult","description":""},"wix.stores.catalog.customization.v3.upstream.wix.common.ItemMetadata":{"type":"object","properties":{"id":{"description":"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).","minLength":1,"maxLength":36,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originalIndex":{"description":"Index of the item within the request array. Allows for correlation between request and response items.","title":"originalIndex","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"success":{"description":"Whether the requested action was successful for this item. When `false`, the `error` field is populated.","title":"success","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"error":{"description":"Details about the error in case of failure.","$ref":"#/components/schemas/wix.api.ApplicationError","summary":"error","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemMetadata","description":""},"wix.api.ApplicationError":{"type":"object","properties":{"code":{"description":"Error code.","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Description of the error.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Data related to the error.","title":"data","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ApplicationError","description":""},"wix.stores.catalog.customization.v3.upstream.wix.common.BulkActionMetadata":{"type":"object","properties":{"totalSuccesses":{"description":"Number of items that were successfully processed.","title":"totalSuccesses","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalFailures":{"description":"Number of items that couldn't be processed.","title":"totalFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"undetailedFailures":{"description":"Number of failures without details because detailed failure threshold was exceeded.","title":"undetailedFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkActionMetadata","description":""},"wix.stores.catalog.customization.v3.CustomizationIdsWrapper":{"type":"object","properties":{"customizationIds":{"description":"list of all the customization ids that are invalid\ne.g list of failed choices ids","minItems":1,"maxItems":100,"minLength":1,"maxLength":36,"title":"customizationIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CustomizationIdsWrapper","description":""},"wix.stores.catalog.customization.v3.AddCustomizationChoicesRequest":{"type":"object","properties":{"customizationId":{"description":"Customization ID.","format":"GUID","title":"customizationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"choices":{"description":"Choices to add.","minItems":1,"maxItems":100,"title":"choices","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Choice"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AddCustomizationChoicesRequest","description":""},"wix.stores.catalog.customization.v3.AddCustomizationChoicesResponse":{"type":"object","properties":{"customization":{"description":"Updated customization.","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Customization","summary":"customization","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AddCustomizationChoicesResponse","description":""},"wix.stores.catalog.customization.v3.SetCustomizationChoicesRequest":{"type":"object","properties":{"customizationId":{"description":"Customization ID.","format":"GUID","title":"customizationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"choices":{"description":"Choices to set.","minItems":1,"maxItems":100,"title":"choices","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Choice"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SetCustomizationChoicesRequest","description":""},"wix.stores.catalog.customization.v3.SetCustomizationChoicesResponse":{"type":"object","properties":{"customization":{"description":"Updated customization.","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Customization","summary":"customization","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SetCustomizationChoicesResponse","description":""},"wix.stores.catalog.customization.v3.RemoveCustomizationChoicesRequest":{"type":"object","properties":{"customizationId":{"description":"Customization ID.","format":"GUID","title":"customizationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"choiceIds":{"description":"IDs of choices to remove.","format":"GUID","minItems":1,"maxItems":100,"title":"choiceIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Customization revision.","title":"revision","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RemoveCustomizationChoicesRequest","description":""},"wix.stores.catalog.customization.v3.RemoveCustomizationChoicesResponse":{"type":"object","properties":{"customization":{"description":"Updated customization.","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Customization","summary":"customization","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RemoveCustomizationChoicesResponse","description":""},"wix.stores.catalog.customization.v3.BulkAddCustomizationChoicesRequest":{"type":"object","properties":{"customizationsChoices":{"description":"List of customization IDs and choices.","minItems":1,"maxItems":100,"title":"customizationsChoices","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.CustomizationChoices"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the full customization entities in the response.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkAddCustomizationChoicesRequest","description":""},"wix.stores.catalog.customization.v3.CustomizationChoices":{"type":"object","properties":{"customizationId":{"description":"Customization ID.","minLength":1,"maxLength":36,"title":"customizationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"choices":{"description":"Choices to add.","minItems":1,"maxItems":100,"title":"choices","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Choice"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CustomizationChoices","description":""},"wix.stores.catalog.customization.v3.BulkAddCustomizationChoicesResponse":{"type":"object","properties":{"results":{"description":"Customizations updated by bulk action.","minItems":1,"maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.BulkCustomizationResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkAddCustomizationChoicesResponse","description":""},"wix.stores.catalog.customization.v3.BulkUpdateCustomizationsRequest":{"type":"object","properties":{"customizations":{"description":"List of customizations to update.","minItems":1,"maxItems":100,"title":"customizations","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.MaskedCustomization"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the full customization entities in the response.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateCustomizationsRequest","description":""},"wix.stores.catalog.customization.v3.MaskedCustomization":{"type":"object","properties":{"customization":{"description":"Customization to update.","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.Customization","summary":"customization","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MaskedCustomization","description":""},"wix.stores.catalog.customization.v3.BulkUpdateCustomizationsResponse":{"type":"object","properties":{"results":{"description":"Customizations updated by bulk action.","minItems":1,"maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.customization.v3.BulkCustomizationResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/wix.stores.catalog.customization.v3.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateCustomizationsResponse","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"restoreInfo":{"description":"Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity","$ref":"#/components/schemas/wix.common.domainevents.RestoreInfo","summary":"restoreInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.RestoreInfo":{"type":"object","properties":{"deletedDate":{"description":"","title":"deletedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestoreInfo","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"google.protobuf.Empty":{"type":"object","properties":{},"title":"Empty","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":["UNKNOWN","ANONYMOUS_VISITOR","MEMBER","WIX_USER","APP"]}}},"title":"Customization","description":"Customizations include options and modifiers which can later be applied to products.\nOptions are designed to add variations to a product, where modifiers add a customizable change to the product but without creating another variant.","fqdn":"wix.stores.catalog.v3.customization"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Customizations API\n\nThe Customization API allows creating and managing customizations, which include options and modifiers, which later will be applied to products, for customer’s customizes or adds on to the product.\nOptions are meant to add variations to a product which required inventory, where modifiers allow users to collect additional information per product from customers without creating variants affecting inventory.\nOptions and modifiers can be defined together on one product. The options will create variants that may be customized by the customer.\nWith the Customization API, you can manage your site's customizations:\n+ Create and manage a bank of Customizations.\n+ Update entire Customizations or just specific fields.\n+ Delete existing Customizations.\n+ Retrieve information about existing customization.\n\n## Before you begin\n\nIt’s important to note the following points before starting to code:\n+ The Customization API only works with the Wix Stores app. Make sure you have installed this app from the [Wix App Market](fallback::https://www.wix.com/app-market/wix-stores).\n\n## Use cases\n\n+ [Set up and retrieve basic customizations for a clothing store](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/customizations-v3/sample-flows)\n\n## Terminology\n\n+ __Customizations__ are property types that customers can select within the specific product - e.g., Color and Size.\n+ If customization affects inventory, sku and so on we call such customization __Option__. Those __Options__ are basically the product's variants. For example, a T-shirt with 2 Color __Options__: Red and Blue. Each has its own price, sku and inventory.\n+ If customization does not affect inventory and sku, we call such customization __Modifier__. Having a modifier will not affect the variants that will be sent to the customer, but it will add specific customization to it.\nFor example if you sell Ice Cream and allow to select one of different Toppings: Vanilla, Caramel or Chocolate - each is a choice of the Toppings Modifier. It doesn't affect available ice creams in stock.\n+ __Choices__ are the available selections within each customization - e.g., Red and Green choices under the Color option customization.\n + CHOICE_TEXT - The corresponding choice type for Text Choices.\n + ONE_COLOR - The corresponding choice type for Swatch Choices. Also includes a parameter for the relevant color scheme.\n+ CustomizationRenderType: The type of the option or modifier, which needs to match for every choice used:\n + TextChoices - Choices that are text based (e.g., \"small\", \"medium\", \"large\"). Needs to be matched with CHOICE_TEXT choices.\n + SwatchChoices - Choices that are colors. Needs to be matched with ONE_COLOR choices.\n + FreeText - Enables entering of free text without giving predefined choices of the customization. Only usable for a Modifier (not an Option).\n+ __Variant__: A single, specific product determined by the combination of selected options (e.g., a red, size M t-shirt).\n\n"},{"displayName":"Sample Flows","slugifyName":"sample-flows","content":"# Sample Flow\n\nThis article shares a possible use case your app could support, as well as a sample flow that could support this use case. This can be a helpful jumping-off point as you plan your app's implementation.\n\n## Set up and retrieve basic customizations for a clothing store\n\n1. [Create a Customization with Option type](fallback::./examples/CreateCustomization.2.curl), which will have different product colors: red, green, blue.\n + Render type must be SwatchChoices and choice types must be ONE_COLOR.\n2. [Create a Customization with Option type](fallback::./examples/CreateCustomization.1.curl), which will have different product sizes: S, M, L, XL.\n + Render type must be TextChoices and choice types must be CHOICE_TEXT.\n3. [Create a Customization with Modifier type](fallback::./examples/CreateCustomization.3.curl), in order to specify free text to be on a product.\n + Render type must be FreeText.\n + Set freeTextInput's title to \"Choose text to be on shirt\", and have a 10 char count minimum.\n4. Use [add customization choices method](fallback::./examples/AddCustomizationChoices.curl) to add more color choices on Color customization (for example add the color yellow - color code #FFFF00).\n5. [Query](fallback::./examples/QueryCustomizations.3.curl) for all the Product options of type SWATCH_CHOICES (colors) - should return one result.\n\n\n## Create product with new option\n\nIn order to assign a new non-existing option to a new product, you can provide the option to the Create Product request.\n\nTo do this, your app can call Create Product with [Create Product](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/create-product)\nand assign a new option to the product by passing a the `name`, `option_render_type` and `choices`:\n```json\n{\n \"product\": {\n \"name\": \"Running Shoes\",\n \"physical_properties\": {},\n \"product_type\": \"PHYSICAL\",\n \"options\": [\n {\n \"name\": \"Size\",\n \"option_render_type\": \"TEXT_CHOICES\",\n \"choices_settings\": {\n \"choices\": [\n {\n \"name\": \"32\",\n \"choice_type\": \"CHOICE_TEXT\"\n },\n {\n \"name\": \"33\",\n \"choice_type\": \"CHOICE_TEXT\"\n },\n {\n \"name\": \"34\",\n \"choice_type\": \"CHOICE_TEXT\"\n }\n ]\n }\n }\n ],\n \"variants_info\": {\n \"variants\": [\n {\n \"choices\": [\n {\n \"option_choice_names\": {\n \"choice_name\": \"32\",\n \"option_name\": \"Size\",\n \"render_type\": \"TEXT_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"base_price\": {\n \"amount\": \"47\"\n }\n }\n },\n {\n \"choices\": [\n {\n \"option_choice_names\": {\n \"choice_name\": \"33\",\n \"option_name\": \"Size\",\n \"render_type\": \"TEXT_CHOICES\"\n }\n }\n ],\n \"price\": {\n \"base_price\": {\n \"amount\": \"47\"\n }\n }\n }\n ]\n }\n }\n}\n```\n> Note that if an option with `option.name` already exists, it will assign the existing option to the product.\n\n## Create product with new modifier\n\nIn order to assign a new non-existing modifier to a new product, you can provide the modifier to the Create Product request.\n\nTo do this, your app can call Create Product with [Create Product](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/create-product)\nand assign a new option to the product by passing a the `name`, `modifier_render_type` and `free_text_settings`:\n```json\n{\n \"product\": {\n \"name\": \"T-Shirt\",\n \"physical_properties\": {},\n \"product_type\": \"PHYSICAL\",\n \"modifiers\": [\n {\n \"name\": \"Text on T-Shirt\",\n \"modifier_render_type\": \"FREE_TEXT\",\n \"mandatory\": true,\n \"free_text_settings\": {\n \"title\": \"Choose text to be on shirt\",\n \"max_char_count\": 20,\n \"min_char_count\": 10\n }\n }\n ],\n \"variants_info\": {\n \"variants\": [\n {\n \"price\": {\n \"base_price\": {\n \"amount\": \"17\"\n }\n }\n }\n ]\n }\n }\n}\n```\n> Note that if a modifier with `modifier.name` already exists, it will assign the existing modifier to the product.\n\n"},{"displayName":"Supported Filters and Sorting","slugifyName":"supported-filters-and-sorting","content":"# Customizations: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting for the customization object:\n\n| Field | Supported Filters | Sortable |\n|---------------------------|------------------------------------------------------------------------|----------|\n| `id` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | Sortable |\n| `createdDate` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$le`, `$gt`, `$ge` | Sortable |\n| `updatedDate` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$le`, `$gt`, `$ge` | Sortable |\n| `name` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | Sortable |\n| `customizationType` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome` | |\n| `customizationRenderType` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome` | |\n\n\n__Related content:__\n[API Query Language](fallback::https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),\n[Query Customizations](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/customizations-v3/query-customizations)"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}

Get Customization

Permission Scopes