Skip to main content
POST
/
graphql#ListGoodsOutPickLists
List goods out pick lists
curl --request POST \
  --url 'https://clarus-api.com/graphql#ListGoodsOutPickLists' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: GoodsOutPickListsFilterType) { goods_out_pick_lists { all(filter: $filter) { edges { node { id reference pick_reference pick_type load_reference goods_out_status { code name } account { id code } warehouse { id code } } } } } }"
}
'
{
  "data": {
    "goods_out_pick_lists": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "1",
              "reference": "PL-001",
              "pick_reference": "PICK-001",
              "pick_type": "single",
              "load_reference": null,
              "goods_out_status": {
                "code": "PICK",
                "name": "Picking"
              },
              "account": {
                "id": "1",
                "code": "ACME"
              },
              "warehouse": {
                "id": "1",
                "code": "WH1"
              }
            }
          }
        ]
      }
    }
  }
}

​
Query Structure

query($filter: GoodsOutPickListsFilterType) {
  goods_out_pick_lists {
    all(filter: $filter) {
      edges {
        node {
          id
          reference
          pick_reference
          pick_type
          load_reference
          goods_out_status {
            code
            name
          }
          account {
            id
            code
          }
          warehouse {
            id
            code
          }
        }
      }
    }
  }
}

​
Filter Argument

All filters are passed inside the filter argument. Each filter field accepts an input object with operators: 
{
  "filter": {
    "pick_tasks_count": {
      "gteq": 1
    }
  }
}

​
Available Filters

FilterInput TypeOperatorsDescription
pick_tasks_countIntegerInputTypeeq, gt, gteq, lt, lteq, betweenNumber of pick tasks
completed_pick_tasks_countIntegerInputTypeeq, gt, gteq, lt, lteq, betweenNumber of completed pick tasks
loading_tasks_countIntegerInputTypeeq, gt, gteq, lt, lteq, betweenNumber of loading tasks
completed_loading_tasks_countIntegerInputTypeeq, gt, gteq, lt, lteq, betweenNumber of completed loading tasks
dispatch_tasks_countIntegerInputTypeeq, gt, gteq, lt, lteq, betweenNumber of dispatch tasks
completed_dispatch_tasks_countIntegerInputTypeeq, gt, gteq, lt, lteq, betweenNumber of completed dispatch tasks

​
Filter Operators

Input TypeOperators
StringInputTypeeq (exact), ilike (case-insensitive partial), like (case-sensitive partial), in (array match), between (range)
IntegerInputTypeeq, gt, gteq, lt, lteq, between
DatetimeInputTypeeq, from, to, between
BooleanInputTypeeq (required)
IdInputTypeeq, gt, gteq, lt, lteq, in, filled
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: GoodsOutPickListsFilterType) { goods_out_pick_lists { all(filter: $filter) { edges { node { id reference pick_reference pick_type load_reference goods_out_status { code name } account { id code } warehouse { id code } } } } } }"

​
variables
object

Query variables including the filter object

Example:
{
  "filter": { "pick_tasks_count": { "gteq": 1 } }
}

Response

Successful GraphQL response

​
data
object

Query result data

​
errors
object[]

GraphQL errors, if any