> 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 # QueryBrands # Package: catalogV3 # Namespace: BrandService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/brands-v3/query-brands.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). --- ## 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). URL: https://www.wixapis.com/stores/v3/brands/query Method: POST Method parameters: param name: fields | type: array | description: Fields to include in the response. Supported values: `ASSIGNED_PRODUCTS_COUNT` - 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. - 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. - 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 | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: - ASC: Ascending order. - DESC: Descending order. Return type: QueryBrandsResponse - name: brands | type: array | description: List of brands. - name: id | type: string | description: Brand 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. - name: createdDate | type: string | description: Date and time the brand was created. - name: updatedDate | type: string | description: Date and time the brand was updated. - name: name | type: string | description: Brand name. >**Note:** `name` must be unique. - 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. - name: pagingMetadata | type: CursorPagingMetadata | description: Paging metadata. - name: count | type: integer | description: Number of items returned in the response. - 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. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - 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: ' \ -d '{ "query": { "filter": { "createdDate": { "$gte": "2024-06-20T00:00:00.000Z" } } } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.catalogV3.BrandService.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: 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: options | type: QueryBrandsOptions none - name: fields | type: array | description: Fields to include in the response. Supported values: `ASSIGNED_PRODUCTS_COUNT` - enum: ASSIGNED_PRODUCTS_COUNT 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. - 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. - 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 | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: - ASC: Ascending order. - DESC: Descending order. Return type: PROMISE - name: brands | type: array | description: List of brands. - name: _id | type: string | description: Brand 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. - name: _createdDate | type: Date | description: Date and time the brand was created. - name: _updatedDate | type: Date | description: Date and time the brand was updated. - name: name | type: string | description: Brand name. >**Note:** `name` must be unique. - 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. - name: pagingMetadata | type: CursorPagingMetadata | description: Paging metadata. - name: count | type: integer | description: Number of items returned in the response. - 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. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - 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 Query brands created after a specific date ```javascript import { brandsV3 } from "@wix/stores"; const options = { query: { filter: { createdDate: { $gte: "2024-06-20T00:00:00.000Z" } } } }; async function queryBrands() { const response = await brandsV3.queryBrands(options); } /* Promise resolves to: * { * "brands": [ * { "_id": "debc07f9-...", "revision": "1", "name": "Saucony" }, * { "_id": "38ae5b9b-...", "revision": "1", "name": "Adidas" } * ], * "pagingMetadata": { "count": 2, "cursors": {}, "hasNext": false } * } */ ``` ### queryBrands (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 { 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); }; ``` ---