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 } } } } } }"
}
'import requests
url = "https://clarus-api.com/graphql#ListStockBalances"
payload = { "query": "query($filter: StockBalancesFilterType) { stock_balances { all(filter: $filter) { edges { node { available allocated ordered received picked product { id code } account { id code } warehouse { id } } } } } }" }
headers = {
"Authorization": "Bearer <token>",
"X-Clarus-Subdomain": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Clarus-Subdomain': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
query: 'query($filter: StockBalancesFilterType) { stock_balances { all(filter: $filter) { edges { node { available allocated ordered received picked product { id code } account { id code } warehouse { id } } } } } }'
})
};
fetch('https://clarus-api.com/graphql#ListStockBalances', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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"
}
}
}
]
}
}
}
}{
"error": "<string>"
}Stock Balances
List stock balances
Retrieve aggregated stock balances per product/account/warehouse using GraphQL. Balances summarise available, allocated, ordered, received and picked quantities.
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 } } } } } }"
}
'import requests
url = "https://clarus-api.com/graphql#ListStockBalances"
payload = { "query": "query($filter: StockBalancesFilterType) { stock_balances { all(filter: $filter) { edges { node { available allocated ordered received picked product { id code } account { id code } warehouse { id } } } } } }" }
headers = {
"Authorization": "Bearer <token>",
"X-Clarus-Subdomain": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Clarus-Subdomain': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
query: 'query($filter: StockBalancesFilterType) { stock_balances { all(filter: $filter) { edges { node { available allocated ordered received picked product { id code } account { id code } warehouse { id } } } } } }'
})
};
fetch('https://clarus-api.com/graphql#ListStockBalances', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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"
}
}
}
]
}
}
}
}{
"error": "<string>"
}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 thefilter argument. Each filter field accepts an input object with operators (e.g. eq, ilike, from, to, between):
{
"filter": {
"product_id": {
"eq": "value"
}
}
}
Available Filters
| Filter | Input Type | Operators | Description |
|---|---|---|---|
product_id | IdInputType | eq, in, gt, gteq, lt, lteq, filled | Product ID |
product_code | StringInputType | eq, ilike, like, in, between | Product code |
account_id | IdInputType | eq, in, gt, gteq, lt, lteq, filled | Stock account ID (stock owner) |
warehouse_id | IdInputType | eq, in, gt, gteq, lt, lteq, filled | Warehouse ID |
available | DecimalInputType | eq, gt, gteq, lt, lteq, between | Available quantity |
allocated | DecimalInputType | eq, gt, gteq, lt, lteq, between | Allocated quantity |
picked | DecimalInputType | eq, gt, gteq, lt, lteq, between | Picked quantity |
Authorizations
OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.
FlowAuthorization Code
- Authorization URL
- https://clarus-api.com/oauth/authorize
- Token URL
- https://clarus-api.com/oauth/token
FlowClient Credentials
- Token URL
- https://clarus-api.com/oauth/token
The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.
Body
application/json
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 } } } } } }"
Query variables including the filter object
Show child attributes
Show child attributes
Example:
{
"filter": { "product_code": { "ilike": "WIDGET" } }
}