Skip to main content
POST
List products

Query Structure

Filter Argument

All filters are passed inside the filter argument. Each filter field accepts an input object with operators:

Available Filters

Filter Operators

More fields and filters available via GraphQL introspection.

Authorizations

Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Body

application/json
query
string<textarea>
required

GraphQL query string

Example:

"query($filter: ProductsFilterType) { products { all(filter: $filter) { edges { node { id code barcode description long_description product_type units_per_case shelf_life_min shelf_life_max commodity_code country_of_manufacture } } } } }"

variables
object

Query variables including the filter object

Example:

Response

Successful GraphQL response

data
object

Query result data

errors
object[]

GraphQL errors, if any