Home
WooCommerce
Woocommerce Rest Api Product Category Structure
Woocommerce Rest Api Product Category Structure
A product category used to organize the store catalog.
Type: object
Properties: 9
eCommerce Open Source Orders Products WordPress
ProductCategory is a JSON Structure definition published by WooCommerce, describing 9 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
Properties
id
name
slug
parent
description
display
image
menu_order
count
Meta-schema: https://json-structure.org/meta/core/v0/#
JSON Structure
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/woocommerce/refs/heads/main/json-structure/woocommerce-rest-api-product-category-structure.json",
"name": "ProductCategory",
"description": "A product category used to organize the store catalog.",
"type": "object",
"properties": {
"id": {
"type": "int32",
"description": "Category unique identifier.",
"example": 1
},
"name": {
"type": "string",
"description": "Category name.",
"example": "Example Name"
},
"slug": {
"type": "string",
"description": "URL-friendly category identifier.",
"example": "string-value"
},
"parent": {
"type": "int32",
"description": "Parent category ID (0 for top-level categories).",
"example": 1
},
"description": {
"type": "string",
"description": "Category description.",
"example": "A sample description"
},
"display": {
"type": "string",
"description": "Category archive display type. Options: default, products, subcategories, both.",
"example": "string-value"
},
"image": {
"type": "object",
"description": "An image associated with a product.",
"properties": {
"id": {
"type": "int32",
"description": "Image unique identifier.",
"example": 1
},
"src": {
"type": "uri",
"description": "Image URL.",
"example": "https://example.com/path"
},
"name": {
"type": "string",
"description": "Image name.",
"example": "Example Name"
},
"alt": {
"type": "string",
"description": "Image alternative text.",
"example": "string-value"
}
}
},
"menu_order": {
"type": "int32",
"description": "Menu order position for sorting.",
"example": 1
},
"count": {
"type": "int32",
"description": "Number of products in the category.",
"example": 1
}
}
}