> 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

# GetBrand

# Package: catalogV3

# Namespace: BrandService

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

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

## Introduction

Retrieves a brand.

---

## REST API

### Schema

```
 Method: getBrand
 Description: Retrieves a brand.
 URL: https://www.wixapis.com/stores/v3/brands/{brandId}
 Method: GET
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  brandId
 Method parameters: 
   param name: brandId | type:   none | required: true
   query param name: fields | type: array<fields> | description: Fields to include in the response.  Supported values: `ASSIGNED_PRODUCTS_COUNT` 
                 - enum: ASSIGNED_PRODUCTS_COUNT
 Return type: GetBrandResponse
  - name: brand | type: Brand | description: Brand. 
     - 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. 


```

### Examples

### Get brand by ID
Brand fields should include the amount of products using this brand.

```curl
curl -X GET \
  'https://www.wixapis.com/stores/v3/brands/9b1eee8a-2171-455b-807f-1c1e6aa5553b?fields=ASSIGNED_PRODUCTS_COUNT' \
  -H 'Content-type: application/json' \
  -H 'Authorization:  <AUTH>' \
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.catalogV3.BrandService.getBrand(brandId, options)
 Description: Retrieves a brand.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  brandId
 Method parameters: 
   param name: brandId | type: string | description: Brand GUID. | required: true
   param name: options | type: GetBrandOptions  none 
        - name: fields | type: array<RequestedFields> | description: Fields to include in the response.  Supported values: `ASSIGNED_PRODUCTS_COUNT` 
             - enum: ASSIGNED_PRODUCTS_COUNT
 Return type: PROMISE<Brand>
  - 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. 


```

### Examples

### Get a brand by ID
Retrieve a brand with assigned products count

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

const brandId = "9b1eee8a-2171-455b-807f-1c1e6aa5553b";

const options = {
  fields: ["ASSIGNED_PRODUCTS_COUNT"]
};

async function getBrand() {
  const response = await brandsV3.getBrand(brandId, options);
}

/* Promise resolves to:
 * {
 *   "_id": "9b1eee8a-2171-455b-807f-1c1e6aa5553b",
 *   "revision": "1",
 *   "name": "Saucony",
 *   "assignedProductsCount": 2
 * }
 */


```

### getBrand (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 getBrand(brandId,options) {
  const response = await myWixClient.brandsV3.getBrand(brandId,options);
};
```

---