Skip to main content

clusters

Search the catalogue for clusters matching the supplied criteria.

Filters can target identifiers, stock keeping units, codes, categories, hidden visibility, and creation or modification date ranges. Results are paginated and may be sorted by any of the supported fields.

Possible errors:

  • SCHEMA_VALIDATION: One or more search criteria failed validation.

AUTH: Role=[product.OWNER,product.EDITOR,product.VIEWER] OR (('user is authenticated') AND ('userId if present in input matches JWT' AND 'companyId(s) if present in input matches JWT'))

clusters(
input: ClusterSearchInput!
): ClustersResponse!

Arguments

clusters.input ● ClusterSearchInput! non-null input

Search criteria, pagination and sorting for the cluster search.

Type

ClustersResponse object

Paginated response containing clusters