deleteBrand( )

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 a brand.

Note: Deleting a brand will also remove it from all products it is assigned to.

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
function deleteBrand(brandId: string): Promise<void>;
Method Parameters
brandIdstringRequired

Brand ID.

JavaScript
import { brandsV3 } from "@wix/stores";

async function deleteBrand(brandId) {
  const response = await brandsV3.deleteBrand(brandId);
}
Errors

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

Did this help?