> 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 # BulkGetOrCreateBrands # Package: catalogV3 # Namespace: BrandService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/brands-v3/bulk-get-or-create-brands.md ## Permission Scopes: Brand write in v3 catalog: SCOPE.STORES.BRAND_WRITE ## Introduction Retrieves multiple brands by name, or creates multiple brands if those with the passed `brandNames` don't exist. --- ## REST API ### Schema ``` Method: bulkGetOrCreateBrands Description: Retrieves multiple brands by name, or creates multiple brands if those with the passed `brandNames` don't exist. URL: https://www.wixapis.com/stores/v3/bulk/brands/get-or-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: brandNames Method parameters: param name: brandNames | type: array | description: Brand names to retrieve or create. | required: true param name: fields | type: array | description: Fields to include in the response. Supported values: `ASSIGNED_PRODUCTS_COUNT` - enum: ASSIGNED_PRODUCTS_COUNT Return type: BulkGetOrCreateBrandsResponse - name: results | type: array | description: Brands retrieved or 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. ``` ### Examples ### Get or Create multiple brands Retrieve an existing brand "Adidas" and create a new brand "Reef". The response also includes the number of products using each brand. ```curl curl -X POST \ 'https://www.wixapis.com/stores/v3/bulk/brands/get-or-create' \ -H 'Content-type: application/json' \ -H 'Authorization: ' \ -d '{ "brandNames": [ "Adidas", "Reef" ], "fields": [ "ASSIGNED_PRODUCTS_COUNT" ] }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.catalogV3.BrandService.bulkGetOrCreateBrands(brandNames, options) Description: Retrieves multiple brands by name, or creates multiple brands if those with the passed `brandNames` don't exist. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: brandNames Method parameters: param name: brandNames | type: array | description: Brand names to retrieve or create. | required: true param name: options | type: BulkGetOrCreateBrandsOptions none - name: fields | type: array | description: Fields to include in the response. Supported values: `ASSIGNED_PRODUCTS_COUNT` - enum: ASSIGNED_PRODUCTS_COUNT Return type: PROMISE - name: results | type: array | description: Brands retrieved or 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. ``` ### Examples ### Bulk get or create brands Retrieve an existing brand and create a new one if it doesn't exist ```javascript import { brandsV3 } from "@wix/stores"; const brandNames = ["Adidas", "Reef"]; const options = { fields: ["ASSIGNED_PRODUCTS_COUNT"] }; async function bulkGetOrCreateBrands() { const response = await brandsV3.bulkGetOrCreateBrands(brandNames, options); } /* Promise resolves to: * { * "results": [ * { * "itemMetadata": { * "id": "35cfd6ff-2c0d-4e68-b881-2fc78942a3c4", * "originalIndex": 0, * "success": true * }, * "item": { * "_id": "35cfd6ff-2c0d-4e68-b881-2fc78942a3c4", * "revision": "1", * "name": "Adidas", * "assignedProductsCount": 2 * } * }, * { * "itemMetadata": { * "id": "afa50d66-b001-4904-be2a-9f8fc562533d", * "originalIndex": 1, * "success": true * }, * "item": { * "_id": "afa50d66-b001-4904-be2a-9f8fc562533d", * "revision": "1", * "name": "Reef", * "assignedProductsCount": 0 * } * } * ], * "bulkActionMetadata": { * "totalSuccesses": 2, * "totalFailures": 0 * } * } */ ``` ### bulkGetOrCreateBrands (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 bulkGetOrCreateBrands(brandNames,options) { const response = await myWixClient.brandsV3.bulkGetOrCreateBrands(brandNames,options); }; ``` ---