category_Full

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/category_Full",
  "title": "category_Full",
  "type": "object",
  "description": "Common Category object properties.",
  "x-internal": false,
  "properties": {
    "id": {
      "type": "integer",
      "description": "Unique ID of the *Category*. Increments sequentially.\nRead-Only.",
      "readOnly": true
    },
    "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.\nRequired in a POST if creating a child category.",
      "example": 2,
      "x-required": [
        "post"
      ]
    },
    "name": {
      "maxLength": 50,
      "minLength": 1,
      "type": "string",
      "description": "The name displayed for the category. Name is unique with respect to the category\u02bcs siblings.\nRequired in a POST.",
      "example": "Bath",
      "x-required": [
        "post"
      ]
    },
    "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": {
      "maximum": 2147483647,
      "minimum": -2147483648,
      "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": {
      "maxLength": 255,
      "minLength": 0,
      "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"
    },
    "search_keywords": {
      "maxLength": 255,
      "minLength": 0,
      "type": "string",
      "description": "A comma-separated list of keywords that can be used to locate the category when searching the store.\n"
    },
    "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",
      "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 [the article on creating category files (Help Center)](https://support.bigcommerce.com/articles/Public/Creating-Custom-Template-Files/). This field is writable only for stores with a Blueprint theme applied. For stores with a Stencil theme applied, see [Custom Template Associations](/docs/rest-content/custom-template-associations).\n",
      "example": "category.html"
    },
    "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"
    },
    "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"
      ]
    },
    "image_url": {
      "type": "string",
      "description": "Image URL used for this category on the storefront. Images can be uploaded using form file post to `/categories/{categoryId}/image`, or by providing a publicly accessible URL in this field. An image extension like .jpg or .png is required.\n",
      "example": "https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png",
      "x-url": true
    },
    "custom_url": {
      "$ref": "#/components/schemas/customUrl_Full"
    }
  },
  "required": [
    "parent_id",
    "name"
  ]
}