> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# SearchPromotions

# Package: catalogV3

# Namespace: PromotionsService

# Method link: https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/promotions-v3/search-promotions.md

## Permission Scopes:
Read v3 catalog: SCOPE.STORES.CATALOG_READ

## Introduction

Searches promotions using [WQL - Wix Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md) with support for free-text search and aggregations.

Use this method for complex queries that include free-text search, aggregations,
or when you need faceted search results. For simple filtering, use Query Promotions instead.

Learn more about the differences between [Query and Search](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-search-query-and-list-methods.md) methods.

---

## REST API

### Schema

```
 Method: searchPromotions
 Description: Searches promotions using [WQL - Wix Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md) with support for free-text search and aggregations.  Use this method for complex queries that include free-text search, aggregations, or when you need faceted search results. For simple filtering, use Query Promotions instead.  Learn more about the differences between [Query and Search](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-search-query-and-list-methods.md) methods.
 URL: https://www.wixapis.com/stores/v3/promotions/search
 Method: POST
 Method parameters:
   param name: search | type: CursorSearch    
     - name: cursorPaging | type: CursorPaging | description: Cursor paging options.  Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#cursor-paging).  
        - name: limit | type: integer | description: Maximum number of items to return in the results.  | validation: minimum 0, maximum 100, format int32
        - name: cursor | type: string | description: 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.  | validation: maxLength 16000
        - name: filter | type: object | description: Filter object.  Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#the-filter-section).  
        - name: sort | type: array<Sorting> | description: List of sort objects.  Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#the-sort-section).  | validation: maxItems 10
           - name: fieldName | type: string | description: Name of the field to sort by.  | validation: maxLength 512
           - name: order | type: SortOrder | description: Sort order.  
                 - enum: ASC, DESC
        - name: aggregations | type: array<Aggregation> | description: 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.  | validation: maxItems 10
           - ONE-OF: 
              - name: value | type: ValueAggregation | description: Value aggregation.  
                 - ONE-OF: 
                    - name: includeOptions | type: IncludeMissingValuesOptions | description: Options for including missing values.  
                       - name: addToBucket | type: string | description: Specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...  | validation: maxLength 20
                 - name: sortType | type: SortType | description: Whether to sort by number of matches or value of the field.  
                         - enum:
                         -     COUNT: Sort by number of matches.
                         -     VALUE: Sort by value of the field alphabetically.
                 - name: sortDirection | type: SortDirection | description: Whether to sort in ascending or descending order.  
                         - enum:
                         -     DESC: Sort in descending order.
                         -     ASC: Sort in ascending order.
                 - name: limit | type: integer | description: How many aggregations to return. Can be between 1 and 250. 10 is the default.  | validation: format int32
                 - name: missingValues | type: MissingValues | description: Whether to include or exclude missing values from the aggregation results. Default: `EXCLUDE`.  
                         - enum:
                         -     EXCLUDE: Exclude missing values from the aggregation results.
                         -     INCLUDE: Include missing values in the aggregation results.
              - name: range | type: RangeAggregation | description: Range aggregation.  
                 - name: buckets | type: array<RangeBucket> | description: 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.  | validation: maxItems 50
                    - name: from | type: number | description: Inclusive lower bound of the range. Required if `to` is not provided.  | validation: format double
                    - name: to | type: number | description: Exclusive upper bound of the range. Required if `from` is not provided.  | validation: format double
              - name: scalar | type: ScalarAggregation | description: Scalar aggregation.  
                 - name: type | type: ScalarType | description: Define the operator for the scalar aggregation.  
                         - enum:
                         -     COUNT_DISTINCT: Count of distinct values.
                         -     MIN: Minimum value.
                         -     MAX: Maximum value.
              - name: dateHistogram | type: DateHistogramAggregation | description: Date histogram aggregation.  
                 - name: interval | type: Interval | description: Interval for date histogram aggregation.  
                         - enum:
                         -     YEAR: Yearly interval
                         -     MONTH: Monthly interval
                         -     WEEK: Weekly interval
                         -     DAY: Daily interval
                         -     HOUR: Hourly interval
                         -     MINUTE: Minute interval
                         -     SECOND: Second interval
              - name: nested | type: NestedAggregation | description: Nested aggregation.  
                 - name: nestedAggregations | type: array<NestedAggregationItem> | description: Flattened list of aggregations, where each next aggregation is nested within previous one.  | validation: minItems 2, maxItems 3
                    - ONE-OF: 
                       - name: value | type: ValueAggregation | description: Value aggregation.  
                       - name: range | type: RangeAggregation | description: Range aggregation.  
                       - name: scalar | type: ScalarAggregation | description: Scalar aggregation.  
                       - name: dateHistogram | type: DateHistogramAggregation | description: Date histogram aggregation.  
                    - name: name | type: string | description: User-defined name of aggregation, should be unique, will appear in aggregation results.  | validation: maxLength 100
                    - name: type | type: NestedAggregationType | description: Type of aggregation, client must provide matching aggregation field below.  
                             - enum:
                             -     VALUE: An aggregation where result buckets are dynamically built - one per unique value.
                             -     RANGE: An aggregation, where user can define set of ranges - each representing a bucket.
                             -     SCALAR: A single-value metric aggregation. For example, min, max, sum, avg.
                             -     DATE_HISTOGRAM: An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.).
                    - name: fieldPath | type: string | description: Field to aggregate by, use dot notation to specify json path.  | validation: maxLength 200
           - name: name | type: string | description: User-defined name of aggregation, should be unique, will appear in aggregation results.  | validation: maxLength 100
           - name: type | type: AggregationType | description: Type of aggregation, client must provide matching aggregation field below.  
                 - enum:
                 -     VALUE: An aggregation where result buckets are dynamically built - one per unique value.
                 -     RANGE: An aggregation, where user can define set of ranges - each representing a bucket.
                 -     SCALAR: A single-value metric aggregation. For example, min, max, sum, avg.
                 -     DATE_HISTOGRAM: An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.)
                 -     NESTED: Multi-level aggregation, where each next aggregation is nested within previous one.
           - name: fieldPath | type: string | description: Field to aggregate by, use dot notation to specify json path.  | validation: maxLength 200
        - name: search | type: SearchDetails | description: Free text to match in searchable fields.  
           - name: mode | type: Mode | description: Defines how separate search terms in `expression` are combined.  
                 - enum:
                 -     OR: Any of the search terms must be present.
                 -     AND: All search terms must be present.
           - name: expression | type: string | description: Search term or expression.  | validation: maxLength 100
           - name: fields | type: array<string> | description: Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path.  | validation: maxItems 20, maxLength 200
           - name: fuzzy | type: boolean | description: Whether to use auto fuzzy search (allowing typos by a managed proximity algorithm).  
        - name: timeZone | type: string | description: UTC offset or IANA time zone. Valid values are ISO 8601 UTC offsets, such as +02:00 or -06:00, and IANA time zone GUIDs, 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"`.  | validation: maxLength 50
 Searchable fields:
   - field: tags.privateTags.tagIds | operators: $hasAll, $hasSome | sort: ASC, DESC | aggregatable: true | searchable: false
   - field: tags.publicTags.tagIds | operators: $hasAll, $hasSome | sort: ASC, DESC | aggregatable: true | searchable: false
   - field: createdDate | operators: $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte | sort: ASC, DESC | aggregatable: true | searchable: false
   - field: id | operators: $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | sort: ASC, DESC | aggregatable: true | searchable: false
   - field: updatedDate | operators: $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte | sort: ASC, DESC | aggregatable: true | searchable: false
   - field: enabled | operators: $eq, $ne, $exists, $in, $any | sort: ASC, DESC | aggregatable: true | searchable: false
   - field: name | operators: none | sort: none | aggregatable: false | searchable: true
 Return type: SearchPromotionsResponse
  - name: promotions | type: array<Promotion> | description: List of promotions matching the search.  
     - name: id | type: string | description: Promotion GUID.  | validation: format GUID
     - name: revision | type: string | description: Revision number, which increments by 1 each time the promotion is updated. To prevent conflicting changes, the current revision must be passed when updating the promotion.  | validation: format int64
     - name: createdDate | type: string | description: Date and time the promotion was created.  | validation: format date-time
     - name: updatedDate | type: string | description: Date and time the promotion was last updated.  | validation: format date-time
     - name: name | type: string | description: Promotion name.  | validation: minLength 1, maxLength 50
     - name: media | type: PromotionMedia | description: Promotion media.  
        - ONE-OF: 
           - name: id | type: string | description: Set media by GUID of an existing file in Wix Media Manager.  | validation: minLength 1, maxLength 200
           - name: url | type: string | description: Set media using an external media URL.  When provided, Wix Media Manager imports the media asynchronously. During import: - `image` is empty. - The promotion is saved as disabled regardless of the requested `enabled` value.  Once the import completes successfully, the promotion's `image` is populated and `enabled` is set to the originally requested value. If the import fails, the promotion's entire `media` object is cleared and the promotion stays disabled. To retry, set new media.  | validation: format WEB_URL
        - name: altText | type: string | description: Image alt text.  | validation: minLength 1, maxLength 1000
        - name: displayName | type: string | description: Media display name.  Overrides the default media name. Can be passed only when the media is set by a URL in this item's `url` field.  | validation: maxLength 80
        - name: mediaType | type: MediaType | description: Media type.  
             - enum:
             -     IMAGE: Image media type.
        - name: uploadId | type: string | description: GUID of the asynchronous media import that Wix Media Manager runs when media is set with a `url`.  | validation: format GUID
     - name: destinationUrl | type: string | description: URL the promotion redirects to when a customer clicks the banner.  | validation: format WEB_URL
     - name: categories | type: array<CategoryAssignment> | description: Categories the promotion is directly assigned to. A promotion may also appear in subcategories when `appliedToSubcategories` is `true` for a directly assigned category.  | validation: maxItems 1000
        - name: id | type: string | description: Category GUID.  | validation: format GUID
        - name: position | type: integer | description: Position of the promotion within the category, starting from 1.  Must be provided for each category assignment — omitting it fails validation, because positions start from 1.  | validation: minimum 1
        - name: appliedToSubcategories | type: boolean | description: Whether the promotion also appears in this category's subcategories. When inherited by a subcategory, the promotion keeps the same position.  Default: `false`  
     - name: enabled | type: boolean | description: Whether the promotion is enabled.  When creating or updating with `media.url`, this value takes effect only after the media import completes successfully. See `media.url` for details.  Default: `false`  
     - name: extendedFields | type: ExtendedFields | description: Custom field data for the promotion object.  [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md) must be configured in the app dashboard before they can be accessed with API calls.  
        - name: namespaces | type: object | description: 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.md).  | validation: format map
     - name: tags | type: Tags | description: Tags for organizing and filtering promotions.  
        - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors.  
           - name: tagIds | type: array<string> | description: List of tag GUIDs.  | validation: maxItems 100, maxLength 5
        - name: publicTags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors.  
  - name: pagingMetadata | type: CursorPagingMetadata | description: Paging metadata.  
     - name: count | type: integer | description: Number of items returned in current page.  | validation: format int32
     - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both.  
        - name: next | type: string | description: Cursor string pointing to the next page in the list of results.  | validation: maxLength 16000
        - name: prev | type: string | description: Cursor pointing to the previous page in the list of results.  | validation: maxLength 16000
     - name: hasNext | type: boolean | description: 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.  
  - name: aggregationData | type: AggregationData | description: Aggregation data.  
     - name: results | type: array<AggregationResults> | description: key = aggregation name (as derived from search request).  | validation: maxItems 10000
        - ONE-OF: 
           - name: values | type: ValueResults | description: Value aggregation results.  
              - name: results | type: array<ValueAggregationResult> | description: List of value aggregations.  | validation: maxItems 250
                 - name: value | type: string | description: Value of the field.  | validation: maxLength 100
                 - name: count | type: integer | description: Count of entities with this value.  
           - name: ranges | type: RangeResults | description: Range aggregation results.  
              - name: results | type: array<RangeAggregationResult> | description: List of ranges returned in same order as requested.  | validation: maxItems 50
                 - name: from | type: number | description: Inclusive lower bound of the range.  | validation: format double
                 - name: to | type: number | description: Exclusive upper bound of the range.  | validation: format double
                 - name: count | type: integer | description: Count of entities in this range.  
           - name: scalar | type: ScalarResult | description: Scalar aggregation results.  
              - name: type | type: ScalarType | description: Type of scalar aggregation.  
                     - enum:
                     -     COUNT_DISTINCT: Count of distinct values.
                     -     MIN: Minimum value.
                     -     MAX: Maximum value.
              - name: value | type: number | description: Value of the scalar aggregation.  
           - name: groupedByValue | type: GroupByValueResults | description: Group by value aggregation results.  
              - name: results | type: array<NestedValueAggregationResult> | description: List of value aggregations.  | validation: maxItems 1000
                 - name: value | type: string | description: Value of the field.  | validation: maxLength 1000
                 - name: nestedResults | type: NestedAggregationResults | description: Nested aggregations.  
                    - ONE-OF: 
                       - name: values | type: ValueResults | description: Value aggregation results.  
                       - name: ranges | type: RangeResults | description: Range aggregation results.  
                       - name: scalar | type: ScalarResult | description: Scalar aggregation results.  
                    - name: name | type: string | description: User-defined name of aggregation, matches the one provided in request.  | validation: maxLength 100
                    - name: type | type: AggregationType | description: Type of aggregation that matches result.  
                             - enum:
                             -     VALUE: An aggregation where result buckets are dynamically built - one per unique value.
                             -     RANGE: An aggregation, where user can define set of ranges - each representing a bucket.
                             -     SCALAR: A single-value metric aggregation. For example, min, max, sum, avg.
                             -     DATE_HISTOGRAM: An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.)
                             -     NESTED: Multi-level aggregation, where each next aggregation is nested within previous one.
                    - name: fieldPath | type: string | description: Field to aggregate by, matches the one provided in request.  | validation: maxLength 200
           - name: dateHistogram | type: DateHistogramResults | description: Date histogram aggregation results.  
              - name: results | type: array<DateHistogramResult> | description: List of date histogram aggregations.  | validation: maxItems 200
                 - name: value | type: string | description: Date in ISO 8601 format.  | validation: maxLength 100
                 - name: count | type: integer | description: Count of documents in the bucket.  
           - name: nested | type: NestedResults | description: Nested aggregation results.  
              - name: results | type: array<Results> | description: List of nested aggregations.  | validation: maxItems 1000
                 - name: results | type: Map<string,NestedResultValue> | description: List of nested aggregations.  | validation: format map
                    - ONE-OF: 
                       - name: value | type: ValueResult | description: Value aggregation result.  
                          - name: value | type: string | description: Value of the field.  | validation: maxLength 1000
                          - name: count | type: integer | description: Count of entities with this value.  | validation: format int32
                       - name: range | type: RangeResult | description: Range aggregation result.  
                          - name: from | type: number | description: Inclusive lower bound of the range.  | validation: format double
                          - name: to | type: number | description: Exclusive upper bound of the range.  | validation: format double
                          - name: count | type: integer | description: Count of entities in this range.  | validation: format int32
                       - name: scalar | type: ScalarResult | description: Scalar aggregation result.  
                          - name: value | type: number | description: Value of the scalar aggregation.  
                       - name: dateHistogram | type: ValueResult | description: Date histogram aggregation result.  
        - name: name | type: string | description: User-defined name of aggregation as derived from search request.  | validation: maxLength 100
        - name: type | type: AggregationType | description: Type of aggregation that must match provided kind as derived from search request.  
        - name: fieldPath | type: string | description: Field to aggregate by as derived from search request.  | validation: maxLength 200


