v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-29208421.4 MB

Brand

Get brand and context

Retrieves information about a specific brand and its context.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

Product	Category	Resource
Catalog	Content	Brand Management

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

get/api/catalog/pvt/brand/{brandId}

Path parameters

brandIdstring required

Example:123

Brand ID.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

Idinteger required

Brand's unique numerical identifier.

Namestring required

Brand name.

Textstring

Meta description for the brand page. A brief description of the brand, displayed by search engines. Since search engines can only display less than 150 characters, we recommend not exceeding this character limit when creating the description.

Keywordsstring

Store Framework - Deprecated. Legacy CMS Portal - 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.

SiteTitlestring

Meta title for the brand page.

AdWordsRemarketingCodestring

This is a legacy field. Do not take this information into consideration.

LomadeeCampaignCodestring

This is a legacy field. Do not take this information into consideration.

Scoreinteger nullable

Store Framework - Deprecated Legacy CMS Portal - Value used to set the priority on the search result page.

MenuHomeboolean

Store Framework - Deprecated. Legacy CMS Portal - Defines if the brand appears in the Department Menu control (<vtex.cmc:departmentNavigator/>).

Activeboolean

Defines if the brand is active (true) or not (false).

LinkIdstring nullable

Brand page slug. Only lowercase letters and hyphens (-) are allowed.