WooCommerce · Schema

ProductCategoryInput

Input for creating or updating a product category.

eCommerceOpen SourceOrdersProductsWordPress

Properties

Name Type Description
name string Category name (required for create).
slug string URL-friendly category identifier.
parent integer Parent category ID for nested categories.
description string Category description.
display string Category archive display type.
View JSON Schema on GitHub

JSON Schema

woocommerce-rest-api-product-category-input-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/woocommerce/refs/heads/main/json-schema/woocommerce-rest-api-product-category-input-schema.json",
  "title": "ProductCategoryInput",
  "description": "Input for creating or updating a product category.",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Category name (required for create).",
      "example": "Example Name"
    },
    "slug": {
      "type": "string",
      "description": "URL-friendly category identifier.",
      "example": "string-value"
    },
    "parent": {
      "type": "integer",
      "description": "Parent category ID for nested categories.",
      "example": 1
    },
    "description": {
      "type": "string",
      "description": "Category description.",
      "example": "A sample description"
    },
    "display": {
      "type": "string",
      "description": "Category archive display type.",
      "enum": [
        "default",
        "products",
        "subcategories",
        "both"
      ],
      "example": "default"
    }
  }
}