Brands are product attributes, just like Description and Name are also considered to be product attributes or product properties. Products must have an associated brand.

Brand is a default facet in the search navigation bar.

To learn more see Brand on our Help Center

🚧

Limitation

Products can be associated with only one brand.

❗️

Watch out for these pitfalls

  • Active Brand
    • Don't forget to activate brands otherwise products will not be indexed and thereafter will not be displayed on the website.
  • Brands with space characters at the end
    • Pay attention to empty spaces at the end of the brand name. VTEX understands that as a new brand causing duplication.

Data Model

Field Description Required Format Default
Name Brand's Name Yes String (150) -
Text Brand's Meta Tag Description No Integer null
Keywords Store Framework - Deprecated

Classic CMS - Alternative search terms that will lead to the specific brand. The user can find the desired brand even when misspelling it. Used especially when words are of foreign origin and have a distinct spelling that is transcribed into a generic one, or when small spelling mistakes occur.

No String null
SiteTitle Brand's Page Title (SEO) No String null
Active Flag to activate/deactivate brand No Boolean (true/false) false
MenuHome Store Framework - Deprecated

Classic CMS - Brand appears in the Department Menu control (<vtex.cmc:departmentNavigator/>)

No - null
AdWordsRemarketingCode Deprecated No - null
LomadeeCampaignCode Deprecated No - null
Score Store Framework Deprecated

Classic CMS - Value used to set the priority on the search result page. More Details

No Integer null

API integration

To create a new brand use the Create brand API endpoint.

Body:

{
    "Name": "Adidas",
    "Text": "Welcome to adidas. Shop for adidas shoes, clothing and view new collections for adidas Originals, running, football, soccer, training and much more.",
    "Keywords": "Adidas, Originals",
    "SiteTitle": "Adidas",
    "Active": true,
    "MenuHome": false,
    "Score": null
}

Response:

{
    "Id": 12121219,
    "Name": "Adidas",
    "Text": "Welcome to adidas. Shop for adidas shoes, clothing and view new collections for adidas Originals, running, football, soccer, training and much more.",
    "Keywords": "Adidas, Originals",
    "SiteTitle": "Adidas",
    "Active": true,
    "MenuHome": false,
    "AdWordsRemarketingCode": null,
    "LomadeeCampaignCode": null,
    "Score": null,
    "LinkId": null
}

Did this page help you?