# About the Brands API

The Brands API allows you to create and manage brands, which can then be assigned to products using the [Products API](fallback::https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/introduction).

With the Brands API, you can:
- Create and manage brands.
- Retrieve information about existing brands.
- Count the brands that match a filter.

## Assigning brands to products

You can assign a brand to a product by:
- Passing the brand's `id` when creating or updating a product.
- Passing a brand `name`. If a brand with that name exists, it's assigned; otherwise, a new brand is created.

## Deleting brands

When a brand is deleted, it is asynchronously removed from all products that reference it.

## Before you begin

It's important to note the following point before starting to code:

- The Wix user must install the [Wix Stores app](fallback::https://www.wix.com/app-market/wix-stores).

## Use cases
- [Create a product with a new brand](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::d8dd83e3-88d7-4d6e-afd8-aaf1618d6187slug::sample-flows#create-a-product-with-a-new-brand*fallback::https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/brands-v3/sample-use-cases-and-flows#create-a-product-with-a-new-brand)
- [Assign an existing brand to a product](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::d8dd83e3-88d7-4d6e-afd8-aaf1618d6187slug::sample-flows#assign-an-existing-brand-to-a-product*fallback::https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/brands-v3/sample-use-cases-and-flows#assign-an-existing-brand-to-a-product)

## Terminology

For a comprehensive glossary of Catalog V3 terms, see [Terminology](fallback::https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/terminology).

@sdk_package_setup

# Brands API: Sample Flows

This article presents possible use cases and corresponding sample flows that you can support. This can be a helpful jumping off point as you plan your implementation.

## Create a product with a new brand

To create a product and assign a new brand with a single API call:
Call [Create Product](fallback::https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/create-product) and pass
a new `product.brand.name` to the `product.brand` field.

Note: if you pass the `brand.name` of a brand you've already created, that brand will be assigned to the product.

## Assign an existing brand to a product

The Brands API allows you to create, update, and manage multiple brands. You can then use and reuse these brands and assign them across multiple products.

To create and assign a brand to a product:

1. Call [Create Brand](fallback::https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/brands-v3/create-brand).
2. Save the `brand.id` or `brand.name` from your newly created brand.
3. Call [Create Product](fallback::https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/create-product) or [Update Product](fallback::https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/update-product), and pass either the `brand.id` or the `brand.name` to the `product.brand` field.

## Consolidate two brands

This flow explains how to merge brand A into brand B. This process involves moving every product currently assigned to A onto B, then deleting A, so that no products are left with a dangling brand reference:

1. Call [Search Products](fallback::https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/search-products) with a filter on `brand.id` equal to brand A's `id` to list every product currently assigned to brand A. Page through all results.
2. For each affected product, call [Update Product](fallback::https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/update-product) (or [Bulk Update Products](fallback::https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/bulk-update-products) for higher throughput) with `product.brand.id` set to brand B's `id`. Specify the product's current `revision` in the request.
3. For each updated product, call [Get Product](fallback::https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/get-product) and confirm `product.brand.id` equals brand B's `id`. Use Get Product for this readback, not Search Products or `ASSIGNED_PRODUCTS_COUNT` on Query Brands — both are driven by the products search index and lag Update Product writes. Only Get Product is strongly consistent.
4. Once every readback confirms the new assignment, call [Delete Brand](fallback::https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/brands-v3/delete-brand) on brand A.

## Clean up brands with no assigned products

This flow explains how to delete every brand that no product currently references. For example, after a bulk reassignment or import. To do so:

1. Page through every product with [Query Products](fallback::https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/query-products) or [Search Products](fallback::https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/search-products) and collect every non-empty `product.brand.id` into a set of brand IDs that are still in use.
2. Page through every brand with [Query Brands](fallback::https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/brands-v3/query-brands).
3. For each brand whose `id` isn't in the in-use set, call [Delete Brand](fallback::https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/brands-v3/delete-brand).

Don't gate this cleanup on `ASSIGNED_PRODUCTS_COUNT` from Query Brands immediately after a reassignment. The count is computed from the products search index and lags Update Product writes by a small but nonzero interval, so a brand that just received products may still show `0` and get incorrectly deleted. Collecting brand IDs directly from product records (step 1) reads from the product store and isn't affected by the lag.

Mintlify Sandbox

Coding Examples

Overview

Sled Tests

Go Headless

Studio Two

Dashboard Extensions

Backend Extensions

Site Extensions

Extend Websites with SDK

Wix APIs and References

Build Apps

Frontend Modules

Wix Design System (WDS)

Client (Deprecated)

API Preview

Wix CLI

Contexts

Ricos

Extend Websites with Velo

API Reference

Velo

Picasso

Bulk Get Or Create Brands