Brands work as product attributes that help end customers to identify a product and the business behind it.

A product needs to be associated with one brand to exist. Therefore, creating a Brand is a mandatory step when configuring your Catalog. Usually, it is the second step for catalog integration, after creating categories. For more information on Catalog structure and integration flow at VTEX, check our Catalog overview.

To create a brand, use the Create Brand endpoint. In this endpoint, the request and the response follow the same structure. See the example below:

Request and response body example

{
  "Id": 2000013,
  "Name": "Orma Carbon",
  "Text": "Orma Carbon",
  "Keywords": "orma",
  "SiteTitle": "Orma Carbon",
  "Active": true,
  "MenuHome": true,
  "AdWordsRemarketingCode": "",
  "LomadeeCampaignCode": "",
  "Score": null,
  "LinkId": "orma-carbon"
}

You can edit an existing brand by using the Update Brand endpoint with the same request body structure as to create a brand. The only non-editable information is the Brand ID.

You can get information about all the brands configured in your store by placing a request to one of the following endpoints:

• Get Brand List: Full list of brands in your store. This route's response is limited to 20k results. If you need to obtain more results, please use the Get Brand List per page endpoint instead to get a paginated response.
• Get Brand List per page: Paginated list of brands in your store.

You can retrieve information about a specific brand by making a request to Get Brand.

To delete a brand, use the Delete Brand endpoint. This action is permanent and cannot be undone.