---
displayed_sidebar: productReference
---

import ParameterTypes from "@site/src/components/ParameterTypes"

# ProductCategoryDTO

A product category's data.

<ParameterTypes parameters={[
  {
    "name": "category_children",
    "type": "[ProductCategoryDTO](product.ProductCategoryDTO.mdx)[]",
    "description": "The associated child categories.",
    "optional": false,
    "defaultValue": "",
    "expandable": true,
    "children": [
      {
        "name": "category_children",
        "type": "[ProductCategoryDTO](product.ProductCategoryDTO.mdx)[]",
        "description": "The associated child categories.",
        "optional": false,
        "defaultValue": "",
        "expandable": true,
        "children": [
          {
            "name": "category_children",
            "type": "[ProductCategoryDTO](product.ProductCategoryDTO.mdx)[]",
            "description": "The associated child categories.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "created_at",
            "type": "`string` \\| `Date`",
            "description": "When the product category was created.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "description",
            "type": "`string`",
            "description": "The description of the product category.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "handle",
            "type": "`string`",
            "description": "The handle of the product category. The handle can be used to create slug URL paths.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "id",
            "type": "`string`",
            "description": "The ID of the product category.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "is_active",
            "type": "`boolean`",
            "description": "Whether the product category is active.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "is_internal",
            "type": "`boolean`",
            "description": "Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "name",
            "type": "`string`",
            "description": "The name of the product category.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "parent_category",
            "type": "[ProductCategoryDTO](product.ProductCategoryDTO.mdx)",
            "description": "The associated parent category.",
            "optional": true,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "rank",
            "type": "`number`",
            "description": "The ranking of the product category among sibling categories.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "updated_at",
            "type": "`string` \\| `Date`",
            "description": "When the product category was updated.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          }
        ]
      },
      {
        "name": "created_at",
        "type": "`string` \\| `Date`",
        "description": "When the product category was created.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "description",
        "type": "`string`",
        "description": "The description of the product category.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "handle",
        "type": "`string`",
        "description": "The handle of the product category. The handle can be used to create slug URL paths.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "id",
        "type": "`string`",
        "description": "The ID of the product category.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "is_active",
        "type": "`boolean`",
        "description": "Whether the product category is active.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "is_internal",
        "type": "`boolean`",
        "description": "Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "name",
        "type": "`string`",
        "description": "The name of the product category.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "parent_category",
        "type": "[ProductCategoryDTO](product.ProductCategoryDTO.mdx)",
        "description": "The associated parent category.",
        "optional": true,
        "defaultValue": "",
        "expandable": true,
        "children": [
          {
            "name": "category_children",
            "type": "[ProductCategoryDTO](product.ProductCategoryDTO.mdx)[]",
            "description": "The associated child categories.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "created_at",
            "type": "`string` \\| `Date`",
            "description": "When the product category was created.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "description",
            "type": "`string`",
            "description": "The description of the product category.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "handle",
            "type": "`string`",
            "description": "The handle of the product category. The handle can be used to create slug URL paths.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "id",
            "type": "`string`",
            "description": "The ID of the product category.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "is_active",
            "type": "`boolean`",
            "description": "Whether the product category is active.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "is_internal",
            "type": "`boolean`",
            "description": "Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "name",
            "type": "`string`",
            "description": "The name of the product category.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "parent_category",
            "type": "[ProductCategoryDTO](product.ProductCategoryDTO.mdx)",
            "description": "The associated parent category.",
            "optional": true,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "rank",
            "type": "`number`",
            "description": "The ranking of the product category among sibling categories.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "updated_at",
            "type": "`string` \\| `Date`",
            "description": "When the product category was updated.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          }
        ]
      },
      {
        "name": "rank",
        "type": "`number`",
        "description": "The ranking of the product category among sibling categories.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "updated_at",
        "type": "`string` \\| `Date`",
        "description": "When the product category was updated.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "created_at",
    "type": "`string` \\| `Date`",
    "description": "When the product category was created.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "description",
    "type": "`string`",
    "description": "The description of the product category.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "handle",
    "type": "`string`",
    "description": "The handle of the product category. The handle can be used to create slug URL paths.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "id",
    "type": "`string`",
    "description": "The ID of the product category.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "is_active",
    "type": "`boolean`",
    "description": "Whether the product category is active.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "is_internal",
    "type": "`boolean`",
    "description": "Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "name",
    "type": "`string`",
    "description": "The name of the product category.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "parent_category",
    "type": "[ProductCategoryDTO](product.ProductCategoryDTO.mdx)",
    "description": "The associated parent category.",
    "optional": true,
    "defaultValue": "",
    "expandable": true,
    "children": [
      {
        "name": "category_children",
        "type": "[ProductCategoryDTO](product.ProductCategoryDTO.mdx)[]",
        "description": "The associated child categories.",
        "optional": false,
        "defaultValue": "",
        "expandable": true,
        "children": [
          {
            "name": "category_children",
            "type": "[ProductCategoryDTO](product.ProductCategoryDTO.mdx)[]",
            "description": "The associated child categories.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "created_at",
            "type": "`string` \\| `Date`",
            "description": "When the product category was created.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "description",
            "type": "`string`",
            "description": "The description of the product category.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "handle",
            "type": "`string`",
            "description": "The handle of the product category. The handle can be used to create slug URL paths.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "id",
            "type": "`string`",
            "description": "The ID of the product category.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "is_active",
            "type": "`boolean`",
            "description": "Whether the product category is active.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "is_internal",
            "type": "`boolean`",
            "description": "Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "name",
            "type": "`string`",
            "description": "The name of the product category.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "parent_category",
            "type": "[ProductCategoryDTO](product.ProductCategoryDTO.mdx)",
            "description": "The associated parent category.",
            "optional": true,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "rank",
            "type": "`number`",
            "description": "The ranking of the product category among sibling categories.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "updated_at",
            "type": "`string` \\| `Date`",
            "description": "When the product category was updated.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          }
        ]
      },
      {
        "name": "created_at",
        "type": "`string` \\| `Date`",
        "description": "When the product category was created.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "description",
        "type": "`string`",
        "description": "The description of the product category.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "handle",
        "type": "`string`",
        "description": "The handle of the product category. The handle can be used to create slug URL paths.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "id",
        "type": "`string`",
        "description": "The ID of the product category.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "is_active",
        "type": "`boolean`",
        "description": "Whether the product category is active.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "is_internal",
        "type": "`boolean`",
        "description": "Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "name",
        "type": "`string`",
        "description": "The name of the product category.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "parent_category",
        "type": "[ProductCategoryDTO](product.ProductCategoryDTO.mdx)",
        "description": "The associated parent category.",
        "optional": true,
        "defaultValue": "",
        "expandable": true,
        "children": [
          {
            "name": "category_children",
            "type": "[ProductCategoryDTO](product.ProductCategoryDTO.mdx)[]",
            "description": "The associated child categories.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "created_at",
            "type": "`string` \\| `Date`",
            "description": "When the product category was created.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "description",
            "type": "`string`",
            "description": "The description of the product category.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "handle",
            "type": "`string`",
            "description": "The handle of the product category. The handle can be used to create slug URL paths.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "id",
            "type": "`string`",
            "description": "The ID of the product category.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "is_active",
            "type": "`boolean`",
            "description": "Whether the product category is active.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "is_internal",
            "type": "`boolean`",
            "description": "Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "name",
            "type": "`string`",
            "description": "The name of the product category.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "parent_category",
            "type": "[ProductCategoryDTO](product.ProductCategoryDTO.mdx)",
            "description": "The associated parent category.",
            "optional": true,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "rank",
            "type": "`number`",
            "description": "The ranking of the product category among sibling categories.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "updated_at",
            "type": "`string` \\| `Date`",
            "description": "When the product category was updated.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          }
        ]
      },
      {
        "name": "rank",
        "type": "`number`",
        "description": "The ranking of the product category among sibling categories.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "updated_at",
        "type": "`string` \\| `Date`",
        "description": "When the product category was updated.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "rank",
    "type": "`number`",
    "description": "The ranking of the product category among sibling categories.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "updated_at",
    "type": "`string` \\| `Date`",
    "description": "When the product category was updated.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />
