@wix/auto_sdk_categories_categories 1.0.89 → 1.0.90

package/build/cjs/{categories-v1-category-categories.universal-BSVLZtNA.d.ts → categories-v1-category-categories.universal-D6LO11T_.d.ts}

@@ -1,5 +1,12 @@
 import { QuerySpec, SearchSpec, Query, Search, NonNullablePaths } from '@wix/sdk-types';
 
+/**
+ * A category for organizing items into a hierarchical structure.
+ *
+ * Categories can be nested to create a multi-level hierarchy. Each category belongs to a specific category tree, identified by its `treeReference`. Each Wix Stores site has one category tree.
+ *
+ * > **Note:** Currently, only Wix Stores Catalog (V3) categories are supported. Pass `appNamespace: "@wix/stores"` in the `treeReference` for all API calls.
+ */
 interface Category {
     /**
      * Category ID.
@@ -39,35 +46,42 @@ interface Category {
      */
     image?: string;
     /**
-     * Number of items in this category.
+     * Number of items directly assigned to this category. Doesn't include items in subcategories.
      * @readonly
      */
     itemCounter?: number;
     /**
-     * Category description.
-     * > **Note:** This field is returned only when you pass `fields: "DESCRIPTION"` in the request.
+     * Plain-text category description.
+     *
+     * Returned only when you pass `"DESCRIPTION"` to the `fields` array.
      * @minLength 1
      * @maxLength 600
      */
     description?: string | null;
     /**
-     * Whether the category is visible to site visitors in dynamic pages.
+     * Whether the category is visible to site visitors.
+     *
+     * Visibility cascades to subcategories: if a parent category's visibility is set to `false`, all its subcategories become hidden as well.
+     * Setting a subcategory's visibility to `true` fails if any of its parent categories are hidden.
      *
-     * + If the parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.
-     * + Passing `true` will fail if the visibility of any parent categories is `false`.
-     * + Default: `false`.
+     * > **Notes:**
+     * > 1. Hidden categories and their items are still accessible via API calls. For example, List Items In Category returns items even for hidden categories.
+     * > 2. The `visible` field can only be changed using the [Update Category Visibility](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/categories/update-category-visibility) method.
+     * > 3. Default: `true`
      * @immutable
      */
     visible?: boolean | null;
     /**
-     * Category breadcrumbs.
+     * Category breadcrumbs, representing the path from the top-level ancestor category down to the parent of the current category.
      *
-     * > **Note:** Returned only when you pass `"BREADCRUMBS_INFO"` to the `fields` array in Categories API requests.
+     * Breadcrumbs are useful for building navigation UI and for SEO purposes. For top-level categories, the breadcrumbs list is empty.
+     *
+     * Returned only when you pass `"BREADCRUMBS_INFO"` to the `fields` array.
      * @readonly
      */
     breadcrumbsInfo?: BreadcrumbsInfo;
     /**
-     * Parent category reference data.
+     * Information about the category's parent. Top-level categories don't have a parent.
      * @immutable
      */
     parentCategory?: ParentCategory;
@@ -90,9 +104,18 @@ interface Category {
      */
     richContentDescription?: RichContent;
     /**
-     * ID of the app responsible for managing the items in this category.
+     * Reference to the category tree this category belongs to.
+     *
+     * When working with Wix Stores categories, always pass `appNamespace: "@wix/stores"` and `treeKey: null`.
+     * @readonly
+     */
+    treeReference?: TreeReference;
+    /**
+     * ID of the app responsible for managing items in this category.
      *
-     * Pass your app ID to restrict updating and deleting items in this category to your app only.
+     * When set, only the specified app can add or remove items from this category. This is useful for third-party apps that want to create categories exclusively managed by their app, preventing site owners or other apps from modifying the category's items.
+     *
+     * You can get your app's ID from the [app dashboard](https://dev.wix.com/dc3/my-apps/).
      * @format GUID
      * @immutable
      */
@@ -106,7 +129,7 @@ interface Category {
 }
 interface BreadcrumbsInfo {
     /**
-     * List of breadcrumb data. The current category isn't included in the list.
+     * List of ancestor categories from the top-level category down to the parent of the current category. The current category isn't included in the list.
      * @readonly
      * @maxSize 5
      */
@@ -114,18 +137,18 @@ interface BreadcrumbsInfo {
 }
 interface Breadcrumb {
     /**
-     * Category ID.
+     * Ancestor category ID.
      * @format GUID
      */
     categoryId?: string;
     /**
-     * Category name.
+     * Ancestor category name.
      * @minLength 1
      * @maxLength 80
      */
     categoryName?: string;
     /**
-     * Category slug.
+     * Ancestor category slug.
      * @minLength 1
      * @maxLength 100
      */
@@ -133,14 +156,14 @@ interface Breadcrumb {
 }
 interface ParentCategory {
     /**
-     * Parent category ID.
+     * ID of the parent category.
      *
-     * Default: root category ID
+     * Leave empty or omit to create a top-level category.
      * @format GUID
      */
     _id?: string | null;
     /**
-     * Index position of the category within the parent category.
+     * Position of this category among its sibling categories within the parent.
      * @readonly
      */
     index?: number | null;
@@ -2087,15 +2110,17 @@ interface TextNodeStyle {
 }
 interface TreeReference {
     /**
-     * Namespace of the app that manages the tree.
+     * Namespace of the app whose catalog this category tree belongs to.
      *
-     * For example, `"@wix/stores"`, `"@bookings/bookingslist"`, `"@achievements/quizzes"`.
+     * Currently, only `"@wix/stores"` is supported.
      * @minLength 4
      * @maxLength 150
      */
     appNamespace?: string;
     /**
-     * Tree key. You must pass this when a single app manages more than one tree.
+     * Key to differentiate between multiple trees managed by the same app.
+     *
+     * For Wix Stores, pass `null` or omit this field, as each store has only one category tree.
      * @minLength 1
      * @maxLength 44
      */
@@ -2251,22 +2276,17 @@ interface ItemAddedToCategory {
 }
 interface ItemReference {
     /**
-     * ID of the item within the catalog it belongs to.
+     * ID of the item within the catalog.
      *
-     * For example, `product.id` for Wix Stores or `event.id` for Wix Events.
+     * For Wix Stores, this is the product ID from the [Catalog V3 Products API](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/introduction).
      * @minLength 1
      * @maxLength 36
      */
     catalogItemId?: string;
     /**
-     * ID of the app providing the catalog.
+     * ID of the Wix app providing the catalog.
      *
-     * You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
-     *
-     * For items from Wix catalogs, the following values always apply:
-     * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
-     * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
-     * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
+     * Currently, only Wix Stores is supported. Use `"215238eb-22a5-4c36-9e7b-e7c08025e04e"` for all Wix Stores products.
      * @minLength 1
      * @maxLength 36
      */
@@ -2531,13 +2551,7 @@ interface CompactCategory {
     name?: string | null;
 }
 interface SearchCategoriesRequest {
-    /**
-     * Search criteria including filter, sort, aggregations, and paging options.
-     *
-     * Refer to the [supported filters & sorting table](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/search-categories) (SDK)
-     * or the [supported filters article](https://dev.wix.com/docs/api-reference/business-management/categories/supported-filters-and-sorting) (REST)
-     * for a complete list of supported filters and sorting options.
-     */
+    /** Search criteria including filter, sort, aggregations, and paging options. */
     search?: CursorSearch;
     /**
      * Category tree reference details.
@@ -2562,18 +2576,10 @@ interface CursorSearch extends CursorSearchPagingMethodOneOf {
      * `filter`, `sort`, or `search` can't be specified.
      */
     cursorPaging?: CursorPaging;
-    /**
-     * Filter object for narrowing search results. For example, to return only categories from the Stores app: `"filter": {"appNamespace": "@wix/stores"}`.
-     *
-     * Learn more about the filter format in the [supported filters & sorting table](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/search-categories) (SDK)
-     * or the [supported filters article](https://dev.wix.com/docs/api-reference/business-management/categories/supported-filters-and-sorting) (REST).
-     */
+    /** Filter object for narrowing search results. */
     filter?: Record<string, any> | null;
     /**
-     * Array of sort objects specifying result order. For example, to sort by creation date in ascending order: `"sort": [{"fieldName": "createdDate", "order": "ASC"}]`.
-     *
-     * Learn more about the sort format in the [supported filters & sorting table](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/search-categories) (SDK)
-     * or the [supported filters article](https://dev.wix.com/docs/api-reference/business-management/categories/supported-filters-and-sorting) (REST).
+     * Array of sort objects specifying result order.
      * @maxSize 10
      */
     sort?: Sorting[];
@@ -3182,9 +3188,7 @@ interface MoveCategoryRequest {
     /** Category tree reference details. */
     treeReference: TreeReference;
     /**
-     * Parent category ID.
-     *
-     * Default: root category ID
+     * ID of the target parent category. Leave empty or omit to move the category to the top level.
      * @format GUID
      */
     parentCategoryId?: string | null;
@@ -3304,10 +3308,10 @@ interface UpdateCategoryVisibilityRequest {
      */
     categoryId: string;
     /**
-     * Whether the category is visible to site visitors in dynamic pages.
+     * Whether the category is visible to site visitors.
      *
-     * + If a parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.
-     * + Passing `true` will fail if the visibility of any parent categories is `false`.
+     * Visibility cascades to subcategories: setting a parent category to `false` also hides all its subcategories.
+     * Setting to `true` fails if any parent category is hidden.
      */
     visible: boolean;
     /** Category tree reference details. */
@@ -3514,7 +3518,10 @@ interface ListItemsInCategoryRequest extends ListItemsInCategoryRequestPagingMet
     /** Category tree reference details. */
     treeReference: TreeReference;
     /**
-     * Whether to use category arrangement for sorting items.
+     * Whether to use the category's manual arrangement for sorting items.
+     *
+     * When `true`, manually arranged items appear first in their specified order, followed by remaining items sorted by date added (newest first).
+     * When `false`, all items are sorted by date added (newest first).
      *
      * Default: `false`
      */
@@ -3522,7 +3529,7 @@ interface ListItemsInCategoryRequest extends ListItemsInCategoryRequestPagingMet
     /**
      * Whether to include items from subcategories.
      *
-     * Default: `false` (only direct items of the category will be returned)
+     * Default: `false`
      */
     includeItemsFromSubcategories?: boolean;
 }
@@ -3562,13 +3569,13 @@ interface ListCategoriesForItemRequest {
 }
 interface ListCategoriesForItemResponse {
     /**
-     * List of IDs of categories that directly contain this item.
+     * IDs of categories that directly contain this item.
      * @format GUID
      * @maxSize 1000
      */
     directCategoryIds?: string[];
     /**
-     * List of IDs of categories that directly contain this item, and their parent category IDs.
+     * IDs of all categories containing this item, including direct categories and all their ancestor categories.
      * @format GUID
      * @maxSize 1000
      */
@@ -3591,16 +3598,16 @@ interface ListCategoriesForItemsResponse {
     categoriesForItems?: MapItemToCategories[];
 }
 interface MapItemToCategories {
-    /** Item reference info. */
+    /** Item reference. */
     item?: ItemReference;
     /**
-     * List of IDs of categories that directly contain this item.
+     * IDs of categories that directly contain this item.
      * @format GUID
      * @maxSize 1000
      */
     directCategoryIds?: string[];
     /**
-     * List of IDs of categories that indirectly contain this item, including all ancestors of its direct categories in the hierarchy.
+     * IDs of ancestor categories of the item's direct categories. These categories indirectly contain the item through their subcategories.
      * @format GUID
      * @maxSize 1000
      */
@@ -3661,7 +3668,7 @@ interface SetArrangedItemsRequest {
     /** Category tree reference details. */
     treeReference: TreeReference;
     /**
-     * List of items to set.
+     * List of items in the desired order. The order in this array determines the display order when List Items In Category is called with `useCategoryArrangement: true`.
      * @maxSize 100
      */
     items?: ItemReference[];
@@ -4045,7 +4052,7 @@ interface CategoryMovedEnvelope {
     metadata: EventMetadata;
 }
 /**
- * Triggered when a category is moved.
+ * Triggered when a category is moved to a different position or parent category.
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage Stores
@@ -4078,7 +4085,9 @@ interface CategoryCreatedEnvelope {
     entity: Category;
     metadata: EventMetadata;
 }
-/** @permissionScope Manage Stores - all permissions
+/**
+ * Triggered when a category is created.
+ * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage Stores
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
@@ -4109,7 +4118,9 @@ declare function onCategoryCreated(handler: (event: CategoryCreatedEnvelope) =>
 interface CategoryDeletedEnvelope {
     metadata: EventMetadata;
 }
-/** @permissionScope Manage Stores - all permissions
+/**
+ * Triggered when a category is deleted.
+ * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage Stores
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
@@ -4210,7 +4221,7 @@ interface CategoryItemsArrangedInCategoryEnvelope {
     metadata: EventMetadata;
 }
 /**
- * Triggered when items arrangement in category is changed.
+ * Triggered when items are rearranged within a category.
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage Stores
@@ -4245,7 +4256,9 @@ interface CategoryUpdatedEnvelope {
     /** @hidden */
     modifiedFields: Record<string, any>;
 }
-/** @permissionScope Manage Stores - all permissions
+/**
+ * Triggered when a category is updated.
+ * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage Stores
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
@@ -4287,7 +4300,7 @@ declare function onCategoryUpdated(handler: (event: CategoryUpdatedEnvelope) =>
  * @returns Created category.
  * @fqn com.wix.categories.api.v1.CategoriesService.CreateCategory
  */
-declare function createCategory(category: NonNullablePaths<Category, `name` | `parentCategory._id`, 3>, options?: NonNullablePaths<CreateCategoryOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<Category, `itemCounter` | `breadcrumbsInfo.breadcrumbs` | `breadcrumbsInfo.breadcrumbs.${number}.categoryId` | `breadcrumbsInfo.breadcrumbs.${number}.categoryName` | `breadcrumbsInfo.breadcrumbs.${number}.categorySlug` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain`, 6> & {
+declare function createCategory(category: NonNullablePaths<Category, `name` | `parentCategory._id`, 3>, options?: NonNullablePaths<CreateCategoryOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<Category, `itemCounter` | `breadcrumbsInfo.breadcrumbs` | `breadcrumbsInfo.breadcrumbs.${number}.categoryId` | `breadcrumbsInfo.breadcrumbs.${number}.categoryName` | `breadcrumbsInfo.breadcrumbs.${number}.categorySlug` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `treeReference.appNamespace`, 6> & {
     __applicationErrorsType?: CreateCategoryApplicationErrors;
 }>;
 interface CreateCategoryOptions {
@@ -4312,7 +4325,7 @@ interface CreateCategoryOptions {
  * @returns Category.
  * @fqn com.wix.categories.api.v1.CategoriesService.GetCategory
  */
-declare function getCategory(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`, 2>, options?: GetCategoryOptions): Promise<NonNullablePaths<Category, `itemCounter` | `breadcrumbsInfo.breadcrumbs` | `breadcrumbsInfo.breadcrumbs.${number}.categoryId` | `breadcrumbsInfo.breadcrumbs.${number}.categoryName` | `breadcrumbsInfo.breadcrumbs.${number}.categorySlug` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain`, 6>>;
+declare function getCategory(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`, 2>, options?: GetCategoryOptions): Promise<NonNullablePaths<Category, `itemCounter` | `breadcrumbsInfo.breadcrumbs` | `breadcrumbsInfo.breadcrumbs.${number}.categoryId` | `breadcrumbsInfo.breadcrumbs.${number}.categoryName` | `breadcrumbsInfo.breadcrumbs.${number}.categorySlug` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `treeReference.appNamespace`, 6>>;
 interface GetCategoryOptions {
     /**
      * Fields to include in the response.
@@ -4338,7 +4351,7 @@ interface GetCategoryOptions {
  * @returns Updated category.
  * @fqn com.wix.categories.api.v1.CategoriesService.UpdateCategory
  */
-declare function updateCategory(_id: string, category: NonNullablePaths<UpdateCategory, `revision`, 2>, options?: NonNullablePaths<UpdateCategoryOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<Category, `itemCounter` | `breadcrumbsInfo.breadcrumbs` | `breadcrumbsInfo.breadcrumbs.${number}.categoryId` | `breadcrumbsInfo.breadcrumbs.${number}.categoryName` | `breadcrumbsInfo.breadcrumbs.${number}.categorySlug` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain`, 6> & {
+declare function updateCategory(_id: string, category: NonNullablePaths<UpdateCategory, `revision`, 2>, options?: NonNullablePaths<UpdateCategoryOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<Category, `itemCounter` | `breadcrumbsInfo.breadcrumbs` | `breadcrumbsInfo.breadcrumbs.${number}.categoryId` | `breadcrumbsInfo.breadcrumbs.${number}.categoryName` | `breadcrumbsInfo.breadcrumbs.${number}.categorySlug` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `treeReference.appNamespace`, 6> & {
     __applicationErrorsType?: UpdateCategoryApplicationErrors;
 }>;
 interface UpdateCategory {
@@ -4380,35 +4393,42 @@ interface UpdateCategory {
      */
     image?: string;
     /**
-     * Number of items in this category.
+     * Number of items directly assigned to this category. Doesn't include items in subcategories.
      * @readonly
      */
     itemCounter?: number;
     /**
-     * Category description.
-     * > **Note:** This field is returned only when you pass `fields: "DESCRIPTION"` in the request.
+     * Plain-text category description.
+     *
+     * Returned only when you pass `"DESCRIPTION"` to the `fields` array.
      * @minLength 1
      * @maxLength 600
      */
     description?: string | null;
     /**
-     * Whether the category is visible to site visitors in dynamic pages.
+     * Whether the category is visible to site visitors.
+     *
+     * Visibility cascades to subcategories: if a parent category's visibility is set to `false`, all its subcategories become hidden as well.
+     * Setting a subcategory's visibility to `true` fails if any of its parent categories are hidden.
      *
-     * + If the parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.
-     * + Passing `true` will fail if the visibility of any parent categories is `false`.
-     * + Default: `false`.
+     * > **Notes:**
+     * > 1. Hidden categories and their items are still accessible via API calls. For example, List Items In Category returns items even for hidden categories.
+     * > 2. The `visible` field can only be changed using the [Update Category Visibility](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/categories/update-category-visibility) method.
+     * > 3. Default: `true`
      * @immutable
      */
     visible?: boolean | null;
     /**
-     * Category breadcrumbs.
+     * Category breadcrumbs, representing the path from the top-level ancestor category down to the parent of the current category.
      *
-     * > **Note:** Returned only when you pass `"BREADCRUMBS_INFO"` to the `fields` array in Categories API requests.
+     * Breadcrumbs are useful for building navigation UI and for SEO purposes. For top-level categories, the breadcrumbs list is empty.
+     *
+     * Returned only when you pass `"BREADCRUMBS_INFO"` to the `fields` array.
      * @readonly
      */
     breadcrumbsInfo?: BreadcrumbsInfo;
     /**
-     * Parent category reference data.
+     * Information about the category's parent. Top-level categories don't have a parent.
      * @immutable
      */
     parentCategory?: ParentCategory;
@@ -4431,9 +4451,18 @@ interface UpdateCategory {
      */
     richContentDescription?: RichContent;
     /**
-     * ID of the app responsible for managing the items in this category.
+     * Reference to the category tree this category belongs to.
+     *
+     * When working with Wix Stores categories, always pass `appNamespace: "@wix/stores"` and `treeKey: null`.
+     * @readonly
+     */
+    treeReference?: TreeReference;
+    /**
+     * ID of the app responsible for managing items in this category.
      *
-     * Pass your app ID to restrict updating and deleting items in this category to your app only.
+     * When set, only the specified app can add or remove items from this category. This is useful for third-party apps that want to create categories exclusively managed by their app, preventing site owners or other apps from modifying the category's items.
+     *
+     * You can get your app's ID from the [app dashboard](https://dev.wix.com/dc3/my-apps/).
      * @format GUID
      * @immutable
      */
@@ -4456,6 +4485,8 @@ interface UpdateCategoryOptions {
 }
 /**
  * Deletes a category.
+ *
+ * Deleting a category also deletes all of its subcategories. Items that were assigned to the deleted categories remain in the catalog but are no longer associated with those categories.
  * @param categoryId - Category ID.
  * @param treeReference - Category tree reference details.
  * @public
@@ -4473,10 +4504,7 @@ declare function deleteCategory(categoryId: string, treeReference: NonNullablePa
  * Retrieves a list of up to 1,000 categories, given the provided filtering, sorting, and cursor paging.
  * Pass supported values to the `fields` array in the request to include those fields in the response.
  *
- * For field support for filters and sorting,
- * see [Categories: Supported Filters and Sorting](https://dev.wix.com/docs/api-reference/business-management/categories/supported-filters-and-sorting).
- *
- * To learn about working with _Query_ endpoints, see
+ * To learn about working with _Query_ methods, see
  * [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language),
  * and [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
  *
@@ -4519,37 +4547,37 @@ interface CategoriesQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      */
-    eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
+    eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'managingAppId', value: any) => CategoriesQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      */
-    ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
+    ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'managingAppId', value: any) => CategoriesQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      */
-    ge: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
+    ge: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'managingAppId', value: any) => CategoriesQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      */
-    gt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
+    gt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'managingAppId', value: any) => CategoriesQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      */
-    le: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
+    le: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'managingAppId', value: any) => CategoriesQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      */
-    lt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
+    lt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'managingAppId', value: any) => CategoriesQueryBuilder;
     /** @param propertyName - Property whose value is compared with `string`.
      * @param string - String to compare against. Case-insensitive.
      */
-    startsWith: (propertyName: '_id' | 'name' | 'description' | 'parentCategory.id' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: string) => CategoriesQueryBuilder;
+    startsWith: (propertyName: '_id' | 'name' | 'description' | 'parentCategory.id' | 'slug' | 'managingAppId', value: string) => CategoriesQueryBuilder;
     /** @param propertyName - Property whose value is compared with `values`.
      * @param values - List of values to compare against.
      */
-    hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any[]) => CategoriesQueryBuilder;
-    in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
-    exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: boolean) => CategoriesQueryBuilder;
+    hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'managingAppId', value: any[]) => CategoriesQueryBuilder;
+    in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'managingAppId', value: any) => CategoriesQueryBuilder;
+    exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'managingAppId', value: boolean) => CategoriesQueryBuilder;
     /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
     ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'name' | 'parentCategory.id' | 'parentCategory.index' | 'managingAppId'>) => CategoriesQueryBuilder;
     /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
@@ -4566,19 +4594,12 @@ interface CategoriesQueryBuilder {
  * @requiredField query
  * @requiredField options
  */
-declare function typedQueryCategories(query: CategoryQuery, options: QueryCategoriesOptions): Promise<NonNullablePaths<QueryCategoriesResponse, `categories` | `categories.${number}.itemCounter` | `categories.${number}.seoData.settings.preventAutoRedirect`, 6>>;
+declare function typedQueryCategories(query: CategoryQuery, options: QueryCategoriesOptions): Promise<NonNullablePaths<QueryCategoriesResponse, `categories` | `categories.${number}.itemCounter` | `categories.${number}.seoData.settings.preventAutoRedirect` | `categories.${number}.treeReference.appNamespace`, 6>>;
 interface CategoryQuerySpec extends QuerySpec {
     paging: 'cursor';
     wql: [
         {
-            fields: [
-                '_id',
-                'description',
-                'slug',
-                'treeReference.appNamespace',
-                'treeReference.treeKey',
-                'visible'
-            ];
+            fields: ['_id', 'description', 'slug', 'visible'];
             operators: '*';
             sort: 'NONE';
         },
@@ -4671,21 +4692,13 @@ interface CategorySearchSpec extends SearchSpec {
         'parentCategory._id',
         'parentCategory.index',
         'slug',
-        'treeReference.appNamespace',
-        'treeReference.treeKey',
         'visible'
     ];
     paging: 'cursor';
     wql: [
         {
             operators: '*';
-            fields: [
-                '_id',
-                'slug',
-                'treeReference.appNamespace',
-                'treeReference.treeKey',
-                'visible'
-            ];
+            fields: ['_id', 'slug', 'visible'];
             sort: 'NONE';
         },
         {
@@ -4724,17 +4737,11 @@ type CategorySearch = {
         cursor?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['cursor'] | null;
     };
     /**
-    Filter object for narrowing search results. For example, to return only categories from the Stores app: `"filter": {"appNamespace": "@wix/stores"}`.
-  
-    Learn more about the filter format in the [supported filters & sorting table](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/search-categories) (SDK)
-    or the [supported filters article](https://dev.wix.com/docs/api-reference/business-management/categories/supported-filters-and-sorting) (REST).
+    Filter object for narrowing search results.
     */
     filter?: CommonSearchWithEntityContext['filter'] | null;
     /**
-    Array of sort objects specifying result order. For example, to sort by creation date in ascending order: `"sort": [{"fieldName": "createdDate", "order": "ASC"}]`.
-  
-    Learn more about the sort format in the [supported filters & sorting table](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/search-categories) (SDK)
-    or the [supported filters article](https://dev.wix.com/docs/api-reference/business-management/categories/supported-filters-and-sorting) (REST).
+    Array of sort objects specifying result order.
     @maxSize: 10
     */
     sort?: {
@@ -4823,9 +4830,6 @@ type CategorySearch = {
 };
 /**
  * Counts the number of categories that match the provided filtering.
- *
- * For field support for filters and sorting,
- * see [Categories: Supported Filters and Sorting](https://dev.wix.com/docs/api-reference/business-management/categories/supported-filters-and-sorting).
  * @public
  * @requiredField options.treeReference
  * @requiredField options.treeReference.appNamespace
@@ -4870,9 +4874,7 @@ declare function moveCategory(categoryId: string, treeReference: NonNullablePath
 }>;
 interface MoveCategoryOptions {
     /**
-     * Parent category ID.
-     *
-     * Default: root category ID
+     * ID of the target parent category. Leave empty or omit to move the category to the top level.
      * @format GUID
      */
     parentCategoryId?: string | null;
@@ -4908,7 +4910,7 @@ interface MoveCategoryOptions {
  * @applicableIdentity APP
  * @fqn com.wix.categories.api.v1.CategoriesService.BulkUpdateCategories
  */
-declare function bulkUpdateCategories(categories: NonNullablePaths<MaskedCategory, `category` | `category._id` | `category.revision`, 3>[], options?: NonNullablePaths<BulkUpdateCategoriesOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<BulkUpdateCategoriesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.category.itemCounter` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
+declare function bulkUpdateCategories(categories: NonNullablePaths<MaskedCategory, `category` | `category._id` | `category.revision`, 3>[], options?: NonNullablePaths<BulkUpdateCategoriesOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<BulkUpdateCategoriesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.category.itemCounter` | `results.${number}.category.treeReference.appNamespace` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
     __applicationErrorsType?: BulkUpdateCategoriesApplicationErrors;
 }>;
 interface BulkUpdateCategoriesOptions {
@@ -4929,6 +4931,7 @@ interface BulkUpdateCategoriesOptions {
 /**
  * Updates category visibility.
  *
+ * Setting visibility to `false` hides the category from site visitors. This also cascades to all subcategories. Hidden categories and their items remain accessible via API.
  *
  * Each time a category is updated, `revision` increments by 1.
  * The current `revision` must be passed when updating a category.
@@ -4944,15 +4947,15 @@ interface BulkUpdateCategoriesOptions {
  * @applicableIdentity APP
  * @fqn com.wix.categories.api.v1.CategoriesService.UpdateCategoryVisibility
  */
-declare function updateCategoryVisibility(categoryId: string, options?: NonNullablePaths<UpdateCategoryVisibilityOptions, `revision` | `treeReference` | `treeReference.appNamespace` | `visible`, 3>): Promise<NonNullablePaths<UpdateCategoryVisibilityResponse, `category.itemCounter` | `category.breadcrumbsInfo.breadcrumbs` | `category.breadcrumbsInfo.breadcrumbs.${number}.categoryId` | `category.breadcrumbsInfo.breadcrumbs.${number}.categoryName` | `category.breadcrumbsInfo.breadcrumbs.${number}.categorySlug` | `category.seoData.tags` | `category.seoData.tags.${number}.type` | `category.seoData.tags.${number}.children` | `category.seoData.tags.${number}.custom` | `category.seoData.tags.${number}.disabled` | `category.seoData.settings.preventAutoRedirect` | `category.seoData.settings.keywords` | `category.seoData.settings.keywords.${number}.term` | `category.seoData.settings.keywords.${number}.isMain`, 7> & {
+declare function updateCategoryVisibility(categoryId: string, options?: NonNullablePaths<UpdateCategoryVisibilityOptions, `revision` | `treeReference` | `treeReference.appNamespace` | `visible`, 3>): Promise<NonNullablePaths<UpdateCategoryVisibilityResponse, `category.itemCounter` | `category.breadcrumbsInfo.breadcrumbs` | `category.breadcrumbsInfo.breadcrumbs.${number}.categoryId` | `category.breadcrumbsInfo.breadcrumbs.${number}.categoryName` | `category.breadcrumbsInfo.breadcrumbs.${number}.categorySlug` | `category.seoData.tags` | `category.seoData.tags.${number}.type` | `category.seoData.tags.${number}.children` | `category.seoData.tags.${number}.custom` | `category.seoData.tags.${number}.disabled` | `category.seoData.settings.preventAutoRedirect` | `category.seoData.settings.keywords` | `category.seoData.settings.keywords.${number}.term` | `category.seoData.settings.keywords.${number}.isMain` | `category.treeReference.appNamespace`, 7> & {
     __applicationErrorsType?: UpdateCategoryVisibilityApplicationErrors;
 }>;
 interface UpdateCategoryVisibilityOptions {
     /**
-     * Whether the category is visible to site visitors in dynamic pages.
+     * Whether the category is visible to site visitors.
      *
-     * + If a parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.
-     * + Passing `true` will fail if the visibility of any parent categories is `false`.
+     * Visibility cascades to subcategories: setting a parent category to `false` also hides all its subcategories.
+     * Setting to `true` fails if any parent category is hidden.
      */
     visible: boolean;
     /** Category tree reference details. */
@@ -4969,10 +4972,9 @@ interface UpdateCategoryVisibilityOptions {
     fields?: SingleEntityOpsRequestedFieldsWithLiterals[];
 }
 /**
- * Updates the visibility of multiple categories so that they are visible to site visitors in dynamic pages.
+ * Sets visibility to `true` for multiple categories, making them visible to site visitors.
  *
- * Calling this method sets each category's `visible` field to `true`.
- * > **Note:** If one of the passed categories has a parent category that is not visible, the passed category will not be updated.
+ * Categories with a hidden parent category aren't updated.
  * @param categoryIds - IDs of the categories to update.
  * @public
  * @requiredField categoryIds
@@ -4982,7 +4984,7 @@ interface UpdateCategoryVisibilityOptions {
  * @applicableIdentity APP
  * @fqn com.wix.categories.api.v1.CategoriesService.BulkShowCategories
  */
-declare function bulkShowCategories(categoryIds: string[], options?: NonNullablePaths<BulkShowCategoriesOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<BulkShowCategoriesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.category.itemCounter` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
+declare function bulkShowCategories(categoryIds: string[], options?: NonNullablePaths<BulkShowCategoriesOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<BulkShowCategoriesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.category.itemCounter` | `results.${number}.category.treeReference.appNamespace` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
 interface BulkShowCategoriesOptions {
     /** Category tree reference details. */
     treeReference: TreeReference;
@@ -5103,10 +5105,11 @@ interface BulkRemoveItemFromCategoriesOptions {
     treeReference: TreeReference;
 }
 /**
- * Retrieves a list of up to 100 items from a single category, given the provided cursor paging.
+ * Retrieves a list of up to 100 items from a category.
  *
  *
- * List Items In Categories defaults to sorting by the time the item was added to the category, in descending order.
+ * By default, items are sorted by the date they were added to the category, newest first. To use the category's manual arrangement instead, pass `useCategoryArrangement: true`.
+ * When `useCategoryArrangement` is `true`, items arranged with [Set Arranged Items](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/categories/set-arranged-items) appear first in their specified order, followed by remaining items sorted by date added.
  * @param categoryId - Category ID.
  * @param treeReference - Category tree reference details.
  * @public
@@ -5120,7 +5123,10 @@ interface BulkRemoveItemFromCategoriesOptions {
 declare function listItemsInCategory(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`, 2>, options?: ListItemsInCategoryOptions): Promise<NonNullablePaths<ListItemsInCategoryResponse, `items` | `items.${number}.catalogItemId` | `items.${number}.appId`, 4>>;
 interface ListItemsInCategoryOptions extends ListItemsInCategoryOptionsPagingMethodOneOf {
     /**
-     * Whether to use category arrangement for sorting items.
+     * Whether to use the category's manual arrangement for sorting items.
+     *
+     * When `true`, manually arranged items appear first in their specified order, followed by remaining items sorted by date added (newest first).
+     * When `false`, all items are sorted by date added (newest first).
      *
      * Default: `false`
      */
@@ -5128,7 +5134,7 @@ interface ListItemsInCategoryOptions extends ListItemsInCategoryOptionsPagingMet
     /**
      * Whether to include items from subcategories.
      *
-     * Default: `false` (only direct items of the category will be returned)
+     * Default: `false`
      */
     includeItemsFromSubcategories?: boolean;
     /**
@@ -5165,7 +5171,9 @@ interface ListCategoriesForItemOptions {
     treeReference: TreeReference;
 }
 /**
- * Retrieves a map where the keys are ItemReferences, and the values are lists of categories that contain the corresponding item.
+ * Retrieves the categories that contain each of the specified items.
+ *
+ * Returns both directly assigned categories, as well as their parent and ancestor categories for each item.
  * @param items - List of Item reference info.
  * @public
  * @requiredField items
@@ -5192,10 +5200,11 @@ interface ListCategoriesForItemsOptions {
  */
 declare function listTrees(): Promise<NonNullablePaths<ListTreesResponse, `trees` | `trees.${number}.appNamespace`, 4>>;
 /**
- * Sets arranged items in a category.
+ * Sets the manual arrangement of items in a category.
+ *
+ * The order of items in the `items` array determines their display order when L[ist Items In Category](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/categories/list-items-in-category) is called with `useCategoryArrangement: true`. The category's existing arrangement is replaced with the provided list.
  *
- * The order of items in the `items` array determines the order of items in the category.
- * The category's existing list of arranged items will be overridden.
+ * Limited to 100 items. Items beyond this limit are displayed after the arranged items, sorted by the date they were added.
  * @param categoryId - Category ID.
  * @param treeReference - Category tree reference details.
  * @public
@@ -5211,13 +5220,15 @@ declare function setArrangedItems(categoryId: string, treeReference: NonNullable
 }>;
 interface SetArrangedItemsOptions {
     /**
-     * List of items to set.
+     * List of items in the desired order. The order in this array determines the display order when List Items In Category is called with `useCategoryArrangement: true`.
      * @maxSize 100
      */
     items?: ItemReference[];
 }
 /**
- * Retrieves a list of arranged items in a category.
+ * Retrieves the manually arranged items in a category.
+ *
+ * Returns only items that have been explicitly arranged using [Set Arranged Items](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/categories/set-arranged-items). Items added to the category but not manually arranged aren't included.
  * @param categoryId - Category ID.
  * @param treeReference - Category tree reference details.
  * @public