BigCommerce · Schema

EnabledBrandFilter

A storefront filter for product brand

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
collapsed_by_default	boolean
display_name	string
display_product_count	boolean
id	string
is_enabled	boolean
items_to_show	integer
sort_by	string
type	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EnabledBrandFilter",
  "title": "EnabledBrandFilter",
  "description": "A storefront filter for product brand",
  "type": "object",
  "properties": {
    "collapsed_by_default": {
      "type": "boolean"
    },
    "display_name": {
      "type": "string"
    },
    "display_product_count": {
      "type": "boolean"
    },
    "id": {
      "type": "string"
    },
    "is_enabled": {
      "type": "boolean"
    },
    "items_to_show": {
      "type": "integer",
      "enum": [
        5,
        10,
        15
      ]
    },
    "sort_by": {
      "type": "string",
      "enum": [
        "alpha",
        "item_count"
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "brand"
      ]
    }
  },
  "x-internal": false
}