Brands work as product attributes that help end customers to identify a product and the business behind it.
A product can only be associated with a single brand. Each product needs to be associated with a 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.
Create a brand
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
_13{_13 "Id": 2000013,_13 "Name": "Orma Carbon",_13 "Text": "Orma Carbon",_13 "Keywords": "orma",_13 "SiteTitle": "Orma Carbon",_13 "Active": true,_13 "MenuHome": true,_13 "AdWordsRemarketingCode": "",_13 "LomadeeCampaignCode": "",_13 "Score": null,_13 "LinkId": "orma-carbon"_13}
Do not insert empty spaces at the end of the brand name. VTEX interprets that as a new brand, causing duplication.
You must activate the brand, otherwise the associated products will not be indexed and thereafter will not be displayed on the website.
Edit a brand
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.
Get brand list
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 pageendpoint instead to get a paginated response.
- Get Brand List per page: Paginated list of brands in your store.
Get brand
You can retrieve information about a specific brand by making a request to Get Brand.
Delete a brand
To delete a brand, use the Delete Brand endpoint. This action is permanent and cannot be undone.