VTEX · Schema

BrandGet

Object containing brand information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id integer Brand's unique numerical identifier.
name string Brand name.
isActive boolean Defines if the brand is active (`true`) or not (`false`).
title string Meta title for the brand page.
metaTagDescription string 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 char
imageUrl string URL of the brand's image.
View JSON Schema on GitHub

JSON Schema

vtex-brandget-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BrandGet",
  "title": "BrandGet",
  "type": "object",
  "description": "Object containing brand information.",
  "required": [
    "id",
    "name",
    "isActive",
    "imageUrl",
    "title",
    "metaTagDescription"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "description": "Brand's unique numerical identifier."
    },
    "name": {
      "type": "string",
      "description": "Brand name."
    },
    "isActive": {
      "type": "boolean",
      "description": "Defines if the brand is active (`true`) or not (`false`)."
    },
    "title": {
      "type": "string",
      "description": "Meta title for the brand page."
    },
    "metaTagDescription": {
      "type": "string",
      "description": "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."
    },
    "imageUrl": {
      "type": "string",
      "description": "URL of the brand's image.",
      "nullable": true
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/vtex-brandget"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.