Skip to main content
POST
/
graphql#ListStocks
List stocks
curl --request POST \
  --url 'https://clarus-api.com/graphql#ListStocks' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: StockFilterType) { stocks { all(filter: $filter) { edges { node { id quantity status fifo_date product { id code } location { id code } account { id code } storage_unit { id reference } } } } } }"
}
'
{
  "data": {
    "stocks": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "48211",
              "quantity": 240,
              "status": "available",
              "fifo_date": "2026-04-02T00:00:00Z",
              "product": {
                "id": "1024",
                "code": "WIDGET-RED-500"
              },
              "location": {
                "id": "318",
                "code": "AISLE-04-BAY-12"
              },
              "account": {
                "id": "7",
                "code": "ACME"
              },
              "storage_unit": {
                "id": "9981",
                "reference": "PAL00098231"
              }
            }
          }
        ]
      }
    }
  }
}

​
Query Structure

query($filter: StockFilterType) {
  stocks {
    all(filter: $filter) {
      edges {
        node {
          id
          quantity
          status
          fifo_date
          product {
            id
            code
          }
          location {
            id
            code
          }
          account {
            id
            code
          }
          storage_unit {
            id
            reference
          }
        }
      }
    }
  }
}

​
Filter Argument

All filters are passed inside the filter argument. Each filter field accepts an input object with operators (e.g. eq, ilike, from, to, between): 
{
  "filter": {
    "product_id": {
      "eq": "value"
    }
  }
}

​
Available Filters

FilterInput TypeOperatorsDescription
product_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledProduct ID
product_codeStringInputTypeeq, ilike, like, in, betweenProduct code
account_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledStock account ID (stock owner)
warehouse_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledWarehouse ID
location_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledLocation ID
location_codeStringInputTypeeq, ilike, like, in, betweenLocation code
storage_unit_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledStorage unit ID
statusStringInputTypeeq, ilike, like, in, betweenStock status (e.g. available, held)
quantityDecimalInputTypeeq, gt, gteq, lt, lteq, betweenStock quantity
fifo_dateDatetimeInputTypeeq, from, to, betweenFIFO date
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: StockFilterType) { stocks { all(filter: $filter) { edges { node { id quantity status fifo_date product { id code } location { id code } account { id code } storage_unit { id reference } } } } } }"

​
variables
object

Query variables including the filter object

Example:
{
  "filter": { "product_code": { "ilike": "WIDGET" } }
}

Response

Successful GraphQL response

​
data
object

Query result data

​
errors
object[]

GraphQL errors, if any