WooCommerce · Schema
ProductCollectionData
Aggregate data about a filtered product collection.
eCommerceOpen SourceOrdersProductsWordPress
Properties
| Name | Type | Description |
|---|---|---|
| price_range | object | Minimum and maximum prices in the collection. |
| attribute_counts | array | Term counts for requested attributes. |
| rating_counts | array | Product counts by star rating. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/woocommerce/refs/heads/main/json-schema/woocommerce-store-api-product-collection-data-schema.json",
"title": "ProductCollectionData",
"description": "Aggregate data about a filtered product collection.",
"type": "object",
"properties": {
"price_range": {
"type": "object",
"description": "Minimum and maximum prices in the collection.",
"nullable": true,
"properties": {
"min_price": {
"type": "string",
"description": "Minimum product price."
},
"max_price": {
"type": "string",
"description": "Maximum product price."
}
},
"example": {
"min_price": "string-value",
"max_price": "string-value"
}
},
"attribute_counts": {
"type": "array",
"description": "Term counts for requested attributes.",
"items": {
"type": "object",
"properties": {
"term": {
"type": "integer",
"description": "Term ID."
},
"count": {
"type": "integer",
"description": "Number of products with this term."
}
}
},
"example": [
{
"term": 1,
"count": 1
}
]
},
"rating_counts": {
"type": "array",
"description": "Product counts by star rating.",
"items": {
"type": "object",
"properties": {
"rating": {
"type": "integer",
"description": "Star rating value."
},
"count": {
"type": "integer",
"description": "Number of products with this rating."
}
}
},
"example": [
{
"rating": 1,
"count": 1
}
]
}
}
}