> To build or manage a Wix site with an AI agent, follow https://www.wix.com/headless/skill.md
> It builds a new Wix site or puts your own site online, from a prompt, and keeps changing it afterwards. The pages are code in any web technology, and Wix runs the backend.
> It works through the Wix plugin (the Wix MCP and the Wix skills), the Wix CLI or no Wix login, and puts the site live on Wix hosting or on another host.
> Business features include a store, bookings, events and tickets, a restaurant, a blog, forms, members and many more.
> Read the Wix skills online at https://www.wix.com/skills
> 
> 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`).
> - If a reference page seems to be missing its schema (parameters, return types, or type definitions), append `?schema=true` to its `.md` URL (e.g. `https://dev.wix.com/docs/contexts/contexts/stores/category-info/use-category-info-context.md?schema=true`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# QueryBrands

# Package: catalogV3

# Namespace: BrandService

# Method link: https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/brands-v3/query-brands?apiView=SDK.md

## Permission Scopes:
Read brands in catalog v3: SCOPE.STORES.BRAND_READ

## Introduction

Retrieves a list of up to 100 brands, given the provided filtering, sorting, and cursor paging.
Pass supported values to the `fields` array in the request to include those fields in the response.


Query Brands runs with these defaults, which you can override:

- `createdDate` is sorted in `DESC` order
- `cursorPaging.limit` is `100`

To learn about working with _Query_ endpoints, see
[API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md),
and [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging.md).

> **Note:** The set of filterable and sortable fields for Query Brands is narrower than the full Wix API Query Language, and the operators supported per field are also a subset. For the per-field matrix, see [Supported Filters and Sorting](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/brands-v3/supported-filters-and-sorting.md).

> **Note:** `ASSIGNED_PRODUCTS_COUNT` is computed from the products search index and can lag recent Update Product writes. For workflows that depend on accurate brand-assignment counts immediately after a reassignment, see the [brands sample flows](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/brands-v3/sample-flows.md).

---

## REST API

### Schema

```
 Method: queryBrands
 Description: Retrieves a list of up to 100 brands, given the provided filtering, sorting, and cursor paging. Pass supported values to the `fields` array in the request to include those fields in the response.   Query Brands runs with these defaults, which you can override:  - `createdDate` is sorted in `DESC` order - `cursorPaging.limit` is `100`  To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md), and [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging.md).  > **Note:** The set of filterable and sortable fields for Query Brands is narrower than the full Wix API Query Language, and the operators supported per field are also a subset. For the per-field matrix, see [Supported Filters and Sorting](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/brands-v3/supported-filters-and-sorting.md).  > **Note:** `ASSIGNED_PRODUCTS_COUNT` is computed from the products search index and can lag recent Update Product writes. For workflows that depend on accurate brand-assignment counts immediately after a reassignment, see the [brands sample flows](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/brands-v3/sample-flows.md).
 URL: https://www.wixapis.com/stores/v3/brands/query
 Method: POST
 This method is cacheable: Responses from this method are cached for optimal performance.
 Method parameters:
   param name: fields | type: array<fields> | description: Fields to include in the response.  Supported values: `ASSIGNED_PRODUCTS_COUNT`  | validation: maxItems 100
                 - enum: ASSIGNED_PRODUCTS_COUNT
   param name: query | type: CursorQuery    
     - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.  
        - name: limit | type: integer | description: Maximum number of items to return in the results.  | validation: minimum 0, maximum 300, 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 in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`  
        - name: sort | type: array<Sorting> | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`  | validation: maxItems 5
           - name: fieldName | type: string | description: Name of the field to sort by.  | validation: maxLength 512
           - name: order | type: SortOrder | description: Sort order.  
                 - enum:
                 -     ASC: Ascending order.
                 -     DESC: Descending order.
 Query fields:
   - field: createdDate | operators: $eq, $ne, $in, $exists, $gt, $gte, $lt, $lte | sort: ASC, DESC | aggregatable: undefined | searchable: undefined
   - field: updatedDate | operators: $eq, $ne, $in, $exists, $gt, $gte, $lt, $lte | sort: ASC, DESC | aggregatable: undefined | searchable: undefined
   - field: name | operators: $eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith | sort: ASC, DESC | aggregatable: undefined | searchable: undefined
   - field: id | operators: $eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith | sort: none | aggregatable: undefined | searchable: undefined
 Return type: QueryBrandsResponse
  - name: brands | type: array<Brand> | description: List of brands.  | validation: minItems 1, maxItems 300
     - name: id | type: string | description: Brand GUID.  | read-only: true | validation: format GUID
     - name: revision | type: string | description: Revision number, which increments by 1 each time the brand is updated. To prevent conflicting changes, the current revision must be passed when updating the brand.  Ignored when creating a brand.  | read-only: true | validation: format int64
     - name: createdDate | type: string | description: Date and time the brand was created.  | read-only: true | validation: format date-time
     - name: updatedDate | type: string | description: Date and time the brand was updated.  | read-only: true | validation: format date-time
     - name: name | type: string | description: Brand name. >**Note:** `name` must be unique.  | validation: minLength 1, maxLength 50
     - name: assignedProductsCount | type: integer | description: Number of products this brand is assigned to. > **Note:** Returned only when you pass `"ASSIGNED_PRODUCTS_COUNT"` to the `fields` array in Brand API requests.  | read-only: true | validation: format int32
  - name: pagingMetadata | type: CursorPagingMetadata | description: Paging metadata.  
     - name: count | type: integer | description: Number of items returned in the response.  | 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.  


```

