BigCommerce · Schema

categoriesTreeNode_Full

Used to reflect parent <> child category relationships. Used by Category Tree.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
id integer The unique numeric ID of the category; increments sequentially.
parent_id integer The unique numeric ID of the categoryʼs parent. This field controls where the category sits in the tree of categories that organize the catalog.
name string The name displayed for the category. Name is unique with respect to the categoryʼs siblings.
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.
url string The custom URL for the category on the storefront.
View JSON Schema on GitHub

JSON Schema

bigcommerce-categoriestreenode-full-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/categoriesTreeNode_Full",
  "title": "categoriesTreeNode_Full",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "The unique numeric ID of the category; increments sequentially.\n",
      "example": 26
    },
    "parent_id": {
      "type": "integer",
      "description": "The unique numeric ID of the category\u02bcs parent. This field controls where the category sits in the tree of categories that organize the catalog.\n",
      "example": 25
    },
    "name": {
      "type": "string",
      "description": "The name displayed for the category. Name is unique with respect to the category\u02bcs siblings.\n",
      "example": "Bath"
    },
    "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",
      "example": true
    },
    "url": {
      "type": "string",
      "description": "The custom URL for the category on the storefront.\n",
      "example": "/towels/bath-towels/"
    }
  },
  "description": "Used to reflect parent <> child category relationships. Used by Category Tree.",
  "x-internal": false
}