List goods out orders
curl --request POST \
--url 'https://clarus-api.com/graphql#ListGoodsOuts' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"query": "query($filter: GoodsOutsFilterType) { goods_outs { all(filter: $filter) { edges { node { id reference priority expected_date_of_dispatch goods_out_status { code name } account { id code } warehouse { id code } carrier { id code } } } } } }"
}
'import requests
url = "https://clarus-api.com/graphql#ListGoodsOuts"
payload = { "query": "query($filter: GoodsOutsFilterType) { goods_outs { all(filter: $filter) { edges { node { id reference priority expected_date_of_dispatch goods_out_status { code name } account { id code } warehouse { id code } carrier { id code } } } } } }" }
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: GoodsOutsFilterType) { goods_outs { all(filter: $filter) { edges { node { id reference priority expected_date_of_dispatch goods_out_status { code name } account { id code } warehouse { id code } carrier { id code } } } } } }'
})
};
fetch('https://clarus-api.com/graphql#ListGoodsOuts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"goods_outs": {
"all": {
"edges": [
{
"node": {
"id": "1",
"reference": "SO-001",
"priority": 1,
"expected_date_of_dispatch": "2026-03-11",
"goods_out_status": {
"code": "PENDING",
"name": "Pending"
},
"account": {
"id": "1",
"code": "ACME"
},
"warehouse": {
"id": "1",
"code": "WH1"
},
"carrier": {
"id": "5",
"code": "DPD"
}
}
}
]
}
}
}
}{
"error": "<string>"
}Goods Out: Orders
List goods out orders
Retrieve outbound orders using GraphQL. Supports extensive filtering by reference, status, account, warehouse, carrier, dates, and custom fields.
POST
/
graphql#ListGoodsOuts
List goods out orders
curl --request POST \
--url 'https://clarus-api.com/graphql#ListGoodsOuts' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"query": "query($filter: GoodsOutsFilterType) { goods_outs { all(filter: $filter) { edges { node { id reference priority expected_date_of_dispatch goods_out_status { code name } account { id code } warehouse { id code } carrier { id code } } } } } }"
}
'import requests
url = "https://clarus-api.com/graphql#ListGoodsOuts"
payload = { "query": "query($filter: GoodsOutsFilterType) { goods_outs { all(filter: $filter) { edges { node { id reference priority expected_date_of_dispatch goods_out_status { code name } account { id code } warehouse { id code } carrier { id code } } } } } }" }
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: GoodsOutsFilterType) { goods_outs { all(filter: $filter) { edges { node { id reference priority expected_date_of_dispatch goods_out_status { code name } account { id code } warehouse { id code } carrier { id code } } } } } }'
})
};
fetch('https://clarus-api.com/graphql#ListGoodsOuts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"goods_outs": {
"all": {
"edges": [
{
"node": {
"id": "1",
"reference": "SO-001",
"priority": 1,
"expected_date_of_dispatch": "2026-03-11",
"goods_out_status": {
"code": "PENDING",
"name": "Pending"
},
"account": {
"id": "1",
"code": "ACME"
},
"warehouse": {
"id": "1",
"code": "WH1"
},
"carrier": {
"id": "5",
"code": "DPD"
}
}
}
]
}
}
}
}{
"error": "<string>"
}Query Structure
query($filter: GoodsOutsFilterType) {
goods_outs {
all(filter: $filter) {
edges {
node {
id
reference
priority
expected_date_of_dispatch
goods_out_status {
code
name
}
account {
id
code
}
warehouse {
id
code
}
carrier {
id
code
}
}
}
}
}
}
Filter Argument
All filters are passed inside thefilter argument. Each filter field accepts an input object with operators:
{
"filter": {
"goods_out_status_code": {
"eq": "PENDING"
}
}
}
Available Filters
| Filter | Input Type | Operators | Description |
|---|---|---|---|
reference | StringInputType | eq, ilike, like, in, between | Order reference |
goods_out_status_code | StringInputType | eq, ilike, like, in, between | Status code (DRAFT, PENDING, PICK, ALLOCATED, COMPLETED) |
account_id | IdInputType | eq, gt, gteq, lt, lteq, in, filled | Filter by account ID |
warehouse_id | IdInputType | eq, gt, gteq, lt, lteq, in, filled | Filter by warehouse ID |
carrier_id | IdInputType | eq, gt, gteq, lt, lteq, in, filled | Filter by carrier ID |
expected_date_of_dispatch | DatetimeInputType | eq, from, to, between | Expected dispatch date |
Filter Operators
| Input Type | Operators |
|---|---|
| StringInputType | eq (exact), ilike (case-insensitive partial), like (case-sensitive partial), in (array match), between (range) |
| IntegerInputType | eq, gt, gteq, lt, lteq, between |
| DatetimeInputType | eq, from, to, between |
| BooleanInputType | eq (required) |
| IdInputType | eq, gt, gteq, lt, lteq, in, filled |
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: GoodsOutsFilterType) { goods_outs { all(filter: $filter) { edges { node { id reference priority expected_date_of_dispatch goods_out_status { code name } account { id code } warehouse { id code } carrier { id code } } } } } }"
Query variables including the filter object
Show child attributes
Show child attributes
Example:
{
"filter": {
"goods_out_status_code": { "eq": "PENDING" }
}
}