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
    }
  }
}