getBrand( )

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

Permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Manage Products
Read Products
Manage Restaurants - all permissions
Read brands in catalog v3
Read v3 catalog
Manage v3 catalog
Product write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
function getBrand(brandId: string, options: GetBrandOptions): Promise<Brand>;
Method Parameters
brandIdstringRequired

Brand ID.

optionsGetBrandOptions
Returns
Return Type:Promise<Brand>
JavaScript
import { brandsV3 } from "@wix/stores";

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

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

Did this help?