Skip to main content
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 } } } } }"
}
'
{
  "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"
            }
          }
        ]
      }
    }
  }
}

​
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 the filter 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

FilterInput TypeOperatorsDescription
goods_out_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledGoods out (sales order) ID
goods_out_referenceStringInputTypeeq, ilike, like, in, betweenGoods out reference
statusStatusInputTypeeq, inRequest status (enum input — pending, completed, failed)
process_referenceStringInputTypeeq, ilike, like, in, betweenProcessing reference
created_atDatetimeInputTypeeq, from, to, betweenCreation timestamp
updated_atDatetimeInputTypeeq, from, to, betweenLast update timestamp
More fields and filters available via GraphQL introspection.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

​
X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Body

application/json
​
query
string<textarea>
required

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 } } } } }"

​
variables
object

Query variables including the filter object

Example:
{
  "filter": { "status": { "eq": "completed" } }
}

Response

Successful GraphQL response

​
data
object

Query result data

​
errors
object[]

GraphQL errors, if any