```

### Examples

### Search Promotions
Searches promotions by free text matching the promotion name.

```curl
curl -X POST \
  'https://www.wixapis.com/stores/v3/promotions/search' \
  -H 'Authorization: <AUTH>' \
  -H 'Content-Type: application/json' \
  -d '{
    "search": {
      "search": {
        "expression": "sale"
      },
      "cursorPaging": {
        "limit": 10
      }
    }
  }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.stores.promotionsV3.searchPromotions(search)
 Description: Searches promotions using [WQL - Wix Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md) with support for free-text search and aggregations.  Use this method for complex queries that include free-text search, aggregations, or when you need faceted search results. For simple filtering, use Query Promotions instead.  Learn more about the differences between [Query and Search](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-search-query-and-list-methods.md) methods.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  search
 Method parameters: 
   param name: search | type: CursorSearch   | required: true 
     - name: cursorPaging | type: CursorPaging | description: Cursor paging options.  Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#cursor-paging).  
        - name: limit | type: integer | description: Maximum number of items to return in the results.  | validation: minimum 0, maximum 100, format int32
        - name: cursor | type: string | description: 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.  | validation: maxLength 16000
        - name: filter | type: object | description: Filter object.  Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#the-filter-section).  
        - name: sort | type: array<Sorting> | description: List of sort objects.  Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#the-sort-section).  | validation: maxItems 10
           - name: fieldName | type: string | description: Name of the field to sort by.  | validation: maxLength 512
           - name: order | type: SortOrder | description: Sort order.  
                 - enum: ASC, DESC
        - name: aggregations | type: array<Aggregation> | description: 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.  | validation: maxItems 10
           - ONE-OF: 
              - name: value | type: ValueAggregation | description: Value aggregation.  
                 - ONE-OF: 
                    - name: includeOptions | type: IncludeMissingValuesOptions | description: Options for including missing values.  
                       - name: addToBucket | type: string | description: Specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...  | validation: maxLength 20
                 - name: sortType | type: SortType | description: Whether to sort by number of matches or value of the field.  
                         - enum:
                         -     COUNT: Sort by number of matches.
                         -     VALUE: Sort by value of the field alphabetically.
                 - name: sortDirection | type: SortDirection | description: Whether to sort in ascending or descending order.  
                         - enum:
                         -     DESC: Sort in descending order.
                         -     ASC: Sort in ascending order.
                 - name: limit | type: integer | description: How many aggregations to return. Can be between 1 and 250. 10 is the default.  | validation: format int32
                 - name: missingValues | type: MissingValues | description: Whether to include or exclude missing values from the aggregation results. Default: `EXCLUDE`.  
                         - enum:
                         -     EXCLUDE: Exclude missing values from the aggregation results.
                         -     INCLUDE: Include missing values in the aggregation results.
              - name: range | type: RangeAggregation | description: Range aggregation.  
                 - name: buckets | type: array<RangeBucket> | description: 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.  | validation: maxItems 50
                    - name: from | type: number | description: Inclusive lower bound of the range. Required if `to` is not provided.  
                    - name: to | type: number | description: Exclusive upper bound of the range. Required if `from` is not provided.  
              - name: scalar | type: ScalarAggregation | description: Scalar aggregation.  
                 - name: type | type: ScalarType | description: Define the operator for the scalar aggregation.  
                         - enum:
                         -     COUNT_DISTINCT: Count of distinct values.
                         -     MIN: Minimum value.
                         -     MAX: Maximum value.
              - name: dateHistogram | type: DateHistogramAggregation | description: Date histogram aggregation.  
                 - name: interval | type: Interval | description: Interval for date histogram aggregation.  
                         - enum:
                         -     YEAR: Yearly interval
                         -     MONTH: Monthly interval
                         -     WEEK: Weekly interval
                         -     DAY: Daily interval
                         -     HOUR: Hourly interval
                         -     MINUTE: Minute interval
                         -     SECOND: Second interval
              - name: nested | type: NestedAggregation | description: Nested aggregation.  
                 - name: nestedAggregations | type: array<NestedAggregationItem> | description: Flattened list of aggregations, where each next aggregation is nested within previous one.  | validation: minItems 2, maxItems 3
                    - ONE-OF: 
                       - name: value | type: ValueAggregation | description: Value aggregation.  
                       - name: range | type: RangeAggregation | description: Range aggregation.  
                       - name: scalar | type: ScalarAggregation | description: Scalar aggregation.  
                       - name: dateHistogram | type: DateHistogramAggregation | description: Date histogram aggregation.  
                    - name: name | type: string | description: User-defined name of aggregation, should be unique, will appear in aggregation results.  | validation: maxLength 100
                    - name: type | type: NestedAggregationType | description: Type of aggregation, client must provide matching aggregation field below.  
                             - enum:
                             -     VALUE: An aggregation where result buckets are dynamically built - one per unique value.
                             -     RANGE: An aggregation, where user can define set of ranges - each representing a bucket.
                             -     SCALAR: A single-value metric aggregation. For example, min, max, sum, avg.
                             -     DATE_HISTOGRAM: An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.).
                    - name: fieldPath | type: string | description: Field to aggregate by, use dot notation to specify json path.  | validation: maxLength 200
           - name: name | type: string | description: User-defined name of aggregation, should be unique, will appear in aggregation results.  | validation: maxLength 100
           - name: type | type: AggregationType | description: Type of aggregation, client must provide matching aggregation field below.  
                 - enum:
                 -     VALUE: An aggregation where result buckets are dynamically built - one per unique value.
                 -     RANGE: An aggregation, where user can define set of ranges - each representing a bucket.
                 -     SCALAR: A single-value metric aggregation. For example, min, max, sum, avg.
                 -     DATE_HISTOGRAM: An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.)
                 -     NESTED: Multi-level aggregation, where each next aggregation is nested within previous one.
           - name: fieldPath | type: string | description: Field to aggregate by, use dot notation to specify json path.  | validation: maxLength 200
        - name: search | type: SearchDetails | description: Free text to match in searchable fields.  
           - name: mode | type: Mode | description: Defines how separate search terms in `expression` are combined.  
                 - enum:
                 -     OR: Any of the search terms must be present.
                 -     AND: All search terms must be present.
           - name: expression | type: string | description: Search term or expression.  | validation: maxLength 100
           - name: fields | type: array<string> | description: Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path.  | validation: maxItems 20, maxLength 200
           - name: fuzzy | type: boolean | description: Whether to use auto fuzzy search (allowing typos by a managed proximity algorithm).  
        - name: timeZone | type: string | description: UTC offset or IANA time zone. Valid values are ISO 8601 UTC offsets, such as +02:00 or -06:00, and IANA time zone GUIDs, 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"`.  | validation: maxLength 50
 Searchable fields:
   - field: tags.privateTags.tagIds | operators: $hasAll, $hasSome | sort: ASC, DESC | aggregatable: true | searchable: false
   - field: tags.publicTags.tagIds | operators: $hasAll, $hasSome | sort: ASC, DESC | aggregatable: true | searchable: false
   - field: _createdDate | operators: $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte | sort: ASC, DESC | aggregatable: true | searchable: false
   - field: _id | operators: $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | sort: ASC, DESC | aggregatable: true | searchable: false
   - field: _updatedDate | operators: $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte | sort: ASC, DESC | aggregatable: true | searchable: false
   - field: enabled | operators: $eq, $ne, $exists, $in, $any | sort: ASC, DESC | aggregatable: true | searchable: false
   - field: name | operators: none | sort: none | aggregatable: false | searchable: true
 Return type: PROMISE<SearchPromotionsResponse>
  - name: promotions | type: array<Promotion> | description: List of promotions matching the search.  
     - name: _id | type: string | description: Promotion GUID.  | validation: format GUID
     - name: revision | type: string | description: Revision number, which increments by 1 each time the promotion is updated. To prevent conflicting changes, the current revision must be passed when updating the promotion.  | validation: format int64
     - name: _createdDate | type: Date | description: Date and time the promotion was created.  
     - name: _updatedDate | type: Date | description: Date and time the promotion was last updated.  
     - name: name | type: string | description: Promotion name.  | validation: minLength 1, maxLength 50
     - name: media | type: PromotionMedia | description: Promotion media.  
        - ONE-OF: 
           - name: _id | type: string | description: Set media by GUID of an existing file in Wix Media Manager.  | validation: minLength 1, maxLength 200
           - name: url | type: string | description: Set media using an external media URL.  When provided, Wix Media Manager imports the media asynchronously. During import: - `image` is empty. - The promotion is saved as disabled regardless of the requested `enabled` value.  Once the import completes successfully, the promotion's `image` is populated and `enabled` is set to the originally requested value. If the import fails, the promotion's entire `media` object is cleared and the promotion stays disabled. To retry, set new media.  | validation: format WEB_URL
        - name: altText | type: string | description: Image alt text.  | validation: minLength 1, maxLength 1000
        - name: displayName | type: string | description: Media display name.  Overrides the default media name. Can be passed only when the media is set by a URL in this item's `url` field.  | validation: maxLength 80
        - name: mediaType | type: MediaType | description: Media type.  
             - enum:
             -     IMAGE: Image media type.
        - name: uploadId | type: string | description: GUID of the asynchronous media import that Wix Media Manager runs when media is set with a `url`.  | validation: format GUID
     - name: destinationUrl | type: string | description: URL the promotion redirects to when a customer clicks the banner.  | validation: format WEB_URL
     - name: categories | type: array<CategoryAssignment> | description: Categories the promotion is directly assigned to. A promotion may also appear in subcategories when `appliedToSubcategories` is `true` for a directly assigned category.  | validation: maxItems 1000
        - name: _id | type: string | description: Category GUID.  | validation: format GUID
        - name: position | type: integer | description: Position of the promotion within the category, starting from 1.  Must be provided for each category assignment — omitting it fails validation, because positions start from 1.  | validation: minimum 1
        - name: appliedToSubcategories | type: boolean | description: Whether the promotion also appears in this category's subcategories. When inherited by a subcategory, the promotion keeps the same position.  Default: `false`  
     - name: enabled | type: boolean | description: Whether the promotion is enabled.  When creating or updating with `media.url`, this value takes effect only after the media import completes successfully. See `media.url` for details.  Default: `false`  
     - name: extendedFields | type: ExtendedFields | description: Custom field data for the promotion object.  [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md) must be configured in the app dashboard before they can be accessed with API calls.  
        - name: namespaces | type: object | description: 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.md).  | validation: format map
     - name: tags | type: Tags | description: Tags for organizing and filtering promotions.  
        - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors.  
           - name: tagIds | type: array<string> | description: List of tag GUIDs.  | validation: maxItems 100, maxLength 5
        - name: publicTags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors.  
  - name: pagingMetadata | type: CursorPagingMetadata | description: Paging metadata.  
     - name: count | type: integer | description: Number of items returned in current page.  | validation: format int32
     - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both.  
        - name: next | type: string | description: Cursor string pointing to the next page in the list of results.  | validation: maxLength 16000
        - name: prev | type: string | description: Cursor pointing to the previous page in the list of results.  | validation: maxLength 16000
     - name: hasNext | type: boolean | description: 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.  
  - name: aggregationData | type: AggregationData | description: Aggregation data.  
     - name: results | type: array<AggregationResults> | description: key = aggregation name (as derived from search request).  | validation: maxItems 10000
        - ONE-OF: 
           - name: values | type: ValueResults | description: Value aggregation results.  
              - name: results | type: array<ValueAggregationResult> | description: List of value aggregations.  | validation: maxItems 250
                 - name: value | type: string | description: Value of the field.  | validation: maxLength 100
                 - name: count | type: integer | description: Count of entities with this value.  
           - name: ranges | type: RangeResults | description: Range aggregation results.  
              - name: results | type: array<RangeAggregationResult> | description: List of ranges returned in same order as requested.  | validation: maxItems 50
                 - name: from | type: number | description: Inclusive lower bound of the range.  
                 - name: to | type: number | description: Exclusive upper bound of the range.  
                 - name: count | type: integer | description: Count of entities in this range.  
           - name: scalar | type: ScalarResult | description: Scalar aggregation results.  
              - name: type | type: ScalarType | description: Type of scalar aggregation.  
                     - enum:
                     -     COUNT_DISTINCT: Count of distinct values.
                     -     MIN: Minimum value.
                     -     MAX: Maximum value.
              - name: value | type: number | description: Value of the scalar aggregation.  
           - name: groupedByValue | type: GroupByValueResults | description: Group by value aggregation results.  
              - name: results | type: array<NestedValueAggregationResult> | description: List of value aggregations.  | validation: maxItems 1000
                 - name: value | type: string | description: Value of the field.  | validation: maxLength 1000
                 - name: nestedResults | type: NestedAggregationResults | description: Nested aggregations.  
                    - ONE-OF: 
                       - name: values | type: ValueResults | description: Value aggregation results.  
                       - name: ranges | type: RangeResults | description: Range aggregation results.  
                       - name: scalar | type: ScalarResult | description: Scalar aggregation results.  
                    - name: name | type: string | description: User-defined name of aggregation, matches the one provided in request.  | validation: maxLength 100
                    - name: type | type: AggregationType | description: Type of aggregation that matches result.  
                             - enum:
                             -     VALUE: An aggregation where result buckets are dynamically built - one per unique value.
                             -     RANGE: An aggregation, where user can define set of ranges - each representing a bucket.
                             -     SCALAR: A single-value metric aggregation. For example, min, max, sum, avg.
                             -     DATE_HISTOGRAM: An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.)
                             -     NESTED: Multi-level aggregation, where each next aggregation is nested within previous one.
                    - name: fieldPath | type: string | description: Field to aggregate by, matches the one provided in request.  | validation: maxLength 200
           - name: dateHistogram | type: DateHistogramResults | description: Date histogram aggregation results.  
              - name: results | type: array<DateHistogramResult> | description: List of date histogram aggregations.  | validation: maxItems 200
                 - name: value | type: string | description: Date in ISO 8601 format.  | validation: maxLength 100
                 - name: count | type: integer | description: Count of documents in the bucket.  
           - name: nested | type: NestedResults | description: Nested aggregation results.  
              - name: results | type: array<Results> | description: List of nested aggregations.  | validation: maxItems 1000
                 - name: results | type: Map<string,NestedResultValue> | description: List of nested aggregations.  | validation: format map
                    - ONE-OF: 
                       - name: value | type: ValueResult | description: Value aggregation result.  
                          - name: value | type: string | description: Value of the field.  | validation: maxLength 1000
                          - name: count | type: integer | description: Count of entities with this value.  | validation: format int32
                       - name: range | type: RangeResult | description: Range aggregation result.  
                          - name: from | type: number | description: Inclusive lower bound of the range.  
                          - name: to | type: number | description: Exclusive upper bound of the range.  
                          - name: count | type: integer | description: Count of entities in this range.  | validation: format int32
                       - name: scalar | type: ScalarResult | description: Scalar aggregation result.  
                          - name: value | type: number | description: Value of the scalar aggregation.  
                       - name: dateHistogram | type: ValueResult | description: Date histogram aggregation result.  
        - name: name | type: string | description: User-defined name of aggregation as derived from search request.  | validation: maxLength 100
        - name: type | type: AggregationType | description: Type of aggregation that must match provided kind as derived from search request.  
        - name: fieldPath | type: string | description: Field to aggregate by as derived from search request.  | validation: maxLength 200


```

### Examples

### Search promotions with a filter
Searches promotions using WQL filtering and cursor paging. Also supports free-text search and aggregations.

```javascript
import { promotionsV3 } from "@wix/stores";

const search = {
  filter: { enabled: true },
  cursorPaging: { limit: 10 },
};

async function searchPromotions() {
  const response = await promotionsV3.searchPromotions(search);
  return response;
}

/* Promise resolves to (response.promotions):
 * [
 *   {
 *     "_id": "25fc9c97-1ecf-47a1-9350-5766867d307e",
 *     "revision": "3",
 *     "name": "Summer Sale Banner",
 *     "enabled": true,
 *     "tags": { "privateTags": { "tagIds": ["ssn24"] } }
 *   }
 * ]
 */

```

### searchPromotions (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { promotionsV3 } from '@wix/stores';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { promotionsV3 },
  // Include the auth strategy and host as relevant
});


async function searchPromotions(search) {
  const response = await myWixClient.promotionsV3.searchPromotions(search);
};
```

---