@wix/auto_sdk_stores_product-groups-v-3 1.0.0

package/build/cjs/stores-catalog-v3-product-group-product-groups-v-3.universal-BSxpFEZE.d.ts

@@ -0,0 +1,1824 @@
+import * as _wix_sdk_types from '@wix/sdk-types';
+import { QuerySpec, SearchSpec, Query, Search, NonNullablePaths } from '@wix/sdk-types';
+
+/**
+ * A product group aggregates related products based on a shared customization
+ * (option or modifier). Each member product is automatically assigned to
+ * represent a specific choice of that customization.
+ */
+interface ProductGroup {
+    /**
+     * Product group ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the product group is updated.
+     * To prevent conflicting changes,
+     * the current revision must be passed when updating the product group.
+     *
+     * Ignored when creating a product group.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the product group was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the product group was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Product group name.
+     * @minLength 1
+     * @maxLength 100
+     */
+    name?: string | null;
+    /**
+     * ID of the shared customization (option or modifier) that defines
+     * the grouping attribute. Can't be changed after creation.
+     * @minLength 1
+     * @maxLength 36
+     * @readonly
+     * @immutable
+     */
+    groupingCustomizationId?: string | null;
+    /**
+     * Ordered list of choice IDs that defines the display order of choices in the storefront.
+     * Choices not listed here will appear after the listed ones.
+     * @maxSize 100
+     * @format GUID
+     */
+    choiceOrder?: string[];
+    /**
+     * Products that belong to this group, with their derived choice and status.
+     * Ordered according to `choice_order`.
+     * @readonly
+     * @maxSize 100
+     */
+    members?: ProductGroupMember[];
+    /**
+     * Unique human-friendly identifier for the product group.
+     *
+     * Unlike the auto-generated `id`, the handle can be set when creating a product group.
+     * Useful for external catalog sync systems. Unique per site.
+     * If not provided during creation, a random UUID is automatically generated. Can't be changed after creation.
+     * @minLength 1
+     * @maxLength 100
+     * @readonly
+     * @immutable
+     */
+    handle?: string | null;
+    /**
+     * Details of the catalog [customization](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/customizations-v3/introduction) referenced by `grouping_customization_id` (for example, name and render type).
+     *
+     * > **Note:** Returned only when you pass `"GROUPING_CUSTOMIZATION"` to the `fields` array in Product Groups API requests.
+     * @readonly
+     */
+    groupingCustomization?: GroupingCustomization;
+    /**
+     * Custom field data for the product group.
+     * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)
+     * must be configured in the app dashboard before they can be accessed with API calls.
+     */
+    extendedFields?: ExtendedFields;
+    /** Tags */
+    tags?: Tags;
+}
+/** Represents a product within a product group, with its derived choice and status. */
+interface ProductGroupMember {
+    /**
+     * The member product ID.
+     * @minLength 1
+     * @maxLength 36
+     */
+    productId?: string;
+    /**
+     * The choice derived from the product's option or modifier data
+     * for the group's `grouping_customization_id`.
+     */
+    choice?: ProductChoice;
+    /**
+     * The product's URL slug, for storefront navigation between siblings.
+     * @minLength 1
+     * @maxLength 200
+     */
+    slug?: string | null;
+    /** The product's inventory availability status, for rendering out-of-stock choices as disabled. */
+    inventoryAvailabilityStatus?: AvailabilityStatusWithLiterals;
+    /**
+     * Membership status. Indicates whether the product qualifies for display in the group.
+     * + `ACTIVE` — Product has exactly one choice for the group's customization and is visible.
+     * + `HIDDEN` — Merchant manually hid this product from site visitors.
+     * + `OUT_OF_SYNC` — Product no longer qualifies for the group. For example, the group's
+     * customization was removed from the product, or the product has multiple choices for it.
+     */
+    status?: MembershipStatusWithLiterals;
+    /**
+     * The product's name, materialized for search indexing.
+     * @maxLength 100
+     */
+    productName?: string | null;
+}
+interface ProductChoice extends ProductChoiceValueOneOf {
+    /**
+     * Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
+     * @minLength 3
+     * @maxLength 20
+     * @format COLOR_HEX
+     */
+    colorCode?: string;
+    /**
+     * Choice ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * Choice type.
+     *
+     * > **Notes:**
+     * > + For `customizationRenderType: SWATCH_CHOICES`, the supported `choiceType` value is: `ONE_COLOR`.
+     * > + For a `customizationRenderType` of `TEXT_CHOICES`, the supported `choiceType` value is: `CHOICE_TEXT`.
+     * @immutable
+     */
+    choiceType?: ChoiceTypeWithLiterals;
+    /**
+     * A read-only identifier generated from the choice name.
+     *
+     * Use `key` in the `catalogReference.options` object when [integrating Catalog V3 with eCommerce APIs](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/e-commerce-integration).
+     * @readonly
+     * @minLength 1
+     * @maxLength 50
+     */
+    key?: string | null;
+    /**
+     * Choice name.
+     * @minLength 1
+     * @maxLength 50
+     */
+    name?: string;
+}
+/** @oneof */
+interface ProductChoiceValueOneOf {
+    /**
+     * Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
+     * @minLength 3
+     * @maxLength 20
+     * @format COLOR_HEX
+     */
+    colorCode?: string;
+}
+declare enum ChoiceType {
+    /** For a `customizationRenderType` of `TEXT_CHOICES`. */
+    CHOICE_TEXT = "CHOICE_TEXT",
+    /** For `customizationRenderType: SWATCH_CHOICES`. */
+    ONE_COLOR = "ONE_COLOR"
+}
+/** @enumType */
+type ChoiceTypeWithLiterals = ChoiceType | 'CHOICE_TEXT' | 'ONE_COLOR';
+declare enum AvailabilityStatus {
+    /** All variants are in stock and available for purchase. */
+    IN_STOCK = "IN_STOCK",
+    /** All variants are out of stock. */
+    OUT_OF_STOCK = "OUT_OF_STOCK",
+    /** Some variants are out of stock and some are in stock and available for purchase. */
+    PARTIALLY_OUT_OF_STOCK = "PARTIALLY_OUT_OF_STOCK"
+}
+/** @enumType */
+type AvailabilityStatusWithLiterals = AvailabilityStatus | 'IN_STOCK' | 'OUT_OF_STOCK' | 'PARTIALLY_OUT_OF_STOCK';
+declare enum MembershipStatus {
+    /** Product is active and visible in the group. */
+    ACTIVE = "ACTIVE",
+    /** Merchant manually hid this product from site visitors. */
+    HIDDEN = "HIDDEN",
+    /** Product no longer qualifies (missing customization, multiple choices, etc.). */
+    OUT_OF_SYNC = "OUT_OF_SYNC"
+}
+/** @enumType */
+type MembershipStatusWithLiterals = MembershipStatus | 'ACTIVE' | 'HIDDEN' | 'OUT_OF_SYNC';
+interface GroupingCustomization {
+    /**
+     * @minLength 1
+     * @maxLength 36
+     */
+    _id?: string | null;
+    /**
+     * @minLength 1
+     * @maxLength 50
+     */
+    key?: string | null;
+    /**
+     * @minLength 1
+     * @maxLength 50
+     */
+    name?: string;
+    customizationType?: CustomizationTypeWithLiterals;
+    customizationRenderType?: CustomizationRenderTypeWithLiterals;
+}
+declare enum CustomizationType {
+    PRODUCT_OPTION = "PRODUCT_OPTION",
+    MODIFIER = "MODIFIER"
+}
+/** @enumType */
+type CustomizationTypeWithLiterals = CustomizationType | 'PRODUCT_OPTION' | 'MODIFIER';
+declare enum CustomizationRenderType {
+    FREE_TEXT = "FREE_TEXT",
+    TEXT_CHOICES = "TEXT_CHOICES",
+    SWATCH_CHOICES = "SWATCH_CHOICES"
+}
+/** @enumType */
+type CustomizationRenderTypeWithLiterals = CustomizationRenderType | 'FREE_TEXT' | 'TEXT_CHOICES' | 'SWATCH_CHOICES';
+interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+/**
+ * Common object for tags.
+ * Should be use as in this example:
+ * message Foo {
+ * option (.wix.api.decomposite_of) = "wix.commons.v2.tags.Foo";
+ * string id = 1;
+ * ...
+ * Tags tags = 5
+ * }
+ *
+ * example of taggable entity
+ * {
+ * id: "123"
+ * tags: {
+ * public_tags: {
+ * tag_ids:["11","22"]
+ * },
+ * private_tags: {
+ * tag_ids: ["33", "44"]
+ * }
+ * }
+ * }
+ */
+interface Tags {
+    /** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
+    privateTags?: TagList;
+    /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
+    publicTags?: TagList;
+}
+interface TagList {
+    /**
+     * List of tag IDs.
+     * @maxSize 100
+     * @maxLength 5
+     */
+    tagIds?: string[];
+}
+interface ProductGroupTagsModified {
+    /** Updated ProductGroup. */
+    productGroup?: ProductGroup;
+    /** Tags that were assigned to the ProductGroup. */
+    assignedTags?: Tags;
+    /** Tags that were unassigned from the ProductGroup. */
+    unassignedTags?: Tags;
+}
+interface CreateProductGroupRequest {
+    /** The product group to create. */
+    productGroup: ProductGroup;
+    /**
+     * Fields to include on the returned `product_group` (e.g. `GROUPING_CUSTOMIZATION`).
+     * @maxSize 10
+     */
+    fields?: ProductGroupRequestedFieldsWithLiterals[];
+}
+declare enum ProductGroupRequestedFields {
+    /** Provides details of the customization referenced by `grouping_customization_id` (see `ProductGroup.grouping_customization`). */
+    GROUPING_CUSTOMIZATION = "GROUPING_CUSTOMIZATION"
+}
+/** @enumType */
+type ProductGroupRequestedFieldsWithLiterals = ProductGroupRequestedFields | 'GROUPING_CUSTOMIZATION';
+interface CreateProductGroupResponse {
+    /** The created product group. */
+    productGroup?: ProductGroup;
+    /**
+     * Fields to include on the returned `product_group` (e.g. `GROUPING_CUSTOMIZATION`).
+     * @maxSize 10
+     */
+    fields?: ProductGroupRequestedFieldsWithLiterals[];
+}
+interface UpdateProductGroupRequest {
+    /** The product group to update with the desired field values. */
+    productGroup: ProductGroup;
+    /**
+     * Fields to include on the returned `product_group` (e.g. `GROUPING_CUSTOMIZATION`).
+     * @maxSize 10
+     */
+    fields?: ProductGroupRequestedFieldsWithLiterals[];
+}
+interface UpdateProductGroupResponse {
+    /** The updated product group. */
+    productGroup?: ProductGroup;
+    /**
+     * Fields to include on the returned product_group (e.g. GROUPING_CUSTOMIZATION).
+     * @maxSize 10
+     */
+    fields?: ProductGroupRequestedFieldsWithLiterals[];
+}
+interface DeleteProductGroupRequest {
+    /**
+     * ID of the product group to delete.
+     * @format GUID
+     */
+    productGroupId: string;
+}
+interface DeleteProductGroupResponse {
+}
+interface GetProductGroupRequest {
+    /**
+     * ID of the product group to retrieve.
+     * @format GUID
+     */
+    productGroupId: string;
+    /**
+     * Fields to include on the returned product group (e.g. `GROUPING_CUSTOMIZATION`).
+     * @maxSize 10
+     */
+    fields?: ProductGroupRequestedFieldsWithLiterals[];
+}
+interface GetProductGroupResponse {
+    /** The requested product group. */
+    productGroup?: ProductGroup;
+    /**
+     * Optional expansions on each returned product group (e.g. `GROUPING_CUSTOMIZATION`).
+     * @maxSize 10
+     */
+    fields?: ProductGroupRequestedFieldsWithLiterals[];
+}
+interface QueryProductGroupsRequest {
+    /** WQL query — filter, sort, and cursor-based paging criteria. */
+    query?: CursorQuery;
+    /**
+     * Optional expansions on each returned product group (e.g. `GROUPING_CUSTOMIZATION`).
+     * @maxSize 10
+     */
+    fields?: ProductGroupRequestedFieldsWithLiterals[];
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     * @maxSize 5
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+interface QueryProductGroupsResponse {
+    /** List of product groups matching the query. */
+    productGroups?: ProductGroup[];
+    /** Paging metadata for the next cursor. */
+    pagingMetadata?: CursorPagingMetadata;
+    /**
+     * Optional expansions on each returned product group (e.g. `GROUPING_CUSTOMIZATION`).
+     * @maxSize 10
+     */
+    fields?: ProductGroupRequestedFieldsWithLiterals[];
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in current page. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface SearchProductGroupsRequest {
+    /** WQL search — filter, free-text search, sort, and cursor-based paging. */
+    search?: CursorSearch;
+    /**
+     * Optional expansions on each returned product group (e.g. `GROUPING_CUSTOMIZATION`).
+     * @maxSize 10
+     */
+    fields?: ProductGroupRequestedFieldsWithLiterals[];
+}
+interface CursorSearch extends CursorSearchPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * List of sort objects.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     * @maxSize 10
+     */
+    sort?: Sorting[];
+    /**
+     * Aggregations are 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.
+     * @maxSize 10
+     */
+    aggregations?: Aggregation[];
+    /** Free text to match in searchable fields. */
+    search?: SearchDetails;
+    /**
+     * UTC offset or IANA time zone. Valid values are
+     * ISO 8601 UTC offsets, such as +02:00 or -06:00,
+     * and IANA time zone IDs, such as Europe/Rome.
+     *
+     * Affects all filters and aggregations returned values.
+     * You may override this behavior in a specific filter by providing
+     * timestamps including time zone. For example, `"2023-12-20T10:52:34.795Z"`.
+     * @maxLength 50
+     */
+    timeZone?: string | null;
+}
+/** @oneof */
+interface CursorSearchPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+}
+interface Aggregation extends AggregationKindOneOf {
+    /** Value aggregation. */
+    value?: ValueAggregation;
+    /** Range aggregation. */
+    range?: RangeAggregation;
+    /** Scalar aggregation. */
+    scalar?: ScalarAggregation;
+    /** Date histogram aggregation. */
+    dateHistogram?: DateHistogramAggregation;
+    /** Nested aggregation. */
+    nested?: NestedAggregation;
+    /**
+     * User-defined name of aggregation, should be unique, will appear in aggregation results.
+     * @maxLength 100
+     */
+    name?: string | null;
+    /** Type of aggregation, client must provide matching aggregation field below. */
+    type?: AggregationTypeWithLiterals;
+    /**
+     * Field to aggregate by, use dot notation to specify json path.
+     * @maxLength 200
+     */
+    fieldPath?: string;
+}
+/** @oneof */
+interface AggregationKindOneOf {
+    /** Value aggregation. */
+    value?: ValueAggregation;
+    /** Range aggregation. */
+    range?: RangeAggregation;
+    /** Scalar aggregation. */
+    scalar?: ScalarAggregation;
+    /** Date histogram aggregation. */
+    dateHistogram?: DateHistogramAggregation;
+    /** Nested aggregation. */
+    nested?: NestedAggregation;
+}
+interface RangeBucket {
+    /** Inclusive lower bound of the range. Required if `to` is not provided. */
+    from?: number | null;
+    /** Exclusive upper bound of the range. Required if `from` is not provided. */
+    to?: number | null;
+}
+declare enum SortType {
+    /** Sort by number of matches. */
+    COUNT = "COUNT",
+    /** Sort by value of the field alphabetically. */
+    VALUE = "VALUE"
+}
+/** @enumType */
+type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE';
+declare enum SortDirection {
+    /** Sort in descending order. */
+    DESC = "DESC",
+    /** Sort in ascending order. */
+    ASC = "ASC"
+}
+/** @enumType */
+type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC';
+declare enum MissingValues {
+    /** Exclude missing values from the aggregation results. */
+    EXCLUDE = "EXCLUDE",
+    /** Include missing values in the aggregation results. */
+    INCLUDE = "INCLUDE"
+}
+/** @enumType */
+type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
+interface IncludeMissingValuesOptions {
+    /**
+     * Specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
+     * @maxLength 20
+     */
+    addToBucket?: string;
+}
+declare enum ScalarType {
+    /** Count of distinct values. */
+    COUNT_DISTINCT = "COUNT_DISTINCT",
+    /** Minimum value. */
+    MIN = "MIN",
+    /** Maximum value. */
+    MAX = "MAX"
+}
+/** @enumType */
+type ScalarTypeWithLiterals = ScalarType | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
+interface ValueAggregation extends ValueAggregationOptionsOneOf {
+    /** Options for including missing values. */
+    includeOptions?: IncludeMissingValuesOptions;
+    /** Whether to sort by number of matches or value of the field. */
+    sortType?: SortTypeWithLiterals;
+    /** Whether to sort in ascending or descending order. */
+    sortDirection?: SortDirectionWithLiterals;
+    /** How many aggregations to return. Can be between 1 and 250. 10 is the default. */
+    limit?: number | null;
+    /** Whether to include or exclude missing values from the aggregation results. Default: `EXCLUDE`. */
+    missingValues?: MissingValuesWithLiterals;
+}
+/** @oneof */
+interface ValueAggregationOptionsOneOf {
+    /** Options for including missing values. */
+    includeOptions?: IncludeMissingValuesOptions;
+}
+declare enum NestedAggregationType {
+    /** An aggregation where result buckets are dynamically built - one per unique value. */
+    VALUE = "VALUE",
+    /** An aggregation, where user can define set of ranges - each representing a bucket. */
+    RANGE = "RANGE",
+    /** A single-value metric aggregation. For example, min, max, sum, avg. */
+    SCALAR = "SCALAR",
+    /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.). */
+    DATE_HISTOGRAM = "DATE_HISTOGRAM"
+}
+/** @enumType */
+type NestedAggregationTypeWithLiterals = NestedAggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
+interface RangeAggregation {
+    /**
+     * List of range buckets, where during aggregation each entity will be placed in the first bucket its value falls into, based on the provided range bounds.
+     * @maxSize 50
+     */
+    buckets?: RangeBucket[];
+}
+interface ScalarAggregation {
+    /** Define the operator for the scalar aggregation. */
+    type?: ScalarTypeWithLiterals;
+}
+interface DateHistogramAggregation {
+    /** Interval for date histogram aggregation. */
+    interval?: IntervalWithLiterals;
+}
+declare enum Interval {
+    /** Yearly interval */
+    YEAR = "YEAR",
+    /** Monthly interval */
+    MONTH = "MONTH",
+    /** Weekly interval */
+    WEEK = "WEEK",
+    /** Daily interval */
+    DAY = "DAY",
+    /** Hourly interval */
+    HOUR = "HOUR",
+    /** Minute interval */
+    MINUTE = "MINUTE",
+    /** Second interval */
+    SECOND = "SECOND"
+}
+/** @enumType */
+type IntervalWithLiterals = Interval | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
+interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
+    /** Value aggregation. */
+    value?: ValueAggregation;
+    /** Range aggregation. */
+    range?: RangeAggregation;
+    /** Scalar aggregation. */
+    scalar?: ScalarAggregation;
+    /** Date histogram aggregation. */
+    dateHistogram?: DateHistogramAggregation;
+    /**
+     * User-defined name of aggregation, should be unique, will appear in aggregation results.
+     * @maxLength 100
+     */
+    name?: string | null;
+    /** Type of aggregation, client must provide matching aggregation field below. */
+    type?: NestedAggregationTypeWithLiterals;
+    /**
+     * Field to aggregate by, use dot notation to specify json path.
+     * @maxLength 200
+     */
+    fieldPath?: string;
+}
+/** @oneof */
+interface NestedAggregationItemKindOneOf {
+    /** Value aggregation. */
+    value?: ValueAggregation;
+    /** Range aggregation. */
+    range?: RangeAggregation;
+    /** Scalar aggregation. */
+    scalar?: ScalarAggregation;
+    /** Date histogram aggregation. */
+    dateHistogram?: DateHistogramAggregation;
+}
+declare enum AggregationType {
+    /** An aggregation where result buckets are dynamically built - one per unique value. */
+    VALUE = "VALUE",
+    /** An aggregation, where user can define set of ranges - each representing a bucket. */
+    RANGE = "RANGE",
+    /** A single-value metric aggregation. For example, min, max, sum, avg. */
+    SCALAR = "SCALAR",
+    /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
+    DATE_HISTOGRAM = "DATE_HISTOGRAM",
+    /** Multi-level aggregation, where each next aggregation is nested within previous one. */
+    NESTED = "NESTED"
+}
+/** @enumType */
+type AggregationTypeWithLiterals = AggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
+/** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
+interface NestedAggregation {
+    /**
+     * Flattened list of aggregations, where each next aggregation is nested within previous one.
+     * @minSize 2
+     * @maxSize 3
+     */
+    nestedAggregations?: NestedAggregationItem[];
+}
+interface SearchDetails {
+    /** Defines how separate search terms in `expression` are combined. */
+    mode?: ModeWithLiterals;
+    /**
+     * Search term or expression.
+     * @maxLength 100
+     */
+    expression?: string | null;
+    /**
+     * Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path.
+     * @maxLength 200
+     * @maxSize 20
+     */
+    fields?: string[];
+    /** Whether to use auto fuzzy search (allowing typos by a managed proximity algorithm). */
+    fuzzy?: boolean;
+}
+declare enum Mode {
+    /** Any of the search terms must be present. */
+    OR = "OR",
+    /** All search terms must be present. */
+    AND = "AND"
+}
+/** @enumType */
+type ModeWithLiterals = Mode | 'OR' | 'AND';
+interface SearchProductGroupsResponse {
+    /** List of product groups matching the search. */
+    productGroups?: ProductGroup[];
+    /** Paging metadata for the next cursor. */
+    pagingMetadata?: CursorPagingMetadata;
+    /** Aggregation data from the search. */
+    aggregationData?: AggregationData;
+    /**
+     * Optional expansions on each returned product group (e.g. `GROUPING_CUSTOMIZATION`).
+     * @maxSize 10
+     */
+    fields?: ProductGroupRequestedFieldsWithLiterals[];
+}
+interface AggregationData {
+    /**
+     * key = aggregation name (as derived from search request).
+     * @maxSize 10000
+     */
+    results?: AggregationResults[];
+}
+interface ValueAggregationResult {
+    /**
+     * Value of the field.
+     * @maxLength 100
+     */
+    value?: string;
+    /** Count of entities with this value. */
+    count?: number;
+}
+interface RangeAggregationResult {
+    /** Inclusive lower bound of the range. */
+    from?: number | null;
+    /** Exclusive upper bound of the range. */
+    to?: number | null;
+    /** Count of entities in this range. */
+    count?: number;
+}
+interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
+    /** Value aggregation results. */
+    values?: ValueResults;
+    /** Range aggregation results. */
+    ranges?: RangeResults;
+    /** Scalar aggregation results. */
+    scalar?: AggregationResultsScalarResult;
+    /**
+     * User-defined name of aggregation, matches the one provided in request.
+     * @maxLength 100
+     */
+    name?: string;
+    /** Type of aggregation that matches result. */
+    type?: AggregationTypeWithLiterals;
+    /**
+     * Field to aggregate by, matches the one provided in request.
+     * @maxLength 200
+     */
+    fieldPath?: string;
+}
+/** @oneof */
+interface NestedAggregationResultsResultOneOf {
+    /** Value aggregation results. */
+    values?: ValueResults;
+    /** Range aggregation results. */
+    ranges?: RangeResults;
+    /** Scalar aggregation results. */
+    scalar?: AggregationResultsScalarResult;
+}
+interface ValueResults {
+    /**
+     * List of value aggregations.
+     * @maxSize 250
+     */
+    results?: ValueAggregationResult[];
+}
+interface RangeResults {
+    /**
+     * List of ranges returned in same order as requested.
+     * @maxSize 50
+     */
+    results?: RangeAggregationResult[];
+}
+interface AggregationResultsScalarResult {
+    /** Type of scalar aggregation. */
+    type?: ScalarTypeWithLiterals;
+    /** Value of the scalar aggregation. */
+    value?: number;
+}
+interface NestedValueAggregationResult {
+    /**
+     * Value of the field.
+     * @maxLength 1000
+     */
+    value?: string;
+    /** Nested aggregations. */
+    nestedResults?: NestedAggregationResults;
+}
+interface ValueResult {
+    /**
+     * Value of the field.
+     * @maxLength 1000
+     */
+    value?: string;
+    /** Count of entities with this value. */
+    count?: number | null;
+}
+interface RangeResult {
+    /** Inclusive lower bound of the range. */
+    from?: number | null;
+    /** Exclusive upper bound of the range. */
+    to?: number | null;
+    /** Count of entities in this range. */
+    count?: number | null;
+}
+interface ScalarResult {
+    /** Value of the scalar aggregation. */
+    value?: number;
+}
+interface NestedResultValue extends NestedResultValueResultOneOf {
+    /** Value aggregation result. */
+    value?: ValueResult;
+    /** Range aggregation result. */
+    range?: RangeResult;
+    /** Scalar aggregation result. */
+    scalar?: ScalarResult;
+    /** Date histogram aggregation result. */
+    dateHistogram?: ValueResult;
+}
+/** @oneof */
+interface NestedResultValueResultOneOf {
+    /** Value aggregation result. */
+    value?: ValueResult;
+    /** Range aggregation result. */
+    range?: RangeResult;
+    /** Scalar aggregation result. */
+    scalar?: ScalarResult;
+    /** Date histogram aggregation result. */
+    dateHistogram?: ValueResult;
+}
+interface Results {
+    /** List of nested aggregations. */
+    results?: Record<string, NestedResultValue>;
+}
+interface DateHistogramResult {
+    /**
+     * Date in ISO 8601 format.
+     * @maxLength 100
+     */
+    value?: string;
+    /** Count of documents in the bucket. */
+    count?: number;
+}
+interface GroupByValueResults {
+    /**
+     * List of value aggregations.
+     * @maxSize 1000
+     */
+    results?: NestedValueAggregationResult[];
+}
+interface DateHistogramResults {
+    /**
+     * List of date histogram aggregations.
+     * @maxSize 200
+     */
+    results?: DateHistogramResult[];
+}
+/**
+ * Results of `NESTED` aggregation type in a flattened form.
+ * Aggregations in resulting array are keyed by requested aggregation `name`.
+ */
+interface NestedResults {
+    /**
+     * List of nested aggregations.
+     * @maxSize 1000
+     */
+    results?: Results[];
+}
+interface AggregationResults extends AggregationResultsResultOneOf {
+    /** Value aggregation results. */
+    values?: ValueResults;
+    /** Range aggregation results. */
+    ranges?: RangeResults;
+    /** Scalar aggregation results. */
+    scalar?: AggregationResultsScalarResult;
+    /** Group by value aggregation results. */
+    groupedByValue?: GroupByValueResults;
+    /** Date histogram aggregation results. */
+    dateHistogram?: DateHistogramResults;
+    /** Nested aggregation results. */
+    nested?: NestedResults;
+    /**
+     * User-defined name of aggregation as derived from search request.
+     * @maxLength 100
+     */
+    name?: string;
+    /** Type of aggregation that must match provided kind as derived from search request. */
+    type?: AggregationTypeWithLiterals;
+    /**
+     * Field to aggregate by as derived from search request.
+     * @maxLength 200
+     */
+    fieldPath?: string;
+}
+/** @oneof */
+interface AggregationResultsResultOneOf {
+    /** Value aggregation results. */
+    values?: ValueResults;
+    /** Range aggregation results. */
+    ranges?: RangeResults;
+    /** Scalar aggregation results. */
+    scalar?: AggregationResultsScalarResult;
+    /** Group by value aggregation results. */
+    groupedByValue?: GroupByValueResults;
+    /** Date histogram aggregation results. */
+    dateHistogram?: DateHistogramResults;
+    /** Nested aggregation results. */
+    nested?: NestedResults;
+}
+interface BulkCreateProductGroupsRequest {
+    /**
+     * List of product groups to create.
+     * @minSize 1
+     * @maxSize 100
+     */
+    productGroups: ProductGroup[];
+    /** Whether to return the created product group entities in the response. */
+    returnEntity?: boolean;
+    /**
+     * Fields to include on each returned `item` (e.g. `GROUPING_CUSTOMIZATION`).
+     * @maxSize 10
+     */
+    fields?: ProductGroupRequestedFieldsWithLiterals[];
+}
+interface BulkCreateProductGroupsResponse {
+    /**
+     * Results for each product group creation attempt, in request order.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkProductGroupResult[];
+    /** Aggregated success/failure counts. */
+    bulkActionMetadata?: BulkActionMetadata;
+    /**
+     * Fields to include on each returned `item` (e.g. `GROUPING_CUSTOMIZATION`).
+     * @maxSize 10
+     */
+    fields?: ProductGroupRequestedFieldsWithLiterals[];
+}
+interface ItemMetadata {
+    /**
+     * Item ID. Provided only whenever possible. For example, `itemId` can't be provided when item creation has failed.
+     * @format GUID
+     */
+    _id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action for this item was successful. When `false`, the `error` field is returned. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+/** The result of a single item in a bulk create operation. */
+interface BulkProductGroupResult {
+    itemMetadata?: ItemMetadata;
+    /** Only populated if `return_entity` was `true` and the operation succeeded. */
+    item?: ProductGroup;
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+interface BulkUpdateProductGroupsRequest {
+    /**
+     * List of product groups to update, each with its own field mask.
+     * @minSize 1
+     * @maxSize 100
+     */
+    productGroups: MaskedProductGroup[];
+    /** Whether to return the updated product group entities in the response. */
+    returnEntity?: boolean;
+    /**
+     * Fields to include on each returned `item` (e.g. `GROUPING_CUSTOMIZATION`).
+     * @maxSize 10
+     */
+    fields?: ProductGroupRequestedFieldsWithLiterals[];
+}
+interface MaskedProductGroup {
+    /** The product group to update. `product_group.id` and `product_group.revision` are required. */
+    productGroup?: ProductGroup;
+}
+interface BulkUpdateProductGroupsResponse {
+    /**
+     * Results for each product group update attempt, in request order.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkUpdateProductGroupsResponseBulkProductGroupResult[];
+    /** Aggregated success/failure counts. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+/** The result of a single item in a bulk update operation. */
+interface BulkUpdateProductGroupsResponseBulkProductGroupResult {
+    itemMetadata?: ItemMetadata;
+    /** Only populated if `return_entity` was `true` and the operation succeeded. */
+    item?: ProductGroup;
+}
+interface AssignProductsToProductGroupRequest {
+    /**
+     * ID of the product group to assign products to.
+     * @format GUID
+     */
+    productGroupId: string;
+    /**
+     * IDs of the products to assign. Duplicates are silently de-duplicated. Products already in the group are skipped.
+     * @minSize 1
+     * @maxSize 100
+     * @minLength 1
+     * @maxLength 36
+     */
+    productIds: string[];
+}
+interface AssignProductsToProductGroupResponse {
+    /** Per-item results, one entry per product ID in the request. */
+    results?: ProductAssignmentResult[];
+}
+interface ProductAssignmentResult {
+    /** ID of the product. */
+    productId?: string;
+    /** Whether the assignment succeeded. */
+    success?: boolean;
+    /** Error details if the assignment failed. */
+    error?: ApplicationError;
+}
+interface UnassignProductsFromProductGroupRequest {
+    /**
+     * ID of the product group to unassign products from.
+     * @format GUID
+     */
+    productGroupId: string;
+    /**
+     * IDs of the products to unassign. Duplicates are silently de-duplicated. All products must currently be members of the group.
+     * @minSize 1
+     * @maxSize 100
+     * @minLength 1
+     * @maxLength 36
+     */
+    productIds: string[];
+}
+interface UnassignProductsFromProductGroupResponse {
+    /** Per-item results, one entry per product ID in the request. */
+    results?: ProductUnassignmentResult[];
+}
+interface ProductUnassignmentResult {
+    /** ID of the product */
+    productId?: string;
+    /** Whether the unassignment succeeded. */
+    success?: boolean;
+    /** Error details if the unassignment failed. */
+    error?: ApplicationError;
+}
+interface BulkDeleteProductGroupsRequest {
+    /**
+     * IDs of the product groups to delete.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
+    productGroupIds: string[];
+}
+interface BulkDeleteProductGroupsResponse {
+    /**
+     * Results for each product group deletion attempt, in request order.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkDeleteProductGroupsResponseBulkProductGroupResult[];
+    /** Aggregated success/failure counts. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkDeleteProductGroupsResponseBulkProductGroupResult {
+    /** Metadata regarding the specific single delete operation. */
+    itemMetadata?: ItemMetadata;
+}
+interface BulkUpdateProductGroupTagsRequest {
+    /**
+     * List of product group IDs whose tags will be updated.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
+    productGroupIds: string[];
+    /** List of tags to assign. */
+    assignTags?: Tags;
+    /** List of tags to unassign. */
+    unassignTags?: Tags;
+}
+interface BulkUpdateProductGroupTagsResponse {
+    /**
+     * Results.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkUpdateProductGroupTagsResult[];
+    /** Aggregated success/failure counts. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkUpdateProductGroupTagsResult {
+    /** Metadata regarding the specific single update operation. */
+    itemMetadata?: ItemMetadata;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface Empty {
+}
+interface BulkUpdateProductGroupTagsByFilterRequest {
+    /**
+     * Filter object. Supported fields for filtering: `id`, `handle`.
+     * Pass an empty object `{}` to target all product groups.
+     */
+    filter: Record<string, any> | null;
+    /** List of tags to assign. */
+    assignTags?: Tags;
+    /** List of tags to unassign. */
+    unassignTags?: Tags;
+}
+interface BulkUpdateProductGroupTagsByFilterResponse {
+    /**
+     * Job ID.
+     *
+     * Pass this ID to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/introduction) to retrieve job details and metadata..
+     * @format GUID
+     */
+    jobId?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface AccountInfo {
+    /**
+     * ID of the Wix account associated with the event.
+     * @format GUID
+     */
+    accountId?: string | null;
+    /**
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
+     */
+    parentAccountId?: string | null;
+    /**
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * @format GUID
+     */
+    siteId?: string | null;
+}
+/** @docsIgnore */
+type BulkUpdateProductGroupTagsApplicationErrors = {
+    code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type BulkUpdateProductGroupTagsByFilterApplicationErrors = {
+    code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
+    description?: string;
+    data?: Record<string, any>;
+};
+interface CreateProductGroupOptions {
+    /**
+     * Fields to include on the returned `product_group` (e.g. `GROUPING_CUSTOMIZATION`).
+     * @maxSize 10
+     */
+    fields?: ProductGroupRequestedFieldsWithLiterals[];
+}
+interface UpdateProductGroup {
+    /**
+     * Product group ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the product group is updated.
+     * To prevent conflicting changes,
+     * the current revision must be passed when updating the product group.
+     *
+     * Ignored when creating a product group.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the product group was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the product group was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Product group name.
+     * @minLength 1
+     * @maxLength 100
+     */
+    name?: string | null;
+    /**
+     * ID of the shared customization (option or modifier) that defines
+     * the grouping attribute. Can't be changed after creation.
+     * @minLength 1
+     * @maxLength 36
+     * @readonly
+     * @immutable
+     */
+    groupingCustomizationId?: string | null;
+    /**
+     * Ordered list of choice IDs that defines the display order of choices in the storefront.
+     * Choices not listed here will appear after the listed ones.
+     * @maxSize 100
+     * @format GUID
+     */
+    choiceOrder?: string[];
+    /**
+     * Products that belong to this group, with their derived choice and status.
+     * Ordered according to `choice_order`.
+     * @readonly
+     * @maxSize 100
+     */
+    members?: ProductGroupMember[];
+    /**
+     * Unique human-friendly identifier for the product group.
+     *
+     * Unlike the auto-generated `id`, the handle can be set when creating a product group.
+     * Useful for external catalog sync systems. Unique per site.
+     * If not provided during creation, a random UUID is automatically generated. Can't be changed after creation.
+     * @minLength 1
+     * @maxLength 100
+     * @readonly
+     * @immutable
+     */
+    handle?: string | null;
+    /**
+     * Details of the catalog [customization](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/customizations-v3/introduction) referenced by `grouping_customization_id` (for example, name and render type).
+     *
+     * > **Note:** Returned only when you pass `"GROUPING_CUSTOMIZATION"` to the `fields` array in Product Groups API requests.
+     * @readonly
+     */
+    groupingCustomization?: GroupingCustomization;
+    /**
+     * Custom field data for the product group.
+     * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)
+     * must be configured in the app dashboard before they can be accessed with API calls.
+     */
+    extendedFields?: ExtendedFields;
+    /** Tags */
+    tags?: Tags;
+}
+interface UpdateProductGroupOptions {
+    /**
+     * Fields to include on the returned `product_group` (e.g. `GROUPING_CUSTOMIZATION`).
+     * @maxSize 10
+     */
+    fields?: ProductGroupRequestedFieldsWithLiterals[];
+}
+interface GetProductGroupOptions {
+    /**
+     * Fields to include on the returned product group (e.g. `GROUPING_CUSTOMIZATION`).
+     * @maxSize 10
+     */
+    fields?: ProductGroupRequestedFieldsWithLiterals[];
+}
+interface QueryProductGroupsOptions {
+    /**
+     * Optional expansions on each returned product group (e.g. `GROUPING_CUSTOMIZATION`).
+     * @maxSize 10
+     */
+    fields?: ProductGroupRequestedFieldsWithLiterals[] | undefined;
+}
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface ProductGroupsQueryResult extends QueryCursorResult {
+    items: ProductGroup[];
+    query: ProductGroupsQueryBuilder;
+    next: () => Promise<ProductGroupsQueryResult>;
+    prev: () => Promise<ProductGroupsQueryResult>;
+}
+interface ProductGroupsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | 'handle', value: any) => ProductGroupsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id' | 'handle', value: any) => ProductGroupsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: '_id' | 'handle', value: any) => ProductGroupsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_id' | 'handle', value: any) => ProductGroupsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: '_id' | 'handle', value: any) => ProductGroupsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_id' | 'handle', value: any) => ProductGroupsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: '_id' | 'handle', value: string) => ProductGroupsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: '_id' | 'handle', value: any[]) => ProductGroupsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | 'handle', value: any) => ProductGroupsQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: '_id' | 'handle', value: boolean) => ProductGroupsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => ProductGroupsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => ProductGroupsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<ProductGroupsQueryResult>;
+}
+/**
+ * @hidden
+ * @fqn wix.stores.catalog.product_group.v3.ProductGroupService.QueryProductGroups
+ * @requiredField query
+ */
+declare function typedQueryProductGroups(query: ProductGroupQuery, options?: QueryProductGroupsOptions): Promise<NonNullablePaths<QueryProductGroupsResponse, `productGroups` | `productGroups.${number}.groupingCustomization.name` | `productGroups.${number}.groupingCustomization.customizationType` | `productGroups.${number}.groupingCustomization.customizationRenderType` | `fields`, 5>>;
+interface ProductGroupQuerySpec extends QuerySpec {
+    paging: 'cursor';
+    wql: [
+        {
+            fields: ['_id', 'handle'];
+            operators: '*';
+            sort: 'NONE';
+        }
+    ];
+}
+type CommonQueryWithEntityContext = Query<ProductGroup, ProductGroupQuerySpec>;
+type ProductGroupQuery = {
+    /**
+    Cursor paging options.
+  
+    Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+    */
+    cursorPaging?: {
+        /**
+      Maximum number of items to return in the results.
+      @max: 100
+      */
+        limit?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['limit'] | null;
+        /**
+      Pointer to the next or previous page in the list of results.
+    
+      Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+      Not relevant for the first request.
+      @maxLength: 16000
+      */
+        cursor?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    Filter object.
+  
+    Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+    */
+    filter?: CommonQueryWithEntityContext['filter'] | null;
+    /**
+    Sort object.
+  
+    Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+    @maxSize: 5
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @maxLength: 512
+      */
+        fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+    }[];
+};
+declare const utils: {
+    query: {
+        QueryBuilder: () => _wix_sdk_types.QueryBuilder<ProductGroup, ProductGroupQuerySpec, ProductGroupQuery>;
+        Filter: _wix_sdk_types.FilterFactory<ProductGroup, ProductGroupQuerySpec>;
+        Sort: _wix_sdk_types.SortFactory<ProductGroupQuerySpec>;
+    };
+    search: {
+        SearchBuilder: () => _wix_sdk_types.SearchBuilder<ProductGroup, ProductGroupSearchSpec, ProductGroupSearch>;
+        Filter: _wix_sdk_types.FilterFactory<ProductGroup, ProductGroupSearchSpec>;
+        Sort: _wix_sdk_types.SortFactory<ProductGroupSearchSpec>;
+        SearchParams: _wix_sdk_types.SearchParamsFactory<ProductGroupSearchSpec>;
+        Aggregation: _wix_sdk_types.AggregationFactory<ProductGroupSearchSpec>;
+    };
+};
+interface SearchProductGroupsOptions {
+    /**
+     * Optional expansions on each returned product group (e.g. `GROUPING_CUSTOMIZATION`).
+     * @maxSize 10
+     */
+    fields?: ProductGroupRequestedFieldsWithLiterals[];
+}
+interface ProductGroupSearchSpec extends SearchSpec {
+    searchable: ['members.productName', 'name'];
+    aggregatable: [
+        '_createdDate',
+        '_id',
+        'groupingCustomizationId',
+        'members.productId',
+        'members.productName',
+        'name'
+    ];
+    paging: 'cursor';
+    wql: [
+        {
+            operators: '*';
+            fields: ['_createdDate', '_id', 'name'];
+            sort: 'BOTH';
+        },
+        {
+            operators: ['$hasAll', '$hasSome'];
+            fields: ['members.productId', 'members.productName'];
+            sort: 'NONE';
+        },
+        {
+            operators: '*';
+            fields: ['groupingCustomizationId'];
+            sort: 'NONE';
+        }
+    ];
+}
+type CommonSearchWithEntityContext = Search<ProductGroup, ProductGroupSearchSpec>;
+type ProductGroupSearch = {
+    /**
+    Cursor paging options.
+  
+    Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+    */
+    cursorPaging?: {
+        /**
+      Maximum number of items to return in the results.
+      @max: 100
+      */
+        limit?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['limit'] | null;
+        /**
+      Pointer to the next or previous page in the list of results.
+    
+      Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+      Not relevant for the first request.
+      @maxLength: 16000
+      */
+        cursor?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    Filter object.
+  
+    Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+    */
+    filter?: CommonSearchWithEntityContext['filter'] | null;
+    /**
+    List of sort objects.
+  
+    Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+    @maxSize: 10
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @maxLength: 512
+      */
+        fieldName?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['order'];
+    }[];
+    /**
+    Aggregations are 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.
+    @maxSize: 10
+    */
+    aggregations?: {
+        /**
+      Value aggregation.
+      */
+        value?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['value'];
+        /**
+      Range aggregation.
+      */
+        range?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['range'];
+        /**
+      Scalar aggregation.
+      */
+        scalar?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['scalar'];
+        /**
+      Date histogram aggregation.
+      */
+        dateHistogram?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['dateHistogram'];
+        /**
+      Nested aggregation.
+      */
+        nested?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['nested'];
+        /**
+      User-defined name of aggregation, should be unique, will appear in aggregation results.
+      @maxLength: 100
+      */
+        name?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['name'] | null;
+        /**
+      Type of aggregation, client must provide matching aggregation field below.
+      */
+        type?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['type'];
+        /**
+      Field to aggregate by, use dot notation to specify json path.
+      @maxLength: 200
+      */
+        fieldPath?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['fieldPath'];
+    }[];
+    /**
+    Free text to match in searchable fields.
+    */
+    search?: {
+        /**
+      Defines how separate search terms in `expression` are combined.
+      */
+        mode?: NonNullable<CommonSearchWithEntityContext['search']>['mode'];
+        /**
+      Search term or expression.
+      @maxLength: 100
+      */
+        expression?: NonNullable<CommonSearchWithEntityContext['search']>['expression'] | null;
+        /**
+      Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path.
+      @maxLength: 200,
+      @maxSize: 20
+      */
+        fields?: NonNullable<CommonSearchWithEntityContext['search']>['fields'];
+        /**
+      Whether to use auto fuzzy search (allowing typos by a managed proximity algorithm).
+      */
+        fuzzy?: NonNullable<CommonSearchWithEntityContext['search']>['fuzzy'];
+    };
+    /**
+    UTC offset or IANA time zone. Valid values are
+    ISO 8601 UTC offsets, such as +02:00 or -06:00,
+    and IANA time zone IDs, such as Europe/Rome.
+  
+    Affects all filters and aggregations returned values.
+    You may override this behavior in a specific filter by providing
+    timestamps including time zone. For example, `"2023-12-20T10:52:34.795Z"`.
+    @maxLength: 50
+    */
+    timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
+};
+interface BulkCreateProductGroupsOptions {
+    /** Whether to return the created product group entities in the response. */
+    returnEntity?: boolean;
+    /**
+     * Fields to include on each returned `item` (e.g. `GROUPING_CUSTOMIZATION`).
+     * @maxSize 10
+     */
+    fields?: ProductGroupRequestedFieldsWithLiterals[];
+}
+interface BulkUpdateProductGroupsOptions {
+    /** Whether to return the updated product group entities in the response. */
+    returnEntity?: boolean;
+    /**
+     * Fields to include on each returned `item` (e.g. `GROUPING_CUSTOMIZATION`).
+     * @maxSize 10
+     */
+    fields?: ProductGroupRequestedFieldsWithLiterals[];
+}
+interface AssignProductsToProductGroupOptions {
+    /**
+     * IDs of the products to assign. Duplicates are silently de-duplicated. Products already in the group are skipped.
+     * @minSize 1
+     * @maxSize 100
+     * @minLength 1
+     * @maxLength 36
+     */
+    productIds: string[];
+}
+interface UnassignProductsFromProductGroupOptions {
+    /**
+     * IDs of the products to unassign. Duplicates are silently de-duplicated. All products must currently be members of the group.
+     * @minSize 1
+     * @maxSize 100
+     * @minLength 1
+     * @maxLength 36
+     */
+    productIds: string[];
+}
+interface BulkUpdateProductGroupTagsOptions {
+    /** List of tags to assign. */
+    assignTags?: Tags;
+    /** List of tags to unassign. */
+    unassignTags?: Tags;
+}
+interface BulkUpdateProductGroupTagsByFilterOptions {
+    /** List of tags to assign. */
+    assignTags?: Tags;
+    /** List of tags to unassign. */
+    unassignTags?: Tags;
+}
+
+export { type ValueAggregationOptionsOneOf as $, AvailabilityStatus as A, type Sorting as B, ChoiceType as C, type DeleteProductGroupRequest as D, type ExtendedFields as E, type CursorPaging as F, type GroupingCustomization as G, type QueryProductGroupsResponse as H, Interval as I, type CursorPagingMetadata as J, type Cursors as K, type SearchProductGroupsRequest as L, MembershipStatus as M, NestedAggregationType as N, type CursorSearch as O, type ProductGroupQuery as P, type QueryProductGroupsOptions as Q, type CursorSearchPagingMethodOneOf as R, SortOrder as S, type Tags as T, type UpdateProductGroupRequest as U, type Aggregation as V, WebhookIdentityType as W, type AggregationKindOneOf as X, type RangeBucket as Y, type IncludeMissingValuesOptions as Z, type ValueAggregation as _, type ProductGroupsQueryBuilder as a, type IdentificationDataIdOneOf as a$, type RangeAggregation as a0, type ScalarAggregation as a1, type DateHistogramAggregation as a2, type NestedAggregationItem as a3, type NestedAggregationItemKindOneOf as a4, type NestedAggregation as a5, type SearchDetails as a6, type SearchProductGroupsResponse as a7, type AggregationData as a8, type ValueAggregationResult as a9, type MaskedProductGroup as aA, type BulkUpdateProductGroupsResponse as aB, type BulkUpdateProductGroupsResponseBulkProductGroupResult as aC, type AssignProductsToProductGroupRequest as aD, type AssignProductsToProductGroupResponse as aE, type ProductAssignmentResult as aF, type UnassignProductsFromProductGroupRequest as aG, type UnassignProductsFromProductGroupResponse as aH, type ProductUnassignmentResult as aI, type BulkDeleteProductGroupsRequest as aJ, type BulkDeleteProductGroupsResponse as aK, type BulkDeleteProductGroupsResponseBulkProductGroupResult as aL, type BulkUpdateProductGroupTagsRequest as aM, type BulkUpdateProductGroupTagsResponse as aN, type BulkUpdateProductGroupTagsResult as aO, type DomainEvent as aP, type DomainEventBodyOneOf as aQ, type EntityCreatedEvent as aR, type RestoreInfo as aS, type EntityUpdatedEvent as aT, type EntityDeletedEvent as aU, type ActionEvent as aV, type Empty as aW, type BulkUpdateProductGroupTagsByFilterRequest as aX, type BulkUpdateProductGroupTagsByFilterResponse as aY, type MessageEnvelope as aZ, type IdentificationData as a_, type RangeAggregationResult as aa, type NestedAggregationResults as ab, type NestedAggregationResultsResultOneOf as ac, type ValueResults as ad, type RangeResults as ae, type AggregationResultsScalarResult as af, type NestedValueAggregationResult as ag, type ValueResult as ah, type RangeResult as ai, type ScalarResult as aj, type NestedResultValue as ak, type NestedResultValueResultOneOf as al, type Results as am, type DateHistogramResult as an, type GroupByValueResults as ao, type DateHistogramResults as ap, type NestedResults as aq, type AggregationResults as ar, type AggregationResultsResultOneOf as as, type BulkCreateProductGroupsRequest as at, type BulkCreateProductGroupsResponse as au, type ItemMetadata as av, type ApplicationError as aw, type BulkProductGroupResult as ax, type BulkActionMetadata as ay, type BulkUpdateProductGroupsRequest as az, CustomizationType as b, type AccountInfo as b0, type CreateProductGroupOptions as b1, type UpdateProductGroup as b2, type UpdateProductGroupOptions as b3, type GetProductGroupOptions as b4, type ProductGroupsQueryResult as b5, type ProductGroupQuerySpec as b6, type SearchProductGroupsOptions as b7, type ProductGroupSearchSpec as b8, type BulkCreateProductGroupsOptions as b9, type ProductGroupSearch as bA, type BulkUpdateProductGroupsOptions as ba, type AssignProductsToProductGroupOptions as bb, type UnassignProductsFromProductGroupOptions as bc, type BulkUpdateProductGroupTagsOptions as bd, type BulkUpdateProductGroupTagsByFilterOptions as be, utils as bf, type ChoiceTypeWithLiterals as bg, type AvailabilityStatusWithLiterals as bh, type MembershipStatusWithLiterals as bi, type CustomizationTypeWithLiterals as bj, type CustomizationRenderTypeWithLiterals as bk, type ProductGroupRequestedFieldsWithLiterals as bl, type SortOrderWithLiterals as bm, type SortTypeWithLiterals as bn, type SortDirectionWithLiterals as bo, type MissingValuesWithLiterals as bp, type ScalarTypeWithLiterals as bq, type NestedAggregationTypeWithLiterals as br, type IntervalWithLiterals as bs, type AggregationTypeWithLiterals as bt, type ModeWithLiterals as bu, type WebhookIdentityTypeWithLiterals as bv, type BulkUpdateProductGroupTagsApplicationErrors as bw, type BulkUpdateProductGroupTagsByFilterApplicationErrors as bx, type CommonQueryWithEntityContext as by, type CommonSearchWithEntityContext as bz, CustomizationRenderType as c, ProductGroupRequestedFields as d, SortType as e, SortDirection as f, MissingValues as g, ScalarType as h, AggregationType as i, Mode as j, type ProductGroup as k, type ProductGroupMember as l, type ProductChoice as m, type ProductChoiceValueOneOf as n, type TagList as o, type ProductGroupTagsModified as p, type CreateProductGroupRequest as q, type CreateProductGroupResponse as r, type UpdateProductGroupResponse as s, typedQueryProductGroups as t, type DeleteProductGroupResponse as u, type GetProductGroupRequest as v, type GetProductGroupResponse as w, type QueryProductGroupsRequest as x, type CursorQuery as y, type CursorQueryPagingMethodOneOf as z };