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 >
• ProductAvailabilityTermAggregation

ProductAvailabilityTerm

The ProductAvailabilityTermAggregation aggregates search results by product availability (available/unavailable).

Arguments

• name - name of the Aggregation object

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": [
        {
            "ProductAvailabilityTerm": {
                "name": "availability"
            }
        }
    ]
}

Copy as Markdown View as Markdown View on GitHub