BrandCreateUpdate

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BrandCreateUpdate",
  "title": "BrandCreateUpdate",
  "type": "object",
  "description": "Object containing brand information.",
  "required": [
    "Id",
    "Name"
  ],
  "properties": {
    "Id": {
      "type": "integer",
      "description": "Brand's unique numerical identifier.",
      "example": 2000003
    },
    "Name": {
      "type": "string",
      "description": "Brand name.",
      "example": "Adidas"
    },
    "Text": {
      "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.",
      "example": "Adidas"
    },
    "Keywords": {
      "type": "string",
      "description": "Store Framework - Deprecated.\r\nLegacy 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.",
      "example": "adidas"
    },
    "SiteTitle": {
      "type": "string",
      "description": "Meta title for the brand page.",
      "example": "Adidas"
    },
    "AdWordsRemarketingCode": {
      "type": "string",
      "description": "This is a legacy field. Do not take this information into consideration.",
      "deprecated": true
    },
    "LomadeeCampaignCode": {
      "type": "string",
      "description": "This is a legacy field. Do not take this information into consideration.",
      "deprecated": true
    },
    "Score": {
      "type": "integer",
      "description": "Store Framework - Deprecated\r\nLegacy CMS Portal - Value used to set the priority on the search result page.",
      "example": 10,
      "nullable": true
    },
    "MenuHome": {
      "type": "boolean",
      "description": "Store Framework - Deprecated.\r\nLegacy CMS Portal - Defines if the brand appears in the Department Menu control (`<vtex.cmc:departmentNavigator/>`).",
      "example": true
    },
    "Active": {
      "type": "boolean",
      "description": "Defines if the brand is active (`true`) or not (`false`).",
      "example": true
    },
    "LinkId": {
      "type": "string",
      "description": "Brand page slug. Only lowercase letters and hyphens (`-`) are allowed.",
      "example": "adidas-sports",
      "nullable": true
    }
  },
  "example": {
    "Id": 2000013,
    "Name": "Orma Carbono2",
    "Text": "Orma Carbon2",
    "Keywords": "orma",
    "SiteTitle": "Orma Carbon2",
    "Active": true,
    "MenuHome": true,
    "AdWordsRemarketingCode": "",
    "LomadeeCampaignCode": "",
    "Score": null,
    "LinkId": null
  }
}