List pick processing requests
curl --request POST \
--url 'https://clarus-api.com/graphql#ListPickProcessingRequests' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"query": "query($filter: PickProcessingRequestFilterType) { pick_processing_requests { all(filter: $filter) { edges { node { status process_reference message goods_out { id reference } created_at } } } } }"
}
'import requests
url = "https://clarus-api.com/graphql#ListPickProcessingRequests"
payload = { "query": "query($filter: PickProcessingRequestFilterType) { pick_processing_requests { all(filter: $filter) { edges { node { status process_reference message goods_out { id reference } created_at } } } } }" }
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: PickProcessingRequestFilterType) { pick_processing_requests { all(filter: $filter) { edges { node { status process_reference message goods_out { id reference } created_at } } } } }'
})
};
fetch('https://clarus-api.com/graphql#ListPickProcessingRequests', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"pick_processing_requests": {
"all": {
"edges": [
{
"node": {
"status": "completed",
"process_reference": "PPR-2026-004417",
"message": "Pick processing completed successfully",
"goods_out": {
"id": "3301",
"reference": "SO-2026-008812"
},
"created_at": "2026-06-15T09:14:02Z"
}
}
]
}
}
}
}{
"error": "<string>"
}Goods Out: Processing
List pick processing requests
Retrieve pick processing requests using GraphQL. These track asynchronous pick-list generation for goods out orders.
POST
/
graphql#ListPickProcessingRequests
List pick processing requests
curl --request POST \
--url 'https://clarus-api.com/graphql#ListPickProcessingRequests' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"query": "query($filter: PickProcessingRequestFilterType) { pick_processing_requests { all(filter: $filter) { edges { node { status process_reference message goods_out { id reference } created_at } } } } }"
}
'import requests
url = "https://clarus-api.com/graphql#ListPickProcessingRequests"
payload = { "query": "query($filter: PickProcessingRequestFilterType) { pick_processing_requests { all(filter: $filter) { edges { node { status process_reference message goods_out { id reference } created_at } } } } }" }
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: PickProcessingRequestFilterType) { pick_processing_requests { all(filter: $filter) { edges { node { status process_reference message goods_out { id reference } created_at } } } } }'
})
};
fetch('https://clarus-api.com/graphql#ListPickProcessingRequests', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"pick_processing_requests": {
"all": {
"edges": [
{
"node": {
"status": "completed",
"process_reference": "PPR-2026-004417",
"message": "Pick processing completed successfully",
"goods_out": {
"id": "3301",
"reference": "SO-2026-008812"
},
"created_at": "2026-06-15T09:14:02Z"
}
}
]
}
}
}
}{
"error": "<string>"
}Query Structure
query($filter: PickProcessingRequestFilterType) {
pick_processing_requests {
all(filter: $filter) {
edges {
node {
status
process_reference
message
goods_out { id reference }
created_at
}
}
}
}
}
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 | Goods out (sales order) ID |
goods_out_reference | StringInputType | eq, ilike, like, in, between | Goods out reference |
status | StatusInputType | eq, in | Request status (enum input — pending, completed, failed) |
process_reference | StringInputType | eq, ilike, like, in, between | Processing reference |
created_at | DatetimeInputType | eq, from, to, between | Creation timestamp |
updated_at | DatetimeInputType | eq, from, to, between | Last update 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: PickProcessingRequestFilterType) { pick_processing_requests { all(filter: $filter) { edges { node { status process_reference message goods_out { id reference } created_at } } } } }"
Query variables including the filter object
Show child attributes
Show child attributes
Example:
{ "filter": { "status": { "eq": "completed" } } }