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.
  • Documentation >
  • Search >
  • Product Search Criteria >
  • CatalogStatus

CatalogStatus Criterion

The CatalogStatus Search Criterion searches for catalogs by the value of their status.

Arguments

  • value - string representing the catalog's status

Example

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

1
2
3
4
5
<CatalogQuery>
    <Query>
        <CatalogStatusCriterion>published</CatalogStatusCriterion>
    </Query>
</CatalogQuery>

1
2
3
4
5
6
7
{
    "CatalogQuery": {
        "Query": {
            "CatalogStatusCriterion": "published"
        }
    }
}
View as Markdown View on GitHub