Get list of brands
📘 This API is part of the Seller Portal Catalog. This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact our Support Center.
Retrieves general information about all brands of the store. It is mandatory to use at least one query parameter.
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 |
|---|---|---|
| CatalogV2 | Management | Brand Read |
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.
Query parameters
Search word.
The first page of the interval of the brand list.
The last page of the interval of the brand list.
The order that the list is displayed. You can select name, or updated_at to select the order criteria. Then you can add , , asc or desc to define the brands order.
Brand name.
Headers
Type of the content being sent.
HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
Response
OK