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

ProductAvailability Criterion

The ProductAvailability Search Criterion searches for products by the availability flag, the boolean value set per product or variant.

To search for products that can be ordered, combine this Criterion with other product search criteria. For more information, see Availability and computed availability.

Arguments

  • (optional) productAvailability - bool representing whether the product is available (default true)

Example

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

1
2
3
4
5
<ProductQuery>
    <Filter>
        <ProductAvailabilityCriterion>false</ProductAvailabilityCriterion
    </Filter>
</ProductQuery>
1
2
3
4
5
6
7
{
    "ProductQuery": {
        "Filter": {
            "ProductAvailabilityCriterion": false
        }
    }
}