inner content

{"id":"a42915fd-6235-4030-a977-44fe7400b91d","createdDate":"2024-08-25T14:26:17.926Z","updatedDate":"2024-08-25T14:26:17.926Z","resourceId":"46d50937-8106-4cbe-89cf-b0603d702593","api":{"schema":{"object":{"displayName":"Category Object","description":"Short description of CategoriesService","slug":"category-object","$ref":"#/components/schemas/com.wix.categories.api.v1.Category","legacyExamples":[{"title":"Category","content":"{\n \"category\": {\n \"id\": \"b13e1166-fdf2-425a-a35c-d698edcbafa7\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-26T09:28:08.288Z\",\n \"updatedDate\": \"2024-06-26T11:10:35.577Z\",\n \"name\": \"Bottles\",\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"The Bottles subcategory offers a diverse selection of containers designed for carrying and consuming beverages\",\n \"visible\": false,\n \"breadcrumbs\": {\n \"values\": [\n {\n \"categoryId\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"categoryName\": \"Drink Containers\",\n \"categorySlug\": \"drinkware-2\"\n }\n ]\n },\n \"parentCategory\": {\n \"id\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"index\": 5\n },\n \"slug\": \"bottles-1\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }\n}\n"}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"methods":[{"summary":"Create Category","description":"Creates a category.","operationId":"com.wix.categories.api.v1.CategoriesService.CreateCategory","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.categories.api.v1.CreateCategoryResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/categories/v1/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/categories/v1/categories","destinationPath":"/v1/categories","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateCategoryRequest","description":"","properties":{"category":{"description":"Category to create.","$ref":"#/components/schemas/com.wix.categories.api.v1.Category","summary":"category","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.SingleEntityOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["category","category.name","category.parentCategory.id","treeReference","treeReference.appNamespace"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"NAMESPACE_NOT_FOUND_IN_DEV_CENTER"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"DUPLICATE_SLUG"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CATEGORIES_LIMIT_PER_TREE_EXCEEDED"},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"PARENT_CATEGORY_NOT_IN_TREE"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TREES_LIMIT_EXCEEDED"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CATEGORY_DEPTH_LIMIT_EXCEEDED"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PARENT_CATEGORY_HIDDEN"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.CreateCategoryRequest","responseMessage":"com.wix.categories.api.v1.CreateCategoryResponse"},"legacyExamples":[{"name":"CreateCategory","type":"METHOD","order":1,"content":{"title":"Create category","description":"Creates a category with name and description in the specified tree","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/categories' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"category\": {\n \"name\": \"Drinkware\",\n \"description\": \"The Drinkware category includes a wide range of containers designed for holding beverages\",\n \"visible\": true\n },\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n }'","response":"{\n \"category\": {\n \"id\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:12:48.985Z\",\n \"updatedDate\": \"2024-06-26T09:12:48.985Z\",\n \"name\": \"Drinkware\",\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"The Drinkware category includes a wide range of containers designed for holding beverages\",\n \"visible\": true,\n \"parentCategory\": {\n \"index\": 1\n },\n \"slug\": \"drinkware\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }\n}"}},{"name":"CreateCategory","type":"METHOD","order":2,"content":{"title":"Create subcategory","description":"Creates a subcategory under an existing parent category","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/categories' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"category\": {\n \"name\": \"Bottles\",\n \"description\": \"The Bottles subcategory offers a diverse selection of containers designed for carrying and consuming beverages\",\n \"slug\": \"bottles-1\",\n \"visible\": true,\n \"parentCategory\": {\n \"id\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\"\n }\n },\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n }'","response":"{\n \"category\": {\n \"id\": \"b13e1166-fdf2-425a-a35c-d698edcbafa7\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:28:08.288Z\",\n \"updatedDate\": \"2024-06-26T09:28:08.288Z\",\n \"name\": \"Bottles\",\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"The Bottles subcategory offers a diverse selection of containers designed for carrying and consuming beverages\",\n \"visible\": true,\n \"parentCategory\": {\n \"id\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"index\": 1\n },\n \"slug\": \"bottles-1\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }\n}"}},{"name":"CreateCategory","type":"METHOD","order":3,"content":{"title":"Create hidden subcategory","description":"Creates hidden subcategory in parent category.","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/categories' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"category\": {\n \"name\": \"Cups\",\n \"description\": \"The Cups subcategory features a versatile range of containers designed for drinking beverages of all kinds\",\n \"visible\": false,\n \"parentCategory\": {\n \"id\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\"\n }\n },\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n }'","response":"{\n \"category\": {\n \"id\": \"b12487f7-cc4a-46ae-9c4f-48369f76c226\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:42:37.551Z\",\n \"updatedDate\": \"2024-06-26T09:42:37.551Z\",\n \"name\": \"Cups\",\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"The Cups subcategory features a versatile range of containers designed for drinking beverages of all kinds\",\n \"visible\": false,\n \"parentCategory\": {\n \"id\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"index\": 2\n },\n \"slug\": \"cups-3\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/categories","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"NAMESPACE_NOT_FOUND_IN_DEV_CENTER"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"DUPLICATE_SLUG"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CATEGORIES_LIMIT_PER_TREE_EXCEEDED"},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"PARENT_CATEGORY_NOT_IN_TREE"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TREES_LIMIT_EXCEEDED"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CATEGORY_DEPTH_LIMIT_EXCEEDED"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PARENT_CATEGORY_HIDDEN"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.CreateCategoryRequest","responseMessage":"com.wix.categories.api.v1.CreateCategoryResponse"},"legacyExamples":[{"name":"CreateCategory","type":"METHOD","order":1,"content":{"title":"Create category","description":"Creates a category with name and description in the specified tree","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/categories' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"category\": {\n \"name\": \"Drinkware\",\n \"description\": \"The Drinkware category includes a wide range of containers designed for holding beverages\",\n \"visible\": true\n },\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n }'","response":"{\n \"category\": {\n \"id\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:12:48.985Z\",\n \"updatedDate\": \"2024-06-26T09:12:48.985Z\",\n \"name\": \"Drinkware\",\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"The Drinkware category includes a wide range of containers designed for holding beverages\",\n \"visible\": true,\n \"parentCategory\": {\n \"index\": 1\n },\n \"slug\": \"drinkware\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }\n}"}},{"name":"CreateCategory","type":"METHOD","order":2,"content":{"title":"Create subcategory","description":"Creates a subcategory under an existing parent category","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/categories' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"category\": {\n \"name\": \"Bottles\",\n \"description\": \"The Bottles subcategory offers a diverse selection of containers designed for carrying and consuming beverages\",\n \"slug\": \"bottles-1\",\n \"visible\": true,\n \"parentCategory\": {\n \"id\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\"\n }\n },\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n }'","response":"{\n \"category\": {\n \"id\": \"b13e1166-fdf2-425a-a35c-d698edcbafa7\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:28:08.288Z\",\n \"updatedDate\": \"2024-06-26T09:28:08.288Z\",\n \"name\": \"Bottles\",\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"The Bottles subcategory offers a diverse selection of containers designed for carrying and consuming beverages\",\n \"visible\": true,\n \"parentCategory\": {\n \"id\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"index\": 1\n },\n \"slug\": \"bottles-1\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }\n}"}},{"name":"CreateCategory","type":"METHOD","order":3,"content":{"title":"Create hidden subcategory","description":"Creates hidden subcategory in parent category.","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/categories' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"category\": {\n \"name\": \"Cups\",\n \"description\": \"The Cups subcategory features a versatile range of containers designed for drinking beverages of all kinds\",\n \"visible\": false,\n \"parentCategory\": {\n \"id\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\"\n }\n },\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n }'","response":"{\n \"category\": {\n \"id\": \"b12487f7-cc4a-46ae-9c4f-48369f76c226\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:42:37.551Z\",\n \"updatedDate\": \"2024-06-26T09:42:37.551Z\",\n \"name\": \"Cups\",\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"The Cups subcategory features a versatile range of containers designed for drinking beverages of all kinds\",\n \"visible\": false,\n \"parentCategory\": {\n \"id\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"index\": 2\n },\n \"slug\": \"cups-3\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Create Category","slugifiedName":"create-category"},"permissionScopes":[{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}]},{"summary":"Get Category","description":"Retrieves a category.","operationId":"com.wix.categories.api.v1.CategoriesService.GetCategory","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"categoryId","description":"Category ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"treeReference","in":"query","description":"Category tree reference details.","required":true,"schema":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"fields","in":"query","description":"Fields to include in the response.","required":false,"schema":{"description":"Fields to include in the response.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.SingleEntityOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wix.categories.api.v1.GetCategoryResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/categories/v1/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/categories/v1/categories","destinationPath":"/v1/categories","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.GetCategoryRequest","responseMessage":"com.wix.categories.api.v1.GetCategoryResponse"},"legacyExamples":[{"name":"GetCategory","type":"METHOD","order":2,"content":{"title":"Get category with breadcrumbs","description":"Get a category with breadcrumbs","request":"curl -X GET \\\n 'https://www.wixapis.com/categories/v1/categories/b13e1166-fdf2-425a-a35c-d698edcbafa7?treeReference.appNamespace=%40wix%2Fstores&fields=BREADCRUMBS' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"category\": {\n \"id\": \"b13e1166-fdf2-425a-a35c-d698edcbafa7\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-26T09:28:08.288Z\",\n \"updatedDate\": \"2024-06-26T11:10:35.577Z\",\n \"name\": \"Bottles\",\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"The Bottles subcategory offers a diverse selection of containers designed for carrying and consuming beverages\",\n \"visible\": false,\n \"breadcrumbs\": {\n \"values\": [\n {\n \"categoryId\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"categoryName\": \"Drink Containers\",\n \"categorySlug\": \"drinkware\"\n }\n ]\n },\n \"parentCategory\": {\n \"id\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"index\": 5\n },\n \"slug\": \"bottles\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }\n}"}},{"name":"GetCategory","type":"METHOD","order":1,"content":{"title":"Get category","description":"Get a category by ID in the specified tree","request":"curl -X GET \\\n 'https://www.wixapis.com/categories/v1/categories/b12487f7-cc4a-46ae-9c4f-48369f76c226?treeReference.appNamespace=%40wix%2Fstores' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"category\": {\n \"id\": \"b12487f7-cc4a-46ae-9c4f-48369f76c226\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:42:37.551Z\",\n \"updatedDate\": \"2024-06-26T09:58:56.693Z\",\n \"name\": \"Cups\",\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"The Cups subcategory features a versatile range of containers designed for drinking beverages of all kinds\",\n \"visible\": false,\n \"parentCategory\": {\n \"index\": 7\n },\n \"slug\": \"cups-3\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"get","path":"/v1/categories/{categoryId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.GetCategoryRequest","responseMessage":"com.wix.categories.api.v1.GetCategoryResponse"},"legacyExamples":[{"name":"GetCategory","type":"METHOD","order":2,"content":{"title":"Get category with breadcrumbs","description":"Get a category with breadcrumbs","request":"curl -X GET \\\n 'https://www.wixapis.com/categories/v1/categories/b13e1166-fdf2-425a-a35c-d698edcbafa7?treeReference.appNamespace=%40wix%2Fstores&fields=BREADCRUMBS' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"category\": {\n \"id\": \"b13e1166-fdf2-425a-a35c-d698edcbafa7\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-26T09:28:08.288Z\",\n \"updatedDate\": \"2024-06-26T11:10:35.577Z\",\n \"name\": \"Bottles\",\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"The Bottles subcategory offers a diverse selection of containers designed for carrying and consuming beverages\",\n \"visible\": false,\n \"breadcrumbs\": {\n \"values\": [\n {\n \"categoryId\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"categoryName\": \"Drink Containers\",\n \"categorySlug\": \"drinkware\"\n }\n ]\n },\n \"parentCategory\": {\n \"id\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"index\": 5\n },\n \"slug\": \"bottles\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }\n}"}},{"name":"GetCategory","type":"METHOD","order":1,"content":{"title":"Get category","description":"Get a category by ID in the specified tree","request":"curl -X GET \\\n 'https://www.wixapis.com/categories/v1/categories/b12487f7-cc4a-46ae-9c4f-48369f76c226?treeReference.appNamespace=%40wix%2Fstores' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"category\": {\n \"id\": \"b12487f7-cc4a-46ae-9c4f-48369f76c226\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:42:37.551Z\",\n \"updatedDate\": \"2024-06-26T09:58:56.693Z\",\n \"name\": \"Cups\",\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"The Cups subcategory features a versatile range of containers designed for drinking beverages of all kinds\",\n \"visible\": false,\n \"parentCategory\": {\n \"index\": 7\n },\n \"slug\": \"cups-3\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Get Category","slugifiedName":"get-category"},"permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"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"}]},{"summary":"Delete Category","description":"Deletes a category.","operationId":"com.wix.categories.api.v1.CategoriesService.DeleteCategory","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"categoryId","description":"Category ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"treeReference","in":"query","description":"Category tree reference details.","required":true,"schema":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wix.categories.api.v1.DeleteCategoryResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/categories/v1/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/categories/v1/categories","destinationPath":"/v1/categories","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"MANAGED_CATEGORY_OPERATION_NOT_ALLOWED"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_DELETE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.DeleteCategoryRequest","responseMessage":"com.wix.categories.api.v1.DeleteCategoryResponse"},"legacyExamples":[{"name":"DeleteCategory","type":"METHOD","order":1,"content":{"title":"Delete category","description":"Deletes category in the specified tree.","request":"curl -X DELETE \\\n 'https://www.wixapis.com/categories/v1/categories/b13e1166-fdf2-425a-a35c-d698edcbafa7?treeReference.appNamespace=%40wix%2Fstores' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"delete","path":"/v1/categories/{categoryId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"MANAGED_CATEGORY_OPERATION_NOT_ALLOWED"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_DELETE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.DeleteCategoryRequest","responseMessage":"com.wix.categories.api.v1.DeleteCategoryResponse"},"legacyExamples":[{"name":"DeleteCategory","type":"METHOD","order":1,"content":{"title":"Delete category","description":"Deletes category in the specified tree.","request":"curl -X DELETE \\\n 'https://www.wixapis.com/categories/v1/categories/b13e1166-fdf2-425a-a35c-d698edcbafa7?treeReference.appNamespace=%40wix%2Fstores' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Delete Category","slugifiedName":"delete-category"},"permissionScopes":[{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}]},{"summary":"Update Category","description":"Updates a category.\n\nEach time the category is updated, `revision` increments by 1.\nThe current `revision` must be passed when updating the category.\nThis ensures you're working with the latest category and prevents unintended overwrites.","operationId":"com.wix.categories.api.v1.CategoriesService.UpdateCategory","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"category.id","description":"Category ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wix.categories.api.v1.UpdateCategoryResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/categories/v1/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/categories/v1/categories","destinationPath":"/v1/categories","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateCategoryRequest","description":"","properties":{"category":{"description":"Category to update.","$ref":"#/components/schemas/com.wix.categories.api.v1.Category","summary":"category","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.SingleEntityOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["category","category.id","treeReference","treeReference.appNamespace","category.revision"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"DUPLICATE_SLUG"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"REMOVED_SLUG"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.UpdateCategoryRequest","responseMessage":"com.wix.categories.api.v1.UpdateCategoryResponse"},"legacyExamples":[{"name":"UpdateCategory","type":"METHOD","order":1,"content":{"title":"Update category","description":"Updates the name field of a category.","request":"curl -X PATCH \\\n 'https://www.wixapis.com/categories/v1/categories/bbd52b32-21d2-4dbe-bfc5-d320f93f8911 \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"category\": {\n \"revision\": \"1\",\n \"name\": \"Drink Containers\"\n },\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n }'","response":"{\n \"category\": {\n \"id\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-26T09:12:48.985Z\",\n \"updatedDate\": \"2024-06-26T11:08:14.348Z\",\n \"name\": \"Drink Containers\",\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"The Drinkware category includes a wide range of containers designed for holding beverages\",\n \"visible\": true,\n \"parentCategory\": {\n \"index\": 8\n },\n \"slug\": \"drinkware\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"patch","path":"/v1/categories/{category.id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"DUPLICATE_SLUG"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"REMOVED_SLUG"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.UpdateCategoryRequest","responseMessage":"com.wix.categories.api.v1.UpdateCategoryResponse"},"legacyExamples":[{"name":"UpdateCategory","type":"METHOD","order":1,"content":{"title":"Update category","description":"Updates the name field of a category.","request":"curl -X PATCH \\\n 'https://www.wixapis.com/categories/v1/categories/bbd52b32-21d2-4dbe-bfc5-d320f93f8911 \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"category\": {\n \"revision\": \"1\",\n \"name\": \"Drink Containers\"\n },\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n }'","response":"{\n \"category\": {\n \"id\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-26T09:12:48.985Z\",\n \"updatedDate\": \"2024-06-26T11:08:14.348Z\",\n \"name\": \"Drink Containers\",\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"The Drinkware category includes a wide range of containers designed for holding beverages\",\n \"visible\": true,\n \"parentCategory\": {\n \"index\": 8\n },\n \"slug\": \"drinkware\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Update Category","slugifiedName":"update-category"},"permissionScopes":[{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}]},{"summary":"Search Categories","description":"Retrieves a list of up to 1,000 categories, 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\nSearch Categories 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 [Categories: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/categories/supported-filters-and-sorting).\n\nTo learn about working with _Search_ endpoints, see\n[API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),\nand [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).","operationId":"com.wix.categories.api.v1.CategoriesService.SearchCategories","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.categories.api.v1.SearchCategoriesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/categories/v1/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/categories/v1/categories","destinationPath":"/v1/categories","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"SearchCategoriesRequest","description":"","properties":{"search":{"description":"Search options.","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.CursorSearch","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.\n> **Note:** Pass `treeReference` only in the first request. Pass the cursor token in subsequent requests.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnNonVisibleCategories":{"description":"Whether to return the categories with `visible: false`.\n\nDefault: `false` - only visible categories are returned in the response","title":"returnNonVisibleCategories","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.MultipleEntitiesOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["treeReference","treeReference.appNamespace"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.SearchCategoriesRequest","responseMessage":"com.wix.categories.api.v1.SearchCategoriesResponse"},"legacyExamples":[{"name":"SearchCategories","type":"METHOD","order":3,"content":{"title":"Search categories by free text- next page","description":"Searches for categories in next page by entering token from previous response.","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/categories/search' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"search\": {\n \"cursorPaging\": {\n \"cursor\": \"1623a751ec60d219a8e3d441193ea4fdbca802df\"\n }\n },\n \"returnNonVisibleCategories\": true,\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n },\n \"fields\": [\n \"BREADCRUMBS\"\n ]\n }'","response":"{\n \"categories\": [\n {\n \"id\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"revision\": \"3\",\n \"createdDate\": \"2024-06-26T09:12:48.985Z\",\n \"updatedDate\": \"2024-06-26T11:10:33.390Z\",\n \"name\": \"Drink Containers\",\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"\",\n \"visible\": false,\n \"breadcrumbs\": {\n \"values\": []\n },\n \"parentCategory\": {\n \"index\": 8\n },\n \"slug\": \"drinkware-2\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n },\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {\n \"prev\": \"b0921a42524a53847b45a67e643006ab4190cde4\"\n },\n \"hasNext\": false\n }\n}"}},{"name":"SearchCategories","type":"METHOD","order":1,"content":{"title":"Search hidden categories","description":"Searches for non-visible categories.","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/categories/search' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"search\": {\n \"filter\": {\"visible\": {\"$eq\": false }},\n \"sort\": [{\"field_name\": \"name\", \"order\": \"DESC\"}]\n },\n \"returnNonVisibleCategories\": true,\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n },\n \"fields\": [\n \"BREADCRUMBS\"\n ]\n }'","response":"{\n \"categories\": [\n {\n \"id\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"revision\": \"3\",\n \"createdDate\": \"2024-06-26T09:12:48.985Z\",\n \"updatedDate\": \"2024-06-26T11:10:33.390Z\",\n \"name\": \"Drink Containers\",\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"The Drinkware category includes a wide range of containers designed for holding beverages\",\n \"visible\": false,\n \"breadcrumbs\": {\n \"values\": []\n },\n \"parentCategory\": {\n \"index\": 8\n },\n \"slug\": \"drinkware-2\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n },\n {\n \"id\": \"df55a225-a5a6-42da-a4f9-7c805c5b3188\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-26T09:41:27.160Z\",\n \"updatedDate\": \"2024-06-26T11:10:35.577Z\",\n \"name\": \"Cups\",\n \"numberOfItems\": 0,\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"The Cups subcategory features a versatile range of containers designed for drinking beverages of all kinds\",\n \"visible\": false,\n \"breadcrumbs\": {\n \"values\": [\n {\n \"categoryId\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"categoryName\": \"Drink Containers\",\n \"categorySlug\": \"drinkware-2\"\n }\n ]\n },\n \"parentCategory\": {\n \"id\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"index\": 2\n },\n \"slug\": \"cups-1\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"cursors\": {},\n \"hasNext\": false\n }\n}"}},{"name":"SearchCategories","type":"METHOD","order":2,"content":{"title":"Search categories by free text","description":"Enter search expression and find it in `name` or `description`","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/categories/search' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"search\": {\n \"search\": {\n \"expression\": \"drink\"\n },\n \"cursorPaging\": {\n \"limit\": 2\n }\n },\n \"returnNonVisibleCategories\": true,\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n },\n \"fields\": [\n \"BREADCRUMBS\"\n ]\n }'","response":"{\n \"categories\": [\n {\n \"id\": \"46986767-540f-4b0c-a330-3c36fce64018\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:06:17.012Z\",\n \"updatedDate\": \"2024-06-26T09:06:17.012Z\",\n \"name\": \"Drinkware\",\n \"numberOfItems\": 0,\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"The Drinkware category includes a wide range of containers designed for holding beverages\",\n \"visible\": true,\n \"breadcrumbs\": {\n \"values\": []\n },\n \"parentCategory\": {\n \"index\": 2\n },\n \"slug\": \"drinkware-1\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n },\n {\n \"id\": \"b12487f7-cc4a-46ae-9c4f-48369f76c226\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:42:37.551Z\",\n \"updatedDate\": \"2024-06-26T09:58:56.693Z\",\n \"name\": \"Cups\",\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"The Cups subcategory features a versatile range of containers designed for drinking beverages of all kinds\",\n \"visible\": false,\n \"breadcrumbs\": {\n \"values\": []\n },\n \"parentCategory\": {\n \"index\": 7\n },\n \"slug\": \"cups-3\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n },\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"cursors\": {\n \"next\": \"1623a751ec60d219a8e3d441193ea4fdbca802df\"\n },\n \"hasNext\": true\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/categories/search","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.SearchCategoriesRequest","responseMessage":"com.wix.categories.api.v1.SearchCategoriesResponse"},"legacyExamples":[{"name":"SearchCategories","type":"METHOD","order":3,"content":{"title":"Search categories by free text- next page","description":"Searches for categories in next page by entering token from previous response.","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/categories/search' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"search\": {\n \"cursorPaging\": {\n \"cursor\": \"1623a751ec60d219a8e3d441193ea4fdbca802df\"\n }\n },\n \"returnNonVisibleCategories\": true,\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n },\n \"fields\": [\n \"BREADCRUMBS\"\n ]\n }'","response":"{\n \"categories\": [\n {\n \"id\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"revision\": \"3\",\n \"createdDate\": \"2024-06-26T09:12:48.985Z\",\n \"updatedDate\": \"2024-06-26T11:10:33.390Z\",\n \"name\": \"Drink Containers\",\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"\",\n \"visible\": false,\n \"breadcrumbs\": {\n \"values\": []\n },\n \"parentCategory\": {\n \"index\": 8\n },\n \"slug\": \"drinkware-2\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n },\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {\n \"prev\": \"b0921a42524a53847b45a67e643006ab4190cde4\"\n },\n \"hasNext\": false\n }\n}"}},{"name":"SearchCategories","type":"METHOD","order":1,"content":{"title":"Search hidden categories","description":"Searches for non-visible categories.","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/categories/search' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"search\": {\n \"filter\": {\"visible\": {\"$eq\": false }},\n \"sort\": [{\"field_name\": \"name\", \"order\": \"DESC\"}]\n },\n \"returnNonVisibleCategories\": true,\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n },\n \"fields\": [\n \"BREADCRUMBS\"\n ]\n }'","response":"{\n \"categories\": [\n {\n \"id\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"revision\": \"3\",\n \"createdDate\": \"2024-06-26T09:12:48.985Z\",\n \"updatedDate\": \"2024-06-26T11:10:33.390Z\",\n \"name\": \"Drink Containers\",\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"The Drinkware category includes a wide range of containers designed for holding beverages\",\n \"visible\": false,\n \"breadcrumbs\": {\n \"values\": []\n },\n \"parentCategory\": {\n \"index\": 8\n },\n \"slug\": \"drinkware-2\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n },\n {\n \"id\": \"df55a225-a5a6-42da-a4f9-7c805c5b3188\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-26T09:41:27.160Z\",\n \"updatedDate\": \"2024-06-26T11:10:35.577Z\",\n \"name\": \"Cups\",\n \"numberOfItems\": 0,\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"The Cups subcategory features a versatile range of containers designed for drinking beverages of all kinds\",\n \"visible\": false,\n \"breadcrumbs\": {\n \"values\": [\n {\n \"categoryId\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"categoryName\": \"Drink Containers\",\n \"categorySlug\": \"drinkware-2\"\n }\n ]\n },\n \"parentCategory\": {\n \"id\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"index\": 2\n },\n \"slug\": \"cups-1\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"cursors\": {},\n \"hasNext\": false\n }\n}"}},{"name":"SearchCategories","type":"METHOD","order":2,"content":{"title":"Search categories by free text","description":"Enter search expression and find it in `name` or `description`","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/categories/search' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"search\": {\n \"search\": {\n \"expression\": \"drink\"\n },\n \"cursorPaging\": {\n \"limit\": 2\n }\n },\n \"returnNonVisibleCategories\": true,\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n },\n \"fields\": [\n \"BREADCRUMBS\"\n ]\n }'","response":"{\n \"categories\": [\n {\n \"id\": \"46986767-540f-4b0c-a330-3c36fce64018\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:06:17.012Z\",\n \"updatedDate\": \"2024-06-26T09:06:17.012Z\",\n \"name\": \"Drinkware\",\n \"numberOfItems\": 0,\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"The Drinkware category includes a wide range of containers designed for holding beverages\",\n \"visible\": true,\n \"breadcrumbs\": {\n \"values\": []\n },\n \"parentCategory\": {\n \"index\": 2\n },\n \"slug\": \"drinkware-1\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n },\n {\n \"id\": \"b12487f7-cc4a-46ae-9c4f-48369f76c226\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:42:37.551Z\",\n \"updatedDate\": \"2024-06-26T09:58:56.693Z\",\n \"name\": \"Cups\",\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"The Cups subcategory features a versatile range of containers designed for drinking beverages of all kinds\",\n \"visible\": false,\n \"breadcrumbs\": {\n \"values\": []\n },\n \"parentCategory\": {\n \"index\": 7\n },\n \"slug\": \"cups-3\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n },\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"cursors\": {\n \"next\": \"1623a751ec60d219a8e3d441193ea4fdbca802df\"\n },\n \"hasNext\": true\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Search Categories","slugifiedName":"search-categories"},"permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"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"}]},{"summary":"Count Categories","description":"Counts the number of categories that match the provided filtering.\n\nFor field support for filters and sorting,\nsee [Categories: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/categories/supported-filters-and-sorting).","operationId":"com.wix.categories.api.v1.CategoriesService.CountCategories","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.categories.api.v1.CountCategoriesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/categories/v1/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/categories/v1/categories","destinationPath":"/v1/categories","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CountCategoriesRequest","description":"","properties":{"filter":{"description":"Filter object.\n\nLearn more about the [filter object structure](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Search options.","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnNonVisibleCategories":{"description":"Whether to return categories with `visible: false` (hidden categories).\n\nDefault: `false` - only visible categories are returned in the response","title":"returnNonVisibleCategories","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["treeReference","treeReference.appNamespace"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.CountCategoriesRequest","responseMessage":"com.wix.categories.api.v1.CountCategoriesResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/categories/count","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.CountCategoriesRequest","responseMessage":"com.wix.categories.api.v1.CountCategoriesResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Count Categories","slugifiedName":"count-categories"},"permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"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"}]},{"summary":"Move Category","description":"Moves a category within its parent category, or to a different parent category.","operationId":"com.wix.categories.api.v1.CategoriesService.MoveCategory","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"categoryId","description":"ID of the category to move.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wix.categories.api.v1.MoveCategoryResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/categories/v1/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/categories/v1/categories","destinationPath":"/v1/categories","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"MoveCategoryRequest","description":"","properties":{"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"parentCategoryId":{"description":"Parent category ID.\n\nDefault: root category ID","format":"GUID","title":"parentCategoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"position":{"description":"Where to place the subcategory.\n\n+ `FIRST`: Position the category as the first subcategory.\n+ `LAST`: Position the category as the last subcategory.\n+ `AFTER`: Position the category after the category ID passed in `moveAfterCategoryId`.","title":"position","type":"string","$ref":"#/components/schemas/com.wix.categories.api.v1.MoveCategoryRequest.Position","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"moveAfterCategoryId":{"description":"Required when passing `position: AFTER`.","format":"GUID","title":"moveAfterCategoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["categoryId","treeReference","treeReference.appNamespace","position"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"PARENT_CATEGORY_NOT_IN_TREE"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CATEGORY_DEPTH_LIMIT_EXCEEDED"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TREE_CYCLE_DETECTED"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_AFTER_CATEGORY"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"AFTER_CATEGORY_NOT_IN_PARENT"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_MOVE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.MoveCategoryRequest","responseMessage":"com.wix.categories.api.v1.MoveCategoryResponse"},"legacyExamples":[{"name":"MoveCategory","type":"METHOD","order":2,"content":{"title":"Move category to different parent","description":"Moves a category after another category in root category","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/categories/df55a225-a5a6-42da-a4f9-7c805c5b3188/move' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"position\": \"AFTER\",\n \"moveAfterCategoryId\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n }'","response":"{\n \"categoriesAfterMove\": [\n \"880286ee-0b24-4b4d-8ca3-10f9d2c8111f\",\n \"74b9a8b4-497a-4452-9ce8-9511e5f0138a\",\n \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"df55a225-a5a6-42da-a4f9-7c805c5b3188\",\n \"8ef7cee2-05f1-42e6-9079-a58bc6d243e3\",\n ]\n}"}},{"name":"MoveCategory","type":"METHOD","order":1,"content":{"title":"Move category to last position","description":"Moves a category to the last position in the parent category","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/categories/b13e1166-fdf2-425a-a35c-d698edcbafa7/move' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"parentCategoryId\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"position\": \"LAST\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n }'","response":"{\n \"parentCategoryId\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"categoriesAfterMove\": [\n \"b12487f7-cc4a-46ae-9c4f-48369f76c226\",\n \"b13e1166-fdf2-425a-a35c-d698edcbafa7\"\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/categories/{categoryId}/move","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"PARENT_CATEGORY_NOT_IN_TREE"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CATEGORY_DEPTH_LIMIT_EXCEEDED"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TREE_CYCLE_DETECTED"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_AFTER_CATEGORY"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"AFTER_CATEGORY_NOT_IN_PARENT"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_MOVE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.MoveCategoryRequest","responseMessage":"com.wix.categories.api.v1.MoveCategoryResponse"},"legacyExamples":[{"name":"MoveCategory","type":"METHOD","order":2,"content":{"title":"Move category to different parent","description":"Moves a category after another category in root category","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/categories/df55a225-a5a6-42da-a4f9-7c805c5b3188/move' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"position\": \"AFTER\",\n \"moveAfterCategoryId\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n }'","response":"{\n \"categoriesAfterMove\": [\n \"880286ee-0b24-4b4d-8ca3-10f9d2c8111f\",\n \"74b9a8b4-497a-4452-9ce8-9511e5f0138a\",\n \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"df55a225-a5a6-42da-a4f9-7c805c5b3188\",\n \"8ef7cee2-05f1-42e6-9079-a58bc6d243e3\",\n ]\n}"}},{"name":"MoveCategory","type":"METHOD","order":1,"content":{"title":"Move category to last position","description":"Moves a category to the last position in the parent category","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/categories/b13e1166-fdf2-425a-a35c-d698edcbafa7/move' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"parentCategoryId\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"position\": \"LAST\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n }'","response":"{\n \"parentCategoryId\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"categoriesAfterMove\": [\n \"b12487f7-cc4a-46ae-9c4f-48369f76c226\",\n \"b13e1166-fdf2-425a-a35c-d698edcbafa7\"\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Move Category","slugifiedName":"move-category"},"permissionScopes":[{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}]},{"summary":"Bulk Update Categories","description":"Updates multiple categories.\n\nEach time a category is updated, `revision` increments by 1.\nThe current `revision` must be passed when updating a category.\nThis ensures you're working with the latest category and prevents unintended overwrites.","operationId":"com.wix.categories.api.v1.CategoriesService.BulkUpdateCategories","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.categories.api.v1.BulkUpdateCategoriesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/categories/v1/bulk/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/categories/v1/bulk/categories","destinationPath":"/v1/bulk/categories","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkUpdateCategoriesRequest","description":"","properties":{"categories":{"description":"List of categories to update.","minItems":1,"maxItems":100,"title":"categories","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.MaskedCategory"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the full category entity in the response.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.MultipleEntitiesOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["categories","categories.category","categories.category.id","categories.category.revision","treeReference","treeReference.appNamespace"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UPDATE_OF_FIELD_NOT_ALLOWED"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.BulkUpdateCategoriesRequest","responseMessage":"com.wix.categories.api.v1.BulkUpdateCategoriesResponse"},"legacyExamples":[{"name":"BulkUpdateCategories","type":"METHOD","order":1,"content":{"title":"Bulk update categories - partial success","description":"Updates different fields on 2 categories","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/bulk/categories/update' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"categories\": [\n {\n \"category\": {\n \"id\": \"b13e1166-fdf2-425a-a35c-d698edcbafa7\",\n \"name\": \"Designed Bottles\",\n \"revision\": \"1\"\n }\n },\n {\n \"category\": {\n \"id\": \"b12487f7-cc4a-46ae-9c4f-48369f76c226\",\n \"slug\": \"special-cups\",\n \"revision\": \"1\"\n }\n }\n ],\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n },\n \"returnEntity\": true\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"b12487f7-cc4a-46ae-9c4f-48369f76c226\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"category\": {\n \"id\": \"b12487f7-cc4a-46ae-9c4f-48369f76c226\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-26T09:42:37.551Z\",\n \"updatedDate\": \"2024-06-27T13:51:17.346Z\",\n \"name\": \"Cups\",\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"The Cups subcategory features a versatile range of containers designed for drinking beverages of all kinds\",\n \"visible\": false,\n \"parentCategory\": {\n \"index\": 7\n },\n \"slug\": \"special-cups\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"b13e1166-fdf2-425a-a35c-d698edcbafa7\",\n \"originalIndex\": 0,\n \"success\": false,\n \"error\": {\n \"code\": \"INVALID_REVISION\",\n \"description\": \"Outdated revision for entity id\",\n \"data\": {\n \"revisionViolation\": {\n \"entityId\": \"b13e1166-fdf2-425a-a35c-d698edcbafa7\"\n }\n }\n }\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 1,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/bulk/categories/update","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UPDATE_OF_FIELD_NOT_ALLOWED"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.BulkUpdateCategoriesRequest","responseMessage":"com.wix.categories.api.v1.BulkUpdateCategoriesResponse"},"legacyExamples":[{"name":"BulkUpdateCategories","type":"METHOD","order":1,"content":{"title":"Bulk update categories - partial success","description":"Updates different fields on 2 categories","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/bulk/categories/update' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"categories\": [\n {\n \"category\": {\n \"id\": \"b13e1166-fdf2-425a-a35c-d698edcbafa7\",\n \"name\": \"Designed Bottles\",\n \"revision\": \"1\"\n }\n },\n {\n \"category\": {\n \"id\": \"b12487f7-cc4a-46ae-9c4f-48369f76c226\",\n \"slug\": \"special-cups\",\n \"revision\": \"1\"\n }\n }\n ],\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n },\n \"returnEntity\": true\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"b12487f7-cc4a-46ae-9c4f-48369f76c226\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"category\": {\n \"id\": \"b12487f7-cc4a-46ae-9c4f-48369f76c226\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-26T09:42:37.551Z\",\n \"updatedDate\": \"2024-06-27T13:51:17.346Z\",\n \"name\": \"Cups\",\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"The Cups subcategory features a versatile range of containers designed for drinking beverages of all kinds\",\n \"visible\": false,\n \"parentCategory\": {\n \"index\": 7\n },\n \"slug\": \"special-cups\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"b13e1166-fdf2-425a-a35c-d698edcbafa7\",\n \"originalIndex\": 0,\n \"success\": false,\n \"error\": {\n \"code\": \"INVALID_REVISION\",\n \"description\": \"Outdated revision for entity id\",\n \"data\": {\n \"revisionViolation\": {\n \"entityId\": \"b13e1166-fdf2-425a-a35c-d698edcbafa7\"\n }\n }\n }\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 1,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Update Categories","slugifiedName":"bulk-update-categories"},"permissionScopes":[{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}]},{"summary":"Update Category Visibility","description":"Updates category visibility.\n\n\nEach time a category is updated, `revision` increments by 1.\nThe current `revision` must be passed when updating a category.\nThis ensures you're working with the latest category and prevents unintended overwrites.","operationId":"com.wix.categories.api.v1.CategoriesService.UpdateCategoryVisibility","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.categories.api.v1.UpdateCategoryVisibilityResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/categories/v1/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/categories/v1/categories","destinationPath":"/v1/categories","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateCategoryVisibilityRequest","description":"","properties":{"categoryId":{"description":"Category ID.","format":"GUID","title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"visible":{"description":"Whether the category is visible to site visitors in dynamic pages.\n\n+ If a parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.\n+ Passing `true` will fail if the visibility of any parent categories is `false`.","title":"visible","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Latest revision of the category.\nTo prevent conflicting changes, the current revision must be passed on update.","title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.SingleEntityOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["categoryId","visible","treeReference","treeReference.appNamespace","revision"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PARENT_CATEGORY_HIDDEN"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.UpdateCategoryVisibilityRequest","responseMessage":"com.wix.categories.api.v1.UpdateCategoryVisibilityResponse"},"legacyExamples":[{"name":"UpdateCategoryVisibility","type":"METHOD","order":1,"content":{"title":"Update category visibility","description":"Updates a category's visible field to false.","request":"curl -X PATCH \\\n 'https://www.wixapis.com/categories/v1/categories/visibility' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"categoryId\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"visible\": false,\n \"revision\": 2,\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n }'","response":"{\n \"category\": {\n \"id\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"revision\": \"3\",\n \"createdDate\": \"2024-06-26T09:12:48.985Z\",\n \"updatedDate\": \"2024-06-26T11:10:33.390Z\",\n \"name\": \"Drink Containers\",\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"The Drinkware category includes a wide range of containers designed for holding beverages\",\n \"visible\": false,\n \"parentCategory\": {\n \"index\": 8\n },\n \"slug\": \"drinkware\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"patch","path":"/v1/categories/visibility","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PARENT_CATEGORY_HIDDEN"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.UpdateCategoryVisibilityRequest","responseMessage":"com.wix.categories.api.v1.UpdateCategoryVisibilityResponse"},"legacyExamples":[{"name":"UpdateCategoryVisibility","type":"METHOD","order":1,"content":{"title":"Update category visibility","description":"Updates a category's visible field to false.","request":"curl -X PATCH \\\n 'https://www.wixapis.com/categories/v1/categories/visibility' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"categoryId\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"visible\": false,\n \"revision\": 2,\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n }'","response":"{\n \"category\": {\n \"id\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"revision\": \"3\",\n \"createdDate\": \"2024-06-26T09:12:48.985Z\",\n \"updatedDate\": \"2024-06-26T11:10:33.390Z\",\n \"name\": \"Drink Containers\",\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"The Drinkware category includes a wide range of containers designed for holding beverages\",\n \"visible\": false,\n \"parentCategory\": {\n \"index\": 8\n },\n \"slug\": \"drinkware\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Update Category Visibility","slugifiedName":"update-category-visibility"},"permissionScopes":[{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}]},{"summary":"Bulk Add Items To Category","description":"Adds multiple items to a single category.","operationId":"com.wix.categories.api.v1.CategoriesService.BulkAddItemsToCategory","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"categoryId","description":"Category ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wix.categories.api.v1.BulkAddItemsToCategoryResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/categories/v1/bulk/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/categories/v1/bulk/categories","destinationPath":"/v1/bulk/categories","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkAddItemsToCategoryRequest","description":"","properties":{"items":{"description":"List of items to add.","minItems":1,"maxItems":100,"title":"items","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["categoryId","items","items.catalogItemId","items.appId","treeReference","treeReference.appNamespace"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"MANAGED_CATEGORY_OPERATION_NOT_ALLOWED"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_ADD_ITEM"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Category item write","scopeId":"SCOPE.CATEGORIES.CATEGORY_ITEM_WRITE"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.BulkAddItemsToCategoryRequest","responseMessage":"com.wix.categories.api.v1.BulkAddItemsToCategoryResponse"},"legacyExamples":[{"name":"BulkAddItemsToCategory","type":"METHOD","order":1,"content":{"title":"Bulk add items to category","description":"Adds 2 items to 1 category. Response includes 2 successful actions.","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/bulk/categories/bbd52b32-21d2-4dbe-bfc5-d320f93f8911/add-items' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"items\": [\n {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"05519a6e-222b-413a-957c-0ef7a32779b5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n }\n ],\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"item\": {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"item\": {\n \"catalogItemId\": \"05519a6e-222b-413a-957c-0ef7a32779b5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n \"originalIndex\": 1,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/bulk/categories/{categoryId}/add-items","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"MANAGED_CATEGORY_OPERATION_NOT_ALLOWED"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_ADD_ITEM"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Category item write","scopeId":"SCOPE.CATEGORIES.CATEGORY_ITEM_WRITE"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.BulkAddItemsToCategoryRequest","responseMessage":"com.wix.categories.api.v1.BulkAddItemsToCategoryResponse"},"legacyExamples":[{"name":"BulkAddItemsToCategory","type":"METHOD","order":1,"content":{"title":"Bulk add items to category","description":"Adds 2 items to 1 category. Response includes 2 successful actions.","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/bulk/categories/bbd52b32-21d2-4dbe-bfc5-d320f93f8911/add-items' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"items\": [\n {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"05519a6e-222b-413a-957c-0ef7a32779b5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n }\n ],\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"item\": {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"item\": {\n \"catalogItemId\": \"05519a6e-222b-413a-957c-0ef7a32779b5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n \"originalIndex\": 1,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Add Items To Category","slugifiedName":"bulk-add-items-to-category"},"permissionScopes":[{"name":"Category item write","scopeId":"SCOPE.CATEGORIES.CATEGORY_ITEM_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}]},{"summary":"Bulk Add Item To Categories","description":"Adds a single item to multiple categories.","operationId":"com.wix.categories.api.v1.CategoriesService.BulkAddItemToCategories","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.categories.api.v1.BulkAddItemToCategoriesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/categories/v1/bulk/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/categories/v1/bulk/categories","destinationPath":"/v1/bulk/categories","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkAddItemToCategoriesRequest","description":"","properties":{"item":{"description":"Item to add.","$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference","summary":"item","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"categoryIds":{"description":"IDs of categories to which to add the item.","format":"GUID","minItems":1,"maxItems":100,"title":"categoryIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["item","item.catalogItemId","item.appId","categoryIds","treeReference","treeReference.appNamespace"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"MANAGED_CATEGORY_OPERATION_NOT_ALLOWED"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_ADD_ITEM"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Category item write","scopeId":"SCOPE.CATEGORIES.CATEGORY_ITEM_WRITE"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.BulkAddItemToCategoriesRequest","responseMessage":"com.wix.categories.api.v1.BulkAddItemToCategoriesResponse"},"legacyExamples":[{"name":"BulkAddItemToCategories","type":"METHOD","order":1,"content":{"title":"Bulk add item to categories","description":"Adds 1 item to 2 categories. Response includes 1 successful and 1 failed action.","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/bulk/categories/add-item' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"item\": {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n \"categoryIds\": [\"b13e1166-fdf2-425a-a35c-d698edcbafa7\", \"b12487f7-cc4a-46ae-9c4f-48369f76c226\"],\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"b13e1166-fdf2-425a-a35c-d698edcbafa7\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"b12487f7-cc4a-46ae-9c4f-48369f76c226\",\n \"originalIndex\": 1,\n \"success\": false,\n \"error\": {\n \"code\": \"ALREADY_EXISTS\",\n \"description\": \"Unique constraint violation\",\n \"data\": {\n \"uniqueConstraintViolation\": {\n \"fieldPaths\": [\n {\n \"paths\": [\n \"categoryId\"\n ]\n },\n {\n \"paths\": [\n \"item\",\n \"catalogItemId\"\n ]\n },\n {\n \"paths\": [\n \"item\",\n \"appId\"\n ]\n }\n ]\n }\n }\n }\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 1,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/bulk/categories/add-item","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"MANAGED_CATEGORY_OPERATION_NOT_ALLOWED"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_ADD_ITEM"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Category item write","scopeId":"SCOPE.CATEGORIES.CATEGORY_ITEM_WRITE"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.BulkAddItemToCategoriesRequest","responseMessage":"com.wix.categories.api.v1.BulkAddItemToCategoriesResponse"},"legacyExamples":[{"name":"BulkAddItemToCategories","type":"METHOD","order":1,"content":{"title":"Bulk add item to categories","description":"Adds 1 item to 2 categories. Response includes 1 successful and 1 failed action.","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/bulk/categories/add-item' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"item\": {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n \"categoryIds\": [\"b13e1166-fdf2-425a-a35c-d698edcbafa7\", \"b12487f7-cc4a-46ae-9c4f-48369f76c226\"],\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"b13e1166-fdf2-425a-a35c-d698edcbafa7\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"b12487f7-cc4a-46ae-9c4f-48369f76c226\",\n \"originalIndex\": 1,\n \"success\": false,\n \"error\": {\n \"code\": \"ALREADY_EXISTS\",\n \"description\": \"Unique constraint violation\",\n \"data\": {\n \"uniqueConstraintViolation\": {\n \"fieldPaths\": [\n {\n \"paths\": [\n \"categoryId\"\n ]\n },\n {\n \"paths\": [\n \"item\",\n \"catalogItemId\"\n ]\n },\n {\n \"paths\": [\n \"item\",\n \"appId\"\n ]\n }\n ]\n }\n }\n }\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 1,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Add Item To Categories","slugifiedName":"bulk-add-item-to-categories"},"permissionScopes":[{"name":"Category item write","scopeId":"SCOPE.CATEGORIES.CATEGORY_ITEM_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}]},{"summary":"Bulk Remove Items From Category","description":"Removes multiple items from a single category.","operationId":"com.wix.categories.api.v1.CategoriesService.BulkRemoveItemsFromCategory","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"categoryId","description":"Category ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wix.categories.api.v1.BulkRemoveItemsFromCategoryResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/categories/v1/bulk/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/categories/v1/bulk/categories","destinationPath":"/v1/bulk/categories","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkRemoveItemsFromCategoryRequest","description":"","properties":{"items":{"description":"List of items to remove.","minItems":1,"maxItems":100,"title":"items","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["categoryId","items","items.catalogItemId","items.appId","treeReference","treeReference.appNamespace"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"MANAGED_CATEGORY_OPERATION_NOT_ALLOWED"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_REMOVE_ITEM"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Category item write","scopeId":"SCOPE.CATEGORIES.CATEGORY_ITEM_WRITE"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.BulkRemoveItemsFromCategoryRequest","responseMessage":"com.wix.categories.api.v1.BulkRemoveItemsFromCategoryResponse"},"legacyExamples":[{"name":"BulkRemoveItemsFromCategory","type":"METHOD","order":1,"content":{"title":"Bulk remove items from category","description":"Removes 2 items from 1 category. Response includes 2 successful actions.","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/bulk/categories/bbd52b32-21d2-4dbe-bfc5-d320f93f8911/remove-items' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"items\": [\n {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"05519a6e-222b-413a-957c-0ef7a32779b5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n }\n ],\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"item\": {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"item\": {\n \"catalogItemId\": \"05519a6e-222b-413a-957c-0ef7a32779b5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n \"originalIndex\": 1,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/bulk/categories/{categoryId}/remove-items","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"MANAGED_CATEGORY_OPERATION_NOT_ALLOWED"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_REMOVE_ITEM"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Category item write","scopeId":"SCOPE.CATEGORIES.CATEGORY_ITEM_WRITE"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.BulkRemoveItemsFromCategoryRequest","responseMessage":"com.wix.categories.api.v1.BulkRemoveItemsFromCategoryResponse"},"legacyExamples":[{"name":"BulkRemoveItemsFromCategory","type":"METHOD","order":1,"content":{"title":"Bulk remove items from category","description":"Removes 2 items from 1 category. Response includes 2 successful actions.","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/bulk/categories/bbd52b32-21d2-4dbe-bfc5-d320f93f8911/remove-items' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"items\": [\n {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"05519a6e-222b-413a-957c-0ef7a32779b5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n }\n ],\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"item\": {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"item\": {\n \"catalogItemId\": \"05519a6e-222b-413a-957c-0ef7a32779b5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n \"originalIndex\": 1,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Remove Items From Category","slugifiedName":"bulk-remove-items-from-category"},"permissionScopes":[{"name":"Category item write","scopeId":"SCOPE.CATEGORIES.CATEGORY_ITEM_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}]},{"summary":"Bulk Remove Item From Categories","description":"Removes a single item from multiple categories.","operationId":"com.wix.categories.api.v1.CategoriesService.BulkRemoveItemFromCategories","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.categories.api.v1.BulkRemoveItemFromCategoriesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/categories/v1/bulk/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/categories/v1/bulk/categories","destinationPath":"/v1/bulk/categories","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkRemoveItemFromCategoriesRequest","description":"","properties":{"item":{"description":"Item to remove.","$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference","summary":"item","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"categoryIds":{"description":"IDs of categories from which to remove the item.","format":"GUID","minItems":1,"maxItems":100,"title":"categoryIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["item","item.catalogItemId","item.appId","categoryIds","treeReference","treeReference.appNamespace"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"MANAGED_CATEGORY_OPERATION_NOT_ALLOWED"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_REMOVE_ITEM"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Category item write","scopeId":"SCOPE.CATEGORIES.CATEGORY_ITEM_WRITE"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.BulkRemoveItemFromCategoriesRequest","responseMessage":"com.wix.categories.api.v1.BulkRemoveItemFromCategoriesResponse"},"legacyExamples":[{"name":"BulkRemoveItemFromCategories","type":"METHOD","order":1,"content":{"title":"Bulk remove item from categories","description":"Removes 1 item from 2 categories. Response includes 1 successful and 1 failed action.","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/bulk/categories/remove-item' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"item\": {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n \"categoryIds\": [\"0e6be406-643a-45ca-b540-010290c9b45c\", \"42d1d190-87c9-4f5f-8606-b7e1d1527449\"],\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"0e6be406-643a-45ca-b540-010290c9b45c\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"42d1d190-87c9-4f5f-8606-b7e1d1527449\",\n \"originalIndex\": 1,\n \"success\": false,\n \"error\": {\n \"code\": \"ITEM_NOT_IN_CATEGORY\",\n \"description\": \"Item doesn't belong to category\"\n }\n }\n },\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 1,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/bulk/categories/remove-item","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"MANAGED_CATEGORY_OPERATION_NOT_ALLOWED"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_REMOVE_ITEM"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Category item write","scopeId":"SCOPE.CATEGORIES.CATEGORY_ITEM_WRITE"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.BulkRemoveItemFromCategoriesRequest","responseMessage":"com.wix.categories.api.v1.BulkRemoveItemFromCategoriesResponse"},"legacyExamples":[{"name":"BulkRemoveItemFromCategories","type":"METHOD","order":1,"content":{"title":"Bulk remove item from categories","description":"Removes 1 item from 2 categories. Response includes 1 successful and 1 failed action.","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/bulk/categories/remove-item' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"item\": {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n \"categoryIds\": [\"0e6be406-643a-45ca-b540-010290c9b45c\", \"42d1d190-87c9-4f5f-8606-b7e1d1527449\"],\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"0e6be406-643a-45ca-b540-010290c9b45c\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"42d1d190-87c9-4f5f-8606-b7e1d1527449\",\n \"originalIndex\": 1,\n \"success\": false,\n \"error\": {\n \"code\": \"ITEM_NOT_IN_CATEGORY\",\n \"description\": \"Item doesn't belong to category\"\n }\n }\n },\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 1,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Remove Item From Categories","slugifiedName":"bulk-remove-item-from-categories"},"permissionScopes":[{"name":"Category item write","scopeId":"SCOPE.CATEGORIES.CATEGORY_ITEM_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}]},{"summary":"List Items In Category","description":"Retrieves a list of up to 100 items from a single category, given the provided cursor paging.\n\n\nList Items In Categories defaults to sorting by the time the item was added to the category, in descending order.","operationId":"com.wix.categories.api.v1.CategoriesService.ListItemsInCategory","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"categoryId","description":"Category ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wix.categories.api.v1.ListItemsInCategoryResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/categories/v1/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/categories/v1/categories","destinationPath":"/v1/categories","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"ListItemsInCategoryRequest","description":"","properties":{"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"useCategoryArrangement":{"description":"Whether to use category arrangement for sorting items.\n\nDefault: `false`","title":"useCategoryArrangement","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"includeItemsFromSubcategories":{"description":"Whether to include items from subcategories.\n\nDefault: `false` (only direct items of the category will be returned)","title":"includeItemsFromSubcategories","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wix.categories.api.v1.ListItemsInCategoryRequest.pagingMethod"}],"required":["categoryId","treeReference","treeReference.appNamespace"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.ListItemsInCategoryRequest","responseMessage":"com.wix.categories.api.v1.ListItemsInCategoryResponse"},"legacyExamples":[{"name":"ListItemsInCategory","type":"METHOD","order":2,"content":{"title":"List items in category with manual arrangement","description":"List items in category with manual arrangement","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/categories/bbd52b32-21d2-4dbe-bfc5-d320f93f8911/list-items' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n -d '{\n \"useCategoryArrangement\": true,\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }'","response":"{\n \"items\": [\n {\n \"catalogItemId\": \"77b6a4b3-1542-49bd-918a-5501a5d859f5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"05519a6e-222b-413a-957c-0ef7a32779b5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 3,\n \"cursors\": {}\n }\n}"}},{"name":"ListItemsInCategory","type":"METHOD","order":1,"content":{"title":"List items in category","description":"List items in category","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/categories/bbd52b32-21d2-4dbe-bfc5-d320f93f8911/list-items' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n -d '{\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }'","response":"{\n \"items\": [\n {\n \"catalogItemId\": \"77b6a4b3-1542-49bd-918a-5501a5d859f5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"05519a6e-222b-413a-957c-0ef7a32779b5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 3,\n \"cursors\": {}\n }\n}"}},{"name":"ListItemsInCategory","type":"METHOD","order":3,"content":{"title":"List items in category including items from subcategories","description":"List items in category including items from subcategories","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/categories/bbd52b32-21d2-4dbe-bfc5-d320f93f8911/list-items' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n -d '{\n \"includeItemsFromSubcategories\": true,\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }'","response":"{\n \"items\": [\n {\n \"catalogItemId\": \"77b6a4b3-1542-49bd-918a-5501a5d859f5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"21e6b358-36d3-4329-ad13-d19f954a91d6\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"195076a0-0cd7-43d6-aa30-732ceef5d9de\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"05519a6e-222b-413a-957c-0ef7a32779b5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 6,\n \"cursors\": {}\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/categories/{categoryId}/list-items","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.ListItemsInCategoryRequest","responseMessage":"com.wix.categories.api.v1.ListItemsInCategoryResponse"},"legacyExamples":[{"name":"ListItemsInCategory","type":"METHOD","order":2,"content":{"title":"List items in category with manual arrangement","description":"List items in category with manual arrangement","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/categories/bbd52b32-21d2-4dbe-bfc5-d320f93f8911/list-items' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n -d '{\n \"useCategoryArrangement\": true,\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }'","response":"{\n \"items\": [\n {\n \"catalogItemId\": \"77b6a4b3-1542-49bd-918a-5501a5d859f5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"05519a6e-222b-413a-957c-0ef7a32779b5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 3,\n \"cursors\": {}\n }\n}"}},{"name":"ListItemsInCategory","type":"METHOD","order":1,"content":{"title":"List items in category","description":"List items in category","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/categories/bbd52b32-21d2-4dbe-bfc5-d320f93f8911/list-items' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n -d '{\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }'","response":"{\n \"items\": [\n {\n \"catalogItemId\": \"77b6a4b3-1542-49bd-918a-5501a5d859f5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"05519a6e-222b-413a-957c-0ef7a32779b5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 3,\n \"cursors\": {}\n }\n}"}},{"name":"ListItemsInCategory","type":"METHOD","order":3,"content":{"title":"List items in category including items from subcategories","description":"List items in category including items from subcategories","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/categories/bbd52b32-21d2-4dbe-bfc5-d320f93f8911/list-items' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n -d '{\n \"includeItemsFromSubcategories\": true,\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }'","response":"{\n \"items\": [\n {\n \"catalogItemId\": \"77b6a4b3-1542-49bd-918a-5501a5d859f5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"21e6b358-36d3-4329-ad13-d19f954a91d6\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"195076a0-0cd7-43d6-aa30-732ceef5d9de\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"05519a6e-222b-413a-957c-0ef7a32779b5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 6,\n \"cursors\": {}\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"List Items In Category","slugifiedName":"list-items-in-category"},"permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"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"}]},{"summary":"List Categories For Item","description":"Retrieves a list of categories that contain the specified item.","operationId":"com.wix.categories.api.v1.CategoriesService.ListCategoriesForItem","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.categories.api.v1.ListCategoriesForItemResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/categories/v1/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/categories/v1/categories","destinationPath":"/v1/categories","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"ListCategoriesForItemRequest","description":"","properties":{"item":{"description":"Item reference info.","$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference","summary":"item","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["item","treeReference","treeReference.appNamespace"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.ListCategoriesForItemRequest","responseMessage":"com.wix.categories.api.v1.ListCategoriesForItemResponse"},"legacyExamples":[{"name":"ListCategoriesForItem","type":"METHOD","order":1,"content":{"title":"List categories for item","description":"List all categories that contain the item and their parent category.","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/categories/list-categories-for-item' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n -d '{\n \"item\": {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }'","response":"{\n \"directCategoryIds\": [\n \"b13e1166-fdf2-425a-a35c-d698edcbafa7\"\n ],\n \"allCategoryIds\": [\n \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"b13e1166-fdf2-425a-a35c-d698edcbafa7\"\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/categories/list-categories-for-item","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.ListCategoriesForItemRequest","responseMessage":"com.wix.categories.api.v1.ListCategoriesForItemResponse"},"legacyExamples":[{"name":"ListCategoriesForItem","type":"METHOD","order":1,"content":{"title":"List categories for item","description":"List all categories that contain the item and their parent category.","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/categories/list-categories-for-item' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n -d '{\n \"item\": {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }'","response":"{\n \"directCategoryIds\": [\n \"b13e1166-fdf2-425a-a35c-d698edcbafa7\"\n ],\n \"allCategoryIds\": [\n \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"b13e1166-fdf2-425a-a35c-d698edcbafa7\"\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"List Categories For Item","slugifiedName":"list-categories-for-item"},"permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"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"}]},{"summary":"List Trees","description":"Retrieves a list of all trees installed on the site, sorted by `appNamespace` in ascending order.","operationId":"com.wix.categories.api.v1.CategoriesService.ListTrees","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.categories.api.v1.ListTreesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/categories/v1/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/categories/v1/categories","destinationPath":"/v1/categories","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.ListTreesRequest","responseMessage":"com.wix.categories.api.v1.ListTreesResponse"},"legacyExamples":[{"name":"ListTrees","type":"METHOD","order":1,"content":{"title":"List trees","description":"Returns the list of all category trees existing on the site.","request":"curl -X GET \\\n 'https://www.wixapis.com/categories/v1/categories/list-trees \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"trees\": [\n {\n \"appNamespace\": \"@bookings/bookingslist\",\n \"treeKey\": \"en\"\n },\n {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"get","path":"/v1/categories/list-trees","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.ListTreesRequest","responseMessage":"com.wix.categories.api.v1.ListTreesResponse"},"legacyExamples":[{"name":"ListTrees","type":"METHOD","order":1,"content":{"title":"List trees","description":"Returns the list of all category trees existing on the site.","request":"curl -X GET \\\n 'https://www.wixapis.com/categories/v1/categories/list-trees \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"trees\": [\n {\n \"appNamespace\": \"@bookings/bookingslist\",\n \"treeKey\": \"en\"\n },\n {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"List Trees","slugifiedName":"list-trees"},"permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"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"}]},{"summary":"Set Arranged Items","description":"Sets arranged items in a category.\n\nThe order of items in the `items` array determines the order of items in the category.\nThe category's existing list of arranged items will be overridden.","operationId":"com.wix.categories.api.v1.CategoriesService.SetArrangedItems","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"categoryId","description":"Category ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wix.categories.api.v1.SetArrangedItemsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/categories/v1/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/categories/v1/categories","destinationPath":"/v1/categories","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"SetArrangedItemsRequest","description":"","properties":{"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"items":{"description":"List of items to set.","maxItems":100,"title":"items","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["categoryId","treeReference","treeReference.appNamespace"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ITEM_NOT_IN_CATEGORY"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_MOVE_ITEM"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Category item write","scopeId":"SCOPE.CATEGORIES.CATEGORY_ITEM_WRITE"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.SetArrangedItemsRequest","responseMessage":"com.wix.categories.api.v1.SetArrangedItemsResponse"},"legacyExamples":[{"name":"SetArrangedItems","type":"METHOD","content":{"title":"Set arranged items","description":"Set the manual order of 3 items in a category.","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/categories/bbd52b32-21d2-4dbe-bfc5-d320f93f8911/set-arranged-items' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"items\": [\n {\n \"catalogItemId\": \"77b6a4b3-1542-49bd-918a-5501a5d859f5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"05519a6e-222b-413a-957c-0ef7a32779b5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n }\n ],\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n }'","response":"{\n \"items\": [\n {\n \"catalogItemId\": \"77b6a4b3-1542-49bd-918a-5501a5d859f5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"05519a6e-222b-413a-957c-0ef7a32779b5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/categories/{categoryId}/set-arranged-items","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ITEM_NOT_IN_CATEGORY"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_MOVE_ITEM"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Category item write","scopeId":"SCOPE.CATEGORIES.CATEGORY_ITEM_WRITE"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.SetArrangedItemsRequest","responseMessage":"com.wix.categories.api.v1.SetArrangedItemsResponse"},"legacyExamples":[{"name":"SetArrangedItems","type":"METHOD","content":{"title":"Set arranged items","description":"Set the manual order of 3 items in a category.","request":"curl -X POST \\\n 'https://www.wixapis.com/categories/v1/categories/bbd52b32-21d2-4dbe-bfc5-d320f93f8911/set-arranged-items' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"items\": [\n {\n \"catalogItemId\": \"77b6a4b3-1542-49bd-918a-5501a5d859f5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"05519a6e-222b-413a-957c-0ef7a32779b5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n }\n ],\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n }'","response":"{\n \"items\": [\n {\n \"catalogItemId\": \"77b6a4b3-1542-49bd-918a-5501a5d859f5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"05519a6e-222b-413a-957c-0ef7a32779b5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Set Arranged Items","slugifiedName":"set-arranged-items"},"permissionScopes":[{"name":"Category item write","scopeId":"SCOPE.CATEGORIES.CATEGORY_ITEM_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}]},{"summary":"Get Arranged Items","description":"Retrieves a list of arranged items in a category.","operationId":"com.wix.categories.api.v1.CategoriesService.GetArrangedItems","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"categoryId","description":"Category ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"treeReference","in":"query","description":"Category tree reference details.","required":true,"schema":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wix.categories.api.v1.GetArrangedItemsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/categories/v1/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/categories/v1/categories","destinationPath":"/v1/categories","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.GetArrangedItemsRequest","responseMessage":"com.wix.categories.api.v1.GetArrangedItemsResponse"},"legacyExamples":[{"name":"GetArrangedItems","type":"METHOD","order":1,"content":{"title":"Get arranged items","description":"Get the manual order of items in a category.","request":"curl -X GET \\\n 'https://www.wixapis.com/categories/v1/categories/bbd52b32-21d2-4dbe-bfc5-d320f93f8911/arranged-items?treeReference.appNamespace=%40wix%2Fstores' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"items\": [\n {\n \"catalogItemId\": \"77b6a4b3-1542-49bd-918a-5501a5d859f5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"05519a6e-222b-413a-957c-0ef7a32779b5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"get","path":"/v1/categories/{categoryId}/arranged-items","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.categories.api.v1.CategoriesService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["CATEGORIES.CATEGORY_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.categories:categories-service","serviceArtifactId":"com.wixpress.categories.categories-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.categories.api.v1.GetArrangedItemsRequest","responseMessage":"com.wix.categories.api.v1.GetArrangedItemsResponse"},"legacyExamples":[{"name":"GetArrangedItems","type":"METHOD","order":1,"content":{"title":"Get arranged items","description":"Get the manual order of items in a category.","request":"curl -X GET \\\n 'https://www.wixapis.com/categories/v1/categories/bbd52b32-21d2-4dbe-bfc5-d320f93f8911/arranged-items?treeReference.appNamespace=%40wix%2Fstores' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"items\": [\n {\n \"catalogItemId\": \"77b6a4b3-1542-49bd-918a-5501a5d859f5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"05519a6e-222b-413a-957c-0ef7a32779b5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Get Arranged Items","slugifiedName":"get-arranged-items"},"permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"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"}]}],"webhooks":[{"summary":"Category Created","title":"Category Created","description":"","permissions":["CATEGORIES.CATEGORY_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.categories.v1.category","serviceName":"","domainEvent":"CREATED","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"wix.categories.v1.category_created","legacyExamples":[{"name":"CategoryCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"6b5a762c-eb38-4bb5-bee2-358d1bd571d5\",\n \"entityFqdn\": \"wix.categories.v1.category\",\n \"slug\": \"created\",\n \"entityId\": \"deba80ab-9935-44bd-a21e-6d51fd58321e\",\n \"createdEvent\": {\n \"entityAsJson\": {\n \"id\": \"deba80ab-9935-44bd-a21e-6d51fd58321e\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-27T14:41:34.619Z\",\n \"updatedDate\": \"2024-06-27T14:41:34.619Z\",\n \"name\": \"Wine Glasses\",\n \"numberOfItems\": 0,\n \"itemCounter\": 0,\n \"totalItemCounter\": 0,\n \"description\": \"Explore our exquisite collection of wine glasses designed to elevate your drinking experience\",\n \"visible\": true,\n \"parentCategory\": {\n \"id\": \"b12487f7-cc4a-46ae-9c4f-48369f76c226\",\n \"index\": 1\n },\n \"slug\": \"wine-glasses\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }\n },\n \"eventTime\": \"2024-06-27T14:41:34.729332288Z\",\n \"triggeredByAnonymizeRequest\": false,\n \"entityEventSequence\": \"1\"\n}"}],"$ref":"#/components/schemas/com.wix.categories.api.v1.Category","contentLink":{"displayName":"Category Created","slugifiedName":"category-created"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"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"}]},{"summary":"Category Updated","title":"Category Updated","description":"","permissions":["CATEGORIES.CATEGORY_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.categories.v1.category","serviceName":"","domainEvent":"UPDATED","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"wix.categories.v1.category_updated","legacyExamples":[{"name":"CategoryUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"8335bd4d-0972-4c9f-bef0-25d9f14168a7\",\n \"entityFqdn\": \"wix.categories.v1.category\",\n \"slug\": \"updated\",\n \"entityId\": \"273287a2-24f1-4c5d-8463-d7282f65a63f\",\n \"updatedEvent\": {\n \"currentEntityAsJson\": {\n \"id\": \"273287a2-24f1-4c5d-8463-d7282f65a63f\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-04-09T04:38:25.891Z\",\n \"updatedDate\": \"2024-06-27T11:08:18.774Z\",\n \"name\": \"All Products\",\n \"numberOfItems\": 10,\n \"itemCounter\": 10,\n \"totalItemCounter\": 0,\n \"visible\": true,\n \"parentCategory\": {\n \"index\": 1\n },\n \"slug\": \"all-products\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n },\n \"managingAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n }\n },\n \"eventTime\": \"2024-06-27T11:08:18.912162308Z\",\n \"triggeredByAnonymizeRequest\": false,\n \"entityEventSequence\": \"15\"\n}"}],"$ref":"#/components/schemas/com.wix.categories.api.v1.Category","contentLink":{"displayName":"Category Updated","slugifiedName":"category-updated"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"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"}]},{"summary":"Category Deleted","title":"Category Deleted","description":"","permissions":["CATEGORIES.CATEGORY_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.categories.v1.category","serviceName":"","domainEvent":"DELETED","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"wix.categories.v1.category_deleted","legacyExamples":[{"name":"CategoryDeleted","eventType":"DELETED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"8ff6c624-c1ec-478b-aa03-ab1ded85e3ac\",\n \"entityFqdn\": \"wix.categories.v1.category\",\n \"slug\": \"deleted\",\n \"entityId\": \"b13e1166-fdf2-425a-a35c-d698edcbafa7\",\n \"deletedEvent\": {},\n \"eventTime\": \"2024-06-27T14:01:35.808787048Z\",\n \"triggeredByAnonymizeRequest\": false,\n \"entityEventSequence\": \"17\"\n}"}],"$ref":"#/components/schemas/com.wix.categories.api.v1.Category","contentLink":{"displayName":"Category Deleted","slugifiedName":"category-deleted"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"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"}]},{"summary":"Category Category Moved","title":"Category Category Moved","description":"Triggered when a category is moved.","permissions":["CATEGORIES.CATEGORY_READ"],"payload":{"schemaName":"com.wix.categories.api.v1.CategoryMoved"},"exposure":"PUBLIC","maturity":"BETA","slug":"category_moved","eventTopic":"domain_events_wix.categories.v1.category","serviceName":"","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"wix.categories.v1.category_category_moved","legacyExamples":[{"name":"CategoryMoved","eventType":"ACTION","type":"DOMAIN_EVENT","content":"{\n \"id\": \"927e5c5f-a884-4857-b9de-aa49ce34da56\",\n \"entityFqdn\": \"wix.categories.v1.category\",\n \"slug\": \"category_moved\",\n \"entityId\": \"3cc24beb-bd90-4183-add5-354198c0f66b\",\n \"actionEvent\": {\n \"bodyAsJson\": {\n \"categoryId\": \"3cc24beb-bd90-4183-add5-354198c0f66b\",\n \"parentCategory\": {\n \"id\": \"b12487f7-cc4a-46ae-9c4f-48369f76c226\",\n \"index\": 0\n },\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }\n },\n \"eventTime\": \"2024-07-21T08:44:51.276796889Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"$ref":"#/components/schemas/com.wix.categories.api.v1.CategoryMoved","contentLink":{"displayName":"Category Moved","slugifiedName":"category-moved"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"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"}]},{"summary":"Category Items Arranged In Category","title":"Category Items Arranged In Category","description":"Triggered when items arrangement in category is changed.","permissions":["CATEGORIES.CATEGORY_READ"],"payload":{"schemaName":"com.wix.categories.api.v1.ItemsArrangedInCategory"},"exposure":"PUBLIC","maturity":"BETA","slug":"items_arranged_in_category","eventTopic":"domain_events_wix.categories.v1.category","serviceName":"","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"wix.categories.v1.category_items_arranged_in_category","legacyExamples":[{"name":"ItemsArrangedInCategory","eventType":"ACTION","type":"DOMAIN_EVENT","content":"{\n \"id\": \"c71e3572-4ea9-41b5-bb84-98c647a28e4d\",\n \"entityFqdn\": \"wix.categories.v1.category\",\n \"slug\": \"items_arranged_in_category\",\n \"entityId\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"actionEvent\": {\n \"bodyAsJson\": {\n \"categoryId\": \"bbd52b32-21d2-4dbe-bfc5-d320f93f8911\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n }\n }\n },\n \"eventTime\": \"2024-06-27T13:36:35.006358109Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"$ref":"#/components/schemas/com.wix.categories.api.v1.ItemsArrangedInCategory","contentLink":{"displayName":"Items Arranged In Category","slugifiedName":"items-arranged-in-category"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"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"}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Wix Categories API\n\nThe Wix Categories API allows you to create and manage a tree of categories on your site. \n\nThis API provides essentials tools to establish hierarchical relationships between categories, helping you organize and classify items assigned to these categories.\n\nWith the Wix Categories API, you can:\n- Manage categories and assign them to parent categories.\n- Add and remove items from categories.\n- Specify the manual arrangement of items within a category.\n- Retrieve information about items assigned to a category, directly or indirectly.\n\n## Before you begin\nIt’s important to note the following points before starting to code:\n- The Categories app is currently available only as part of 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- Your app has the necessary permissions to access the Categories API.\n\n## Limitations\nWix Categories is currently limited to:\n1. 1,000 Categories per Tree.\n2. Up to 5 hierarchies levels. \n3. Each category can belong to only one parent category. \n4. Items can be associated with many categories, up to 1,000. \n5. Only the first 100 items within a category can be arranged manually. \n6. Updating visible field to `false` and delete behaviors apply from parent categories to subcategories.\n\n## Sample flows\n* [Create category and subcategory](fallback::./sample-flows#create-category-and-subcategory)\n* [Add and arrange items in category](fallback::./sample-flows#add-and-arrange-items-in-category)\n* [Move subcategory to a different position within a parent category](fallback::./sample-flows#move-subcategory-to-a-different-position-within-a-parent-category)\n* [Find all subcategories of a category](fallback::./sample-flows#find-all-subcategories-of-a-category)\n\n## Terminology\n1. **Tree**: A hierarchical structure of categories. Each tree can have up to 1,000 categories.\n2. **Tree Reference**: A unique identifier for the tree. Defined by app namespace and optionally tree key. Must be provided in all API requests.\n3. **App Namespace**: A unique identifier for the app that owns the tree. This namespace must be defined in dev-center before using the API.\n4. **Tree Key**: An optional key to differentiate between multiple trees managed by the same app. It can be empty, if an app only manages one tree. \n5. **Parent Category**: Each category can have a single parent category for managing a nested hierarchy. The parent Category can be empty when category is at the top level of the hierarchy or for flat category structures.\n6. **SubCategory**: A category nested under another category. Multiple subcategories can exist under a single parent category.\n7. **Depth**: The maximum nesting level allowed within the tree, limited to 5 levels.\n8. **Breadcrumbs**: A path from top-level category to the current category, helping users understand their location within the hierarchy and navigate back to parent categories.\n9. **Item Reference**: Identifies an item assigned to a category, consisting of an appId and a catalogItemId.\n10. **Manual Arrangement**: Allows merchants to manually set the order of items within a category. Up to 100 items can be rearranged to make them displayed in the beginning, while the rest are displayed in the order they were added to the category."},{"displayName":"Sample Use Cases and Flows","slugifyName":"sample-use-cases-and-flows","content":"# Categories: Sample Use Cases and Flows\n\nThis article shares some possible use cases your app could support, as well as\na sample flow that could support each use case. This can be a helpful jumping\noff point as you plan your app's implementation.\n\n## Create category and subcategory\nHelp merchant organize their hierarchy by creating new categories and subcategories.\n1. To create new category call [Create Category](fallback::https://dev.wix.com/docs/rest/business-management/categories/create-category) endpoint. \nIn the request body in addition to `category` you need to pass `treeReference` to specify the tree in which the category will be created.\nThe category will be created in the top nesting level of the tree.\n```json\n{\n \"category\": {\n \"name\": \"Drinkware\",\n \"description\": \"The Drinkware category includes a wide range of containers designed for holding beverages\",\n \"visible\": true\n },\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n}\n```\nSave `category.id` from response.\n\n2. To create subcategory within the newly created category call [Create Category](fallback::https://dev.wix.com/docs/rest/business-management/categories/create-category) endpoint again.\nThis time, include the `parentCategory.id` to specify the parent category that will be assigned.\nThe `treeReference` will be the same as you sent in step 1.\n```json\n{\n \"category\": {\n \"name\": \"Mugs\",\n \"description\": \"The Mugs subcategory includes a wide range of containers designed for holding hot beverages\",\n \"visible\": true,\n \"parentCategory\": {\n \"id\": \"\"\n }\n },\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n}\n```\nReplace `` with category id from response of step 1.\n\n## Add and arrange items in category\nHelp merchant to organize and classify their items by using categories.\nIn this scenario, you will assign set of items to a category and arrange them in a specific order.\n1. Add selected items to category by calling [Bulk Add Items To Category](fallback::https://dev.wix.com/docs/rest/business-management/categories/bulk-add-items-to-category) endpoint.\n\nIn the request path, include `category.id` that you received in response of previous scenario. \nIn the request body `treeReference` will also be the same and in `items` you can send all items that you want to add to category, Each item is referenced by pair of `appId` and `catalogItemId`.\n```json\n{\n \"items\": [\n {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"05519a6e-222b-413a-957c-0ef7a32779b5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"060b9b04-fe14-487d-8336-2d285c50cf98\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n }\n ],\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n}\n```\n\n3. After adding the items to the category, you can rearrange them for example to promote some items to be displayed in the beginning. Note that you can arrange up to 100 items, more items can be added, but you cannot control arrangement of them. \nCall [Set Arranged Items](fallback::https://dev.wix.com/docs/rest/business-management/categories/set-arranged-items) endpoint. Pass exactly same params as in step 1 but now `items` must be in desired order in which you want to see them.\n4. To display all items that belong to given category in the specified arrangement from previous step, use [List Items In Category](fallback::https://dev.wix.com/docs/rest/business-management/categories/list-items-in-category) endpoint.\nIn the request path, include same `category.id` from previous steps and in the request body, send the following:\n \n```json\n{\n \"useCategoryArrangement\": true,\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n}\n```\n\n### Move subcategory to a different position within a parent category\nMerchant may want to change the position of a category in the hierarchy.\n\n1. Use the [Create Category](fallback::https://dev.wix.com/docs/rest/business-management/categories/create-category) endpoint to create an additional subcategory within the parent category.\n In the request body as part of the `category` you need to also provide `parentCategory.id` to specify the parent category that will be assigned.\n```json\n{\n \"category\": {\n \"name\": \"Bottles\",\n \"description\": \"The Bottles subcategory offers a diverse selection of containers designed for carrying and consuming beverages\",\n \"visible\": true,\n \"parentCategory\": {\n \"id\": \"\"\n }\n },\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n}\n```\nSave `category.id` from response.\n\n2. To move the category to a different position in same parent category call [Move Category](fallback::https://dev.wix.com/docs/rest/business-management/categories/move-category) endpoint. \n In the request path, include the `category.id` of the category you want to move.\n In the request, provide the `parentCategoryId` and specify `position` as `FIRST` to move the subcategory to the beginning.\n```json\n{\n \"parentCategoryId\": \"\",\n \"position\": \"FIRST\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n}\n```\nReplace `` with category id from response of previous scenarios.\n\n### Find all subcategories of a category\n\nIn this scenario, you want to retrieve a list of all subcategories that belong to a specific parent category, in the correct order. This is useful for traversing the category hierarchy.\n\nUse the [Search Categories](fallback::https://dev.wix.com/docs/rest/business-management/categories/search-categories) endpoint.\nIn the request body, include the `parentCategory.id` in the `filter` parameter and sort by `parentCategory.index` in ascending order:\n```json\n{\n \"search\": {\n \"filter\": {\"parentCategory.id\": {\"$eq\": \"\" }},\n \"sort\": [{\"fieldName\": \"parentCategory.index\", \"order\": \"ASC\"}]\n },\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n },\n \"fields\": [\n \"BREADCRUMBS\"\n ]\n}\n```\nReplace `` with parent category id from previous scenarios.\n"},{"displayName":"Supported Filters and Sorting","slugifyName":"supported-filters-and-sorting","content":"# Categories: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting for the category object:\n\n| Field | Supported Filters | Sortable |\n|------------------------------|-------------------------------------------------------------------------|----------|\n| `id` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | |\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| `description` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | |\n| `visible` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome` | |\n| `slug` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | |\n| `parentCategory.id` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | Sortable |\n| `parentCategory.index` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$le`, `$gt`, `$ge` | Sortable |\n| `treeReference.appNamespace` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | |\n| `treeReference.treeKey` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | |\n| `treeReference.treeValue` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | |\n\n\n__Related content:__\n[API Query Language](fallback::https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),\n[Search Categories](fallback::https://dev.wix.com/docs/rest/business-management/categories/search-categories)\n"}],"components":{"schemas":{"com.wix.categories.api.v1.Category":{"type":"object","properties":{"id":{"description":"Category ID.","format":"GUID","immutable":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time the category is updated.\nTo prevent conflicting changes, the current revision must be passed when updating.\n\nIgnored when creating a category.","readOnly":true,"title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the category was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the category was updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Category name.","minLength":1,"maxLength":80,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"image":{"description":"Category image.\n\n+ Pass WixMedia image ID for media previously saved in the [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager).\n+ Pass full image URL to upload to Wix Media Manager.","$ref":"#/components/schemas/com.wix.media.site_media.upstream.wix.common.Image","summary":"image","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"itemCounter":{"description":"Number of items in this category.","readOnly":true,"title":"itemCounter","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Category description.\n> **Note:** This field is returned only when you pass `fields: \"DESCRIPTION\"` in the request.","minLength":1,"maxLength":600,"title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"visible":{"description":"Whether the category is visible to site visitors in dynamic pages.\n\n+ If the parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.\n+ Passing `true` will fail if the visibility of any parent categories is `false`.\n+ Default: `false`.","immutable":true,"title":"visible","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"breadcrumbs":{"description":"Category breadcrumbs.\n\n> **Note:** Returned only when you pass `\"BREADCRUMBS\"` to the `fields` array in Categories API requests.","readOnly":true,"$ref":"#/components/schemas/com.wix.categories.api.v1.BreadcrumbItemValues","summary":"breadcrumbs","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"parentCategory":{"description":"Parent category reference data.","immutable":true,"$ref":"#/components/schemas/com.wix.categories.api.v1.ParentCategory","summary":"parentCategory","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"Category slug.\n\nIf not provided, the slug is autogenerated based on the category name.","format":"URL_SLUG","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"richContentDescription":{"description":"Category description using rich content.\n\nLearn more about [Working with Rich Content](https://dev.wix.com/docs/go-headless/tutorials-templates/other-tutorials/working-with-rich-content).\n> **Note:** Returned only when you pass `\"RICH_CONTENT_DESCRIPTION\"` to the `fields` array in Categories API requests.","$ref":"#/components/schemas/wix.rich_content.v1.RichContent","summary":"richContentDescription","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"managingAppId":{"description":"ID of the app responsible for managing the items in this category.\n\nPass your app ID to restrict updating and deleting items in this category to your app only.","format":"GUID","immutable":true,"title":"managingAppId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"extendedFields":{"description":"Custom extended fields for the category object.\n\n[Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the Wix Dev Center before they can be accessed with API calls.","$ref":"#/components/schemas/wix.common.data.dataextensions.ExtendedFields","summary":"extendedFields","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Category","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"com.wix.media.site_media.upstream.wix.common.Image":{"type":"object","properties":{"id":{"description":"WixMedia image ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"Image URL.","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"Original image height.","readOnly":true,"title":"height","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"Original image width.","readOnly":true,"title":"width","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"altText":{"description":"Image alt text.","title":"altText","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filename":{"description":"Image filename.","readOnly":true,"title":"filename","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Image","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"com.wix.categories.api.v1.BreadcrumbItemValues":{"type":"object","properties":{"values":{"description":"List of breadcrumb data.","readOnly":true,"maxItems":5,"title":"values","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.BreadcrumbItem"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BreadcrumbItemValues","description":""},"com.wix.categories.api.v1.BreadcrumbItem":{"type":"object","properties":{"categoryId":{"description":"Category ID.","format":"GUID","title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"categoryName":{"description":"Category name.","minLength":1,"maxLength":80,"title":"categoryName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"categorySlug":{"description":"Category slug.","minLength":1,"maxLength":100,"title":"categorySlug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BreadcrumbItem","description":""},"com.wix.categories.api.v1.ParentCategory":{"type":"object","properties":{"id":{"description":"Parent category ID.\n\nDefault: root category ID","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"index":{"description":"Index position of the category within the parent category.","readOnly":true,"title":"index","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ParentCategory","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"com.wixpress.advanced.seo.SeoSchema":{"type":"object","properties":{"tags":{"description":"SEO tag information.","title":"tags","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.advanced.seo.SeoSchema.Tag"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"settings":{"description":"SEO general settings.","$ref":"#/components/schemas/com.wixpress.advanced.seo.SeoSchema.Settings","summary":"settings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SeoSchema","description":"The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.\nThe search engines use this information for ranking purposes, or to display snippets in the search results.\nThis data will override other sources of tags (for example patterns) and will be included in the section of the HTML document, while not being displayed on the page itself."},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"com.wixpress.advanced.seo.SeoSchema.Keyword":{"type":"object","properties":{"term":{"description":"Keyword value.","title":"term","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"isMain":{"description":"Whether the keyword is the main focus keyword.","title":"isMain","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"origin":{"description":"Who added the keyword to the settings","maxLength":1000,"title":"origin","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Keyword","description":""},"com.wixpress.advanced.seo.SeoSchema.Tag":{"type":"object","properties":{"type":{"description":"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.","title":"type","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"props":{"description":"A `{'key':'value'}` pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.\nFor example: `{'name': 'description', 'content': 'the description itself'}`.","title":"props","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"meta":{"description":"SEO tag meta data. For example, `{height: 300, width: 240}`.","title":"meta","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"children":{"description":"SEO tag inner content. For example, ` inner content `.","title":"children","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"custom":{"description":"Whether the tag is a custom tag.","title":"custom","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"disabled":{"description":"Whether the tag is disabled.","title":"disabled","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Tag","description":""},"com.wixpress.advanced.seo.SeoSchema.Settings":{"type":"object","properties":{"preventAutoRedirect":{"description":"Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.\n\n\nDefault: `false` (Auto Redirect is enabled.)","title":"preventAutoRedirect","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"keywords":{"description":"User-selected keyword terms for a specific page.","maxItems":5,"title":"keywords","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.advanced.seo.SeoSchema.Keyword"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Settings","description":""},"wix.rich_content.v1.RichContent":{"type":"object","properties":{"nodes":{"description":"Node objects representing a rich content document.","title":"nodes","type":"array","items":{"$ref":"#/components/schemas/wix.rich_content.v1.Node"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metadata":{"description":"Object metadata.","$ref":"#/components/schemas/wix.rich_content.v1.Metadata","summary":"metadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"documentStyle":{"description":"Global styling for header, paragraph, block quote, and code block nodes in the object.","$ref":"#/components/schemas/wix.rich_content.v1.DocumentStyle","summary":"documentStyle","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RichContent","description":""},"wix.rich_content.v1.Node":{"type":"object","properties":{"type":{"description":"Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format.","title":"type","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.Node.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"id":{"description":"Node ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nodes":{"description":"A list of child nodes.","title":"nodes","type":"array","items":{"$ref":"#/components/schemas/wix.rich_content.v1.Node"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"style":{"description":"Padding and background color styling for the node.","$ref":"#/components/schemas/wix.rich_content.v1.NodeStyle","summary":"style","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Node","description":"","oneOf":[{"description":"","summary":"data","$ref":"#/components/schemas/wix.rich_content.v1.Node.data"}]},"wix.rich_content.v1.Node.data":{"type":"object","title":"data","properties":{"buttonData":{"description":"Data for a button node.","$ref":"#/components/schemas/wix.rich_content.v1.ButtonData","summary":"buttonData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"codeBlockData":{"description":"Data for a code block node.","$ref":"#/components/schemas/wix.rich_content.v1.CodeBlockData","summary":"codeBlockData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dividerData":{"description":"Data for a divider node.","$ref":"#/components/schemas/wix.rich_content.v1.DividerData","summary":"dividerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fileData":{"description":"Data for a file node.","$ref":"#/components/schemas/wix.rich_content.v1.FileData","summary":"fileData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"galleryData":{"description":"Data for a gallery node.","$ref":"#/components/schemas/wix.rich_content.v1.GalleryData","summary":"galleryData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"gifData":{"description":"Data for a GIF node.","$ref":"#/components/schemas/wix.rich_content.v1.GIFData","summary":"gifData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"headingData":{"description":"Data for a heading node.","$ref":"#/components/schemas/wix.rich_content.v1.HeadingData","summary":"headingData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"htmlData":{"description":"Data for an embedded HTML node.","$ref":"#/components/schemas/wix.rich_content.v1.HTMLData","summary":"htmlData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"imageData":{"description":"Data for an image node.","$ref":"#/components/schemas/wix.rich_content.v1.ImageData","summary":"imageData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"linkPreviewData":{"description":"Data for a link preview node.","$ref":"#/components/schemas/wix.rich_content.v1.LinkPreviewData","summary":"linkPreviewData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mapData":{"description":"Data for a map node.","$ref":"#/components/schemas/wix.rich_content.v1.MapData","summary":"mapData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paragraphData":{"description":"Data for a paragraph node.","$ref":"#/components/schemas/wix.rich_content.v1.ParagraphData","summary":"paragraphData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pollData":{"description":"Data for a poll node.","$ref":"#/components/schemas/wix.rich_content.v1.PollData","summary":"pollData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"textData":{"description":"Data for a text node. Used to apply decorations to text.","$ref":"#/components/schemas/wix.rich_content.v1.TextData","summary":"textData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appEmbedData":{"description":"Data for an app embed node.","$ref":"#/components/schemas/wix.rich_content.v1.AppEmbedData","summary":"appEmbedData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"videoData":{"description":"Data for a video node.","$ref":"#/components/schemas/wix.rich_content.v1.VideoData","summary":"videoData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"embedData":{"description":"Data for an oEmbed node.","$ref":"#/components/schemas/wix.rich_content.v1.EmbedData","summary":"embedData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"collapsibleListData":{"description":"Data for a collapsible list node.","$ref":"#/components/schemas/wix.rich_content.v1.CollapsibleListData","summary":"collapsibleListData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tableData":{"description":"Data for a table node.","$ref":"#/components/schemas/wix.rich_content.v1.TableData","summary":"tableData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tableCellData":{"description":"Data for a table cell node.","$ref":"#/components/schemas/wix.rich_content.v1.TableCellData","summary":"tableCellData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"externalData":{"description":"Data for a custom external node.","$ref":"#/components/schemas/wix.rich_content.v1.Struct","summary":"externalData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"audioData":{"description":"Data for an audio node.","$ref":"#/components/schemas/wix.rich_content.v1.AudioData","summary":"audioData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"orderedListData":{"description":"Data for an ordered list node.","$ref":"#/components/schemas/wix.rich_content.v1.OrderedListData","summary":"orderedListData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulletedListData":{"description":"Data for a bulleted list node.","$ref":"#/components/schemas/wix.rich_content.v1.BulletedListData","summary":"bulletedListData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"blockquoteData":{"description":"Data for a block quote node.","$ref":"#/components/schemas/wix.rich_content.v1.BlockquoteData","summary":"blockquoteData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.rich_content.v1.Node.Type":{"type":"string","description":"","title":"Type","enum":["PARAGRAPH","TEXT","HEADING","BULLETED_LIST","ORDERED_LIST","LIST_ITEM","BLOCKQUOTE","CODE_BLOCK","VIDEO","DIVIDER","FILE","GALLERY","GIF","HTML","IMAGE","LINK_PREVIEW","MAP","POLL","APP_EMBED","BUTTON","COLLAPSIBLE_LIST","TABLE","EMBED","COLLAPSIBLE_ITEM","COLLAPSIBLE_ITEM_TITLE","COLLAPSIBLE_ITEM_BODY","TABLE_CELL","TABLE_ROW","EXTERNAL","AUDIO"]},"wix.rich_content.v1.NodeStyle":{"type":"object","properties":{"paddingTop":{"description":"The top padding value in pixels.","title":"paddingTop","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paddingBottom":{"description":"The bottom padding value in pixels.","title":"paddingBottom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"backgroundColor":{"description":"The background color as a hexadecimal value.","title":"backgroundColor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NodeStyle","description":""},"wix.rich_content.v1.ButtonData":{"type":"object","properties":{"containerData":{"description":"Styling for the button's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"The button type.","title":"type","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.ButtonData.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"styles":{"description":"Styling for the button.","$ref":"#/components/schemas/wix.rich_content.v1.ButtonData.Styles","summary":"styles","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"text":{"description":"The text to display on the button.","title":"text","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"link":{"description":"Button link details.","$ref":"#/components/schemas/wix.rich_content.v1.Link","summary":"link","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ButtonData","description":""},"wix.rich_content.v1.ButtonData.Styles.Border":{"type":"object","properties":{"width":{"description":"Border width in pixels.","title":"width","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"radius":{"description":"Border radius in pixels.","title":"radius","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Border","description":""},"wix.rich_content.v1.ButtonData.Styles.Colors":{"type":"object","properties":{"text":{"description":"The text color as a hexadecimal value.","title":"text","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"border":{"description":"The border color as a hexadecimal value.","title":"border","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"background":{"description":"The background color as a hexadecimal value.","title":"background","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Colors","description":""},"wix.rich_content.v1.PluginContainerData":{"type":"object","properties":{"width":{"description":"The width of the node when it's displayed.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData.Width","summary":"width","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"alignment":{"description":"The node's alignment within its container.","title":"alignment","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData.Alignment","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"spoiler":{"description":"Spoiler cover settings for the node.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData.Spoiler","summary":"spoiler","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"The height of the node when it's displayed.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData.Height","summary":"height","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"textWrap":{"description":"Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`.","title":"textWrap","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PluginContainerData","description":""},"wix.rich_content.v1.PluginContainerData.Width.Type":{"type":"string","description":"","title":"Type","enum":["CONTENT","SMALL","ORIGINAL","FULL_WIDTH"]},"wix.rich_content.v1.PluginContainerData.Width":{"type":"object","properties":{},"title":"Width","description":"","oneOf":[{"description":"","summary":"data","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData.Width.data"}]},"wix.rich_content.v1.PluginContainerData.Width.data":{"type":"object","title":"data","properties":{"size":{"description":"One of the following predefined width options:\n`CONTENT`: The width of the container matches the content width.\n`SMALL`: A small width.\n`ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.\n`FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.","title":"size","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData.Width.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"custom":{"description":"A custom width value in pixels.","title":"custom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.rich_content.v1.PluginContainerData.Alignment":{"type":"string","description":"","title":"Alignment","enum":["CENTER","LEFT","RIGHT"]},"wix.rich_content.v1.PluginContainerData.Spoiler":{"type":"object","properties":{"enabled":{"description":"Sets whether the spoiler cover is enabled for this node. Defaults to `false`.","title":"enabled","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"The description displayed on top of the spoiler cover.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"buttonText":{"description":"The text for the button used to remove the spoiler cover.","title":"buttonText","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Spoiler","description":""},"wix.rich_content.v1.PluginContainerData.Height":{"type":"object","properties":{"custom":{"description":"A custom height value in pixels.","title":"custom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Height","description":""},"wix.rich_content.v1.ButtonData.Type":{"type":"string","description":"","title":"Type","enum":["LINK","ACTION"]},"wix.rich_content.v1.ButtonData.Styles":{"type":"object","properties":{"border":{"description":"Border attributes.","$ref":"#/components/schemas/wix.rich_content.v1.ButtonData.Styles.Border","summary":"border","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"colors":{"description":"Color attributes.","$ref":"#/components/schemas/wix.rich_content.v1.ButtonData.Styles.Colors","summary":"colors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Styles","description":""},"wix.rich_content.v1.Link":{"type":"object","properties":{"target":{"description":"he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:\n`SELF` - Default. Opens the linked document in the same frame as the link.\n`BLANK` - Opens the linked document in a new browser tab or window.\n`PARENT` - Opens the linked document in the link's parent frame.\n`TOP` - Opens the linked document in the full body of the link's browser tab or window.","title":"target","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.Link.Target","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rel":{"description":"The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document.","$ref":"#/components/schemas/wix.rich_content.v1.Link.Rel","summary":"rel","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"customData":{"description":"A serialized object used for a custom or external link panel.","title":"customData","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Link","description":"","oneOf":[{"description":"","summary":"data","$ref":"#/components/schemas/wix.rich_content.v1.Link.data"}]},"wix.rich_content.v1.Link.data":{"type":"object","title":"data","properties":{"url":{"description":"The absolute URL for the linked document.","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"anchor":{"description":"The target node's ID. Used for linking to another node in this object.","title":"anchor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.rich_content.v1.Link.Target":{"type":"string","description":"","title":"Target","enum":["SELF","BLANK","PARENT","TOP"]},"wix.rich_content.v1.Link.Rel":{"type":"object","properties":{"nofollow":{"description":"Indicates to search engine crawlers not to follow the link. Defaults to `false`.","title":"nofollow","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sponsored":{"description":"Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`.","title":"sponsored","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ugc":{"description":"Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page’s author. For example, a link in a fourm post. Defaults to `false`.","title":"ugc","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"noreferrer":{"description":"Indicates that this link protect referral information from being passed to the target website.","title":"noreferrer","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Rel","description":""},"wix.rich_content.v1.CodeBlockData":{"type":"object","properties":{"textStyle":{"description":"Styling for the code block's text.","$ref":"#/components/schemas/wix.rich_content.v1.TextStyle","summary":"textStyle","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CodeBlockData","description":""},"wix.rich_content.v1.TextStyle":{"type":"object","properties":{"textAlignment":{"description":"Text alignment. Defaults to `AUTO`.","title":"textAlignment","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.TextStyle.TextAlignment","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lineHeight":{"description":"A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px.","title":"lineHeight","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TextStyle","description":""},"wix.rich_content.v1.TextStyle.TextAlignment":{"type":"string","description":"","title":"TextAlignment","enum":["AUTO","LEFT","RIGHT","CENTER","JUSTIFY"]},"wix.rich_content.v1.DividerData":{"type":"object","properties":{"containerData":{"description":"Styling for the divider's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lineStyle":{"description":"Divider line style.","title":"lineStyle","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.DividerData.LineStyle","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"Divider width.","title":"width","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.DividerData.Width","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"alignment":{"description":"Divider alignment.","title":"alignment","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.DividerData.Alignment","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DividerData","description":""},"wix.rich_content.v1.DividerData.LineStyle":{"type":"string","description":"","title":"LineStyle","enum":["SINGLE","DOUBLE","DASHED","DOTTED"]},"wix.rich_content.v1.DividerData.Width":{"type":"string","description":"","title":"Width","enum":["LARGE","MEDIUM","SMALL"]},"wix.rich_content.v1.DividerData.Alignment":{"type":"string","description":"","title":"Alignment","enum":["CENTER","LEFT","RIGHT"]},"wix.rich_content.v1.FileData":{"type":"object","properties":{"containerData":{"description":"Styling for the file's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"src":{"description":"The source for the file's data.","$ref":"#/components/schemas/wix.rich_content.v1.FileSource","summary":"src","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"File name.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"File type.","title":"type","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"size":{"description":"Use `sizeInKb` instead.","title":"size","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"pdfSettings":{"description":"Settings for PDF files.","$ref":"#/components/schemas/wix.rich_content.v1.FileData.PDFSettings","summary":"pdfSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mimeType":{"description":"File MIME type.","title":"mimeType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"path":{"description":"File path.","title":"path","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sizeInKb":{"description":"File size in KB.","title":"sizeInKb","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FileData","description":""},"wix.rich_content.v1.FileData.PDFSettings.ViewMode":{"type":"string","description":"","title":"ViewMode","enum":["NONE","FULL","MINI"]},"wix.rich_content.v1.FileSource":{"type":"object","properties":{"private":{"description":"Indicates whether the file's source is private. Defaults to `false`.","title":"private","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FileSource","description":"","oneOf":[{"description":"","summary":"data","$ref":"#/components/schemas/wix.rich_content.v1.FileSource.data"}]},"wix.rich_content.v1.FileSource.data":{"type":"object","title":"data","properties":{"url":{"description":"The absolute URL for the file's source.","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"custom":{"description":"Custom ID. Use `id` instead.","title":"custom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"id":{"description":"An ID that's resolved to a URL by a resolver function.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.rich_content.v1.FileData.PDFSettings":{"type":"object","properties":{"viewMode":{"description":"PDF view mode. One of the following:\n`NONE` : The PDF isn't displayed.\n`FULL` : A full page view of the PDF is displayed.\n`MINI` : A mini view of the PDF is displayed.","title":"viewMode","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.FileData.PDFSettings.ViewMode","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"disableDownload":{"description":"Sets whether the PDF download button is disabled. Defaults to `false`.","title":"disableDownload","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"disablePrint":{"description":"Sets whether the PDF print button is disabled. Defaults to `false`.","title":"disablePrint","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PDFSettings","description":""},"wix.rich_content.v1.GalleryData":{"type":"object","properties":{"containerData":{"description":"Styling for the gallery's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"items":{"description":"The items in the gallery.","title":"items","type":"array","items":{"$ref":"#/components/schemas/wix.rich_content.v1.GalleryData.Item"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"options":{"description":"Options for defining the gallery's appearance.","$ref":"#/components/schemas/wix.rich_content.v1.GalleryOptions","summary":"options","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"disableExpand":{"description":"Sets whether the gallery's expand button is disabled. Defaults to `false`.","title":"disableExpand","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"disableDownload":{"description":"Sets whether the gallery's download button is disabled. Defaults to `false`.","title":"disableDownload","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GalleryData","description":""},"wix.rich_content.v1.Media":{"type":"object","properties":{"src":{"description":"The source for the media's data.","$ref":"#/components/schemas/wix.rich_content.v1.FileSource","summary":"src","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"Media width in pixels.","title":"width","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"Media height in pixels.","title":"height","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"duration":{"description":"Media duration in seconds. Only relevant for audio and video files.","title":"duration","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Media","description":""},"google.protobuf.DoubleValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DoubleValue","description":""},"wix.rich_content.v1.GalleryData.Item.Image":{"type":"object","properties":{"media":{"description":"Image file details.","$ref":"#/components/schemas/wix.rich_content.v1.Media","summary":"media","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"link":{"description":"Link details for images that are links.","$ref":"#/components/schemas/wix.rich_content.v1.Link","summary":"link","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Image","description":""},"wix.rich_content.v1.GalleryData.Item.Video":{"type":"object","properties":{"media":{"description":"Video file details.","$ref":"#/components/schemas/wix.rich_content.v1.Media","summary":"media","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"thumbnail":{"description":"Video thumbnail file details.","$ref":"#/components/schemas/wix.rich_content.v1.Media","summary":"thumbnail","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Video","description":""},"wix.rich_content.v1.GalleryData.Item":{"type":"object","properties":{"title":{"description":"Item title.","title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"altText":{"description":"Item's alternative text.","title":"altText","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Item","description":"","oneOf":[{"description":"","summary":"data","$ref":"#/components/schemas/wix.rich_content.v1.GalleryData.Item.data"}]},"wix.rich_content.v1.GalleryData.Item.data":{"type":"object","title":"data","properties":{"image":{"description":"An image item.","$ref":"#/components/schemas/wix.rich_content.v1.GalleryData.Item.Image","summary":"image","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"video":{"description":"A video item.","$ref":"#/components/schemas/wix.rich_content.v1.GalleryData.Item.Video","summary":"video","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.rich_content.v1.GalleryOptions":{"type":"object","properties":{"layout":{"description":"Gallery layout.","$ref":"#/components/schemas/wix.rich_content.v1.GalleryOptions.Layout","summary":"layout","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"item":{"description":"Styling for gallery items.","$ref":"#/components/schemas/wix.rich_content.v1.GalleryOptions.ItemStyle","summary":"item","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"thumbnails":{"description":"Styling for gallery thumbnail images.","$ref":"#/components/schemas/wix.rich_content.v1.GalleryOptions.Thumbnails","summary":"thumbnails","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GalleryOptions","description":""},"wix.rich_content.v1.GalleryOptions.Layout.Type":{"type":"string","description":"","title":"Type","enum":["COLLAGE","MASONRY","GRID","THUMBNAIL","SLIDER","SLIDESHOW","PANORAMA","COLUMN","MAGIC","FULLSIZE"]},"wix.rich_content.v1.GalleryOptions.Layout.Orientation":{"type":"string","description":"","title":"Orientation","enum":["ROWS","COLUMNS"]},"wix.rich_content.v1.GalleryOptions.ItemStyle.Crop":{"type":"string","description":"","title":"Crop","enum":["FILL","FIT"]},"wix.rich_content.v1.GalleryOptions.Thumbnails.Alignment":{"type":"string","description":"","title":"Alignment","enum":["TOP","RIGHT","BOTTOM","LEFT","NONE"]},"wix.rich_content.v1.GalleryOptions.Layout":{"type":"object","properties":{"type":{"description":"Gallery layout type.","title":"type","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.GalleryOptions.Layout.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"horizontalScroll":{"description":"Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`.","title":"horizontalScroll","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"orientation":{"description":"Gallery orientation.","title":"orientation","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.GalleryOptions.Layout.Orientation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberOfColumns":{"description":"The number of columns to display on full size screens.","title":"numberOfColumns","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mobileNumberOfColumns":{"description":"The number of columns to display on mobile screens.","title":"mobileNumberOfColumns","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Layout","description":""},"wix.rich_content.v1.GalleryOptions.ItemStyle":{"type":"object","properties":{"targetSize":{"description":"Desirable dimension for each item in pixels (behvaior changes according to gallery type)","title":"targetSize","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ratio":{"description":"Item ratio","title":"ratio","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"crop":{"description":"Sets how item images are cropped.","title":"crop","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.GalleryOptions.ItemStyle.Crop","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"spacing":{"description":"The spacing between items in pixels.","title":"spacing","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemStyle","description":""},"wix.rich_content.v1.GalleryOptions.Thumbnails":{"type":"object","properties":{"placement":{"description":"Thumbnail alignment.","title":"placement","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.GalleryOptions.Thumbnails.Alignment","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"spacing":{"description":"Spacing between thumbnails in pixels.","title":"spacing","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Thumbnails","description":""},"wix.rich_content.v1.GIFData":{"type":"object","properties":{"containerData":{"description":"Styling for the GIF's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"original":{"description":"The source of the full size GIF.","$ref":"#/components/schemas/wix.rich_content.v1.GIF","summary":"original","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"downsized":{"description":"The source of the downsized GIF.","$ref":"#/components/schemas/wix.rich_content.v1.GIF","summary":"downsized","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"Height in pixels.","title":"height","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"Width in pixels.","title":"width","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GIFData","description":""},"wix.rich_content.v1.GIF":{"type":"object","properties":{"gif":{"description":"GIF format URL.","format":"WEB_URL","title":"gif","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mp4":{"description":"MP4 format URL.","format":"WEB_URL","title":"mp4","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"still":{"description":"Thumbnail URL.","format":"WEB_URL","title":"still","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GIF","description":""},"wix.rich_content.v1.HeadingData":{"type":"object","properties":{"level":{"description":"Heading level from 1-6.","title":"level","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"textStyle":{"description":"Styling for the heading text.","$ref":"#/components/schemas/wix.rich_content.v1.TextStyle","summary":"textStyle","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"indentation":{"description":"Indentation level from 1-4.","title":"indentation","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"HeadingData","description":""},"wix.rich_content.v1.HTMLData":{"type":"object","properties":{"containerData":{"description":"Styling for the HTML node's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"source":{"description":"The type of HTML code.","title":"source","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.HTMLData.Source","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"HTMLData","description":"","oneOf":[{"description":"","summary":"data","$ref":"#/components/schemas/wix.rich_content.v1.HTMLData.data"}]},"wix.rich_content.v1.HTMLData.data":{"type":"object","title":"data","properties":{"url":{"description":"The URL for the HTML code for the node.","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"html":{"description":"The HTML code for the node.","title":"html","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"isAdsense":{"description":"Whether this is an AdSense element. Use `source` instead.","title":"isAdsense","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}}}},"wix.rich_content.v1.HTMLData.Source":{"type":"string","description":"","title":"Source","enum":["HTML","ADSENSE"]},"wix.rich_content.v1.ImageData":{"type":"object","properties":{"containerData":{"description":"Styling for the image's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"image":{"description":"Image file details.","$ref":"#/components/schemas/wix.rich_content.v1.Media","summary":"image","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"link":{"description":"Link details for images that are links.","$ref":"#/components/schemas/wix.rich_content.v1.Link","summary":"link","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"disableExpand":{"description":"Sets whether the image expands to full screen when clicked. Defaults to `false`.","title":"disableExpand","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"altText":{"description":"Image's alternative text.","title":"altText","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"caption":{"description":"Image caption.","title":"caption","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"disableDownload":{"description":"Sets whether the image's download button is disabled. Defaults to `false`.","title":"disableDownload","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ImageData","description":""},"wix.rich_content.v1.LinkPreviewData":{"type":"object","properties":{"containerData":{"description":"Styling for the link preview's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"link":{"description":"Link details.","$ref":"#/components/schemas/wix.rich_content.v1.Link","summary":"link","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Preview title.","title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"thumbnailUrl":{"description":"Preview thumbnail URL.","title":"thumbnailUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Preview description.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"html":{"description":"The preview content as HTML.","title":"html","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LinkPreviewData","description":""},"wix.rich_content.v1.MapData":{"type":"object","properties":{"containerData":{"description":"Styling for the map's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mapSettings":{"description":"Map settings.","$ref":"#/components/schemas/wix.rich_content.v1.MapSettings","summary":"mapSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MapData","description":""},"wix.rich_content.v1.MapSettings":{"type":"object","properties":{"address":{"description":"The address to display on the map.","title":"address","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"draggable":{"description":"Sets whether the map is draggable.","title":"draggable","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"marker":{"description":"Sets whether the location marker is visible.","title":"marker","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"streetViewControl":{"description":"Sets whether street view control is enabled.","title":"streetViewControl","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"zoomControl":{"description":"Sets whether zoom control is enabled.","title":"zoomControl","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lat":{"description":"Location latitude.","title":"lat","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lng":{"description":"Location longitude.","title":"lng","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"locationName":{"description":"Location name.","title":"locationName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"viewModeControl":{"description":"Sets whether view mode control is enabled.","title":"viewModeControl","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"initialZoom":{"description":"Initial zoom value.","title":"initialZoom","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mapType":{"description":"Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types.","title":"mapType","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.MapType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MapSettings","description":""},"wix.rich_content.v1.MapType":{"type":"string","description":"","title":"MapType","enum":["ROADMAP","SATELITE","HYBRID","TERRAIN"]},"wix.rich_content.v1.ParagraphData":{"type":"object","properties":{"textStyle":{"description":"Styling for the paragraph text.","$ref":"#/components/schemas/wix.rich_content.v1.TextStyle","summary":"textStyle","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"indentation":{"description":"Indentation level from 1-4.","title":"indentation","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"level":{"description":"Paragraph level","title":"level","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ParagraphData","description":""},"wix.rich_content.v1.PollData":{"type":"object","properties":{"containerData":{"description":"Styling for the poll's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"poll":{"description":"Poll data.","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Poll","summary":"poll","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"layout":{"description":"Layout settings for the poll and voting options.","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Layout","summary":"layout","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"design":{"description":"Styling for the poll and voting options.","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Design","summary":"design","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PollData","description":""},"wix.rich_content.v1.PollData.Poll.Settings.Permissions.ViewRole":{"type":"string","description":"","title":"ViewRole","enum":["CREATOR","VOTERS","EVERYONE"]},"wix.rich_content.v1.PollData.Poll.Settings.Permissions.VoteRole":{"type":"string","description":"","title":"VoteRole","enum":["SITE_MEMBERS","ALL"]},"wix.rich_content.v1.PollData.Poll.Settings.Permissions":{"type":"object","properties":{"view":{"description":"Sets who can view the poll results.","title":"view","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Poll.Settings.Permissions.ViewRole","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"vote":{"description":"Sets who can vote.","title":"vote","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Poll.Settings.Permissions.VoteRole","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"allowMultipleVotes":{"description":"Sets whether one voter can vote multiple times. Defaults to `false`.","title":"allowMultipleVotes","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Permissions","description":""},"wix.rich_content.v1.PollData.Poll.Option":{"type":"object","properties":{"id":{"description":"Option ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Option title.","title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"image":{"description":"The image displayed with the option.","$ref":"#/components/schemas/wix.rich_content.v1.Media","summary":"image","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Option","description":""},"wix.rich_content.v1.PollData.Poll.Settings":{"type":"object","properties":{"permissions":{"description":"Permissions settings for voting.","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Poll.Settings.Permissions","summary":"permissions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"showVoters":{"description":"Sets whether voters are displayed in the vote results. Defaults to `true`.","title":"showVoters","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"showVotesCount":{"description":"Sets whether the vote count is displayed. Defaults to `true`.","title":"showVotesCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Settings","description":""},"wix.rich_content.v1.PollData.Layout.PollLayout.Type":{"type":"string","description":"","title":"Type","enum":["LIST","GRID"]},"wix.rich_content.v1.PollData.Layout.PollLayout.Direction":{"type":"string","description":"","title":"Direction","enum":["LTR","RTL"]},"wix.rich_content.v1.PollData.Layout.PollLayout":{"type":"object","properties":{"type":{"description":"The layout for displaying the voting options.","title":"type","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Layout.PollLayout.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"direction":{"description":"The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right.","title":"direction","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Layout.PollLayout.Direction","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"enableImage":{"description":"Sets whether to display the main poll image. Defaults to `false`.","title":"enableImage","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PollLayout","description":""},"wix.rich_content.v1.PollData.Layout.OptionLayout":{"type":"object","properties":{"enableImage":{"description":"Sets whether to display option images. Defaults to `false`.","title":"enableImage","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"OptionLayout","description":""},"wix.rich_content.v1.PollData.Design.PollDesign.Background.Type":{"type":"string","description":"","title":"Type","enum":["COLOR","IMAGE","GRADIENT"]},"wix.rich_content.v1.PollData.Design.PollDesign.Background.Gradient":{"type":"object","properties":{"angle":{"description":"The gradient angle in degrees.","title":"angle","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"startColor":{"description":"The start color as a hexademical value.","format":"COLOR_HEX","title":"startColor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lastColor":{"description":"The end color as a hexademical value.","format":"COLOR_HEX","title":"lastColor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Gradient","description":""},"wix.rich_content.v1.PollData.Design.PollDesign.Background":{"type":"object","properties":{"type":{"description":"Background type. For each option, include the relevant details.","title":"type","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Design.PollDesign.Background.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Background","description":"","oneOf":[{"description":"","summary":"background","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Design.PollDesign.Background.background"}]},"wix.rich_content.v1.PollData.Design.PollDesign.Background.background":{"type":"object","title":"background","properties":{"color":{"description":"The background color as a hexademical value.","format":"COLOR_HEX","title":"color","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"image":{"description":"An image to use for the background.","$ref":"#/components/schemas/wix.rich_content.v1.Media","summary":"image","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"gradient":{"description":"Details for a gradient background.","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Design.PollDesign.Background.Gradient","summary":"gradient","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.rich_content.v1.PollData.Design.PollDesign":{"type":"object","properties":{"background":{"description":"Background styling.","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Design.PollDesign.Background","summary":"background","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderRadius":{"description":"Border radius in pixels.","title":"borderRadius","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PollDesign","description":""},"wix.rich_content.v1.PollData.Design.OptionDesign":{"type":"object","properties":{"borderRadius":{"description":"Border radius in pixels.","title":"borderRadius","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"OptionDesign","description":""},"wix.rich_content.v1.PollData.Poll":{"type":"object","properties":{"id":{"description":"Poll ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Poll title.","title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"creatorId":{"description":"Poll creator ID.","title":"creatorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"image":{"description":"Main poll image.","$ref":"#/components/schemas/wix.rich_content.v1.Media","summary":"image","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"options":{"description":"Voting options.","title":"options","type":"array","items":{"$ref":"#/components/schemas/wix.rich_content.v1.PollData.Poll.Option"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"settings":{"description":"The poll's permissions and display settings.","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Poll.Settings","summary":"settings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Poll","description":""},"wix.rich_content.v1.PollData.Layout":{"type":"object","properties":{"poll":{"description":"Poll layout settings.","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Layout.PollLayout","summary":"poll","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"options":{"description":"Voting otpions layout settings.","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Layout.OptionLayout","summary":"options","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Layout","description":""},"wix.rich_content.v1.PollData.Design":{"type":"object","properties":{"poll":{"description":"Styling for the poll.","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Design.PollDesign","summary":"poll","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"options":{"description":"Styling for voting options.","$ref":"#/components/schemas/wix.rich_content.v1.PollData.Design.OptionDesign","summary":"options","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Design","description":""},"wix.rich_content.v1.TextData":{"type":"object","properties":{"text":{"description":"The text to apply decorations to.","title":"text","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"decorations":{"description":"The decorations to apply.","title":"decorations","type":"array","items":{"$ref":"#/components/schemas/wix.rich_content.v1.Decoration"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TextData","description":""},"wix.rich_content.v1.Decoration":{"type":"object","properties":{"type":{"description":"The type of decoration to apply.","title":"type","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.Decoration.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Decoration","description":"Adds appearence changes to text","oneOf":[{"description":"","summary":"data","$ref":"#/components/schemas/wix.rich_content.v1.Decoration.data"}]},"wix.rich_content.v1.Decoration.data":{"type":"object","title":"data","properties":{"anchorData":{"description":"Data for an anchor link decoration.","$ref":"#/components/schemas/wix.rich_content.v1.AnchorData","summary":"anchorData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"colorData":{"description":"Data for a color decoration.","$ref":"#/components/schemas/wix.rich_content.v1.ColorData","summary":"colorData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"linkData":{"description":"Data for an external link decoration.","$ref":"#/components/schemas/wix.rich_content.v1.LinkData","summary":"linkData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mentionData":{"description":"Data for a mention decoration.","$ref":"#/components/schemas/wix.rich_content.v1.MentionData","summary":"mentionData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fontSizeData":{"description":"Data for a font size decoration.","$ref":"#/components/schemas/wix.rich_content.v1.FontSizeData","summary":"fontSizeData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fontWeightValue":{"description":"Font weight for a bold decoration.","title":"fontWeightValue","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"italicData":{"description":"Data for an italic decoration. Defaults to `true`.","title":"italicData","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"underlineData":{"description":"Data for an underline decoration. Defaults to `true`.","title":"underlineData","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"spoilerData":{"description":"Data for a spoiler decoration.","$ref":"#/components/schemas/wix.rich_content.v1.SpoilerData","summary":"spoilerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.rich_content.v1.Decoration.Type":{"type":"string","description":"","title":"Type","enum":["BOLD","ITALIC","UNDERLINE","SPOILER","ANCHOR","MENTION","LINK","COLOR","FONT_SIZE","EXTERNAL"]},"wix.rich_content.v1.AnchorData":{"type":"object","properties":{"anchor":{"description":"The target node's ID.","title":"anchor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AnchorData","description":""},"wix.rich_content.v1.ColorData":{"type":"object","properties":{"background":{"description":"The text's background color as a hexadecimal value.","title":"background","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"foreground":{"description":"The text's foreground color as a hexadecimal value.","title":"foreground","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ColorData","description":""},"wix.rich_content.v1.LinkData":{"type":"object","properties":{"link":{"description":"Link details.","$ref":"#/components/schemas/wix.rich_content.v1.Link","summary":"link","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LinkData","description":""},"wix.rich_content.v1.MentionData":{"type":"object","properties":{"name":{"description":"The mentioned user's name.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"The version of the user's name that appears after the `@` character in the mention.","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"id":{"description":"Mentioned user's ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MentionData","description":""},"wix.rich_content.v1.FontSizeData":{"type":"object","properties":{"unit":{"description":"The units used for the font size.","title":"unit","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.FontSizeData.fontType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"value":{"description":"Font size value.","title":"value","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FontSizeData","description":""},"wix.rich_content.v1.FontSizeData.fontType":{"type":"string","description":"","title":"fontType","enum":["PX","EM"]},"wix.rich_content.v1.SpoilerData":{"type":"object","properties":{"id":{"description":"Spoiler ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SpoilerData","description":""},"wix.rich_content.v1.AppEmbedData":{"type":"object","properties":{"type":{"description":"The type of Wix App content being embedded.","title":"type","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.AppEmbedData.AppType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"itemId":{"description":"The ID of the embedded content.","title":"itemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"The name of the embedded content.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"imageSrc":{"description":"Deprecated: Use `image` instead.","title":"imageSrc","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"url":{"description":"The URL for the embedded content.","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"image":{"description":"An image for the embedded content.","$ref":"#/components/schemas/wix.rich_content.v1.Media","summary":"image","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AppEmbedData","description":"","oneOf":[{"description":"","summary":"appData","$ref":"#/components/schemas/wix.rich_content.v1.AppEmbedData.appData"}]},"wix.rich_content.v1.AppEmbedData.appData":{"type":"object","title":"appData","properties":{"bookingData":{"description":"Data for embedded Wix Bookings content.","$ref":"#/components/schemas/wix.rich_content.v1.AppEmbedData.BookingData","summary":"bookingData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventData":{"description":"Data for embedded Wix Events content.","$ref":"#/components/schemas/wix.rich_content.v1.AppEmbedData.EventData","summary":"eventData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.rich_content.v1.AppEmbedData.AppType":{"type":"string","description":"","title":"AppType","enum":["PRODUCT","EVENT","BOOKING"]},"wix.rich_content.v1.AppEmbedData.BookingData":{"type":"object","properties":{"durations":{"description":"Booking duration in minutes.","title":"durations","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BookingData","description":""},"wix.rich_content.v1.AppEmbedData.EventData":{"type":"object","properties":{"scheduling":{"description":"Event schedule.","title":"scheduling","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"location":{"description":"Event location.","title":"location","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EventData","description":""},"wix.rich_content.v1.VideoData":{"type":"object","properties":{"containerData":{"description":"Styling for the video's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"video":{"description":"Video details.","$ref":"#/components/schemas/wix.rich_content.v1.Media","summary":"video","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"thumbnail":{"description":"Video thumbnail details.","$ref":"#/components/schemas/wix.rich_content.v1.Media","summary":"thumbnail","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"disableDownload":{"description":"Sets whether the video's download button is disabled. Defaults to `false`.","title":"disableDownload","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Video title.","title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"options":{"description":"Video options.","$ref":"#/components/schemas/wix.rich_content.v1.PlaybackOptions","summary":"options","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"VideoData","description":""},"wix.rich_content.v1.PlaybackOptions":{"type":"object","properties":{"autoPlay":{"description":"Sets whether the media will automatically start playing.","title":"autoPlay","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"playInLoop":{"description":"Sets whether media's will be looped.","title":"playInLoop","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"showControls":{"description":"Sets whether media's controls will be shown.","title":"showControls","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PlaybackOptions","description":""},"wix.rich_content.v1.EmbedData":{"type":"object","properties":{"containerData":{"description":"Styling for the oEmbed node's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"oembed":{"description":"An [oEmbed](https://www.oembed.com) object.","$ref":"#/components/schemas/wix.rich_content.v1.Oembed","summary":"oembed","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"src":{"description":"Origin asset source.","title":"src","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EmbedData","description":""},"wix.rich_content.v1.Oembed":{"type":"object","properties":{"type":{"description":"The resource type.","title":"type","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"The width of the resource specified in the `url` property in pixels.","title":"width","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"The height of the resource specified in the `url` property in pixels.","title":"height","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Resource title.","title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"The source URL for the resource.","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"html":{"description":"HTML for embedding a video player. The HTML should have no padding or margins.","title":"html","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"authorName":{"description":"The name of the author or owner of the resource.","title":"authorName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"authorUrl":{"description":"The URL for the author or owner of the resource.","title":"authorUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"providerName":{"description":"The name of the resource provider.","title":"providerName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"providerUrl":{"description":"The URL for the resource provider.","title":"providerUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"thumbnailUrl":{"description":"The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined.","title":"thumbnailUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"thumbnailWidth":{"description":"The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined.","title":"thumbnailWidth","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"thumbnailHeight":{"description":"The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined.","title":"thumbnailHeight","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"videoUrl":{"description":"The URL for an embedded viedo.","title":"videoUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"version":{"description":"The oEmbed version number. This value must be `1.0`.","title":"version","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Oembed","description":""},"wix.rich_content.v1.CollapsibleListData":{"type":"object","properties":{"containerData":{"description":"Styling for the collapsible list's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"expandOnlyOne":{"description":"If `true`, only one item can be expanded at a time. Defaults to `false`.","title":"expandOnlyOne","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"initialExpandedItems":{"description":"Sets which items are expanded when the page loads.","title":"initialExpandedItems","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.CollapsibleListData.InitialExpandedItems","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"direction":{"description":"The direction of the text in the list. Either left-to-right or right-to-left.","title":"direction","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.CollapsibleListData.Direction","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"isQapageData":{"description":"If `true`, The collapsible item will appear in search results as an FAQ.","title":"isQapageData","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CollapsibleListData","description":""},"wix.rich_content.v1.CollapsibleListData.InitialExpandedItems":{"type":"string","description":"","title":"InitialExpandedItems","enum":["FIRST","ALL","NONE"]},"wix.rich_content.v1.CollapsibleListData.Direction":{"type":"string","description":"","title":"Direction","enum":["LTR","RTL"]},"wix.rich_content.v1.TableData":{"type":"object","properties":{"containerData":{"description":"Styling for the table's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dimensions":{"description":"The table's dimensions.","$ref":"#/components/schemas/wix.rich_content.v1.TableData.Dimensions","summary":"dimensions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"header":{"description":"Deprecated: Use `rowHeader` and `columnHeader` instead.","title":"header","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"rowHeader":{"description":"Sets whether the table's first row is a header. Defaults to `false`.","title":"rowHeader","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"columnHeader":{"description":"Sets whether the table's first column is a header. Defaults to `false`.","title":"columnHeader","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TableData","description":""},"wix.rich_content.v1.TableData.Dimensions":{"type":"object","properties":{"colsWidthRatio":{"description":"An array representing relative width of each column in relation to the other columns.","title":"colsWidthRatio","type":"array","items":{"type":"integer"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rowsHeight":{"description":"An array representing the height of each row in pixels.","title":"rowsHeight","type":"array","items":{"type":"integer"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"colsMinWidth":{"description":"An array representing the minimum width of each column in pixels.","title":"colsMinWidth","type":"array","items":{"type":"integer"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Dimensions","description":""},"wix.rich_content.v1.TableCellData":{"type":"object","properties":{"cellStyle":{"description":"Styling for the cell's background color and text alignment.","$ref":"#/components/schemas/wix.rich_content.v1.TableCellData.CellStyle","summary":"cellStyle","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"borderColors":{"description":"The cell's border colors.","$ref":"#/components/schemas/wix.rich_content.v1.TableCellData.BorderColors","summary":"borderColors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TableCellData","description":""},"wix.rich_content.v1.TableCellData.VerticalAlignment":{"type":"string","description":"","title":"VerticalAlignment","enum":["TOP","MIDDLE","BOTTOM"]},"wix.rich_content.v1.TableCellData.CellStyle":{"type":"object","properties":{"verticalAlignment":{"description":"Vertical alignment for the cell's text.","title":"verticalAlignment","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.TableCellData.VerticalAlignment","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"backgroundColor":{"description":"Cell background color as a hexadecimal value.","format":"COLOR_HEX","title":"backgroundColor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CellStyle","description":""},"wix.rich_content.v1.TableCellData.BorderColors":{"type":"object","properties":{"left":{"description":"Left border color as a hexadecimal value.","format":"COLOR_HEX","title":"left","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"right":{"description":"Right border color as a hexadecimal value.","format":"COLOR_HEX","title":"right","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"top":{"description":"Top border color as a hexadecimal value.","format":"COLOR_HEX","title":"top","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bottom":{"description":"Bottom border color as a hexadecimal value.","format":"COLOR_HEX","title":"bottom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BorderColors","description":""},"wix.rich_content.v1.Struct":{"type":"object","properties":{"fields":{"description":"An unordered map of dynamically typed values.","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/wix.rich_content.v1.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":"`Struct` represents a structured data value, consisting of fields\nwhich map to dynamically typed values. In some languages, `Struct`\nmight be supported by a native representation. For example, in\nscripting languages like JS a struct is represented as an\nobject. The details of that representation are described together\nwith the proto support for the language.\n\nThe JSON representation for `Struct` is JSON object."},"wix.rich_content.v1.Value":{"type":"object","properties":{},"title":"Value","description":"`Value` represents a dynamically typed value which can be either\nnull, a number, a string, a boolean, a recursive struct value, or a\nlist of values. A producer of value is expected to set one of these\nvariants. Absence of any variant indicates an error.\n\nThe JSON representation for `Value` is JSON value.","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/wix.rich_content.v1.Value.kind"}]},"wix.rich_content.v1.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"A null value.","title":"nullValue","type":"string","$ref":"#/components/schemas/wix.rich_content.v1.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"A double value.","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"A string value.","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"A boolean value.","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"A structured value.","$ref":"#/components/schemas/wix.rich_content.v1.Struct","summary":"structValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"An array of `value` objects.","$ref":"#/components/schemas/wix.rich_content.v1.ListValue","summary":"listValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.rich_content.v1.NullValue":{"type":"string","description":"`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\nThe JSON representation for `NullValue` is JSON `null`.","title":"NullValue","enum":["NULL_VALUE"]},"wix.rich_content.v1.ListValue":{"type":"object","properties":{"values":{"description":"Repeated field of dynamically typed values.","title":"values","type":"array","items":{"$ref":"#/components/schemas/wix.rich_content.v1.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":"`ListValue` is a wrapper around a repeated field of values.\n\nThe JSON representation for `ListValue` is JSON array."},"wix.rich_content.v1.AudioData":{"type":"object","properties":{"containerData":{"description":"Styling for the audio node's container.","$ref":"#/components/schemas/wix.rich_content.v1.PluginContainerData","summary":"containerData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"audio":{"description":"Audio file details.","$ref":"#/components/schemas/wix.rich_content.v1.Media","summary":"audio","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"disableDownload":{"description":"Sets whether the audio node's download button is disabled. Defaults to `false`.","title":"disableDownload","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"coverImage":{"description":"Cover image.","$ref":"#/components/schemas/wix.rich_content.v1.Media","summary":"coverImage","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Track name.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"authorName":{"description":"Author name.","title":"authorName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"html":{"description":"An HTML version of the audio node.","title":"html","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AudioData","description":""},"wix.rich_content.v1.OrderedListData":{"type":"object","properties":{"indentation":{"description":"Indentation level from 0-4.","title":"indentation","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Offset level from 0-4.","title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"OrderedListData","description":""},"wix.rich_content.v1.BulletedListData":{"type":"object","properties":{"indentation":{"description":"Indentation level from 0-4.","title":"indentation","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Offset level from 0-4.","title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulletedListData","description":""},"wix.rich_content.v1.BlockquoteData":{"type":"object","properties":{"indentation":{"description":"Indentation level from 1-4.","title":"indentation","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BlockquoteData","description":""},"wix.rich_content.v1.Metadata":{"type":"object","properties":{"version":{"description":"Schema version.","minimum":1,"title":"version","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdTimestamp":{"description":"When the object was created.","readOnly":true,"title":"createdTimestamp","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"updatedTimestamp":{"description":"When the object was most recently updated.","title":"updatedTimestamp","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"id":{"description":"Object ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Metadata","description":""},"wix.rich_content.v1.DocumentStyle":{"type":"object","properties":{"headerOne":{"description":"Styling for H1 nodes.","$ref":"#/components/schemas/wix.rich_content.v1.TextNodeStyle","summary":"headerOne","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"headerTwo":{"description":"Styling for H2 nodes.","$ref":"#/components/schemas/wix.rich_content.v1.TextNodeStyle","summary":"headerTwo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"headerThree":{"description":"Styling for H3 nodes.","$ref":"#/components/schemas/wix.rich_content.v1.TextNodeStyle","summary":"headerThree","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"headerFour":{"description":"Styling for H4 nodes.","$ref":"#/components/schemas/wix.rich_content.v1.TextNodeStyle","summary":"headerFour","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"headerFive":{"description":"Styling for H5 nodes.","$ref":"#/components/schemas/wix.rich_content.v1.TextNodeStyle","summary":"headerFive","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"headerSix":{"description":"Styling for H6 nodes.","$ref":"#/components/schemas/wix.rich_content.v1.TextNodeStyle","summary":"headerSix","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paragraph":{"description":"Styling for paragraph nodes.","$ref":"#/components/schemas/wix.rich_content.v1.TextNodeStyle","summary":"paragraph","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"blockquote":{"description":"Styling for block quote nodes.","$ref":"#/components/schemas/wix.rich_content.v1.TextNodeStyle","summary":"blockquote","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"codeBlock":{"description":"Styling for code block nodes.","$ref":"#/components/schemas/wix.rich_content.v1.TextNodeStyle","summary":"codeBlock","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DocumentStyle","description":""},"wix.rich_content.v1.TextNodeStyle":{"type":"object","properties":{"decorations":{"description":"The decorations to apply to the node.","title":"decorations","type":"array","items":{"$ref":"#/components/schemas/wix.rich_content.v1.Decoration"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nodeStyle":{"description":"Padding and background color for the node.","$ref":"#/components/schemas/wix.rich_content.v1.NodeStyle","summary":"nodeStyle","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lineHeight":{"description":"Line height for text in the node.","title":"lineHeight","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TextNodeStyle","description":""},"com.wix.categories.api.v1.TreeReference":{"type":"object","properties":{"appNamespace":{"description":"Namespace of the app that manages the tree.\n\nFor example, `\"@wix/stores\"`, `\"@bookings/bookingslist\"`, `\"@achievements/quizzes\"`.","minLength":4,"maxLength":150,"title":"appNamespace","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeKey":{"description":"Tree key. You must pass this when a single app manages more than one tree.","minLength":1,"maxLength":44,"title":"treeKey","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TreeReference","description":""},"wix.common.data.dataextensions.ExtendedFields":{"type":"object","properties":{"namespaces":{"description":"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).","title":"namespaces","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Struct"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ExtendedFields","description":""},"com.wixpress.html.cache.invalidate.InvalidateCache":{"type":"object","properties":{"reason":{"description":"tell us why you're invalidating the cache. You don't need to add your app name","maxLength":256,"title":"reason","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"localDc":{"description":"Is local DS","title":"localDc","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InvalidateCache","description":"","oneOf":[{"description":"","summary":"getBy","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.getBy"}]},"com.wixpress.html.cache.invalidate.InvalidateCache.getBy":{"type":"object","title":"getBy","properties":{"metaSiteId":{"description":"Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteId":{"description":"Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!","format":"GUID","title":"siteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"app":{"description":"Invalidate by App","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.App","summary":"app","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"page":{"description":"Invalidate by page id","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.Page","summary":"page","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"uri":{"description":"Invalidate by URI path","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.URI","summary":"uri","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"file":{"description":"Invalidate by file (for media files such as PDFs)","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.File","summary":"file","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.html.cache.invalidate.InvalidateCache.App":{"type":"object","properties":{"appDefId":{"description":"The AppDefId","minLength":1,"title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"The instance Id","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"App","description":""},"com.wixpress.html.cache.invalidate.InvalidateCache.Page":{"type":"object","properties":{"metaSiteId":{"description":"the msid the page is on","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pageId":{"description":"Invalidate by Page ID","minLength":1,"title":"pageId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Page","description":""},"com.wixpress.html.cache.invalidate.InvalidateCache.URI":{"type":"object","properties":{"metaSiteId":{"description":"the msid the URI is on","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"uriPath":{"description":"URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes","minLength":1,"title":"uriPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"URI","description":""},"com.wixpress.html.cache.invalidate.InvalidateCache.File":{"type":"object","properties":{"metaSiteId":{"description":"the msid the file is related to","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fileName":{"description":"Invalidate by filename (for media files such as PDFs)","minLength":1,"maxLength":256,"title":"fileName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"File","description":""},"com.wix.categories.api.v1.CategoryMoved":{"type":"object","properties":{"categoryId":{"description":"Category ID.","format":"GUID","title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"parentCategory":{"description":"Parent category details.","$ref":"#/components/schemas/com.wix.categories.api.v1.ParentCategory","summary":"parentCategory","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CategoryMoved","description":""},"com.wix.categories.api.v1.ItemAddedToCategory":{"type":"object","properties":{"categoryId":{"description":"Category ID.","format":"GUID","title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"addedItem":{"description":"Details about the added item.","$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference","summary":"addedItem","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemAddedToCategory","description":""},"com.wix.categories.api.v1.ItemReference":{"type":"object","properties":{"catalogItemId":{"description":"ID of the item within the catalog it belongs to.\n\nFor example, `product.id` for Wix Stores or `event.id` for Wix Events.","minLength":1,"maxLength":36,"title":"catalogItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of the app providing the catalog.\n\nYou can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).\n\nFor items from Wix catalogs, the following values always apply:\n+ Wix Stores: `\"215238eb-22a5-4c36-9e7b-e7c08025e04e\"`\n+ Wix Bookings: `\"13d21c63-b5ec-5912-8397-c3a5ddb27a97\"`\n+ Wix Restaurants: `\"9a5d83fd-8570-482e-81ab-cfa88942ee60\"`","minLength":1,"maxLength":36,"title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemReference","description":""},"com.wix.categories.api.v1.ItemsAddedToCategory":{"type":"object","properties":{"categoryId":{"description":"Category ID.","format":"GUID","title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"addedItems":{"description":"List of added items.","maxItems":100,"title":"addedItems","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemsAddedToCategory","description":""},"com.wix.categories.api.v1.ItemRemovedFromCategory":{"type":"object","properties":{"categoryId":{"description":"Category ID.","format":"GUID","title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"removedItem":{"description":"Details about the removed item.","$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference","summary":"removedItem","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemRemovedFromCategory","description":""},"com.wix.categories.api.v1.ItemsRemovedFromCategory":{"type":"object","properties":{"categoryId":{"description":"Category ID.","format":"GUID","title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"removedItems":{"description":"List of removed items.","maxItems":100,"title":"removedItems","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemsRemovedFromCategory","description":""},"com.wix.categories.api.v1.ItemsArrangedInCategory":{"type":"object","properties":{"categoryId":{"description":"Category ID.","format":"GUID","title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemsArrangedInCategory","description":""},"com.wix.categories.api.v1.CreateCategoryRequest":{"type":"object","properties":{"category":{"description":"Category to create.","$ref":"#/components/schemas/com.wix.categories.api.v1.Category","summary":"category","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.SingleEntityOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateCategoryRequest","description":""},"com.wix.categories.api.v1.SingleEntityOps.RequestedFields":{"type":"string","description":"","title":"RequestedFields","enum":["UNKNOWN_REQUESTED_FIELD","BREADCRUMBS","DESCRIPTION","RICH_CONTENT_DESCRIPTION"]},"com.wix.categories.api.v1.CreateCategoryResponse":{"type":"object","properties":{"category":{"description":"Created category.","$ref":"#/components/schemas/com.wix.categories.api.v1.Category","summary":"category","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateCategoryResponse","description":""},"com.wix.categories.api.v1.GetCategoryRequest":{"type":"object","properties":{"categoryId":{"description":"Category ID.","format":"GUID","title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.SingleEntityOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetCategoryRequest","description":""},"com.wix.categories.api.v1.GetCategoryResponse":{"type":"object","properties":{"category":{"description":"Category.","$ref":"#/components/schemas/com.wix.categories.api.v1.Category","summary":"category","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetCategoryResponse","description":""},"com.wix.categories.api.v1.UpdateCategoryRequest":{"type":"object","properties":{"category":{"description":"Category to update.","$ref":"#/components/schemas/com.wix.categories.api.v1.Category","summary":"category","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.SingleEntityOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateCategoryRequest","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":""},"com.wix.categories.api.v1.UpdateCategoryResponse":{"type":"object","properties":{"category":{"description":"Updated category.","$ref":"#/components/schemas/com.wix.categories.api.v1.Category","summary":"category","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateCategoryResponse","description":""},"com.wix.categories.api.v1.DeleteCategoryRequest":{"type":"object","properties":{"categoryId":{"description":"Category ID.","format":"GUID","title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteCategoryRequest","description":""},"com.wix.categories.api.v1.DeleteCategoryResponse":{"type":"object","properties":{},"title":"DeleteCategoryResponse","description":""},"com.wix.categories.api.v1.QueryCategoriesRequest":{"type":"object","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.CursorQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnNonVisibleCategories":{"description":"Whether to return categories with `visible:false`. Default: false so only visible categories will be in response.\nUsed only in the first request. Following requests use the cursor token.","title":"returnNonVisibleCategories","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.MultipleEntitiesOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryCategoriesRequest","description":""},"com.wix.categories.api.v1.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/com.wix.categories.api.v1.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorQuery","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.CursorQuery.pagingMethod"}]},"com.wix.categories.api.v1.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/com.wix.categories.api.v1.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.categories.api.v1.upstream.wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","maxLength":512,"title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.","title":"order","type":"string","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"com.wix.categories.api.v1.upstream.wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"com.wix.categories.api.v1.upstream.wix.common.CursorPaging":{"type":"object","properties":{"limit":{"description":"Maximum number of items to return in the results.","minimum":0,"maximum":1000,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursor":{"description":"Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request.","maxLength":16000,"title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPaging","description":""},"com.wix.categories.api.v1.MultipleEntitiesOps.RequestedFields":{"type":"string","description":"","title":"RequestedFields","enum":["UNKNOWN_REQUESTED_FIELD","BREADCRUMBS"]},"com.wix.categories.api.v1.QueryCategoriesResponse":{"type":"object","properties":{"categories":{"description":"Categories which satisfy the provided query.","minItems":0,"maxItems":1000,"title":"categories","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.Category"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging metadata. Contains cursor which can be used in next query.","$ref":"#/components/schemas/com.wix.ecommerce.commons.api.PlatformPagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryCategoriesResponse","description":""},"com.wix.ecommerce.commons.api.PlatformPagingMetadataV2":{"type":"object","properties":{"count":{"description":"The number of items returned in this response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Cursors to navigate through result pages. Returned if cursor paging was used.","$ref":"#/components/schemas/wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PlatformPagingMetadataV2","description":""},"wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor string pointing to the next page in the list of results.","maxLength":16000,"title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to the previous page in the list of results.","maxLength":16000,"title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"com.wix.categories.api.v1.ListCompactCategoriesByIdsRequest":{"type":"object","properties":{"categoryIds":{"description":"List of category ids.","format":"GUID","minItems":1,"maxItems":1000,"title":"categoryIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"A reference to the tree that contains the categories.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListCompactCategoriesByIdsRequest","description":""},"com.wix.categories.api.v1.ListCompactCategoriesByIdsResponse":{"type":"object","properties":{"categories":{"description":"Categories which satisfy the provided ids.","title":"categories","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.CompactCategory"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListCompactCategoriesByIdsResponse","description":""},"com.wix.categories.api.v1.CompactCategory":{"type":"object","properties":{"id":{"description":"Category ID.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Category name.","minLength":1,"maxLength":80,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CompactCategory","description":""},"com.wix.categories.api.v1.SearchCategoriesRequest":{"type":"object","properties":{"search":{"description":"Search options.","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.CursorSearch","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.\n> **Note:** Pass `treeReference` only in the first request. Pass the cursor token in subsequent requests.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnNonVisibleCategories":{"description":"Whether to return the categories with `visible: false`.\n\nDefault: `false` - only visible categories are returned in the response","title":"returnNonVisibleCategories","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.MultipleEntitiesOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SearchCategoriesRequest","description":""},"com.wix.categories.api.v1.upstream.wix.common.CursorSearch":{"type":"object","properties":{"filter":{"description":"A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf)","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object in the form [{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]","maxItems":10,"title":"sort","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"aggregations":{"description":"Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.","maxItems":10,"title":"aggregations","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Aggregation"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Free text to match in searchable fields","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"timeZone":{"description":"UTC offset or IANA time zone. Valid values are\nISO 8601 UTC offsets, such as +02:00 or -06:00,\nand IANA time zone IDs, such as Europe/Rome\n\nAffects all filters and aggregations returned values.\nYou may override this behavior in a specific filter by providing\ntimestamps including time zone. e.g. `\"2023-12-20T10:52:34.795Z\"`","maxLength":50,"title":"timeZone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorSearch","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.CursorSearch.pagingMethod"}]},"com.wix.categories.api.v1.upstream.wix.common.CursorSearch.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"cursorPaging":{"description":"Cursor pointing to page of results.\nWhen requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.categories.api.v1.upstream.wix.common.Aggregation":{"type":"object","properties":{"name":{"description":"User-defined name of aggregation, should be unique, will appear in aggregation results","maxLength":100,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Type of aggregation, client must provide matching aggregation field below","title":"type","type":"string","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldPath":{"description":"Field to aggregate by, use dot notation to specify json path","maxLength":200,"title":"fieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Aggregation","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Aggregation.kind"}]},"com.wix.categories.api.v1.upstream.wix.common.Aggregation.kind":{"type":"object","title":"kind","properties":{"value":{"description":"Value aggregation","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Aggregation.ValueAggregation","summary":"value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"range":{"description":"Range aggregation","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Aggregation.RangeAggregation","summary":"range","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"Scalar aggregation","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Aggregation.ScalarAggregation","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateHistogram":{"description":"Date histogram aggregation","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Aggregation.DateHistogramAggregation","summary":"dateHistogram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nested":{"description":"Nested aggregation","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Aggregation.NestedAggregation","summary":"nested","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.categories.api.v1.upstream.wix.common.Aggregation.RangeAggregation.RangeBucket":{"type":"object","properties":{"from":{"description":"Inclusive lower bound of the range. Required if to is not given","title":"from","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"to":{"description":"Exclusive upper bound of the range. Required if from is not given","title":"to","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeBucket","description":""},"com.wix.categories.api.v1.upstream.wix.common.Aggregation.ValueAggregation.SortType":{"type":"string","description":"","title":"SortType","enum":["COUNT","VALUE"]},"com.wix.categories.api.v1.upstream.wix.common.Aggregation.ValueAggregation.SortDirection":{"type":"string","description":"","title":"SortDirection","enum":["DESC","ASC"]},"com.wix.categories.api.v1.upstream.wix.common.Aggregation.ValueAggregation.MissingValues":{"type":"string","description":"","title":"MissingValues","enum":["EXCLUDE","INCLUDE"]},"com.wix.categories.api.v1.upstream.wix.common.Aggregation.ValueAggregation.IncludeMissingValuesOptions":{"type":"object","properties":{"addToBucket":{"description":"Can specify custom bucket name. Defaults are [string -> \"N/A\"], [int -> \"0\"], [bool -> \"false\"] ...","maxLength":20,"title":"addToBucket","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IncludeMissingValuesOptions","description":""},"com.wix.categories.api.v1.upstream.wix.common.ScalarType":{"type":"string","description":"","title":"ScalarType","enum":["UNKNOWN_SCALAR_TYPE","COUNT_DISTINCT","MIN","MAX","SUM","AVG"]},"com.wix.categories.api.v1.upstream.wix.common.Aggregation.ValueAggregation":{"type":"object","properties":{"sortType":{"description":"Should sort by number of matches or value of the field","title":"sortType","type":"string","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Aggregation.ValueAggregation.SortType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sortDirection":{"description":"Should sort in ascending or descending order","title":"sortDirection","type":"string","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Aggregation.ValueAggregation.SortDirection","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"limit":{"description":"How many aggregations would you like to return? Can be between 1 and 250. 10 is the default.","title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"missingValues":{"description":"Should missing values be included or excluded from the aggregation results. Default is EXCLUDE","title":"missingValues","type":"string","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Aggregation.ValueAggregation.MissingValues","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValueAggregation","description":"","oneOf":[{"description":"","summary":"options","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Aggregation.ValueAggregation.options"}]},"com.wix.categories.api.v1.upstream.wix.common.Aggregation.ValueAggregation.options":{"type":"object","title":"options","properties":{"includeOptions":{"description":"Options for including missing values","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Aggregation.ValueAggregation.IncludeMissingValuesOptions","summary":"includeOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.categories.api.v1.upstream.wix.common.Aggregation.NestedAggregation.NestedAggregationType":{"type":"string","description":"","title":"NestedAggregationType","enum":["UNKNOWN_AGGREGATION_TYPE","VALUE","RANGE","SCALAR","DATE_HISTOGRAM"]},"com.wix.categories.api.v1.upstream.wix.common.Aggregation.RangeAggregation":{"type":"object","properties":{"buckets":{"description":"List of range buckets, where during aggregation each entity will be placed in the first bucket where its value falls into based on provided range bounds","maxItems":50,"title":"buckets","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Aggregation.RangeAggregation.RangeBucket"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeAggregation","description":""},"com.wix.categories.api.v1.upstream.wix.common.Aggregation.ScalarAggregation":{"type":"object","properties":{"type":{"description":"Define the operator for the scalar aggregation","title":"type","type":"string","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.ScalarType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ScalarAggregation","description":""},"com.wix.categories.api.v1.upstream.wix.common.Aggregation.DateHistogramAggregation":{"type":"object","properties":{"interval":{"description":"Interval for date histogram aggregation","title":"interval","type":"string","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Aggregation.DateHistogramAggregation.Interval","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DateHistogramAggregation","description":""},"com.wix.categories.api.v1.upstream.wix.common.Aggregation.DateHistogramAggregation.Interval":{"type":"string","description":"","title":"Interval","enum":["UNKNOWN_INTERVAL","YEAR","MONTH","WEEK","DAY","HOUR","MINUTE","SECOND"]},"com.wix.categories.api.v1.upstream.wix.common.Aggregation.NestedAggregation.NestedAggregationItem":{"type":"object","properties":{"name":{"description":"User-defined name of aggregation, should be unique, will appear in aggregation results","maxLength":100,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Type of aggregation, client must provide matching aggregation field below","title":"type","type":"string","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Aggregation.NestedAggregation.NestedAggregationType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldPath":{"description":"Field to aggregate by, use dont notation to specify json path","maxLength":200,"title":"fieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedAggregationItem","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Aggregation.NestedAggregation.NestedAggregationItem.kind"}]},"com.wix.categories.api.v1.upstream.wix.common.Aggregation.NestedAggregation.NestedAggregationItem.kind":{"type":"object","title":"kind","properties":{"value":{"description":"Value aggregation","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Aggregation.ValueAggregation","summary":"value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"range":{"description":"Range aggregation","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Aggregation.RangeAggregation","summary":"range","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"Scalar aggregation","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Aggregation.ScalarAggregation","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateHistogram":{"description":"Date histogram aggregation","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Aggregation.DateHistogramAggregation","summary":"dateHistogram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.categories.api.v1.upstream.wix.common.AggregationType":{"type":"string","description":"","title":"AggregationType","enum":["UNKNOWN_AGGREGATION_TYPE","VALUE","RANGE","SCALAR","DATE_HISTOGRAM","NESTED"]},"com.wix.categories.api.v1.upstream.wix.common.Aggregation.NestedAggregation":{"type":"object","properties":{"nestedAggregations":{"description":"Flattened list of aggregations, where each next aggregation is nested within previous one","minItems":2,"maxItems":3,"title":"nestedAggregations","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Aggregation.NestedAggregation.NestedAggregationItem"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedAggregation","description":"Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one"},"com.wix.categories.api.v1.upstream.wix.common.SearchDetails":{"type":"object","properties":{"mode":{"description":"Defines how separate search terms in `expression` are combined.\n\nSupported values:\n+ `OR` - Any of the search terms must be present\n+ `AND` - All search terms must be present","title":"mode","type":"string","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.SearchDetails.Mode","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"expression":{"description":"Search term or expression.","maxLength":100,"title":"expression","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields in which to search for the `expression`. Use dot notation to specify field path.\n\nWhen empty - all searchable fields are looked at.","maxLength":200,"maxItems":20,"title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fuzzy":{"description":"Whether to use fuzzy search - allowing typos and other minor errors in the search.","title":"fuzzy","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SearchDetails","description":""},"com.wix.categories.api.v1.upstream.wix.common.SearchDetails.Mode":{"type":"string","description":"","title":"Mode","enum":["OR","AND"]},"com.wix.categories.api.v1.SearchCategoriesResponse":{"type":"object","properties":{"categories":{"description":"List of categories.","minItems":0,"maxItems":1000,"title":"categories","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.Category"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging metadata.","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.CursorPagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"aggregationData":{"description":"Aggregation data.","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationData","summary":"aggregationData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SearchCategoriesResponse","description":""},"com.wix.categories.api.v1.upstream.wix.common.CursorPagingMetadata":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Cursor strings that point to the next page, previous page, or both.","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hasNext":{"description":"Whether there are more pages to retrieve following the current page.\n\n+ `true`: Another page of results can be retrieved.\n+ `false`: This is the last page.","title":"hasNext","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPagingMetadata","description":""},"com.wix.categories.api.v1.upstream.wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor string pointing to the next page in the list of results.","maxLength":16000,"title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to the previous page in the list of results.","maxLength":16000,"title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"com.wix.categories.api.v1.upstream.wix.common.AggregationData":{"type":"object","properties":{"results":{"description":"key = aggregation name (as derived from search request)","maxItems":10000,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AggregationData","description":""},"com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.ValueResults.ValueAggregationResult":{"type":"object","properties":{"value":{"description":"Value of the field","maxLength":100,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Count of entities with this value","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValueAggregationResult","description":""},"com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.RangeResults.RangeAggregationResult":{"type":"object","properties":{"from":{"description":"Inclusive lower bound of the range","title":"from","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"to":{"description":"Exclusive upper bound of the range","title":"to","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Count of entities in this range","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeAggregationResult","description":""},"com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.NestedAggregationResults":{"type":"object","properties":{"name":{"description":"User-defined name of aggregation, matches the one provided in request","maxLength":100,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Type of aggregation that matches result","title":"type","type":"string","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldPath":{"description":"Field to aggregate by, matches the one provided in request","maxLength":200,"title":"fieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedAggregationResults","description":"","oneOf":[{"description":"","summary":"result","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.NestedAggregationResults.result"}]},"com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.NestedAggregationResults.result":{"type":"object","title":"result","properties":{"values":{"description":"Value aggregation results","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.ValueResults","summary":"values","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ranges":{"description":"Range aggregation results","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.RangeResults","summary":"ranges","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"Scalar aggregation results","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.ScalarResult","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.ValueResults":{"type":"object","properties":{"results":{"description":"List of value aggregations","maxItems":250,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.ValueResults.ValueAggregationResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValueResults","description":""},"com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.RangeResults":{"type":"object","properties":{"results":{"description":"List of ranges returned in same order as requested","maxItems":50,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.RangeResults.RangeAggregationResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeResults","description":""},"com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.ScalarResult":{"type":"object","properties":{"type":{"description":"Type of scalar aggregation","title":"type","type":"string","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.ScalarType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"value":{"description":"Value of the scalar aggregation","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ScalarResult","description":""},"com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.GroupByValueResults.NestedValueAggregationResult":{"type":"object","properties":{"value":{"description":"Value of the field","maxLength":1000,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nestedResults":{"description":"Nested aggregations","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.NestedAggregationResults","summary":"nestedResults","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedValueAggregationResult","description":""},"com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults.ValueResult":{"type":"object","properties":{"value":{"description":"Value of the field","maxLength":1000,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Count of entities with this value","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValueResult","description":""},"com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults.RangeResult":{"type":"object","properties":{"from":{"description":"Inclusive lower bound of the range","title":"from","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"to":{"description":"Exclusive upper bound of the range","title":"to","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Count of entities in this range","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeResult","description":""},"com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults.ScalarResult":{"type":"object","properties":{"value":{"description":"Value of the scalar aggregation","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ScalarResult","description":""},"com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults.NestedResultValue":{"type":"object","properties":{},"title":"NestedResultValue","description":"","oneOf":[{"description":"","summary":"result","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults.NestedResultValue.result"}]},"com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults.NestedResultValue.result":{"type":"object","title":"result","properties":{"value":{"description":"Value aggregation result","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults.ValueResult","summary":"value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"range":{"description":"Range aggregation result","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults.RangeResult","summary":"range","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"Scalar aggregation result","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults.ScalarResult","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateHistogram":{"description":"Date histogram aggregation result","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults.ValueResult","summary":"dateHistogram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults.Results":{"type":"object","properties":{"results":{"description":"List of nested aggregations","title":"results","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults.NestedResultValue"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Results","description":""},"com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.DateHistogramResults.DateHistogramResult":{"type":"object","properties":{"value":{"description":"Date in ISO 8601 format","maxLength":100,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Count of documents in the bucket","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DateHistogramResult","description":""},"com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.GroupByValueResults":{"type":"object","properties":{"results":{"description":"List of value aggregations","maxItems":1000,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.GroupByValueResults.NestedValueAggregationResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GroupByValueResults","description":""},"com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.DateHistogramResults":{"type":"object","properties":{"results":{"description":"List of date histogram aggregations","maxItems":200,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.DateHistogramResults.DateHistogramResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DateHistogramResults","description":""},"com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults":{"type":"object","properties":{"results":{"description":"List of nested aggregations","maxItems":1000,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults.Results"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedResults","description":"Results of `NESTED` aggregation type in a flattened form\naggregations in resulting array are keyed by requested aggregation `name`."},"com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults":{"type":"object","properties":{"name":{"description":"User-defined name of aggregation as derived from search request","maxLength":100,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Type of aggregation that must match provided kind as derived from search request","title":"type","type":"string","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldPath":{"description":"Field to aggregate by as derived from search request","maxLength":200,"title":"fieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AggregationResults","description":"","oneOf":[{"description":"","summary":"result","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.result"}]},"com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.result":{"type":"object","title":"result","properties":{"values":{"description":"Value aggregation results","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.ValueResults","summary":"values","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ranges":{"description":"Range aggregation results","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.RangeResults","summary":"ranges","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"Scalar aggregation results","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.ScalarResult","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"groupedByValue":{"description":"Group by value aggregation results","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.GroupByValueResults","summary":"groupedByValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateHistogram":{"description":"Date histogram aggregation results","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.DateHistogramResults","summary":"dateHistogram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nested":{"description":"Nested aggregation results","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults","summary":"nested","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.categories.api.v1.DeprecatedSearchCategoriesWithOffsetRequest":{"type":"object","properties":{"search":{"description":"WQL query expression.","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.OffsetSearch","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnNonVisibleCategories":{"description":"Whether to return categories with `visible:false`. Default: false so only visible categories will be in response.","title":"returnNonVisibleCategories","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.MultipleEntitiesOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeprecatedSearchCategoriesWithOffsetRequest","description":""},"com.wix.categories.api.v1.upstream.wix.common.OffsetSearch":{"type":"object","properties":{"filter":{"description":"A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf)","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object in the form [{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]","maxItems":10,"title":"sort","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"aggregations":{"description":"Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.","maxItems":10,"title":"aggregations","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Aggregation"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Free text to match in searchable fields","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"timeZone":{"description":"UTC offset or IANA time zone. Valid values are\nISO 8601 UTC offsets, such as +02:00 or -06:00,\nand IANA time zone IDs, such as Europe/Rome\n\nAffects all filters and aggregations returned values.\nYou may override this behavior in a specific filter by providing\ntimestamps including time zone. e.g. `\"2023-12-20T10:52:34.795Z\"`","maxLength":50,"title":"timeZone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"OffsetSearch","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.OffsetSearch.pagingMethod"}]},"com.wix.categories.api.v1.upstream.wix.common.OffsetSearch.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"paging":{"description":"Pointer to page of results using offset. Can not be used together with 'cursor_paging'","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.categories.api.v1.upstream.wix.common.Paging":{"type":"object","properties":{"limit":{"description":"Number of items to load.","minimum":0,"maximum":1000,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Number of items to skip in the current sort order.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Paging","description":""},"com.wix.categories.api.v1.DeprecatedSearchCategoriesWithOffsetResponse":{"type":"object","properties":{"categories":{"description":"Categories which satisfy the provided query.","minItems":0,"maxItems":1000,"title":"categories","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.Category"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging metadata.","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.PagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"aggregationData":{"description":"Aggregation data.","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.AggregationData","summary":"aggregationData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeprecatedSearchCategoriesWithOffsetResponse","description":""},"com.wix.categories.api.v1.upstream.wix.common.PagingMetadata":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Offset that was requested.","title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"Total number of items that match the query.","title":"total","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tooManyToCount":{"description":"Flag that indicates the server failed to calculate the `total` field.","title":"tooManyToCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PagingMetadata","description":""},"com.wix.categories.api.v1.CountCategoriesRequest":{"type":"object","properties":{"filter":{"description":"Filter object.\n\nLearn more about the [filter object structure](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Search options.","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnNonVisibleCategories":{"description":"Whether to return categories with `visible: false` (hidden categories).\n\nDefault: `false` - only visible categories are returned in the response","title":"returnNonVisibleCategories","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CountCategoriesRequest","description":""},"com.wix.categories.api.v1.CountCategoriesResponse":{"type":"object","properties":{"count":{"description":"Total count of categories which satisfy the given filter and/or search.","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CountCategoriesResponse","description":""},"com.wix.categories.api.v1.MoveCategoryRequest":{"type":"object","properties":{"categoryId":{"description":"ID of the category to move.","format":"GUID","title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"parentCategoryId":{"description":"Parent category ID.\n\nDefault: root category ID","format":"GUID","title":"parentCategoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"position":{"description":"Where to place the subcategory.\n\n+ `FIRST`: Position the category as the first subcategory.\n+ `LAST`: Position the category as the last subcategory.\n+ `AFTER`: Position the category after the category ID passed in `moveAfterCategoryId`.","title":"position","type":"string","$ref":"#/components/schemas/com.wix.categories.api.v1.MoveCategoryRequest.Position","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"moveAfterCategoryId":{"description":"Required when passing `position: AFTER`.","format":"GUID","title":"moveAfterCategoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MoveCategoryRequest","description":""},"com.wix.categories.api.v1.MoveCategoryRequest.Position":{"type":"string","description":"","title":"Position","enum":["UNKNOWN_POSITION","FIRST","LAST","AFTER"]},"com.wix.categories.api.v1.MoveCategoryResponse":{"type":"object","properties":{"parentCategoryId":{"description":"Parent category ID.","format":"GUID","title":"parentCategoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"categoriesAfterMove":{"description":"List of category IDs in the new order of arrangement.","format":"GUID","maxItems":100,"title":"categoriesAfterMove","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MoveCategoryResponse","description":""},"com.wix.categories.api.v1.BulkCreateCategoriesRequest":{"type":"object","properties":{"categories":{"description":"List of categories to be created.","minItems":1,"maxItems":100,"title":"categories","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.Category"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the category entity in the response.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.MultipleEntitiesOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateCategoriesRequest","description":""},"com.wix.categories.api.v1.BulkCreateCategoriesResponse":{"type":"object","properties":{"results":{"description":"Categories created by bulk action.","minItems":1,"maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.BulkCategoriesResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateCategoriesResponse","description":""},"com.wix.categories.api.v1.BulkCategoriesResult":{"type":"object","properties":{"itemMetadata":{"description":"Bulk action metadata for category.","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"category":{"description":"Full category entity.\n\nReturned only if `returnEntity: true` is passed in the request.","$ref":"#/components/schemas/com.wix.categories.api.v1.Category","summary":"category","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCategoriesResult","description":""},"com.wix.categories.api.v1.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).","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originalIndex":{"description":"Index of the item within the request array. Allows for correlation between request and response items.","title":"originalIndex","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"success":{"description":"Whether the requested action was successful for this item. When `false`, the `error` field is populated.","title":"success","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"error":{"description":"Details about the error in case of failure.","$ref":"#/components/schemas/wix.api.ApplicationError","summary":"error","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemMetadata","description":""},"wix.api.ApplicationError":{"type":"object","properties":{"code":{"description":"Error code.","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Description of the error.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Data related to the error.","title":"data","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ApplicationError","description":""},"com.wix.categories.api.v1.upstream.wix.common.BulkActionMetadata":{"type":"object","properties":{"totalSuccesses":{"description":"Number of items that were successfully processed.","title":"totalSuccesses","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalFailures":{"description":"Number of items that couldn't be processed.","title":"totalFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"undetailedFailures":{"description":"Number of failures without details because detailed failure threshold was exceeded.","title":"undetailedFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkActionMetadata","description":""},"com.wix.categories.api.v1.BulkUpdateCategoriesRequest":{"type":"object","properties":{"categories":{"description":"List of categories to update.","minItems":1,"maxItems":100,"title":"categories","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.MaskedCategory"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the full category entity in the response.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.MultipleEntitiesOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateCategoriesRequest","description":""},"com.wix.categories.api.v1.MaskedCategory":{"type":"object","properties":{"category":{"description":"Category to update.","$ref":"#/components/schemas/com.wix.categories.api.v1.Category","summary":"category","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MaskedCategory","description":""},"com.wix.categories.api.v1.BulkUpdateCategoriesResponse":{"type":"object","properties":{"results":{"description":"Categories updated by bulk action.","minItems":1,"maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.BulkCategoriesResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateCategoriesResponse","description":""},"com.wix.categories.api.v1.UpdateCategoryVisibilityRequest":{"type":"object","properties":{"categoryId":{"description":"Category ID.","format":"GUID","title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"visible":{"description":"Whether the category is visible to site visitors in dynamic pages.\n\n+ If a parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.\n+ Passing `true` will fail if the visibility of any parent categories is `false`.","title":"visible","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Latest revision of the category.\nTo prevent conflicting changes, the current revision must be passed on update.","title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.SingleEntityOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateCategoryVisibilityRequest","description":""},"com.wix.categories.api.v1.UpdateCategoryVisibilityResponse":{"type":"object","properties":{"category":{"description":"Updated category.","$ref":"#/components/schemas/com.wix.categories.api.v1.Category","summary":"category","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateCategoryVisibilityResponse","description":""},"com.wix.categories.api.v1.BulkUpdateCategoryVisibilityRequest":{"type":"object","properties":{"categoryIds":{"description":"IDs of the categories to update.","format":"GUID","minItems":1,"maxItems":100,"title":"categoryIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"visible":{"description":"value to set `visible` to. This value will be set for all categories in the request","title":"visible","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the category entity in the response.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.MultipleEntitiesOps.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateCategoryVisibilityRequest","description":""},"com.wix.categories.api.v1.BulkUpdateCategoryVisibilityResponse":{"type":"object","properties":{"results":{"description":"Categories updated by bulk action.","minItems":1,"maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.BulkCategoriesResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateCategoryVisibilityResponse","description":""},"com.wix.categories.api.v1.BulkUpdateCategoryVisibilityByFilterRequest":{"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"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"visible":{"description":"value to set `visible` to. This value will be set for all categories that match the filter","title":"visible","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateCategoryVisibilityByFilterRequest","description":""},"com.wix.categories.api.v1.BulkUpdateCategoryVisibilityByFilterResponse":{"type":"object","properties":{"jobId":{"description":"Job ID.\n\nPass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..","format":"GUID","title":"jobId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateCategoryVisibilityByFilterResponse","description":""},"com.wix.categories.api.v1.BulkDeleteCategoriesRequest":{"type":"object","properties":{"categoryIds":{"description":"IDs of categories to be deleted.","format":"GUID","minItems":1,"maxItems":100,"title":"categoryIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDeleteCategoriesRequest","description":""},"com.wix.categories.api.v1.BulkDeleteCategoriesResponse":{"type":"object","properties":{"results":{"description":"Categories deleted by bulk action.","minItems":1,"maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.BulkDeleteCategoriesResponse.BulkCategoriesResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDeleteCategoriesResponse","description":""},"com.wix.categories.api.v1.BulkDeleteCategoriesResponse.BulkCategoriesResult":{"type":"object","properties":{"itemMetadata":{"description":"Information about successful action or error for failure.","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCategoriesResult","description":""},"com.wix.categories.api.v1.BulkDeleteCategoriesByFilterRequest":{"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"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDeleteCategoriesByFilterRequest","description":""},"com.wix.categories.api.v1.BulkDeleteCategoriesByFilterResponse":{"type":"object","properties":{"jobId":{"description":"Job ID.\n\nPass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..","format":"GUID","title":"jobId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDeleteCategoriesByFilterResponse","description":""},"com.wix.categories.api.v1.BulkAddItemsToCategoryRequest":{"type":"object","properties":{"categoryId":{"description":"Category ID.","format":"GUID","title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"items":{"description":"List of items to add.","minItems":1,"maxItems":100,"title":"items","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkAddItemsToCategoryRequest","description":""},"com.wix.categories.api.v1.BulkAddItemsToCategoryResponse":{"type":"object","properties":{"results":{"description":"List of items added to a category by bulk action.","minItems":1,"maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.BulkItemsToCategoryResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkAddItemsToCategoryResponse","description":""},"com.wix.categories.api.v1.BulkItemsToCategoryResult":{"type":"object","properties":{"itemMetadata":{"description":"Bulk action metadata for category.","$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReferenceMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkItemsToCategoryResult","description":""},"com.wix.categories.api.v1.ItemReferenceMetadata":{"type":"object","properties":{"item":{"description":"Catalog and item reference info.","$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference","summary":"item","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originalIndex":{"description":"Original 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 action was successful.\nWhen `false`, the `error` field is populated.","title":"success","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"error":{"description":"Error details in the case of an unsuccessful action.","$ref":"#/components/schemas/wix.api.ApplicationError","summary":"error","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemReferenceMetadata","description":""},"com.wix.categories.api.v1.BulkAddItemToCategoriesRequest":{"type":"object","properties":{"item":{"description":"Item to add.","$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference","summary":"item","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"categoryIds":{"description":"IDs of categories to which to add the item.","format":"GUID","minItems":1,"maxItems":100,"title":"categoryIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkAddItemToCategoriesRequest","description":""},"com.wix.categories.api.v1.BulkAddItemToCategoriesResponse":{"type":"object","properties":{"results":{"description":"Items added by bulk action.","minItems":1,"maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.BulkItemToCategoriesResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkAddItemToCategoriesResponse","description":""},"com.wix.categories.api.v1.BulkItemToCategoriesResult":{"type":"object","properties":{"itemMetadata":{"description":"Bulk action metadata for category.","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkItemToCategoriesResult","description":""},"com.wix.categories.api.v1.BulkRemoveItemsFromCategoryRequest":{"type":"object","properties":{"categoryId":{"description":"Category ID.","format":"GUID","title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"items":{"description":"List of items to remove.","minItems":1,"maxItems":100,"title":"items","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkRemoveItemsFromCategoryRequest","description":""},"com.wix.categories.api.v1.BulkRemoveItemsFromCategoryResponse":{"type":"object","properties":{"results":{"description":"Items removed by bulk action.","minItems":1,"maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.BulkItemsToCategoryResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkRemoveItemsFromCategoryResponse","description":""},"com.wix.categories.api.v1.BulkRemoveItemFromCategoriesRequest":{"type":"object","properties":{"item":{"description":"Item to remove.","$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference","summary":"item","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"categoryIds":{"description":"IDs of categories from which to remove the item.","format":"GUID","minItems":1,"maxItems":100,"title":"categoryIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkRemoveItemFromCategoriesRequest","description":""},"com.wix.categories.api.v1.BulkRemoveItemFromCategoriesResponse":{"type":"object","properties":{"results":{"description":"Items removed by bulk action.","minItems":1,"maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.BulkItemToCategoriesResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkRemoveItemFromCategoriesResponse","description":""},"com.wix.categories.api.v1.ListItemsInCategoryRequest":{"type":"object","properties":{"categoryId":{"description":"Category ID.","format":"GUID","title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"useCategoryArrangement":{"description":"Whether to use category arrangement for sorting items.\n\nDefault: `false`","title":"useCategoryArrangement","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"includeItemsFromSubcategories":{"description":"Whether to include items from subcategories.\n\nDefault: `false` (only direct items of the category will be returned)","title":"includeItemsFromSubcategories","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListItemsInCategoryRequest","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wix.categories.api.v1.ListItemsInCategoryRequest.pagingMethod"}]},"com.wix.categories.api.v1.ListItemsInCategoryRequest.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"cursorPaging":{"description":"Cursor paging options.\n\nLearn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.categories.api.v1.ListItemsInCategoryResponse":{"type":"object","properties":{"items":{"description":"List of items in the category.","maxItems":100,"title":"items","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging metadata.","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListItemsInCategoryResponse","description":""},"com.wix.categories.api.v1.upstream.wix.common.PagingMetadataV2":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Offset that was requested.","title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.","title":"total","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.","$ref":"#/components/schemas/com.wix.categories.api.v1.upstream.wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PagingMetadataV2","description":""},"com.wix.categories.api.v1.ListCategoriesForItemRequest":{"type":"object","properties":{"item":{"description":"Item reference info.","$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference","summary":"item","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListCategoriesForItemRequest","description":""},"com.wix.categories.api.v1.ListCategoriesForItemResponse":{"type":"object","properties":{"directCategoryIds":{"description":"List of IDs of categories that directly contain this item.","format":"GUID","maxItems":1000,"title":"directCategoryIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"allCategoryIds":{"description":"List of IDs of categories that directly contain this item, and their parent category IDs.","format":"GUID","maxItems":1000,"title":"allCategoryIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListCategoriesForItemResponse","description":""},"com.wix.categories.api.v1.ListTreesRequest":{"type":"object","properties":{},"title":"ListTreesRequest","description":""},"com.wix.categories.api.v1.ListTreesResponse":{"type":"object","properties":{"trees":{"description":"List of trees.","maxItems":20,"title":"trees","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListTreesResponse","description":""},"com.wix.categories.api.v1.MoveItemInCategoryRequest":{"type":"object","properties":{"categoryId":{"description":"Category ID.","format":"GUID","title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"item":{"description":"Item to move.","$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference","summary":"item","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"position":{"description":"Where to move item.\n`FIRST` - make `item` first item with manual arrangement. If before this operation category already has 100 manually arranged items, the 100th item will be removed from list of items with manual arrangement.\n`LAST` - make `item` last item with manual arrangement. If before this operation category already has 100 manually arranged items, moving item will be not last but 100th.\n`BEFORE` - requires `before_item`, `item` will be moved before it. If `before_item` was 100th item in category it will be removed from list of items with manual arrangement.\n`NONE` - don't use manual arrangement for `item`, it will be shown after all items with manual arrangement according to default sorting.","title":"position","type":"string","$ref":"#/components/schemas/com.wix.categories.api.v1.MoveItemInCategoryRequest.Position","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"beforeItem":{"description":"Required when `position` is `BEFORE`. `before_item` must be manually arranged item.","$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference","summary":"beforeItem","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MoveItemInCategoryRequest","description":""},"com.wix.categories.api.v1.MoveItemInCategoryRequest.Position":{"type":"string","description":"","title":"Position","enum":["UNKNOWN_POSITION","FIRST","LAST","BEFORE","NONE"]},"com.wix.categories.api.v1.MoveItemInCategoryResponse":{"type":"object","properties":{"itemsAfterMove":{"description":"Information about manually arranged items after move.","maxItems":100,"title":"itemsAfterMove","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MoveItemInCategoryResponse","description":""},"com.wix.categories.api.v1.SetArrangedItemsRequest":{"type":"object","properties":{"categoryId":{"description":"Category ID.","format":"GUID","title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"items":{"description":"List of items to set.","maxItems":100,"title":"items","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SetArrangedItemsRequest","description":""},"com.wix.categories.api.v1.SetArrangedItemsResponse":{"type":"object","properties":{"items":{"description":"List of arranged items.","maxItems":100,"title":"items","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SetArrangedItemsResponse","description":""},"com.wix.categories.api.v1.GetArrangedItemsRequest":{"type":"object","properties":{"categoryId":{"description":"Category ID.","format":"GUID","title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetArrangedItemsRequest","description":""},"com.wix.categories.api.v1.GetArrangedItemsResponse":{"type":"object","properties":{"items":{"description":"List of arranged items.","maxItems":100,"title":"items","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.ItemReference"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetArrangedItemsResponse","description":""},"com.wix.categories.api.v1.GetCategoriesTreeRequest":{"type":"object","properties":{"treeReference":{"description":"Category tree reference details.","$ref":"#/components/schemas/com.wix.categories.api.v1.TreeReference","summary":"treeReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetCategoriesTreeRequest","description":""},"com.wix.categories.api.v1.GetCategoriesTreeResponse":{"type":"object","properties":{"categoriesTree":{"description":"Categories tree.","title":"categoriesTree","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.CategoryTreeNode"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetCategoriesTreeResponse","description":""},"com.wix.categories.api.v1.CategoryTreeNode":{"type":"object","properties":{"id":{"description":"Category ID.","title":"id","type":"bytes","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"subcategories":{"description":"List of subcategories.","maxItems":1000,"title":"subcategories","type":"array","items":{"$ref":"#/components/schemas/com.wix.categories.api.v1.CategoryTreeNode"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CategoryTreeNode","description":"Represents a node in the view of categories tree"},"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":"Category","description":"Short description of CategoriesService","fqdn":"wix.categories.v1.category"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Wix Categories API\n\nThe Wix Categories API allows you to create and manage a tree of categories on your site. \n\nThis API provides essentials tools to establish hierarchical relationships between categories, helping you organize and classify items assigned to these categories.\n\nWith the Wix Categories API, you can:\n- Manage categories and assign them to parent categories.\n- Add and remove items from categories.\n- Specify the manual arrangement of items within a category.\n- Retrieve information about items assigned to a category, directly or indirectly.\n\n## Before you begin\nIt’s important to note the following points before starting to code:\n- The Categories app is currently available only as part of 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- Your app has the necessary permissions to access the Categories API.\n\n## Limitations\nWix Categories is currently limited to:\n1. 1,000 Categories per Tree.\n2. Up to 5 hierarchies levels. \n3. Each category can belong to only one parent category. \n4. Items can be associated with many categories, up to 1,000. \n5. Only the first 100 items within a category can be arranged manually. \n6. Updating visible field to `false` and delete behaviors apply from parent categories to subcategories.\n\n## Sample flows\n* [Create category and subcategory](fallback::./sample-flows#create-category-and-subcategory)\n* [Add and arrange items in category](fallback::./sample-flows#add-and-arrange-items-in-category)\n* [Move subcategory to a different position within a parent category](fallback::./sample-flows#move-subcategory-to-a-different-position-within-a-parent-category)\n* [Find all subcategories of a category](fallback::./sample-flows#find-all-subcategories-of-a-category)\n\n## Terminology\n1. **Tree**: A hierarchical structure of categories. Each tree can have up to 1,000 categories.\n2. **Tree Reference**: A unique identifier for the tree. Defined by app namespace and optionally tree key. Must be provided in all API requests.\n3. **App Namespace**: A unique identifier for the app that owns the tree. This namespace must be defined in dev-center before using the API.\n4. **Tree Key**: An optional key to differentiate between multiple trees managed by the same app. It can be empty, if an app only manages one tree. \n5. **Parent Category**: Each category can have a single parent category for managing a nested hierarchy. The parent Category can be empty when category is at the top level of the hierarchy or for flat category structures.\n6. **SubCategory**: A category nested under another category. Multiple subcategories can exist under a single parent category.\n7. **Depth**: The maximum nesting level allowed within the tree, limited to 5 levels.\n8. **Breadcrumbs**: A path from top-level category to the current category, helping users understand their location within the hierarchy and navigate back to parent categories.\n9. **Item Reference**: Identifies an item assigned to a category, consisting of an appId and a catalogItemId.\n10. **Manual Arrangement**: Allows merchants to manually set the order of items within a category. Up to 100 items can be rearranged to make them displayed in the beginning, while the rest are displayed in the order they were added to the category."},{"displayName":"Sample Use Cases and Flows","slugifyName":"sample-use-cases-and-flows","content":"# Categories: Sample Use Cases and Flows\n\nThis article shares some possible use cases your app could support, as well as\na sample flow that could support each use case. This can be a helpful jumping\noff point as you plan your app's implementation.\n\n## Create category and subcategory\nHelp merchant organize their hierarchy by creating new categories and subcategories.\n1. To create new category call [Create Category](fallback::https://dev.wix.com/docs/rest/business-management/categories/create-category) endpoint. \nIn the request body in addition to `category` you need to pass `treeReference` to specify the tree in which the category will be created.\nThe category will be created in the top nesting level of the tree.\n```json\n{\n \"category\": {\n \"name\": \"Drinkware\",\n \"description\": \"The Drinkware category includes a wide range of containers designed for holding beverages\",\n \"visible\": true\n },\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n}\n```\nSave `category.id` from response.\n\n2. To create subcategory within the newly created category call [Create Category](fallback::https://dev.wix.com/docs/rest/business-management/categories/create-category) endpoint again.\nThis time, include the `parentCategory.id` to specify the parent category that will be assigned.\nThe `treeReference` will be the same as you sent in step 1.\n```json\n{\n \"category\": {\n \"name\": \"Mugs\",\n \"description\": \"The Mugs subcategory includes a wide range of containers designed for holding hot beverages\",\n \"visible\": true,\n \"parentCategory\": {\n \"id\": \"\"\n }\n },\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n}\n```\nReplace `` with category id from response of step 1.\n\n## Add and arrange items in category\nHelp merchant to organize and classify their items by using categories.\nIn this scenario, you will assign set of items to a category and arrange them in a specific order.\n1. Add selected items to category by calling [Bulk Add Items To Category](fallback::https://dev.wix.com/docs/rest/business-management/categories/bulk-add-items-to-category) endpoint.\n\nIn the request path, include `category.id` that you received in response of previous scenario. \nIn the request body `treeReference` will also be the same and in `items` you can send all items that you want to add to category, Each item is referenced by pair of `appId` and `catalogItemId`.\n```json\n{\n \"items\": [\n {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"05519a6e-222b-413a-957c-0ef7a32779b5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"060b9b04-fe14-487d-8336-2d285c50cf98\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n }\n ],\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n}\n```\n\n3. After adding the items to the category, you can rearrange them for example to promote some items to be displayed in the beginning. Note that you can arrange up to 100 items, more items can be added, but you cannot control arrangement of them. \nCall [Set Arranged Items](fallback::https://dev.wix.com/docs/rest/business-management/categories/set-arranged-items) endpoint. Pass exactly same params as in step 1 but now `items` must be in desired order in which you want to see them.\n4. To display all items that belong to given category in the specified arrangement from previous step, use [List Items In Category](fallback::https://dev.wix.com/docs/rest/business-management/categories/list-items-in-category) endpoint.\nIn the request path, include same `category.id` from previous steps and in the request body, send the following:\n \n```json\n{\n \"useCategoryArrangement\": true,\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n}\n```\n\n### Move subcategory to a different position within a parent category\nMerchant may want to change the position of a category in the hierarchy.\n\n1. Use the [Create Category](fallback::https://dev.wix.com/docs/rest/business-management/categories/create-category) endpoint to create an additional subcategory within the parent category.\n In the request body as part of the `category` you need to also provide `parentCategory.id` to specify the parent category that will be assigned.\n```json\n{\n \"category\": {\n \"name\": \"Bottles\",\n \"description\": \"The Bottles subcategory offers a diverse selection of containers designed for carrying and consuming beverages\",\n \"visible\": true,\n \"parentCategory\": {\n \"id\": \"\"\n }\n },\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n}\n```\nSave `category.id` from response.\n\n2. To move the category to a different position in same parent category call [Move Category](fallback::https://dev.wix.com/docs/rest/business-management/categories/move-category) endpoint. \n In the request path, include the `category.id` of the category you want to move.\n In the request, provide the `parentCategoryId` and specify `position` as `FIRST` to move the subcategory to the beginning.\n```json\n{\n \"parentCategoryId\": \"\",\n \"position\": \"FIRST\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n}\n```\nReplace `` with category id from response of previous scenarios.\n\n### Find all subcategories of a category\n\nIn this scenario, you want to retrieve a list of all subcategories that belong to a specific parent category, in the correct order. This is useful for traversing the category hierarchy.\n\nUse the [Search Categories](fallback::https://dev.wix.com/docs/rest/business-management/categories/search-categories) endpoint.\nIn the request body, include the `parentCategory.id` in the `filter` parameter and sort by `parentCategory.index` in ascending order:\n```json\n{\n \"search\": {\n \"filter\": {\"parentCategory.id\": {\"$eq\": \"\" }},\n \"sort\": [{\"fieldName\": \"parentCategory.index\", \"order\": \"ASC\"}]\n },\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n },\n \"fields\": [\n \"BREADCRUMBS\"\n ]\n}\n```\nReplace `` with parent category id from previous scenarios.\n"},{"displayName":"Supported Filters and Sorting","slugifyName":"supported-filters-and-sorting","content":"# Categories: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting for the category object:\n\n| Field | Supported Filters | Sortable |\n|------------------------------|-------------------------------------------------------------------------|----------|\n| `id` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | |\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| `description` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | |\n| `visible` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome` | |\n| `slug` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | |\n| `parentCategory.id` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | Sortable |\n| `parentCategory.index` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$le`, `$gt`, `$ge` | Sortable |\n| `treeReference.appNamespace` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | |\n| `treeReference.treeKey` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | |\n| `treeReference.treeValue` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | |\n\n\n__Related content:__\n[API Query Language](fallback::https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),\n[Search Categories](fallback::https://dev.wix.com/docs/rest/business-management/categories/search-categories)\n"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}

Bulk Add Item To Categories

Permission Scopes