For AI agents: the complete documentation index is available at llms.txt; this page is also available as Markdown at index.md.

• Documentation >
• Search >
• Aggregation reference >
• ProductStockRangeAggregation

ProductStockRangeAggregation

The ProductStockRangeAggregation aggregates search results by products' numerical stock.

Arguments

• name - name of the Aggregation
• ranges - array of Range objects that define the borders of the specific range sets

Example

You can use this Aggregation over the REST API, in the Aggregations element of the payload of the POST /product/catalog/products/view request:

"ProductQuery": {
    "Aggregations": [
        {
            "ProductStockRange": {
                "name": "stock",
                "ranges": [
                    {
                        "from": 0,
                        "to": 10
                    },
                    {
                        "from": 10,
                        "to": null
                    }
                ]
            }
        }
    ]
}

Copy as Markdown View as Markdown View on GitHub