> 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

# BulkCreateBrands

# Package: catalogV3

# Namespace: BrandService

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

## Permission Scopes:
Brand write in v3 catalog: SCOPE.STORES.BRAND_WRITE

## Introduction

Creates multiple brands.

---

## REST API

### Schema

```
 Method: bulkCreateBrands
 Description: Creates multiple brands.
 URL: https://www.wixapis.com/stores/v3/bulk/brands/create
 Method: POST
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  brands, brands.name
 Method parameters: 
   param name: brands | type: array<brands> | description: Brands to create. | required: true
              - name: name | type: string | description: Brand name. >**Note:** `name` must be unique. | required: true
   param name: returnEntity | type: returnEntity | description: Whether to return the full created brand entities in the response.  Default: `false` 
 Return type: BulkCreateBrandsResponse
  - name: results | type: array<BulkBrandsResult> | description: Brands created by bulk action. 
     - name: itemMetadata | type: ItemMetadata | description: Bulk action metadata for brand. 
        - name: id | type: string | description: Item GUID. Should always be available, unless it's impossible (for example, when failing to create an item). 
        - name: originalIndex | type: integer | description: Index of the item within the request array. Allows for correlation between request and response items. 
        - name: success | type: boolean | description: Whether the requested action was successful for this item. When `false`, the `error` field is populated. 
        - name: error | type: ApplicationError | description: Details about the error in case of failure. 
           - name: code | type: string | description: Error code. 
           - name: description | type: string | description: Description of the error. 
           - name: data | type: object | description: Data related to the error. 
     - name: item | type: Brand | description: Full brand entity.  Returned only if `returnEntity: true` is passed in the request. 
        - 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: bulkActionMetadata | type: BulkActionMetadata | description: Bulk action metadata. 
     - name: totalSuccesses | type: integer | description: Number of items that were successfully processed. 
     - name: totalFailures | type: integer | description: Number of items that couldn't be processed. 
     - name: undetailedFailures | type: integer | description: Number of failures without details because detailed failure threshold was exceeded. 

 Possible Errors:
   HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: ONLY_SPACES_STRING_ERROR | Description: `name` contains only spaces. Provide valid text content.
   HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: BRAND_LIMIT_EXCEEDED | Description: Number of brands exceeded the store limit.


```

### Examples

### Create multiple Brands
Request to create 4 brands. 3 of them are created successfully and 1 fails due to a unique constraint violation.

```curl
curl -X POST \
  'https://www.wixapis.com/stores/v3/bulk/brands/create' \
  -H 'Content-type: application/json' \
  -H 'Authorization:  <AUTH>' \
  -d '{
    "brands": [
        {
            "name": "ASICS"
        },
        {
          "name": "Altra"
        },
        {
          "name": "Altra"
        },
        {
          "name": "New Balance"
        }
      ],
    "returnEntity": true
  }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.catalogV3.BrandService.bulkCreateBrands(brands, options)
 Description: Creates multiple brands.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  brands, brands.name
 Method parameters: 
   param name: brands | type: array<array> | description: Brands to create. | required: true
              - name: name | type: string | description: Brand name. >**Note:** `name` must be unique. | required: true
   param name: options | type: BulkCreateBrandsOptions  none 
        - name: returnEntity | type: boolean | description: Whether to return the full created brand entities in the response.  Default: `false` 
 Return type: PROMISE<BulkCreateBrandsResponse>
  - name: results | type: array<BulkBrandsResult> | description: Brands created by bulk action. 
     - name: itemMetadata | type: ItemMetadata | description: Bulk action metadata for brand. 
        - name: _id | type: string | description: Item GUID. Should always be available, unless it's impossible (for example, when failing to create an item). 
        - name: originalIndex | type: integer | description: Index of the item within the request array. Allows for correlation between request and response items. 
        - name: success | type: boolean | description: Whether the requested action was successful for this item. When `false`, the `error` field is populated. 
        - name: error | type: ApplicationError | description: Details about the error in case of failure. 
           - name: code | type: string | description: Error code. 
           - name: description | type: string | description: Description of the error. 
           - name: data | type: object | description: Data related to the error. 
     - name: item | type: Brand | description: Full brand entity.  Returned only if `returnEntity: true` is passed in the request. 
        - 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: bulkActionMetadata | type: BulkActionMetadata | description: Bulk action metadata. 
     - name: totalSuccesses | type: integer | description: Number of items that were successfully processed. 
     - name: totalFailures | type: integer | description: Number of items that couldn't be processed. 
     - name: undetailedFailures | type: integer | description: Number of failures without details because detailed failure threshold was exceeded. 

 Possible Errors:
   HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: ONLY_SPACES_STRING_ERROR | Description: `name` contains only spaces. Provide valid text content.
   HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: BRAND_LIMIT_EXCEEDED | Description: Number of brands exceeded the store limit.


```

### Examples

### Bulk create brands
```javascript
import { brandsV3 } from "@wix/stores";

const brands = [
  {
    name: "ASICS"
  },
  {
    name: "Altra"
  },
  {
    name: "New Balance"
  }
];

const options = {
  returnEntity: true
};

async function bulkCreateBrands() {
  const response = await brandsV3.bulkCreateBrands(brands, options);
}


```

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

---