List goods out lines
curl --request POST \
--url 'https://clarus-api.com/graphql#ListGoodsOutLines' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"query": "query($filter: GoodsOutLineFilterType) { goods_out_lines { all(filter: $filter) { edges { node { id order_quantity allocated_quantity pick_quantity dispatch_quantity short_status product { id code } goods_out { id reference } carrier { id } } } } } }"
}
'import requests
url = "https://clarus-api.com/graphql#ListGoodsOutLines"
payload = { "query": "query($filter: GoodsOutLineFilterType) { goods_out_lines { all(filter: $filter) { edges { node { id order_quantity allocated_quantity pick_quantity dispatch_quantity short_status product { id code } goods_out { id reference } carrier { 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: GoodsOutLineFilterType) { goods_out_lines { all(filter: $filter) { edges { node { id order_quantity allocated_quantity pick_quantity dispatch_quantity short_status product { id code } goods_out { id reference } carrier { id } } } } } }'
})
};
fetch('https://clarus-api.com/graphql#ListGoodsOutLines', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"goods_out_lines": {
"all": {
"edges": [
{
"node": {
"id": "60781",
"order_quantity": 100,
"allocated_quantity": 100,
"pick_quantity": 100,
"dispatch_quantity": 0,
"short_status": "",
"product": {
"id": "1024",
"code": "WIDGET-RED-500"
},
"goods_out": {
"id": "3301",
"reference": "SO-2026-008812"
},
"carrier": {
"id": "5"
}
}
}
]
}
}
}
}{
"error": "<string>"
}Goods Out: Orders
List goods out lines
Retrieve goods out (sales order) lines using GraphQL. Supports filtering, sorting, and pagination via relay-style connections.
POST
/
graphql#ListGoodsOutLines
List goods out lines
curl --request POST \
--url 'https://clarus-api.com/graphql#ListGoodsOutLines' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"query": "query($filter: GoodsOutLineFilterType) { goods_out_lines { all(filter: $filter) { edges { node { id order_quantity allocated_quantity pick_quantity dispatch_quantity short_status product { id code } goods_out { id reference } carrier { id } } } } } }"
}
'import requests
url = "https://clarus-api.com/graphql#ListGoodsOutLines"
payload = { "query": "query($filter: GoodsOutLineFilterType) { goods_out_lines { all(filter: $filter) { edges { node { id order_quantity allocated_quantity pick_quantity dispatch_quantity short_status product { id code } goods_out { id reference } carrier { 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: GoodsOutLineFilterType) { goods_out_lines { all(filter: $filter) { edges { node { id order_quantity allocated_quantity pick_quantity dispatch_quantity short_status product { id code } goods_out { id reference } carrier { id } } } } } }'
})
};
fetch('https://clarus-api.com/graphql#ListGoodsOutLines', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"goods_out_lines": {
"all": {
"edges": [
{
"node": {
"id": "60781",
"order_quantity": 100,
"allocated_quantity": 100,
"pick_quantity": 100,
"dispatch_quantity": 0,
"short_status": "",
"product": {
"id": "1024",
"code": "WIDGET-RED-500"
},
"goods_out": {
"id": "3301",
"reference": "SO-2026-008812"
},
"carrier": {
"id": "5"
}
}
}
]
}
}
}
}{
"error": "<string>"
}Query Structure
query($filter: GoodsOutLineFilterType) {
goods_out_lines {
all(filter: $filter) {
edges {
node {
id
order_quantity
allocated_quantity
pick_quantity
dispatch_quantity
short_status
product { id code }
goods_out { id reference }
carrier { 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": {
"goods_out_id": {
"eq": "value"
}
}
}
Available Filters
| Filter | Input Type | Operators | Description |
|---|---|---|---|
goods_out_id | IdInputType | eq, in, gt, gteq, lt, lteq, filled | Parent goods out (sales order) ID |
product_id | IdInputType | eq, in, gt, gteq, lt, lteq, filled | Product ID |
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 |
goods_out_status_code | StatusCodeInputType | eq, in | Goods out status code (enum input — e.g. PICK, ALLOCATED, COMPLETED) |
carrier_id | IdInputType | eq, in, gt, gteq, lt, lteq, filled | Carrier ID |
order_quantity | DecimalInputType | eq, gt, gteq, lt, lteq, between | Ordered quantity |
pick_quantity | DecimalInputType | eq, gt, gteq, lt, lteq, between | Picked quantity |
created_at | DatetimeInputType | eq, from, to, between | Creation timestamp |
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: GoodsOutLineFilterType) { goods_out_lines { all(filter: $filter) { edges { node { id order_quantity allocated_quantity pick_quantity dispatch_quantity short_status product { id code } goods_out { id reference } carrier { id } } } } } }"
Query variables including the filter object
Show child attributes
Show child attributes
Example:
{
"filter": { "goods_out_id": { "eq": "3301" } }
}