BigCommerce · Schema

brand_Full

Common Brand properties.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
id integer Unique ID of the *Brand*. Read-Only.
name string The name of the brand. Must be unique. Required in POST.
page_title string The title shown in the browser while viewing the brand.
meta_keywords array An array of meta keywords to include in the HTML.
meta_description string A meta description to include.
search_keywords string A comma-separated list of keywords that can be used to locate this brand.
image_url string Image URL used for this category on the storefront. Images can be uploaded via form file post to `/brands/{brandId}/image`, or by providing a publicly accessible URL in this field.
custom_url object
View JSON Schema on GitHub

JSON Schema

bigcommerce-brand-full-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/brand_Full",
  "title": "brand_Full",
  "required": [
    "name"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Unique ID of the *Brand*. Read-Only.",
      "readOnly": true
    },
    "name": {
      "maxLength": 255,
      "minLength": 1,
      "type": "string",
      "description": "The name of the brand. Must be unique.\nRequired in POST.",
      "example": "Common Good",
      "x-required": [
        "post",
        "put"
      ]
    },
    "page_title": {
      "maxLength": 255,
      "minLength": 0,
      "type": "string",
      "description": "The title shown in the browser while viewing the brand.\n",
      "example": "Common Good"
    },
    "meta_keywords": {
      "type": "array",
      "description": "An array of meta keywords to include in the HTML.\n",
      "items": {
        "type": "string"
      },
      "example": [
        "modern",
        "clean",
        "contemporary"
      ]
    },
    "meta_description": {
      "maxLength": 65535,
      "minLength": 0,
      "type": "string",
      "description": "A meta description to include.\n",
      "example": "Common Good is a modern brand."
    },
    "search_keywords": {
      "maxLength": 65535,
      "minLength": 0,
      "type": "string",
      "description": "A comma-separated list of keywords that can be used to locate this brand.\n",
      "example": "kitchen, laundry, cart, storage"
    },
    "image_url": {
      "type": "string",
      "description": "Image URL used for this category on the storefront. Images can be uploaded via form file post to `/brands/{brandId}/image`, or by providing a publicly accessible URL in this field.\n",
      "example": "https://cdn8.bigcommerce.com/s-12345/product_images/k/your-image-name.png",
      "x-url": true
    },
    "custom_url": {
      "$ref": "#/components/schemas/customUrl_Full"
    }
  },
  "description": "Common Brand properties.",
  "x-internal": false
}