Catalog - Brands
The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the Catalog Overview.
Our Catalog brands endpoints let you create individual brands and modify the brands associated with a storeʼs products, along with deleting brands.
Brand images have their own dedicated create a brand image and delete a brand image endpoints.
In addition, brands have metafields that you can use to store information structured in key-value pairs; learn more about creating brand metafields, updating brand metafields, and deleting brand metafields.
To learn more about authenticating Catalog endpoints, locate the Authentication section at the top of each endpoint, then click Show Details.
Resources
Webhooks
Additional Catalog endpoints
Get All Brands
GET https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/brandsRequest
Returns a list of brands. Optional filter parameters can be passed in.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Body
dataarray[object]
example
Create a Brand
POST https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/brandsRequest
Creates a brand.
Required Fields
- name
Limits
- 30,000 brands per store limit
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
Common brand properties.
namestring
required>= 1 characters<= 255 charactersThe name of the brand. Must be unique. Required in POST.
Example: Common Goodpage_titlestring
>= 0 characters<= 255 charactersThe title shown in the browser while viewing the brand.
Example: Common Goodsearch_keywordsstring
>= 0 characters<= 65535 charactersA comma-separated list of keywords that can be used to locate this brand.
Example: kitchen, laundry, cart, storageimage_urlstring
Image URL used for this category on the storefront. Images can be uploaded via form file post to
/brands/{brandId}/image
, or by providing a publicly accessible URL in this field.Example: https://cdn8.bigcommerce.com/s-12345/product_images/k/your-image-name.pngcustom_urlobject
The custom URL for the brand on the storefront. If not provided, the URL will be autogenerated from the brand name.
example
Response
Body
Brand Response returns for:
- Create Brand
- Get Brand by Id
- Update Brand by Id
dataobject
Common Brand properties.
example
Delete Brands
DELETE https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/brandsRequest
To delete brand objects, you must include a value for the name filter.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Get a Brand
GET https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/brands/{brand_id}Request
Returns a single brand. Optional filter parameters can be passed in.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Body
Brand Response returns for:
- Create Brand
- Get Brand by Id
- Update Brand by Id
dataobject
Common Brand properties.
example
Update a Brand
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/brands/{brand_id}Request
Updates a brand.
To update a brand image, send a request with an image_url
.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
Common Brand properties.
idinteger
read-onlyUnique ID of the brand.
namestring
required>= 1 characters<= 255 charactersThe name of the brand. Must be unique. Required in POST.
Example: Common Goodpage_titlestring
>= 0 characters<= 255 charactersThe title shown in the browser while viewing the brand.
Example: Common Goodsearch_keywordsstring
>= 0 characters<= 65535 charactersA comma-separated list of keywords that can be used to locate this brand.
Example: kitchen, laundry, cart, storageimage_urlstring
Image URL used for this category on the storefront. Images can be uploaded via form file post to
/brands/{brandId}/image
, or by providing a publicly accessible URL in this field.Example: https://cdn8.bigcommerce.com/s-12345/product_images/k/your-image-name.pngcustom_urlobject
The custom URL for the brand on the storefront.
example
Response
Body
Brand Response returns for:
- Create Brand
- Get Brand by Id
- Update Brand by Id
dataobject
Common Brand properties.