WooCommerce · JSON Structure

Woocommerce Store Api Store Brand Structure

A product brand.

Type: object Properties: 5
eCommerceOpen SourceOrdersProductsWordPress

StoreBrand is a JSON Structure definition published by WooCommerce, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id name slug description image

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/woocommerce/refs/heads/main/json-structure/woocommerce-store-api-store-brand-structure.json",
  "name": "StoreBrand",
  "description": "A product brand.",
  "type": "object",
  "properties": {
    "id": {
      "type": "int32",
      "description": "Brand unique identifier.",
      "example": 1
    },
    "name": {
      "type": "string",
      "description": "Brand display name.",
      "example": "Example Name"
    },
    "slug": {
      "type": "string",
      "description": "URL-friendly brand slug.",
      "example": "string-value"
    },
    "description": {
      "type": "string",
      "description": "Brand description.",
      "example": "A sample description"
    },
    "image": {
      "type": "object",
      "description": "Product image with thumbnail variants.",
      "properties": {
        "id": {
          "type": "int32",
          "description": "Image attachment ID.",
          "example": 1
        },
        "src": {
          "type": "uri",
          "description": "Full-size image URL.",
          "example": "https://example.com/path"
        },
        "thumbnail": {
          "type": "uri",
          "description": "Thumbnail image URL.",
          "example": "https://example.com/path"
        },
        "srcset": {
          "type": "string",
          "description": "Responsive image srcset attribute value.",
          "example": "string-value"
        },
        "sizes": {
          "type": "string",
          "description": "Responsive image sizes attribute value.",
          "example": "string-value"
        },
        "name": {
          "type": "string",
          "description": "Image file name.",
          "example": "Example Name"
        },
        "alt": {
          "type": "string",
          "description": "Image alternative text.",
          "example": "string-value"
        }
      }
    }
  }
}