### Examples

### Query brands by Created Date
Get brands that were created after a specific date.

```curl
curl -X POST \
  'https://www.wixapis.com/stores/v3/brands/query' \
  -H 'Content-type: application/json' \
  -H 'Authorization:  <AUTH>' \
  -d '{
    "query": {
        "filter": {
          "createdDate": {
            "$gte": "2024-06-20T00:00:00.000Z"
          }
        }
    }
  }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.stores.brandsV3.queryBrands(query, options)
 Description: Retrieves a list of up to 100 brands, given the provided filtering, sorting, and cursor paging. Pass supported values to the `fields` array in the request to include those fields in the response.   Query Brands runs with these defaults, which you can override:  - `createdDate` is sorted in `DESC` order - `cursorPaging.limit` is `100`  To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md), and [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging.md).  > **Note:** The set of filterable and sortable fields for Query Brands is narrower than the full Wix API Query Language, and the operators supported per field are also a subset. For the per-field matrix, see [Supported Filters and Sorting](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/brands-v3/supported-filters-and-sorting.md).  > **Note:** `ASSIGNED_PRODUCTS_COUNT` is computed from the products search index and can lag recent Update Product writes. For workflows that depend on accurate brand-assignment counts immediately after a reassignment, see the [brands sample flows](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/brands-v3/sample-flows.md).
 This method is cacheable: Responses from this method are cached for optimal performance.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  query
 Method parameters: 
   param name: query | type: BrandQuery   | required: true 
     - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.  
        - name: limit | type: integer | description: Maximum number of items to return in the results.  | validation: minimum 0, maximum 300, 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 in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`  
        - name: sort | type: array<Sorting> | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`  | validation: maxItems 5
           - name: fieldName | type: string | description: Name of the field to sort by.  | validation: maxLength 512
           - name: order | type: SortOrder | description: Sort order.  
                 - enum:
                 -     ASC: Ascending order.
                 -     DESC: Descending order.
   param name: options | type: QueryBrandsOptions  none  
        - name: fields | type: array<RequestedFields> | description: Fields to include in the response.  Supported values: `ASSIGNED_PRODUCTS_COUNT`  | validation: maxItems 100
             - enum: ASSIGNED_PRODUCTS_COUNT
 Query fields:
   - field: _createdDate | operators: $eq, $ne, $in, $exists, $gt, $gte, $lt, $lte | sort: ASC, DESC | aggregatable: undefined | searchable: undefined
   - field: _updatedDate | operators: $eq, $ne, $in, $exists, $gt, $gte, $lt, $lte | sort: ASC, DESC | aggregatable: undefined | searchable: undefined
   - field: name | operators: $eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith | sort: ASC, DESC | aggregatable: undefined | searchable: undefined
   - field: _id | operators: $eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith | sort: none | aggregatable: undefined | searchable: undefined
 Return type: PROMISE<QueryBrandsResponse>
  - name: brands | type: array<Brand> | description: List of brands.  | validation: minItems 1, maxItems 300
     - name: _id | type: string | description: Brand GUID.  | read-only: true | validation: format GUID
     - name: revision | type: string | description: Revision number, which increments by 1 each time the brand is updated. To prevent conflicting changes, the current revision must be passed when updating the brand.  Ignored when creating a brand.  | read-only: true | validation: format int64
     - name: _createdDate | type: Date | description: Date and time the brand was created.  | read-only: true 
     - name: _updatedDate | type: Date | description: Date and time the brand was updated.  | read-only: true 
     - name: name | type: string | description: Brand name. >**Note:** `name` must be unique.  | validation: minLength 1, maxLength 50
     - name: assignedProductsCount | type: integer | description: Number of products this brand is assigned to. > **Note:** Returned only when you pass `"ASSIGNED_PRODUCTS_COUNT"` to the `fields` array in Brand API requests.  | read-only: true | validation: format int32
  - name: pagingMetadata | type: CursorPagingMetadata | description: Paging metadata.  
     - name: count | type: integer | description: Number of items returned in the response.  | 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.  


```

### Examples

### Query brands created after a date
Retrieve brands that were created on or after a specific timestamp.

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

async function queryBrands() {
  const response = await brandsV3.queryBrands({
    filter: {
      _createdDate: {
        $gte: new Date("2024-06-20T00:00:00.000Z"),
      },
    },
  });
  return response;
}

/* Promise resolves to:
 * {
 *   "brands": [
 *     {
 *       "id": "a1b2c3d4-e5f6-7a8b-9c0d-e1f2a3b4c5d6"
 *     }
 *   ],
 *   "pagingMetadata": {
 *     "count": 27,
 *     "hasNext": false
 *   }
 * }
 */

```

### queryBrands (self-managed)
Self-managed 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 { brandsV3 } from '@wix/stores';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

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


async function queryBrands(query,options) {
  const response = await myWixClient.brandsV3.queryBrands(query,options);
};
```

---