Skip to main content
POST
/
graphql#ListStockBalances
List stock balances
curl --request POST \
  --url 'https://clarus-api.com/graphql#ListStockBalances' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: StockBalancesFilterType) { stock_balances { all(filter: $filter) { edges { node { available allocated ordered received picked product { id code } account { id code } warehouse { id } } } } } }"
}
'
{
  "data": {
    "stock_balances": {
      "all": {
        "edges": [
          {
            "node": {
              "available": 1380,
              "allocated": 120,
              "ordered": 500,
              "received": 2000,
              "picked": 80,
              "product": {
                "id": "1024",
                "code": "WIDGET-RED-500"
              },
              "account": {
                "id": "7",
                "code": "ACME"
              },
              "warehouse": {
                "id": "2"
              }
            }
          }
        ]
      }
    }
  }
}

​
Query Structure

query($filter: StockBalancesFilterType) {
  stock_balances {
    all(filter: $filter) {
      edges {
        node {
          available
          allocated
          ordered
          received
          picked
          product { id code }
          account { id code }
          warehouse { id }
        }
      }
    }
  }
}

​
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
availableDecimalInputTypeeq, gt, gteq, lt, lteq, betweenAvailable quantity
allocatedDecimalInputTypeeq, gt, gteq, lt, lteq, betweenAllocated quantity
pickedDecimalInputTypeeq, gt, gteq, lt, lteq, betweenPicked quantity
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: StockBalancesFilterType) { stock_balances { all(filter: $filter) { edges { node { available allocated ordered received picked product { id code } account { id code } warehouse { id } } } } } }"

​
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