About the Wix Stores Brands V3 API

The Brands API allows you to create and manage brands, which can then be assigned to products using the Products API.

Brands enhance product visibility and customer engagement, making it easier for customers to find products based on their brand preferences.

This API provides all the necessary functionality to manage a bank of brands, which can be applied to products to ensure a consistent brand experience across your store.

With the Brands API, you can:

  • Create and manage a bank of brands.
  • Retrieve information about existing brands.

Before you begin

It’s important to note the following points before starting to code:

  • The Brands V3 API is only available for use with the Stores Catalog V3.
  • You must call getCatalogVersion() to get the site's Stores catalog version before using any of the Brands V3 API methods. If the site uses Stores Catalog V1, the Brands V3 API methods will not be available.
Did this help?

Setup

To use the BrandsV3 API, install the @wix/stores package using npm or Yarn:

Copy

or

Copy

Then import { brandsV3 } from @wix/stores:

Copy
Did this help?

bulkCreateBrands( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates multiple brands.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Stores - all permissions
Manage Products
Brand write in v3 catalog
Manage v3 catalog
Product write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
brandsArray<Brand>Required

Brands to create.

optionsBulkCreateBrandsOptions
Returns
Return Type:Promise<BulkCreateBrandsResponse>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

bulkDeleteBrands( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Deletes multiple brands.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Stores - all permissions
Manage Products
Brand write in v3 catalog
Manage v3 catalog
Product write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
brandIdsArray<string>Required

IDs of brands to delete.

Returns
Return Type:Promise<BulkDeleteBrandsResponse>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

bulkGetOrCreateBrands( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves multiple brands by name, or creates multiple brands if those with the passed ribbonNames don't exist.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Stores - all permissions
Manage Products
Brand write in v3 catalog
Manage v3 catalog
Product write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
brandNamesArray<string>Required

Brand names to retrieve or create.

optionsBulkGetOrCreateBrandsOptions
Returns
Return Type:Promise<BulkGetOrCreateBrandsResponse>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

bulkUpdateBrands( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates multiple brands.

Each time a brand is updated, revision increments by 1. The current revision must be passed when updating a brand. This ensures you're working with the latest brand and prevents unintended overwrites.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Stores - all permissions
Manage Products
Brand write in v3 catalog
Manage v3 catalog
Product write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
brandsArray<MaskedBrand>Required

List of brands to update.

optionsBulkUpdateBrandsOptions
Returns
Return Type:Promise<BulkUpdateBrandsResponse>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

createBrand( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates a brand.

To assign the brand to a product, include the brand.id or brand.name when creating or updating a product.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Stores - all permissions
Manage Products
Brand write in v3 catalog
Manage v3 catalog
Product write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
brandBrandRequired

Brand to create.

Returns
Return Type:Promise<Brand>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?