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 } } } } } }"
}
'import requests
url = "https://clarus-api.com/graphql#ListStocks"
payload = { "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 } } } } } }" }
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: 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 } } } } } }'
})
};
fetch('https://clarus-api.com/graphql#ListStocks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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"
}
}
}
]
}
}
}
}{
"error": "<string>"
}Stocks
List stocks
Retrieve individual stock records using GraphQL. Supports filtering, sorting, and pagination via relay-style connections.
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 } } } } } }"
}
'import requests
url = "https://clarus-api.com/graphql#ListStocks"
payload = { "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 } } } } } }" }
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: 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 } } } } } }'
})
};
fetch('https://clarus-api.com/graphql#ListStocks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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"
}
}
}
]
}
}
}
}{
"error": "<string>"
}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 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 |
location_id | IdInputType | eq, in, gt, gteq, lt, lteq, filled | Location ID |
location_code | StringInputType | eq, ilike, like, in, between | Location code |
storage_unit_id | IdInputType | eq, in, gt, gteq, lt, lteq, filled | Storage unit ID |
status | StringInputType | eq, ilike, like, in, between | Stock status (e.g. available, held) |
quantity | DecimalInputType | eq, gt, gteq, lt, lteq, between | Stock quantity |
fifo_date | DatetimeInputType | eq, from, to, between | FIFO date |
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: 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 } } } } } }"
Query variables including the filter object
Show child attributes
Show child attributes
Example:
{
"filter": { "product_code": { "ilike": "WIDGET" } }
}