BigCommerce · Schema

Category

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
description	string	The product description, which can include HTML formatting.
views	integer	Number of views the category has on the storefront.
sort_order	integer	Priority this category will be given when included in the menu and category pages. The lower the number, the closer to the top of the results the category will be.
page_title	string	Custom title for the category page. If not defined, the category name will be used as the meta title.
meta_keywords	array	Custom meta keywords for the category page. If not defined, the storeʼs default keywords will be used. Must post as an array like: ["awesome","sauce"].
meta_description	string	Custom meta description for the category page. If not defined, the storeʼs default meta description will be used.
layout_file	string	A valid layout file. (Please refer to [this article](https://support.bigcommerce.com/articles/Public/Creating-Custom-Template-Files/) on creating category files.) This field is writable only for store
image_url	string	Image URL used for this category on the storefront. Images can be uploaded via form file post to `/categories/{categoryId}/image`, or by providing a publicly accessible URL in this field. Must be eith
is_visible	boolean	Flag to determine whether the product should be displayed to customers browsing the store. If `true`, the category will be displayed. If `false`, the category will be hidden from view.
search_keywords	string	A comma-separated list of keywords that can be used to locate the category when searching the store.
default_product_sort	string	Determines how the products are sorted on category page load.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CategoryBase",
  "title": "Category",
  "type": "object",
  "properties": {
    "description": {
      "type": "string",
      "description": "The product description, which can include HTML formatting.\n",
      "example": "<p>We offer a wide variety of products perfect for relaxing</p>"
    },
    "views": {
      "type": "integer",
      "description": "Number of views the category has on the storefront.\n",
      "example": 1050
    },
    "sort_order": {
      "type": "integer",
      "description": "Priority this category will be given when included in the menu and category pages. The lower the number, the closer to the top of the results the category will be.\n",
      "example": 3
    },
    "page_title": {
      "type": "string",
      "description": "Custom title for the category page. If not defined, the category name will be used as the meta title.\n",
      "example": "Bath"
    },
    "meta_keywords": {
      "type": "array",
      "description": "Custom meta keywords for the category page. If not defined, the store\u02bcs default keywords will be used. Must post as an array like: [\"awesome\",\"sauce\"].\n",
      "example": [
        "shower",
        "tub"
      ],
      "items": {
        "type": "string"
      }
    },
    "meta_description": {
      "maxLength": 65535,
      "minLength": 0,
      "type": "string",
      "description": "Custom meta description for the category page. If not defined, the store\u02bcs default meta description will be used.\n"
    },
    "layout_file": {
      "maxLength": 500,
      "minLength": 0,
      "type": "string",
      "description": "A valid layout file. (Please refer to [this article](https://support.bigcommerce.com/articles/Public/Creating-Custom-Template-Files/) on creating category files.) This field is writable only for stores with a Blueprint theme applied.\n",
      "example": "category.html"
    },
    "image_url": {
      "type": "string",
      "description": "Image URL used for this category on the storefront. Images can be uploaded via form file post to `/categories/{categoryId}/image`, or by providing a publicly accessible URL in this field. Must be either a full-qualified URL or an empty string.\n",
      "example": "https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png",
      "x-url": true
    },
    "is_visible": {
      "type": "boolean",
      "description": "Flag to determine whether the product should be displayed to customers browsing the store. If `true`, the category will be displayed. If `false`, the category will be hidden from view.\n"
    },
    "search_keywords": {
      "type": "string",
      "description": "A comma-separated list of keywords that can be used to locate the category when searching the store.\n"
    },
    "default_product_sort": {
      "type": "string",
      "description": "Determines how the products are sorted on category page load.\n",
      "enum": [
        "use_store_settings",
        "featured",
        "newest",
        "best_selling",
        "alpha_asc",
        "alpha_desc",
        "avg_customer_review",
        "price_asc",
        "price_desc"
      ]
    }
  }
}